d7258fffd0
The functions used to track the resultset EOF packets now expose the position of the end of the result set. This allows the modules that use them to check if more results exist in the same buffer. Added the status bits for OK and EOF packets to the mysql.h protocol header. This can be used to check for various state changes that happen in the session. Currently the status bits are only used to detect if more results are expected.
109 lines
4.4 KiB
C
109 lines
4.4 KiB
C
#pragma once
|
|
/*
|
|
* Copyright (c) 2016 MariaDB Corporation Ab
|
|
*
|
|
* Use of this software is governed by the Business Source License included
|
|
* in the LICENSE.TXT file and at www.mariadb.com/bsl11.
|
|
*
|
|
* Change Date: 2019-07-01
|
|
*
|
|
* On the date above, in accordance with the Business Source License, use
|
|
* of this software will be governed by version 2 or later of the General
|
|
* Public License.
|
|
*/
|
|
|
|
/**
|
|
* @file modutil.h A set of useful routines for module writers
|
|
*/
|
|
|
|
#include <maxscale/cdefs.h>
|
|
#include <maxscale/buffer.h>
|
|
#include <maxscale/dcb.h>
|
|
#include <string.h>
|
|
#include <maxscale/pcre2.h>
|
|
|
|
MXS_BEGIN_DECLS
|
|
|
|
#define PTR_IS_RESULTSET(b) (b[0] == 0x01 && b[1] == 0x0 && b[2] == 0x0 && b[3] == 0x01)
|
|
#define PTR_IS_EOF(b) (b[0] == 0x05 && b[1] == 0x0 && b[2] == 0x0 && b[4] == 0xfe)
|
|
#define PTR_IS_OK(b) (b[4] == 0x00)
|
|
#define PTR_IS_ERR(b) (b[4] == 0xff)
|
|
#define PTR_IS_LOCAL_INFILE(b) (b[4] == 0xfb)
|
|
#define IS_FULL_RESPONSE(buf) (modutil_count_signal_packets(buf,0,0) == 2)
|
|
|
|
extern int modutil_is_SQL(GWBUF *);
|
|
extern int modutil_is_SQL_prepare(GWBUF *);
|
|
extern int modutil_extract_SQL(GWBUF *, char **, int *);
|
|
extern int modutil_MySQL_Query(GWBUF *, char **, int *, int *);
|
|
extern char* modutil_get_SQL(GWBUF *);
|
|
extern GWBUF* modutil_replace_SQL(GWBUF *, char *);
|
|
extern char* modutil_get_query(GWBUF* buf);
|
|
extern int modutil_send_mysql_err_packet(DCB *, int, int, int, const char *, const char *);
|
|
GWBUF* modutil_get_next_MySQL_packet(GWBUF** p_readbuf);
|
|
GWBUF* modutil_get_complete_packets(GWBUF** p_readbuf);
|
|
int modutil_MySQL_query_len(GWBUF* buf, int* nbytes_missing);
|
|
void modutil_reply_parse_error(DCB* backend_dcb, char* errstr, uint32_t flags);
|
|
void modutil_reply_auth_error(DCB* backend_dcb, char* errstr, uint32_t flags);
|
|
int modutil_count_statements(GWBUF* buffer);
|
|
GWBUF* modutil_create_query(const char* query);
|
|
GWBUF* modutil_create_mysql_err_msg(int packet_number,
|
|
int affected_rows,
|
|
int merrno,
|
|
const char *statemsg,
|
|
const char *msg);
|
|
|
|
/**
|
|
* @brief Count the number of EOF and ERR packets in the buffer.
|
|
*
|
|
* Only complete packets are inspected and the buffer is assumed to only contain
|
|
* whole packets. If partial packets are in the buffer, they are ignored.
|
|
* The caller must handle the detection of partial packets in buffers.
|
|
*
|
|
* @param reply Buffer to use
|
|
* @param n_found Number of previous found packets
|
|
* @param more Set to true of more results exist
|
|
* @param offset_out Initial offset into the buffer. This offset is set to point
|
|
* to the first byte after the last packet in the buffer.
|
|
*
|
|
* @return Total number of EOF and ERR packets including the ones already found
|
|
*/
|
|
int modutil_count_signal_packets(GWBUF *reply, int n_found, bool* more, size_t* offset_out);
|
|
|
|
mxs_pcre2_result_t modutil_mysql_wildcard_match(const char* pattern, const char* string);
|
|
|
|
/**
|
|
* Given a buffer containing a MySQL statement, this function will return
|
|
* a pointer to the first character that is not whitespace. In this context,
|
|
* comments are also counted as whitespace. For instance:
|
|
*
|
|
* "SELECT" => "SELECT"
|
|
* " SELECT => "SELECT"
|
|
* " / * A comment * / SELECT" => "SELECT"
|
|
* "-- comment\nSELECT" => "SELECT"
|
|
*
|
|
* @param sql Pointer to buffer containing a MySQL statement
|
|
* @param len Length of sql.
|
|
*
|
|
* @return The first non whitespace (including comments) character. If the
|
|
* entire buffer is only whitespace, the returned pointer will point
|
|
* to the character following the buffer (i.e. sql + len).
|
|
*/
|
|
char* modutil_MySQL_bypass_whitespace(char* sql, size_t len);
|
|
|
|
/**
|
|
* @brief Write a COM_PING to a DCB and ignore the response
|
|
*
|
|
* @param dcb The backend DCB where the COM_PING is written
|
|
* @return True if command was successfully sent
|
|
*/
|
|
bool modutil_ignorable_ping(DCB *dcb);
|
|
|
|
/** Character and token searching functions */
|
|
char* strnchr_esc(char* ptr, char c, int len);
|
|
char* strnchr_esc_mysql(char* ptr, char c, int len);
|
|
bool is_mysql_statement_end(const char* start, int len);
|
|
bool is_mysql_sp_end(const char* start, int len);
|
|
char* modutil_get_canonical(GWBUF* querybuf);
|
|
|
|
MXS_END_DECLS
|