1
/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
4
* Copyright (C) 2008 Sun Microsystems, Inc.
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or
9
* (at your option) any later version.
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with this program; if not, write to the Free Software
18
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21
#include <drizzled/global.h>
22
#include <drizzled/session.h>
30
#include <sys/socket.h>
42
The following handles the differences when this is linked between the
43
client and the server.
45
This gives an error if a too big packet is found
46
The server can change this with the -O switch, but because the client
47
can't normally do this the client should have a bigger max_allowed_packet.
51
#define MAX_PACKET_LENGTH (256L*256L*256L-1)
52
const char *not_error_sqlstate= "00000";
54
static bool net_write_buff(NET *net, const unsigned char *packet, uint32_t len);
55
static int drizzleclient_net_real_write(NET *net, const unsigned char *packet, size_t len);
57
/** Init with packet info. */
59
bool drizzleclient_net_init(NET *net, Vio* vio, uint32_t buffer_length)
62
net->max_packet= (uint32_t) buffer_length;
63
net->max_packet_size= max(buffer_length, global_system_variables.max_allowed_packet);
65
if (!(net->buff=(unsigned char*) malloc((size_t) net->max_packet+
66
NET_HEADER_SIZE + COMP_HEADER_SIZE)))
68
net->buff_end=net->buff+net->max_packet;
69
net->error=0; net->return_status=0;
70
net->pkt_nr=net->compress_pkt_nr=0;
71
net->write_pos=net->read_pos = net->buff;
73
net->compress=0; net->reading_or_writing=0;
74
net->where_b = net->remain_in_buf=0;
78
if (vio != 0) /* If real connection */
80
net->fd = drizzleclient_vio_fd(vio); /* For perl DBI/DBD */
81
drizzleclient_vio_fastsend(vio);
86
bool drizzleclient_net_init_sock(NET * net, int sock, int flags,
87
uint32_t buffer_length)
90
Vio *drizzleclient_vio_tmp= drizzleclient_vio_new(sock, VIO_TYPE_TCPIP, flags);
91
if (drizzleclient_vio_tmp == NULL)
94
if (drizzleclient_net_init(net, drizzleclient_vio_tmp, buffer_length))
96
/* Only delete the temporary vio if we didn't already attach it to the
99
if (drizzleclient_vio_tmp && (net->vio != drizzleclient_vio_tmp))
100
drizzleclient_vio_delete(drizzleclient_vio_tmp);
103
(void) shutdown(sock, SHUT_RDWR);
111
void drizzleclient_net_end(NET *net)
113
if (net->buff != NULL)
119
void drizzleclient_net_close(NET *net)
121
if (net->vio != NULL)
123
drizzleclient_vio_delete(net->vio);
128
bool drizzleclient_net_peer_addr(NET *net, char *buf, uint16_t *port, size_t buflen)
130
return drizzleclient_vio_peer_addr(net->vio, buf, port, buflen);
133
void drizzleclient_net_keepalive(NET *net, bool flag)
135
drizzleclient_vio_keepalive(net->vio, flag);
138
int drizzleclient_net_get_sd(NET *net)
143
bool drizzleclient_net_more_data(NET *net)
145
return (net->vio == 0 || net->vio->read_pos < net->vio->read_end);
148
/** Realloc the packet buffer. */
150
static bool drizzleclient_net_realloc(NET *net, size_t length)
155
if (length >= net->max_packet_size)
157
/* @todo: 1 and 2 codes are identical. */
159
net->last_errno= CR_NET_PACKET_TOO_LARGE;
162
pkt_length = (length+IO_SIZE-1) & ~(IO_SIZE-1);
164
We must allocate some extra bytes for the end 0 and to be able to
165
read big compressed blocks
167
if (!(buff= (unsigned char*) realloc((char*) net->buff, pkt_length +
168
NET_HEADER_SIZE + COMP_HEADER_SIZE)))
170
/* @todo: 1 and 2 codes are identical. */
172
net->last_errno= CR_OUT_OF_MEMORY;
173
/* In the server the error is reported by MY_WME flag. */
176
net->buff=net->write_pos=buff;
177
net->buff_end=buff+(net->max_packet= (uint32_t) pkt_length);
183
Check if there is any data to be read from the socket.
185
@param sd socket descriptor
190
1 Data or EOF to read
192
-1 Don't know if data is ready or not
195
static bool net_data_is_ready(int sd)
201
ufds.events= POLLIN | POLLPRI;
202
if (!(res= poll(&ufds, 1, 0)))
204
if (res < 0 || !(ufds.revents & (POLLIN | POLLPRI)))
210
Remove unwanted characters from connection
211
and check if disconnected.
213
Read from socket until there is nothing more to read. Discard
216
If there is anything when to read 'drizzleclient_net_clear' is called this
217
normally indicates an error in the protocol.
219
When connection is properly closed (for TCP it means with
220
a FIN packet), then select() considers a socket "ready to read",
221
in the sense that there's EOF to read, but read() returns 0.
223
@param net NET handler
224
@param clear_buffer if <> 0, then clear all data from comm buff
227
void drizzleclient_net_clear(NET *net, bool clear_buffer)
231
while (net_data_is_ready(net->vio->sd) > 0)
233
/* The socket is ready */
234
if (drizzleclient_vio_read(net->vio, net->buff,
235
(size_t) net->max_packet) <= 0)
242
net->pkt_nr=net->compress_pkt_nr=0; /* Ready for new command */
243
net->write_pos=net->buff;
248
/** Flush write_buffer if not empty. */
250
bool drizzleclient_net_flush(NET *net)
253
if (net->buff != net->write_pos)
255
error=drizzleclient_net_real_write(net, net->buff,
256
(size_t) (net->write_pos - net->buff)) ? 1 : 0;
257
net->write_pos=net->buff;
259
/* Sync packet number if using compression */
261
net->pkt_nr=net->compress_pkt_nr;
266
/*****************************************************************************
267
** Write something to server/client buffer
268
*****************************************************************************/
271
Write a logical packet with packet header.
273
Format: Packet length (3 bytes), packet number(1 byte)
274
When compression is used a 3 byte compression length is added
277
If compression is used the original package is modified!
281
drizzleclient_net_write(NET *net,const unsigned char *packet,size_t len)
283
unsigned char buff[NET_HEADER_SIZE];
284
if (unlikely(!net->vio)) /* nowhere to write */
287
Big packets are handled by splitting them in packets of MAX_PACKET_LENGTH
288
length. The last packet is always a packet that is < MAX_PACKET_LENGTH.
289
(The last packet may even have a length of 0)
291
while (len >= MAX_PACKET_LENGTH)
293
const uint32_t z_size = MAX_PACKET_LENGTH;
294
int3store(buff, z_size);
295
buff[3]= (unsigned char) net->pkt_nr++;
296
if (net_write_buff(net, buff, NET_HEADER_SIZE) ||
297
net_write_buff(net, packet, z_size))
302
/* Write last packet */
304
buff[3]= (unsigned char) net->pkt_nr++;
305
if (net_write_buff(net, buff, NET_HEADER_SIZE))
307
return net_write_buff(net,packet,len) ? 1 : 0;
311
Send a command to the server.
313
The reason for having both header and packet is so that libdrizzle
314
can easy add a header to a special command (like prepared statements)
315
without having to re-alloc the string.
317
As the command is part of the first data packet, we have to do some data
318
juggling to put the command in there, without having to create a new
321
This function will split big packets into sub-packets if needed.
322
(Each sub packet can only be 2^24 bytes)
324
@param net NET handler
325
@param command Command in MySQL server (enum enum_server_command)
326
@param header Header to write after command
327
@param head_len Length of header
328
@param packet Query or parameter to query
329
@param len Length of packet
338
drizzleclient_net_write_command(NET *net,unsigned char command,
339
const unsigned char *header, size_t head_len,
340
const unsigned char *packet, size_t len)
342
uint32_t length=len+1+head_len; /* 1 extra byte for command */
343
unsigned char buff[NET_HEADER_SIZE+1];
344
uint32_t header_size=NET_HEADER_SIZE+1;
346
buff[4]=command; /* For first packet */
348
if (length >= MAX_PACKET_LENGTH)
350
/* Take into account that we have the command in the first header */
351
len= MAX_PACKET_LENGTH - 1 - head_len;
354
int3store(buff, MAX_PACKET_LENGTH);
355
buff[3]= (unsigned char) net->pkt_nr++;
356
if (net_write_buff(net, buff, header_size) ||
357
net_write_buff(net, header, head_len) ||
358
net_write_buff(net, packet, len))
361
length-= MAX_PACKET_LENGTH;
362
len= MAX_PACKET_LENGTH;
364
header_size= NET_HEADER_SIZE;
365
} while (length >= MAX_PACKET_LENGTH);
366
len=length; /* Data left to be written */
368
int3store(buff,length);
369
buff[3]= (unsigned char) net->pkt_nr++;
370
return((net_write_buff(net, buff, header_size) ||
371
(head_len && net_write_buff(net, header, head_len)) ||
372
net_write_buff(net, packet, len) || drizzleclient_net_flush(net)) ? 1 : 0 );
376
Caching the data in a local buffer before sending it.
378
Fill up net->buffer and send it to the client when full.
380
If the rest of the to-be-sent-packet is bigger than buffer,
381
send it in one big block (to avoid copying to internal buffer).
382
If not, copy the rest of the data to the buffer and return without
385
@param net Network handler
386
@param packet Packet to send
387
@param len Length of packet
390
The cached buffer can be sent as it is with 'drizzleclient_net_flush()'.
391
In this code we have to be careful to not send a packet longer than
392
MAX_PACKET_LENGTH to drizzleclient_net_real_write() if we are using the compressed
393
protocol as we store the length of the compressed packet in 3 bytes.
402
net_write_buff(NET *net, const unsigned char *packet, uint32_t len)
404
uint32_t left_length;
405
if (net->compress && net->max_packet > MAX_PACKET_LENGTH)
406
left_length= MAX_PACKET_LENGTH - (net->write_pos - net->buff);
408
left_length= (uint32_t) (net->buff_end - net->write_pos);
410
if (len > left_length)
412
if (net->write_pos != net->buff)
414
/* Fill up already used packet and write it */
415
memcpy(net->write_pos,packet,left_length);
416
if (drizzleclient_net_real_write(net, net->buff,
417
(size_t) (net->write_pos - net->buff) + left_length))
419
net->write_pos= net->buff;
420
packet+= left_length;
426
We can't have bigger packets than 16M with compression
427
Because the uncompressed length is stored in 3 bytes
429
left_length= MAX_PACKET_LENGTH;
430
while (len > left_length)
432
if (drizzleclient_net_real_write(net, packet, left_length))
434
packet+= left_length;
438
if (len > net->max_packet)
439
return drizzleclient_net_real_write(net, packet, len) ? 1 : 0;
440
/* Send out rest of the blocks as full sized blocks */
442
memcpy(net->write_pos,packet,len);
443
net->write_pos+= len;
449
Read and write one packet using timeouts.
450
If needed, the packet is compressed before sending.
453
- TODO is it needed to set this variable if we have no socket
457
TODO: rewrite this in a manner to do non-block writes. If a write can not be made, and we are
458
in the server, yield to another process and come back later.
461
drizzleclient_net_real_write(NET *net, const unsigned char *packet, size_t len)
464
const unsigned char *pos, *end;
465
uint32_t retry_count= 0;
467
/* Backup of the original SO_RCVTIMEO timeout */
470
return(-1); /* socket can't be used */
472
net->reading_or_writing=2;
477
const uint32_t header_length=NET_HEADER_SIZE+COMP_HEADER_SIZE;
478
if (!(b= (unsigned char*) malloc(len + NET_HEADER_SIZE +
482
net->last_errno= CR_OUT_OF_MEMORY;
483
/* In the server, the error is reported by MY_WME flag. */
484
net->reading_or_writing= 0;
487
memcpy(b+header_length,packet,len);
489
complen= len * 120 / 100 + 12;
490
unsigned char * compbuf= (unsigned char *) malloc(complen);
493
uLongf tmp_complen= complen;
494
int res= compress((Bytef*) compbuf, &tmp_complen,
495
(Bytef*) (b+header_length),
497
complen= tmp_complen;
501
if ((res != Z_OK) || (complen >= len))
505
size_t tmplen= complen;
514
int3store(&b[NET_HEADER_SIZE],complen);
516
b[3]=(unsigned char) (net->compress_pkt_nr++);
523
/* Loop until we have read everything */
527
if ((long) (length= drizzleclient_vio_write(net->vio, pos, (size_t) (end-pos))) <= 0)
530
* We could end up here with net->vio == NULL
532
* If that is the case, we exit the while loop
534
if (net->vio == NULL)
537
const bool interrupted= drizzleclient_vio_should_retry(net->vio);
539
If we read 0, or we were interrupted this means that
540
we need to switch to blocking mode and wait until the timeout
541
on the socket kicks in.
543
if ((interrupted || length == 0))
547
while (drizzleclient_vio_blocking(net->vio, true, &old_mode) < 0)
549
if (drizzleclient_vio_should_retry(net->vio) && retry_count++ < net->retry_count)
551
net->error= 2; /* Close socket */
552
net->last_errno= CR_NET_PACKET_TOO_LARGE;
560
if (retry_count++ < net->retry_count)
564
if (drizzleclient_vio_errno(net->vio) == EINTR)
568
net->error= 2; /* Close socket */
569
net->last_errno= (interrupted ? CR_NET_WRITE_INTERRUPTED :
570
CR_NET_ERROR_ON_WRITE);
576
if ((net->compress) && (packet != NULL))
577
free((char*) packet);
578
net->reading_or_writing=0;
580
return(((int) (pos != end)));
585
Reads one packet to net->buff + net->where_b.
586
Long packets are handled by drizzleclient_net_read().
587
This function reallocates the net->buff buffer if necessary.
590
Returns length of packet.
594
my_real_read(NET *net, size_t *complen)
598
uint32_t i,retry_count=0;
599
size_t len=packet_error;
600
uint32_t remain= (net->compress ? NET_HEADER_SIZE+COMP_HEADER_SIZE :
605
net->reading_or_writing= 1;
606
/* Read timeout is set in drizzleclient_net_set_read_timeout */
608
pos = net->buff + net->where_b; /* net->packet -4 */
610
for (i= 0; i < 2 ; i++)
614
/* First read is done with non blocking mode */
615
if ((long) (length= drizzleclient_vio_read(net->vio, pos, remain)) <= 0L)
617
if (net->vio == NULL)
620
const bool interrupted = drizzleclient_vio_should_retry(net->vio);
623
{ /* Probably in MIT threads */
624
if (retry_count++ < net->retry_count)
627
if (drizzleclient_vio_errno(net->vio) == EINTR)
632
net->error= 2; /* Close socket */
633
net->last_errno= (drizzleclient_vio_was_interrupted(net->vio) ?
634
CR_NET_READ_INTERRUPTED :
639
remain -= (uint32_t) length;
643
{ /* First parts is packet length */
646
if (net->buff[net->where_b + 3] != (unsigned char) net->pkt_nr)
649
/* Not a NET error on the client. XXX: why? */
652
net->compress_pkt_nr= ++net->pkt_nr;
656
If the packet is compressed then complen > 0 and contains the
657
number of bytes in the uncompressed packet
659
*complen=uint3korr(&(net->buff[net->where_b + NET_HEADER_SIZE]));
662
len=uint3korr(net->buff+net->where_b);
663
if (!len) /* End of big multi-packet */
665
helping = max(len,*complen) + net->where_b;
666
/* The necessary size of net->buff */
667
if (helping >= net->max_packet)
669
if (drizzleclient_net_realloc(net,helping))
671
len= packet_error; /* Return error and close connection */
675
pos=net->buff + net->where_b;
676
remain = (uint32_t) len;
681
net->reading_or_writing= 0;
688
Read a packet from the client/server and return it without the internal
691
If the packet is the first packet of a multi-packet packet
692
(which is indicated by the length of the packet = 0xffffff) then
693
all sub packets are read and concatenated.
695
If the packet was compressed, its uncompressed and the length of the
696
uncompressed packet is returned.
699
The function returns the length of the found packet or packet_error.
700
net->read_pos points to the read data.
704
drizzleclient_net_read(NET *net)
710
len = my_real_read(net,&complen);
711
if (len == MAX_PACKET_LENGTH)
713
/* First packet of a multi-packet. Concatenate the packets */
714
uint32_t save_pos = net->where_b;
715
size_t total_length= 0;
720
len = my_real_read(net,&complen);
721
} while (len == MAX_PACKET_LENGTH);
722
if (len != packet_error)
724
net->where_b = save_pos;
726
net->read_pos = net->buff + net->where_b;
727
if (len != packet_error)
728
net->read_pos[len]=0; /* Safeguard for drizzleclient_use_result */
733
/* We are using the compressed protocol */
736
uint32_t start_of_packet;
737
uint32_t first_packet_offset;
738
uint32_t read_length, multi_byte_packet=0;
740
if (net->remain_in_buf)
742
buf_length= net->buf_length; /* Data left in old packet */
743
first_packet_offset= start_of_packet= (net->buf_length -
745
/* Restore the character that was overwritten by the end 0 */
746
net->buff[start_of_packet]= net->save_char;
750
/* reuse buffer, as there is nothing in it that we need */
751
buf_length= start_of_packet= first_packet_offset= 0;
757
if (buf_length - start_of_packet >= NET_HEADER_SIZE)
759
read_length = uint3korr(net->buff+start_of_packet);
762
/* End of multi-byte packet */
763
start_of_packet += NET_HEADER_SIZE;
766
if (read_length + NET_HEADER_SIZE <= buf_length - start_of_packet)
768
if (multi_byte_packet)
770
/* Remove packet header for second packet */
771
memmove(net->buff + first_packet_offset + start_of_packet,
772
net->buff + first_packet_offset + start_of_packet +
774
buf_length - start_of_packet);
775
start_of_packet += read_length;
776
buf_length -= NET_HEADER_SIZE;
779
start_of_packet+= read_length + NET_HEADER_SIZE;
781
if (read_length != MAX_PACKET_LENGTH) /* last package */
783
multi_byte_packet= 0; /* No last zero len packet */
786
multi_byte_packet= NET_HEADER_SIZE;
787
/* Move data down to read next data packet after current one */
788
if (first_packet_offset)
790
memmove(net->buff,net->buff+first_packet_offset,
791
buf_length-first_packet_offset);
792
buf_length-=first_packet_offset;
793
start_of_packet -= first_packet_offset;
794
first_packet_offset=0;
799
/* Move data down to read next data packet after current one */
800
if (first_packet_offset)
802
memmove(net->buff,net->buff+first_packet_offset,
803
buf_length-first_packet_offset);
804
buf_length-=first_packet_offset;
805
start_of_packet -= first_packet_offset;
806
first_packet_offset=0;
809
net->where_b=buf_length;
810
if ((packet_len = my_real_read(net,&complen)) == packet_error)
815
unsigned char * compbuf= (unsigned char *) malloc(complen);
818
uLongf tmp_complen= complen;
819
int error= uncompress((Bytef*) compbuf, &tmp_complen,
820
(Bytef*) (net->buff + net->where_b),
822
complen= tmp_complen;
826
net->error= 2; /* caller will close socket */
827
net->last_errno= CR_NET_UNCOMPRESS_ERROR;
831
memcpy((net->buff + net->where_b), compbuf, complen);
840
buf_length+= complen;
842
net->read_pos= net->buff+ first_packet_offset + NET_HEADER_SIZE;
843
net->buf_length= buf_length;
844
net->remain_in_buf= (uint32_t) (buf_length - start_of_packet);
845
len = ((uint32_t) (start_of_packet - first_packet_offset) - NET_HEADER_SIZE -
847
net->save_char= net->read_pos[len]; /* Must be saved */
848
net->read_pos[len]=0; /* Safeguard for drizzleclient_use_result */
854
void drizzleclient_net_set_read_timeout(NET *net, uint32_t timeout)
856
net->read_timeout= timeout;
859
drizzleclient_vio_timeout(net->vio, 0, timeout);
865
void drizzleclient_net_set_write_timeout(NET *net, uint32_t timeout)
867
net->write_timeout= timeout;
870
drizzleclient_vio_timeout(net->vio, 1, timeout);
875
Clear possible error state of struct NET
877
@param net clear the state of the argument
880
void drizzleclient_drizzleclient_net_clear_error(NET *net)
883
net->last_error[0]= '\0';
884
strcpy(net->sqlstate, not_error_sqlstate);