mirror of
https://github.com/php/php-src.git
synced 2024-09-23 02:47:26 +00:00
343 lines
9.9 KiB
C
343 lines
9.9 KiB
C
/*
|
|
+----------------------------------------------------------------------+
|
|
| PHP Version 6 |
|
|
+----------------------------------------------------------------------+
|
|
| Copyright (c) 2006-2009 The PHP Group |
|
|
+----------------------------------------------------------------------+
|
|
| This source file is subject to version 3.01 of the PHP license, |
|
|
| that is bundled with this package in the file LICENSE, and is |
|
|
| available through the world-wide-web at the following url: |
|
|
| http://www.php.net/license/3_01.txt |
|
|
| If you did not receive a copy of the PHP license and are unable to |
|
|
| obtain it through the world-wide-web, please send a note to |
|
|
| license@php.net so we can mail you a copy immediately. |
|
|
+----------------------------------------------------------------------+
|
|
| Authors: Georg Richter <georg@mysql.com> |
|
|
| Andrey Hristov <andrey@mysql.com> |
|
|
| Ulf Wendel <uwendel@mysql.com> |
|
|
+----------------------------------------------------------------------+
|
|
*/
|
|
|
|
/* $Id$ */
|
|
|
|
#ifndef MYSQLND_WIREPROTOCOL_H
|
|
#define MYSQLND_WIREPROTOCOL_H
|
|
|
|
#define MYSQLND_HEADER_SIZE 4
|
|
|
|
#define MYSQLND_NULL_LENGTH (unsigned long) ~0
|
|
|
|
/* Used in mysqlnd_debug.c */
|
|
extern char * mysqlnd_read_header_name;
|
|
extern char * mysqlnd_read_body_name;
|
|
|
|
|
|
/* Packet handling */
|
|
#define PACKET_INIT(packet, enum_type, c_type, pers) \
|
|
{ \
|
|
packet = (c_type) pecalloc(1, packet_methods[(enum_type)].struct_size, (pers)); \
|
|
((c_type) (packet))->header.m = &packet_methods[(enum_type)]; \
|
|
((c_type) (packet))->header.persistent = (pers); \
|
|
DBG_INF_FMT("PACKET_INIT(%p, %d, %d)", packet, (int) enum_type, (int) pers); \
|
|
}
|
|
#define PACKET_WRITE(packet, conn) ((packet)->header.m->write_to_net((packet), (conn) TSRMLS_CC))
|
|
#define PACKET_READ(packet, conn) ((packet)->header.m->read_from_net((packet), (conn) TSRMLS_CC))
|
|
#define PACKET_FREE(packet) \
|
|
do { \
|
|
DBG_INF_FMT("PACKET_FREE(%p)", packet); \
|
|
((packet)->header.m->free_mem((packet), FALSE TSRMLS_CC)); \
|
|
} while (0);
|
|
|
|
#define PACKET_INIT_ALLOCA(packet, enum_type) \
|
|
{ \
|
|
memset(&(packet), 0, packet_methods[enum_type].struct_size); \
|
|
(packet).header.m = &packet_methods[enum_type]; \
|
|
}
|
|
#define PACKET_WRITE_ALLOCA(packet, conn) PACKET_WRITE(&(packet), (conn))
|
|
#define PACKET_READ_ALLOCA(packet, conn) PACKET_READ(&(packet), (conn))
|
|
#define PACKET_FREE_ALLOCA(packet) (packet.header.m->free_mem(&(packet), TRUE TSRMLS_CC))
|
|
|
|
/* Enums */
|
|
enum php_mysql_packet_type
|
|
{
|
|
PROT_GREET_PACKET= 0,
|
|
PROT_AUTH_PACKET,
|
|
PROT_OK_PACKET,
|
|
PROT_EOF_PACKET,
|
|
PROT_CMD_PACKET,
|
|
PROT_RSET_HEADER_PACKET,
|
|
PROT_RSET_FLD_PACKET,
|
|
PROT_ROW_PACKET,
|
|
PROT_STATS_PACKET,
|
|
PROT_PREPARE_RESP_PACKET,
|
|
PROT_CHG_USER_PACKET,
|
|
PROT_LAST, /* should always be last */
|
|
};
|
|
|
|
|
|
enum php_mysqlnd_server_command
|
|
{
|
|
COM_SLEEP = 0,
|
|
COM_QUIT,
|
|
COM_INIT_DB,
|
|
COM_QUERY,
|
|
COM_FIELD_LIST,
|
|
COM_CREATE_DB,
|
|
COM_DROP_DB,
|
|
COM_REFRESH,
|
|
COM_SHUTDOWN,
|
|
COM_STATISTICS,
|
|
COM_PROCESS_INFO,
|
|
COM_CONNECT,
|
|
COM_PROCESS_KILL,
|
|
COM_DEBUG,
|
|
COM_PING,
|
|
COM_TIME = 15,
|
|
COM_DELAYED_INSERT,
|
|
COM_CHANGE_USER,
|
|
COM_BINLOG_DUMP,
|
|
COM_TABLE_DUMP,
|
|
COM_CONNECT_OUT = 20,
|
|
COM_REGISTER_SLAVE,
|
|
COM_STMT_PREPARE = 22,
|
|
COM_STMT_EXECUTE = 23,
|
|
COM_STMT_SEND_LONG_DATA = 24,
|
|
COM_STMT_CLOSE = 25,
|
|
COM_STMT_RESET = 26,
|
|
COM_SET_OPTION = 27,
|
|
COM_STMT_FETCH = 28,
|
|
COM_DAEMON,
|
|
COM_END
|
|
};
|
|
|
|
extern const char * const mysqlnd_command_to_text[COM_END];
|
|
|
|
/* Low-level extraction functionality */
|
|
typedef struct st_mysqlnd_packet_methods {
|
|
size_t struct_size;
|
|
enum_func_status (*read_from_net)(void *packet, MYSQLND *conn TSRMLS_DC);
|
|
size_t (*write_to_net)(void *packet, MYSQLND *conn TSRMLS_DC);
|
|
void (*free_mem)(void *packet, zend_bool alloca TSRMLS_DC);
|
|
} mysqlnd_packet_methods;
|
|
|
|
extern mysqlnd_packet_methods packet_methods[];
|
|
|
|
|
|
typedef struct st_mysqlnd_packet_header {
|
|
size_t size;
|
|
mysqlnd_packet_methods *m;
|
|
zend_uchar packet_no;
|
|
zend_bool persistent;
|
|
} mysqlnd_packet_header;
|
|
|
|
/* Server greets the client */
|
|
typedef struct st_php_mysql_packet_greet {
|
|
mysqlnd_packet_header header;
|
|
uint8_t protocol_version;
|
|
char *server_version;
|
|
uint32_t thread_id;
|
|
zend_uchar scramble_buf[SCRAMBLE_LENGTH];
|
|
/* 1 byte pad */
|
|
uint16_t server_capabilities;
|
|
uint8_t charset_no;
|
|
uint16_t server_status;
|
|
/* 13 byte pad*/
|
|
zend_bool pre41;
|
|
/* If error packet, we use these */
|
|
char error[MYSQLND_ERRMSG_SIZE+1];
|
|
char sqlstate[MYSQLND_SQLSTATE_LENGTH + 1];
|
|
unsigned int error_no;
|
|
} php_mysql_packet_greet;
|
|
|
|
|
|
/* Client authenticates */
|
|
typedef struct st_php_mysql_packet_auth {
|
|
mysqlnd_packet_header header;
|
|
uint32_t client_flags;
|
|
uint32_t max_packet_size;
|
|
uint8_t charset_no;
|
|
/* 23 byte pad */
|
|
const char *user;
|
|
/* 8 byte scramble */
|
|
const char *db;
|
|
/* 12 byte scramble */
|
|
|
|
/* Here the packet ends. This is user supplied data */
|
|
const char *password;
|
|
/* +1 for \0 because of scramble() */
|
|
unsigned char *server_scramble_buf;
|
|
size_t db_len;
|
|
} php_mysql_packet_auth;
|
|
|
|
/* OK packet */
|
|
typedef struct st_php_mysql_packet_ok {
|
|
mysqlnd_packet_header header;
|
|
uint8_t field_count; /* always 0x0 */
|
|
uint64_t affected_rows;
|
|
uint64_t last_insert_id;
|
|
uint16_t server_status;
|
|
uint16_t warning_count;
|
|
char *message;
|
|
size_t message_len;
|
|
/* If error packet, we use these */
|
|
char error[MYSQLND_ERRMSG_SIZE+1];
|
|
char sqlstate[MYSQLND_SQLSTATE_LENGTH + 1];
|
|
unsigned int error_no;
|
|
} php_mysql_packet_ok;
|
|
|
|
|
|
/* Command packet */
|
|
typedef struct st_php_mysql_packet_command {
|
|
mysqlnd_packet_header header;
|
|
enum php_mysqlnd_server_command command;
|
|
const char *argument;
|
|
size_t arg_len;
|
|
} php_mysql_packet_command;
|
|
|
|
|
|
/* EOF packet */
|
|
typedef struct st_php_mysql_packet_eof {
|
|
mysqlnd_packet_header header;
|
|
uint8_t field_count; /* 0xFE */
|
|
uint16_t warning_count;
|
|
uint16_t server_status;
|
|
/* If error packet, we use these */
|
|
char error[MYSQLND_ERRMSG_SIZE+1];
|
|
char sqlstate[MYSQLND_SQLSTATE_LENGTH + 1];
|
|
unsigned int error_no;
|
|
} php_mysql_packet_eof;
|
|
/* EOF packet */
|
|
|
|
|
|
/* Result Set header*/
|
|
typedef struct st_php_mysql_packet_rset_header {
|
|
mysqlnd_packet_header header;
|
|
/*
|
|
0x00 => ok
|
|
~0 => LOAD DATA LOCAL
|
|
error_no != 0 => error
|
|
others => result set -> Read res_field packets up to field_count
|
|
*/
|
|
unsigned long field_count;
|
|
/*
|
|
These are filled if no SELECT query. For SELECT warning_count
|
|
and server status are in the last row packet, the EOF packet.
|
|
*/
|
|
uint16_t warning_count;
|
|
uint16_t server_status;
|
|
uint64_t affected_rows;
|
|
uint64_t last_insert_id;
|
|
/* This is for both LOAD DATA or info, when no result set */
|
|
char *info_or_local_file;
|
|
size_t info_or_local_file_len;
|
|
/* If error packet, we use these */
|
|
mysqlnd_error_info error_info;
|
|
} php_mysql_packet_rset_header;
|
|
|
|
|
|
/* Result set field packet */
|
|
typedef struct st_php_mysql_packet_res_field {
|
|
mysqlnd_packet_header header;
|
|
MYSQLND_FIELD *metadata;
|
|
/* For table definitions, empty for result sets */
|
|
zend_bool skip_parsing;
|
|
zend_bool stupid_list_fields_eof;
|
|
} php_mysql_packet_res_field;
|
|
|
|
|
|
/* Row packet */
|
|
struct st_php_mysql_packet_row {
|
|
mysqlnd_packet_header header;
|
|
zval **fields;
|
|
uint32_t field_count;
|
|
zend_bool eof;
|
|
/*
|
|
These are, of course, only for SELECT in the EOF packet,
|
|
which is detected by this packet
|
|
*/
|
|
uint16_t warning_count;
|
|
uint16_t server_status;
|
|
|
|
struct st_mysqlnd_memory_pool_chunk *row_buffer;
|
|
|
|
zend_bool skip_extraction;
|
|
zend_bool binary_protocol;
|
|
zend_bool persistent_alloc;
|
|
MYSQLND_FIELD *fields_metadata;
|
|
/* We need this to alloc bigger bufs in non-PS mode */
|
|
unsigned int bit_fields_count;
|
|
size_t bit_fields_total_len; /* trailing \0 not counted */
|
|
|
|
/* If error packet, we use these */
|
|
mysqlnd_error_info error_info;
|
|
};
|
|
|
|
|
|
/* Statistics packet */
|
|
typedef struct st_php_mysql_packet_stats {
|
|
mysqlnd_packet_header header;
|
|
char *message;
|
|
/* message_len is not part of the packet*/
|
|
size_t message_len;
|
|
} php_mysql_packet_stats;
|
|
|
|
|
|
/* COM_PREPARE response packet */
|
|
typedef struct st_php_mysql_packet_prepare_response {
|
|
mysqlnd_packet_header header;
|
|
/* also known as field_count 0x00=OK , 0xFF=error */
|
|
unsigned char error_code;
|
|
unsigned long stmt_id;
|
|
unsigned int field_count;
|
|
unsigned int param_count;
|
|
unsigned int warning_count;
|
|
|
|
/* present in case of error */
|
|
mysqlnd_error_info error_info;
|
|
} php_mysql_packet_prepare_response;
|
|
|
|
|
|
/* Statistics packet */
|
|
typedef struct st_php_mysql_packet_chg_user_resp {
|
|
mysqlnd_packet_header header;
|
|
uint32_t field_count;
|
|
|
|
/* message_len is not part of the packet*/
|
|
uint16_t server_capabilities;
|
|
/* If error packet, we use these */
|
|
mysqlnd_error_info error_info;
|
|
} php_mysql_packet_chg_user_resp;
|
|
|
|
|
|
size_t mysqlnd_stream_write(MYSQLND * const conn, char * const buf, size_t count TSRMLS_DC);
|
|
size_t mysqlnd_stream_write_w_header(MYSQLND * const conn, char * const buf, size_t count TSRMLS_DC);
|
|
|
|
#ifdef MYSQLND_DO_WIRE_CHECK_BEFORE_COMMAND
|
|
size_t php_mysqlnd_consume_uneaten_data(MYSQLND * const conn, enum php_mysqlnd_server_command cmd TSRMLS_DC);
|
|
#endif
|
|
|
|
void php_mysqlnd_scramble(zend_uchar * const buffer, const zend_uchar * const scramble, const zend_uchar * const pass);
|
|
|
|
unsigned long php_mysqlnd_net_field_length(zend_uchar **packet);
|
|
zend_uchar * php_mysqlnd_net_store_length(zend_uchar *packet, uint64_t length);
|
|
|
|
extern char * const mysqlnd_empty_string;
|
|
|
|
|
|
void php_mysqlnd_rowp_read_binary_protocol(MYSQLND_MEMORY_POOL_CHUNK * row_buffer, zval ** fields,
|
|
unsigned int field_count, MYSQLND_FIELD *fields_metadata, MYSQLND *conn TSRMLS_DC);
|
|
|
|
void php_mysqlnd_rowp_read_text_protocol(MYSQLND_MEMORY_POOL_CHUNK * row_buffer, zval ** fields,
|
|
unsigned int field_count, MYSQLND_FIELD *fields_metadata, MYSQLND *conn TSRMLS_DC);
|
|
|
|
#endif /* MYSQLND_WIREPROTOCOL_H */
|
|
|
|
/*
|
|
* Local variables:
|
|
* tab-width: 4
|
|
* c-basic-offset: 4
|
|
* End:
|
|
* vim600: noet sw=4 ts=4 fdm=marker
|
|
* vim<600: noet sw=4 ts=4
|
|
*/
|