/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*- * vim:expandtab:shiftwidth=2:tabstop=2:smarttab: * * Copyright (C) 2008 Sun Microsystems, Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ #include #include "libdrizzle.h" #include "libdrizzle_priv.h" #include "errmsg.h" #include "vio.h" #include #include #include #include #include #include #include #include #include /* The following handles the differences when this is linked between the client and the server. This gives an error if a too big packet is found The server can change this with the -O switch, but because the client can't normally do this the client should have a bigger max_allowed_packet. */ #define MAX_PACKET_LENGTH (256L*256L*256L-1) static bool net_write_buff(NET *net, const unsigned char *packet, uint32_t len); /** Init with packet info. */ bool drizzleclient_net_init(NET *net, Vio* vio) { net->vio = vio; drizzleclient_net_local_init(net); /* Set some limits */ if (!(net->buff=(unsigned char*) malloc((size_t) net->max_packet+ NET_HEADER_SIZE + COMP_HEADER_SIZE))) return(1); net->buff_end=net->buff+net->max_packet; net->error=0; net->return_status=0; net->pkt_nr=net->compress_pkt_nr=0; net->write_pos=net->read_pos = net->buff; net->last_error[0]=0; net->compress=0; net->reading_or_writing=0; net->where_b = net->remain_in_buf=0; net->last_errno=0; net->unused= 0; if (vio != 0) /* If real connection */ { net->fd = drizzleclient_vio_fd(vio); /* For perl DBI/DBD */ drizzleclient_vio_fastsend(vio); } return(0); } bool drizzleclient_net_init_sock(NET * net, int sock, int flags) { Vio *drizzleclient_vio_tmp= drizzleclient_vio_new(sock, VIO_TYPE_TCPIP, flags); if (drizzleclient_vio_tmp == NULL) return true; else if (drizzleclient_net_init(net, drizzleclient_vio_tmp)) { /* Only delete the temporary vio if we didn't already attach it to the * NET object. */ if (drizzleclient_vio_tmp && (net->vio != drizzleclient_vio_tmp)) drizzleclient_vio_delete(drizzleclient_vio_tmp); else { (void) shutdown(sock, SHUT_RDWR); (void) close(sock); } return true; } return false; } void drizzleclient_net_end(NET *net) { if (net->buff != NULL) free(net->buff); net->buff= NULL; return; } void drizzleclient_net_close(NET *net) { if (net->vio != NULL) { drizzleclient_vio_delete(net->vio); net->vio= 0; } } bool drizzleclient_net_peer_addr(NET *net, char *buf, uint16_t *port, size_t buflen) { return drizzleclient_vio_peer_addr(net->vio, buf, port, buflen); } void drizzleclient_net_keepalive(NET *net, bool flag) { drizzleclient_vio_keepalive(net->vio, flag); } int drizzleclient_net_get_sd(NET *net) { return net->vio->sd; } bool drizzleclient_net_should_close(NET *net) { return net->error || (net->vio == 0); } bool drizzleclient_net_more_data(NET *net) { return (net->vio == 0 || net->vio->read_pos < net->vio->read_end); } /** Realloc the packet buffer. */ bool drizzleclient_net_realloc(NET *net, size_t length) { unsigned char *buff; size_t pkt_length; if (length >= net->max_packet_size) { /* @todo: 1 and 2 codes are identical. */ net->error= 1; net->last_errno= CR_NET_PACKET_TOO_LARGE; return(1); } pkt_length = (length+IO_SIZE-1) & ~(IO_SIZE-1); /* We must allocate some extra bytes for the end 0 and to be able to read big compressed blocks */ if (!(buff= (unsigned char*) realloc((char*) net->buff, pkt_length + NET_HEADER_SIZE + COMP_HEADER_SIZE))) { /* @todo: 1 and 2 codes are identical. */ net->error= 1; net->last_errno= CR_OUT_OF_MEMORY; /* In the server the error is reported by MY_WME flag. */ return(1); } net->buff=net->write_pos=buff; net->buff_end=buff+(net->max_packet= (uint32_t) pkt_length); return(0); } /** Check if there is any data to be read from the socket. @param sd socket descriptor @retval 0 No data to read @retval 1 Data or EOF to read @retval -1 Don't know if data is ready or not */ static bool net_data_is_ready(int sd) { struct pollfd ufds; int res; ufds.fd= sd; ufds.events= POLLIN | POLLPRI; if (!(res= poll(&ufds, 1, 0))) return 0; if (res < 0 || !(ufds.revents & (POLLIN | POLLPRI))) return 0; return 1; } /** Remove unwanted characters from connection and check if disconnected. Read from socket until there is nothing more to read. Discard what is read. If there is anything when to read 'drizzleclient_net_clear' is called this normally indicates an error in the protocol. When connection is properly closed (for TCP it means with a FIN packet), then select() considers a socket "ready to read", in the sense that there's EOF to read, but read() returns 0. @param net NET handler @param clear_buffer if <> 0, then clear all data from comm buff */ void drizzleclient_net_clear(NET *net, bool clear_buffer) { if (clear_buffer) { while (net_data_is_ready(net->vio->sd) > 0) { /* The socket is ready */ if (drizzleclient_vio_read(net->vio, net->buff, (size_t) net->max_packet) <= 0) { net->error= 2; break; } } } net->pkt_nr=net->compress_pkt_nr=0; /* Ready for new command */ net->write_pos=net->buff; return; } /** Flush write_buffer if not empty. */ bool drizzleclient_net_flush(NET *net) { bool error= 0; if (net->buff != net->write_pos) { error=drizzleclient_net_real_write(net, net->buff, (size_t) (net->write_pos - net->buff)) ? 1 : 0; net->write_pos=net->buff; } /* Sync packet number if using compression */ if (net->compress) net->pkt_nr=net->compress_pkt_nr; return(error); } /***************************************************************************** ** Write something to server/client buffer *****************************************************************************/ /** Write a logical packet with packet header. Format: Packet length (3 bytes), packet number(1 byte) When compression is used a 3 byte compression length is added @note If compression is used the original package is modified! */ bool drizzleclient_net_write(NET *net,const unsigned char *packet,size_t len) { unsigned char buff[NET_HEADER_SIZE]; if (unlikely(!net->vio)) /* nowhere to write */ return 0; /* Big packets are handled by splitting them in packets of MAX_PACKET_LENGTH length. The last packet is always a packet that is < MAX_PACKET_LENGTH. (The last packet may even have a length of 0) */ while (len >= MAX_PACKET_LENGTH) { const uint32_t z_size = MAX_PACKET_LENGTH; int3store(buff, z_size); buff[3]= (unsigned char) net->pkt_nr++; if (net_write_buff(net, buff, NET_HEADER_SIZE) || net_write_buff(net, packet, z_size)) return 1; packet += z_size; len-= z_size; } /* Write last packet */ int3store(buff,len); buff[3]= (unsigned char) net->pkt_nr++; if (net_write_buff(net, buff, NET_HEADER_SIZE)) return 1; return net_write_buff(net,packet,len) ? 1 : 0; } /** Send a command to the server. The reason for having both header and packet is so that libdrizzle can easy add a header to a special command (like prepared statements) without having to re-alloc the string. As the command is part of the first data packet, we have to do some data juggling to put the command in there, without having to create a new packet. This function will split big packets into sub-packets if needed. (Each sub packet can only be 2^24 bytes) @param net NET handler @param command Command in MySQL server (enum enum_server_command) @param header Header to write after command @param head_len Length of header @param packet Query or parameter to query @param len Length of packet @retval 0 ok @retval 1 error */ bool drizzleclient_net_write_command(NET *net,unsigned char command, const unsigned char *header, size_t head_len, const unsigned char *packet, size_t len) { uint32_t length=len+1+head_len; /* 1 extra byte for command */ unsigned char buff[NET_HEADER_SIZE+1]; uint32_t header_size=NET_HEADER_SIZE+1; buff[4]=command; /* For first packet */ if (length >= MAX_PACKET_LENGTH) { /* Take into account that we have the command in the first header */ len= MAX_PACKET_LENGTH - 1 - head_len; do { int3store(buff, MAX_PACKET_LENGTH); buff[3]= (unsigned char) net->pkt_nr++; if (net_write_buff(net, buff, header_size) || net_write_buff(net, header, head_len) || net_write_buff(net, packet, len)) return(1); packet+= len; length-= MAX_PACKET_LENGTH; len= MAX_PACKET_LENGTH; head_len= 0; header_size= NET_HEADER_SIZE; } while (length >= MAX_PACKET_LENGTH); len=length; /* Data left to be written */ } int3store(buff,length); buff[3]= (unsigned char) net->pkt_nr++; return((net_write_buff(net, buff, header_size) || (head_len && net_write_buff(net, header, head_len)) || net_write_buff(net, packet, len) || drizzleclient_net_flush(net)) ? 1 : 0 ); } /** Caching the data in a local buffer before sending it. Fill up net->buffer and send it to the client when full. If the rest of the to-be-sent-packet is bigger than buffer, send it in one big block (to avoid copying to internal buffer). If not, copy the rest of the data to the buffer and return without sending data. @param net Network handler @param packet Packet to send @param len Length of packet @note The cached buffer can be sent as it is with 'drizzleclient_net_flush()'. In this code we have to be careful to not send a packet longer than MAX_PACKET_LENGTH to drizzleclient_net_real_write() if we are using the compressed protocol as we store the length of the compressed packet in 3 bytes. @retval 0 ok @retval 1 */ static bool net_write_buff(NET *net, const unsigned char *packet, uint32_t len) { uint32_t left_length; if (net->compress && net->max_packet > MAX_PACKET_LENGTH) left_length= MAX_PACKET_LENGTH - (net->write_pos - net->buff); else left_length= (uint32_t) (net->buff_end - net->write_pos); if (len > left_length) { if (net->write_pos != net->buff) { /* Fill up already used packet and write it */ memcpy(net->write_pos,packet,left_length); if (drizzleclient_net_real_write(net, net->buff, (size_t) (net->write_pos - net->buff) + left_length)) return 1; net->write_pos= net->buff; packet+= left_length; len-= left_length; } if (net->compress) { /* We can't have bigger packets than 16M with compression Because the uncompressed length is stored in 3 bytes */ left_length= MAX_PACKET_LENGTH; while (len > left_length) { if (drizzleclient_net_real_write(net, packet, left_length)) return 1; packet+= left_length; len-= left_length; } } if (len > net->max_packet) return drizzleclient_net_real_write(net, packet, len) ? 1 : 0; /* Send out rest of the blocks as full sized blocks */ } memcpy(net->write_pos,packet,len); net->write_pos+= len; return 0; } /** Read and write one packet using timeouts. If needed, the packet is compressed before sending. @todo - TODO is it needed to set this variable if we have no socket */ /* TODO: rewrite this in a manner to do non-block writes. If a write can not be made, and we are in the server, yield to another process and come back later. */ int drizzleclient_net_real_write(NET *net, const unsigned char *packet, size_t len) { size_t length; const unsigned char *pos, *end; uint32_t retry_count= 0; /* Backup of the original SO_RCVTIMEO timeout */ #ifndef __sun struct timespec backtime; int error; #endif if (net->error == 2) return(-1); /* socket can't be used */ net->reading_or_writing=2; if (net->compress) { size_t complen; unsigned char *b; const uint32_t header_length=NET_HEADER_SIZE+COMP_HEADER_SIZE; if (!(b= (unsigned char*) malloc(len + NET_HEADER_SIZE + COMP_HEADER_SIZE))) { net->error= 2; net->last_errno= CR_OUT_OF_MEMORY; /* In the server, the error is reported by MY_WME flag. */ net->reading_or_writing= 0; return(1); } memcpy(b+header_length,packet,len); complen= len * 120 / 100 + 12; unsigned char * compbuf= (unsigned char *) malloc(complen); if (compbuf != NULL) { uLongf tmp_complen= complen; int res= compress((Bytef*) compbuf, &tmp_complen, (Bytef*) (b+header_length), len); complen= tmp_complen; free(compbuf); if ((res != Z_OK) || (complen >= len)) complen= 0; else { size_t tmplen= complen; complen= len; len= tmplen; } } else { complen=0; } int3store(&b[NET_HEADER_SIZE],complen); int3store(b,len); b[3]=(unsigned char) (net->compress_pkt_nr++); len+= header_length; packet= b; } #ifndef __sun /* Check for error, currently assert */ if (net->write_timeout) { struct timespec waittime; socklen_t time_len; waittime.tv_sec= net->write_timeout; waittime.tv_nsec= 0; memset(&backtime, 0, sizeof(struct timespec)); time_len= sizeof(struct timespec); error= getsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO, &backtime, &time_len); if (error != 0) { perror("getsockopt"); assert(error == 0); } error= setsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO, &waittime, (socklen_t)sizeof(struct timespec)); assert(error == 0); } #endif pos= packet; end=pos+len; /* Loop until we have read everything */ while (pos != end) { assert(pos); if ((long) (length= drizzleclient_vio_write(net->vio, pos, (size_t) (end-pos))) <= 0) { const bool interrupted= drizzleclient_vio_should_retry(net->vio); /* If we read 0, or we were interrupted this means that we need to switch to blocking mode and wait until the timeout on the socket kicks in. */ if ((interrupted || length == 0)) { bool old_mode; while (drizzleclient_vio_blocking(net->vio, true, &old_mode) < 0) { if (drizzleclient_vio_should_retry(net->vio) && retry_count++ < net->retry_count) continue; net->error= 2; /* Close socket */ net->last_errno= CR_NET_PACKET_TOO_LARGE; goto end; } retry_count=0; continue; } else { if (retry_count++ < net->retry_count) continue; } if (drizzleclient_vio_errno(net->vio) == EINTR) { continue; } net->error= 2; /* Close socket */ net->last_errno= (interrupted ? CR_NET_WRITE_INTERRUPTED : CR_NET_ERROR_ON_WRITE); break; } pos+=length; } end: if ((net->compress) && (packet != NULL)) free((char*) packet); net->reading_or_writing=0; #ifndef __sun if (net->write_timeout) error= setsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO, &backtime, (socklen_t)sizeof(struct timespec)); #endif return(((int) (pos != end))); } /** Reads one packet to net->buff + net->where_b. Long packets are handled by drizzleclient_net_read(). This function reallocates the net->buff buffer if necessary. @return Returns length of packet. */ static uint32_t my_real_read(NET *net, size_t *complen) { unsigned char *pos; size_t length; uint32_t i,retry_count=0; uint32_t len=packet_error; uint32_t remain= (net->compress ? NET_HEADER_SIZE+COMP_HEADER_SIZE : NET_HEADER_SIZE); #ifndef __sun /* Backup of the original SO_RCVTIMEO timeout */ struct timespec backtime; int error= 0; #endif *complen = 0; net->reading_or_writing= 1; /* Read timeout is set in drizzleclient_net_set_read_timeout */ pos = net->buff + net->where_b; /* net->packet -4 */ #ifndef __sun /* Check for error, currently assert */ if (net->read_timeout) { struct timespec waittime; socklen_t time_len; waittime.tv_sec= net->read_timeout; waittime.tv_nsec= 0; memset(&backtime, 0, sizeof(struct timespec)); time_len= sizeof(struct timespec); error= getsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO, &backtime, &time_len); if (error != 0) { perror("getsockopt"); assert(error == 0); } error= setsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO, &waittime, (socklen_t)sizeof(struct timespec)); assert(error == 0); } #endif for (i= 0; i < 2 ; i++) { while (remain > 0) { /* First read is done with non blocking mode */ if ((long) (length= drizzleclient_vio_read(net->vio, pos, remain)) <= 0L) { const bool interrupted = drizzleclient_vio_should_retry(net->vio); if (interrupted) { /* Probably in MIT threads */ if (retry_count++ < net->retry_count) continue; } if (drizzleclient_vio_errno(net->vio) == EINTR) { continue; } len= packet_error; net->error= 2; /* Close socket */ net->last_errno= (drizzleclient_vio_was_interrupted(net->vio) ? CR_NET_READ_INTERRUPTED : CR_NET_READ_ERROR); ER(net->last_errno); goto end; } remain -= (uint32_t) length; pos+= length; } if (i == 0) { /* First parts is packet length */ uint32_t helping; if (net->buff[net->where_b + 3] != (unsigned char) net->pkt_nr) { len= packet_error; /* Not a NET error on the client. XXX: why? */ goto end; } net->compress_pkt_nr= ++net->pkt_nr; if (net->compress) { /* If the packet is compressed then complen > 0 and contains the number of bytes in the uncompressed packet */ *complen=uint3korr(&(net->buff[net->where_b + NET_HEADER_SIZE])); } len=uint3korr(net->buff+net->where_b); if (!len) /* End of big multi-packet */ goto end; helping = max(len,*complen) + net->where_b; /* The necessary size of net->buff */ if (helping >= net->max_packet) { if (drizzleclient_net_realloc(net,helping)) { len= packet_error; /* Return error and close connection */ goto end; } } pos=net->buff + net->where_b; remain = (uint32_t) len; } } end: #ifndef __sun if (net->read_timeout) error= setsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO, &backtime, (socklen_t)sizeof(struct timespec)); assert(error == 0); #endif net->reading_or_writing= 0; return(len); } /** Read a packet from the client/server and return it without the internal package header. If the packet is the first packet of a multi-packet packet (which is indicated by the length of the packet = 0xffffff) then all sub packets are read and concatenated. If the packet was compressed, its uncompressed and the length of the uncompressed packet is returned. @return The function returns the length of the found packet or packet_error. net->read_pos points to the read data. */ uint32_t drizzleclient_net_read(NET *net) { size_t len, complen; if (!net->compress) { len = my_real_read(net,&complen); if (len == MAX_PACKET_LENGTH) { /* First packet of a multi-packet. Concatenate the packets */ uint32_t save_pos = net->where_b; size_t total_length= 0; do { net->where_b += len; total_length += len; len = my_real_read(net,&complen); } while (len == MAX_PACKET_LENGTH); if (len != packet_error) len+= total_length; net->where_b = save_pos; } net->read_pos = net->buff + net->where_b; if (len != packet_error) net->read_pos[len]=0; /* Safeguard for drizzleclient_use_result */ return len; } else { /* We are using the compressed protocol */ uint32_t buf_length; uint32_t start_of_packet; uint32_t first_packet_offset; uint32_t read_length, multi_byte_packet=0; if (net->remain_in_buf) { buf_length= net->buf_length; /* Data left in old packet */ first_packet_offset= start_of_packet= (net->buf_length - net->remain_in_buf); /* Restore the character that was overwritten by the end 0 */ net->buff[start_of_packet]= net->save_char; } else { /* reuse buffer, as there is nothing in it that we need */ buf_length= start_of_packet= first_packet_offset= 0; } for (;;) { uint32_t packet_len; if (buf_length - start_of_packet >= NET_HEADER_SIZE) { read_length = uint3korr(net->buff+start_of_packet); if (!read_length) { /* End of multi-byte packet */ start_of_packet += NET_HEADER_SIZE; break; } if (read_length + NET_HEADER_SIZE <= buf_length - start_of_packet) { if (multi_byte_packet) { /* Remove packet header for second packet */ memmove(net->buff + first_packet_offset + start_of_packet, net->buff + first_packet_offset + start_of_packet + NET_HEADER_SIZE, buf_length - start_of_packet); start_of_packet += read_length; buf_length -= NET_HEADER_SIZE; } else start_of_packet+= read_length + NET_HEADER_SIZE; if (read_length != MAX_PACKET_LENGTH) /* last package */ { multi_byte_packet= 0; /* No last zero len packet */ break; } multi_byte_packet= NET_HEADER_SIZE; /* Move data down to read next data packet after current one */ if (first_packet_offset) { memmove(net->buff,net->buff+first_packet_offset, buf_length-first_packet_offset); buf_length-=first_packet_offset; start_of_packet -= first_packet_offset; first_packet_offset=0; } continue; } } /* Move data down to read next data packet after current one */ if (first_packet_offset) { memmove(net->buff,net->buff+first_packet_offset, buf_length-first_packet_offset); buf_length-=first_packet_offset; start_of_packet -= first_packet_offset; first_packet_offset=0; } net->where_b=buf_length; if ((packet_len = my_real_read(net,&complen)) == packet_error) return packet_error; if (complen) { unsigned char * compbuf= (unsigned char *) malloc(complen); if (compbuf != NULL) { uLongf tmp_complen= complen; int error= uncompress((Bytef*) compbuf, &tmp_complen, (Bytef*) (net->buff + net->where_b), (uLong)packet_len); complen= tmp_complen; if (error != Z_OK) { net->error= 2; /* caller will close socket */ net->last_errno= CR_NET_UNCOMPRESS_ERROR; } else { memcpy((net->buff + net->where_b), compbuf, complen); } free(compbuf); } } else complen= packet_len; } buf_length+= complen; net->read_pos= net->buff+ first_packet_offset + NET_HEADER_SIZE; net->buf_length= buf_length; net->remain_in_buf= (uint32_t) (buf_length - start_of_packet); len = ((uint32_t) (start_of_packet - first_packet_offset) - NET_HEADER_SIZE - multi_byte_packet); net->save_char= net->read_pos[len]; /* Must be saved */ net->read_pos[len]=0; /* Safeguard for drizzleclient_use_result */ } return len; } void drizzleclient_net_set_read_timeout(NET *net, uint32_t timeout) { net->read_timeout= timeout; #ifndef __sun if (net->vio) drizzleclient_vio_timeout(net->vio, 0, timeout); #endif return; } void drizzleclient_net_set_write_timeout(NET *net, uint32_t timeout) { net->write_timeout= timeout; #ifndef __sun if (net->vio) drizzleclient_vio_timeout(net->vio, 1, timeout); #endif return; } /** Clear possible error state of struct NET @param net clear the state of the argument */ void drizzleclient_drizzleclient_net_clear_error(NET *net) { net->last_errno= 0; net->last_error[0]= '\0'; strcpy(net->sqlstate, drizzleclient_sqlstate_get_not_error()); }