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 "libdrizzle.h"
23
#include "libdrizzle_priv.h"
32
#include <sys/socket.h>
39
The following handles the differences when this is linked between the
40
client and the server.
42
This gives an error if a too big packet is found
43
The server can change this with the -O switch, but because the client
44
can't normally do this the client should have a bigger max_allowed_packet.
48
#define MAX_PACKET_LENGTH (256L*256L*256L-1)
50
static bool net_write_buff(NET *net, const unsigned char *packet, uint32_t len);
53
/** Init with packet info. */
55
bool drizzleclient_net_init(NET *net, Vio* vio)
58
drizzleclient_net_local_init(net); /* Set some limits */
59
if (!(net->buff=(unsigned char*) malloc((size_t) net->max_packet+
60
NET_HEADER_SIZE + COMP_HEADER_SIZE)))
62
net->buff_end=net->buff+net->max_packet;
63
net->error=0; net->return_status=0;
64
net->pkt_nr=net->compress_pkt_nr=0;
65
net->write_pos=net->read_pos = net->buff;
67
net->compress=0; net->reading_or_writing=0;
68
net->where_b = net->remain_in_buf=0;
72
if (vio != 0) /* If real connection */
74
net->fd = drizzleclient_vio_fd(vio); /* For perl DBI/DBD */
75
drizzleclient_vio_fastsend(vio);
80
bool drizzleclient_net_init_sock(NET * net, int sock, int flags)
83
Vio *drizzleclient_vio_tmp= drizzleclient_vio_new(sock, VIO_TYPE_TCPIP, flags);
84
if (drizzleclient_vio_tmp == NULL)
87
if (drizzleclient_net_init(net, drizzleclient_vio_tmp))
89
/* Only delete the temporary vio if we didn't already attach it to the
92
if (drizzleclient_vio_tmp && (net->vio != drizzleclient_vio_tmp))
93
drizzleclient_vio_delete(drizzleclient_vio_tmp);
96
(void) shutdown(sock, SHUT_RDWR);
104
void drizzleclient_net_end(NET *net)
106
if (net->buff != NULL)
112
void drizzleclient_net_close(NET *net)
114
if (net->vio != NULL)
116
drizzleclient_vio_delete(net->vio);
121
bool drizzleclient_net_peer_addr(NET *net, char *buf, uint16_t *port, size_t buflen)
123
return drizzleclient_vio_peer_addr(net->vio, buf, port, buflen);
126
void drizzleclient_net_keepalive(NET *net, bool flag)
128
drizzleclient_vio_keepalive(net->vio, flag);
131
int drizzleclient_net_get_sd(NET *net)
136
bool drizzleclient_net_should_close(NET *net)
138
return net->error || (net->vio == 0);
141
bool drizzleclient_net_more_data(NET *net)
143
return (net->vio == 0 || net->vio->read_pos < net->vio->read_end);
146
/** Realloc the packet buffer. */
148
bool drizzleclient_net_realloc(NET *net, size_t length)
153
if (length >= net->max_packet_size)
155
/* @todo: 1 and 2 codes are identical. */
157
net->last_errno= CR_NET_PACKET_TOO_LARGE;
160
pkt_length = (length+IO_SIZE-1) & ~(IO_SIZE-1);
162
We must allocate some extra bytes for the end 0 and to be able to
163
read big compressed blocks
165
if (!(buff= (unsigned char*) realloc((char*) net->buff, pkt_length +
166
NET_HEADER_SIZE + COMP_HEADER_SIZE)))
168
/* @todo: 1 and 2 codes are identical. */
170
net->last_errno= CR_OUT_OF_MEMORY;
171
/* In the server the error is reported by MY_WME flag. */
174
net->buff=net->write_pos=buff;
175
net->buff_end=buff+(net->max_packet= (uint32_t) pkt_length);
181
Check if there is any data to be read from the socket.
183
@param sd socket descriptor
188
1 Data or EOF to read
190
-1 Don't know if data is ready or not
193
static bool net_data_is_ready(int sd)
199
ufds.events= POLLIN | POLLPRI;
200
if (!(res= poll(&ufds, 1, 0)))
202
if (res < 0 || !(ufds.revents & (POLLIN | POLLPRI)))
208
Remove unwanted characters from connection
209
and check if disconnected.
211
Read from socket until there is nothing more to read. Discard
214
If there is anything when to read 'drizzleclient_net_clear' is called this
215
normally indicates an error in the protocol.
217
When connection is properly closed (for TCP it means with
218
a FIN packet), then select() considers a socket "ready to read",
219
in the sense that there's EOF to read, but read() returns 0.
221
@param net NET handler
222
@param clear_buffer if <> 0, then clear all data from comm buff
225
void drizzleclient_net_clear(NET *net, bool clear_buffer)
229
while (net_data_is_ready(net->vio->sd) > 0)
231
/* The socket is ready */
232
if (drizzleclient_vio_read(net->vio, net->buff,
233
(size_t) net->max_packet) <= 0)
240
net->pkt_nr=net->compress_pkt_nr=0; /* Ready for new command */
241
net->write_pos=net->buff;
246
/** Flush write_buffer if not empty. */
248
bool drizzleclient_net_flush(NET *net)
251
if (net->buff != net->write_pos)
253
error=drizzleclient_net_real_write(net, net->buff,
254
(size_t) (net->write_pos - net->buff)) ? 1 : 0;
255
net->write_pos=net->buff;
257
/* Sync packet number if using compression */
259
net->pkt_nr=net->compress_pkt_nr;
264
/*****************************************************************************
265
** Write something to server/client buffer
266
*****************************************************************************/
269
Write a logical packet with packet header.
271
Format: Packet length (3 bytes), packet number(1 byte)
272
When compression is used a 3 byte compression length is added
275
If compression is used the original package is modified!
279
drizzleclient_net_write(NET *net,const unsigned char *packet,size_t len)
281
unsigned char buff[NET_HEADER_SIZE];
282
if (unlikely(!net->vio)) /* nowhere to write */
285
Big packets are handled by splitting them in packets of MAX_PACKET_LENGTH
286
length. The last packet is always a packet that is < MAX_PACKET_LENGTH.
287
(The last packet may even have a length of 0)
289
while (len >= MAX_PACKET_LENGTH)
291
const uint32_t z_size = MAX_PACKET_LENGTH;
292
int3store(buff, z_size);
293
buff[3]= (unsigned char) net->pkt_nr++;
294
if (net_write_buff(net, buff, NET_HEADER_SIZE) ||
295
net_write_buff(net, packet, z_size))
300
/* Write last packet */
302
buff[3]= (unsigned char) net->pkt_nr++;
303
if (net_write_buff(net, buff, NET_HEADER_SIZE))
305
return net_write_buff(net,packet,len) ? 1 : 0;
309
Send a command to the server.
311
The reason for having both header and packet is so that libdrizzle
312
can easy add a header to a special command (like prepared statements)
313
without having to re-alloc the string.
315
As the command is part of the first data packet, we have to do some data
316
juggling to put the command in there, without having to create a new
319
This function will split big packets into sub-packets if needed.
320
(Each sub packet can only be 2^24 bytes)
322
@param net NET handler
323
@param command Command in MySQL server (enum enum_server_command)
324
@param header Header to write after command
325
@param head_len Length of header
326
@param packet Query or parameter to query
327
@param len Length of packet
336
drizzleclient_net_write_command(NET *net,unsigned char command,
337
const unsigned char *header, size_t head_len,
338
const unsigned char *packet, size_t len)
340
uint32_t length=len+1+head_len; /* 1 extra byte for command */
341
unsigned char buff[NET_HEADER_SIZE+1];
342
uint32_t header_size=NET_HEADER_SIZE+1;
344
buff[4]=command; /* For first packet */
346
if (length >= MAX_PACKET_LENGTH)
348
/* Take into account that we have the command in the first header */
349
len= MAX_PACKET_LENGTH - 1 - head_len;
352
int3store(buff, MAX_PACKET_LENGTH);
353
buff[3]= (unsigned char) net->pkt_nr++;
354
if (net_write_buff(net, buff, header_size) ||
355
net_write_buff(net, header, head_len) ||
356
net_write_buff(net, packet, len))
359
length-= MAX_PACKET_LENGTH;
360
len= MAX_PACKET_LENGTH;
362
header_size= NET_HEADER_SIZE;
363
} while (length >= MAX_PACKET_LENGTH);
364
len=length; /* Data left to be written */
366
int3store(buff,length);
367
buff[3]= (unsigned char) net->pkt_nr++;
368
return((net_write_buff(net, buff, header_size) ||
369
(head_len && net_write_buff(net, header, head_len)) ||
370
net_write_buff(net, packet, len) || drizzleclient_net_flush(net)) ? 1 : 0 );
374
Caching the data in a local buffer before sending it.
376
Fill up net->buffer and send it to the client when full.
378
If the rest of the to-be-sent-packet is bigger than buffer,
379
send it in one big block (to avoid copying to internal buffer).
380
If not, copy the rest of the data to the buffer and return without
383
@param net Network handler
384
@param packet Packet to send
385
@param len Length of packet
388
The cached buffer can be sent as it is with 'drizzleclient_net_flush()'.
389
In this code we have to be careful to not send a packet longer than
390
MAX_PACKET_LENGTH to drizzleclient_net_real_write() if we are using the compressed
391
protocol as we store the length of the compressed packet in 3 bytes.
400
net_write_buff(NET *net, const unsigned char *packet, uint32_t len)
402
uint32_t left_length;
403
if (net->compress && net->max_packet > MAX_PACKET_LENGTH)
404
left_length= MAX_PACKET_LENGTH - (net->write_pos - net->buff);
406
left_length= (uint32_t) (net->buff_end - net->write_pos);
408
if (len > left_length)
410
if (net->write_pos != net->buff)
412
/* Fill up already used packet and write it */
413
memcpy(net->write_pos,packet,left_length);
414
if (drizzleclient_net_real_write(net, net->buff,
415
(size_t) (net->write_pos - net->buff) + left_length))
417
net->write_pos= net->buff;
418
packet+= left_length;
424
We can't have bigger packets than 16M with compression
425
Because the uncompressed length is stored in 3 bytes
427
left_length= MAX_PACKET_LENGTH;
428
while (len > left_length)
430
if (drizzleclient_net_real_write(net, packet, left_length))
432
packet+= left_length;
436
if (len > net->max_packet)
437
return drizzleclient_net_real_write(net, packet, len) ? 1 : 0;
438
/* Send out rest of the blocks as full sized blocks */
440
memcpy(net->write_pos,packet,len);
441
net->write_pos+= len;
447
Read and write one packet using timeouts.
448
If needed, the packet is compressed before sending.
451
- TODO is it needed to set this variable if we have no socket
455
TODO: rewrite this in a manner to do non-block writes. If a write can not be made, and we are
456
in the server, yield to another process and come back later.
459
drizzleclient_net_real_write(NET *net, const unsigned char *packet, size_t len)
462
const unsigned char *pos, *end;
463
uint32_t retry_count= 0;
465
/* Backup of the original SO_RCVTIMEO timeout */
467
struct timespec backtime;
472
return(-1); /* socket can't be used */
474
net->reading_or_writing=2;
479
const uint32_t header_length=NET_HEADER_SIZE+COMP_HEADER_SIZE;
480
if (!(b= (unsigned char*) malloc(len + NET_HEADER_SIZE +
484
net->last_errno= CR_OUT_OF_MEMORY;
485
/* In the server, the error is reported by MY_WME flag. */
486
net->reading_or_writing= 0;
489
memcpy(b+header_length,packet,len);
491
complen= len * 120 / 100 + 12;
492
unsigned char * compbuf= (unsigned char *) malloc(complen);
495
uLongf tmp_complen= complen;
496
int res= compress((Bytef*) compbuf, &tmp_complen,
497
(Bytef*) (b+header_length),
499
complen= tmp_complen;
503
if ((res != Z_OK) || (complen >= len))
507
size_t tmplen= complen;
516
int3store(&b[NET_HEADER_SIZE],complen);
518
b[3]=(unsigned char) (net->compress_pkt_nr++);
524
/* Check for error, currently assert */
525
if (net->write_timeout)
527
struct timespec waittime;
530
waittime.tv_sec= net->write_timeout;
533
memset(&backtime, 0, sizeof(struct timespec));
534
time_len= sizeof(struct timespec);
535
error= getsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO,
536
&backtime, &time_len);
539
perror("getsockopt");
542
error= setsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO,
543
&waittime, (socklen_t)sizeof(struct timespec));
550
/* Loop until we have read everything */
554
if ((long) (length= drizzleclient_vio_write(net->vio, pos, (size_t) (end-pos))) <= 0)
556
const bool interrupted= drizzleclient_vio_should_retry(net->vio);
558
If we read 0, or we were interrupted this means that
559
we need to switch to blocking mode and wait until the timeout
560
on the socket kicks in.
562
if ((interrupted || length == 0))
566
while (drizzleclient_vio_blocking(net->vio, true, &old_mode) < 0)
568
if (drizzleclient_vio_should_retry(net->vio) && retry_count++ < net->retry_count)
570
net->error= 2; /* Close socket */
571
net->last_errno= CR_NET_PACKET_TOO_LARGE;
579
if (retry_count++ < net->retry_count)
583
if (drizzleclient_vio_errno(net->vio) == EINTR)
587
net->error= 2; /* Close socket */
588
net->last_errno= (interrupted ? CR_NET_WRITE_INTERRUPTED :
589
CR_NET_ERROR_ON_WRITE);
595
if ((net->compress) && (packet != NULL))
596
free((char*) packet);
597
net->reading_or_writing=0;
600
if (net->write_timeout)
601
error= setsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO,
602
&backtime, (socklen_t)sizeof(struct timespec));
605
return(((int) (pos != end)));
610
Reads one packet to net->buff + net->where_b.
611
Long packets are handled by drizzleclient_net_read().
612
This function reallocates the net->buff buffer if necessary.
615
Returns length of packet.
619
my_real_read(NET *net, size_t *complen)
623
uint32_t i,retry_count=0;
624
size_t len=packet_error;
625
uint32_t remain= (net->compress ? NET_HEADER_SIZE+COMP_HEADER_SIZE :
629
/* Backup of the original SO_RCVTIMEO timeout */
630
struct timespec backtime;
636
net->reading_or_writing= 1;
637
/* Read timeout is set in drizzleclient_net_set_read_timeout */
639
pos = net->buff + net->where_b; /* net->packet -4 */
643
/* Check for error, currently assert */
644
if (net->read_timeout)
646
struct timespec waittime;
649
waittime.tv_sec= net->read_timeout;
652
memset(&backtime, 0, sizeof(struct timespec));
653
time_len= sizeof(struct timespec);
654
error= getsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO,
655
&backtime, &time_len);
658
perror("getsockopt");
661
error= setsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO,
662
&waittime, (socklen_t)sizeof(struct timespec));
667
for (i= 0; i < 2 ; i++)
671
/* First read is done with non blocking mode */
672
if ((long) (length= drizzleclient_vio_read(net->vio, pos, remain)) <= 0L)
674
const bool interrupted = drizzleclient_vio_should_retry(net->vio);
677
{ /* Probably in MIT threads */
678
if (retry_count++ < net->retry_count)
681
if (drizzleclient_vio_errno(net->vio) == EINTR)
686
net->error= 2; /* Close socket */
687
net->last_errno= (drizzleclient_vio_was_interrupted(net->vio) ?
688
CR_NET_READ_INTERRUPTED :
693
remain -= (uint32_t) length;
697
{ /* First parts is packet length */
700
if (net->buff[net->where_b + 3] != (unsigned char) net->pkt_nr)
703
/* Not a NET error on the client. XXX: why? */
706
net->compress_pkt_nr= ++net->pkt_nr;
710
If the packet is compressed then complen > 0 and contains the
711
number of bytes in the uncompressed packet
713
*complen=uint3korr(&(net->buff[net->where_b + NET_HEADER_SIZE]));
716
len=uint3korr(net->buff+net->where_b);
717
if (!len) /* End of big multi-packet */
719
helping = max(len,*complen) + net->where_b;
720
/* The necessary size of net->buff */
721
if (helping >= net->max_packet)
723
if (drizzleclient_net_realloc(net,helping))
725
len= packet_error; /* Return error and close connection */
729
pos=net->buff + net->where_b;
730
remain = (uint32_t) len;
736
if (net->read_timeout)
737
error= setsockopt(net->vio->sd, SOL_SOCKET, SO_RCVTIMEO,
738
&backtime, (socklen_t)sizeof(struct timespec));
741
net->reading_or_writing= 0;
748
Read a packet from the client/server and return it without the internal
751
If the packet is the first packet of a multi-packet packet
752
(which is indicated by the length of the packet = 0xffffff) then
753
all sub packets are read and concatenated.
755
If the packet was compressed, its uncompressed and the length of the
756
uncompressed packet is returned.
759
The function returns the length of the found packet or packet_error.
760
net->read_pos points to the read data.
764
drizzleclient_net_read(NET *net)
770
len = my_real_read(net,&complen);
771
if (len == MAX_PACKET_LENGTH)
773
/* First packet of a multi-packet. Concatenate the packets */
774
uint32_t save_pos = net->where_b;
775
size_t total_length= 0;
780
len = my_real_read(net,&complen);
781
} while (len == MAX_PACKET_LENGTH);
782
if (len != packet_error)
784
net->where_b = save_pos;
786
net->read_pos = net->buff + net->where_b;
787
if (len != packet_error)
788
net->read_pos[len]=0; /* Safeguard for drizzleclient_use_result */
793
/* We are using the compressed protocol */
796
uint32_t start_of_packet;
797
uint32_t first_packet_offset;
798
uint32_t read_length, multi_byte_packet=0;
800
if (net->remain_in_buf)
802
buf_length= net->buf_length; /* Data left in old packet */
803
first_packet_offset= start_of_packet= (net->buf_length -
805
/* Restore the character that was overwritten by the end 0 */
806
net->buff[start_of_packet]= net->save_char;
810
/* reuse buffer, as there is nothing in it that we need */
811
buf_length= start_of_packet= first_packet_offset= 0;
817
if (buf_length - start_of_packet >= NET_HEADER_SIZE)
819
read_length = uint3korr(net->buff+start_of_packet);
822
/* End of multi-byte packet */
823
start_of_packet += NET_HEADER_SIZE;
826
if (read_length + NET_HEADER_SIZE <= buf_length - start_of_packet)
828
if (multi_byte_packet)
830
/* Remove packet header for second packet */
831
memmove(net->buff + first_packet_offset + start_of_packet,
832
net->buff + first_packet_offset + start_of_packet +
834
buf_length - start_of_packet);
835
start_of_packet += read_length;
836
buf_length -= NET_HEADER_SIZE;
839
start_of_packet+= read_length + NET_HEADER_SIZE;
841
if (read_length != MAX_PACKET_LENGTH) /* last package */
843
multi_byte_packet= 0; /* No last zero len packet */
846
multi_byte_packet= NET_HEADER_SIZE;
847
/* Move data down to read next data packet after current one */
848
if (first_packet_offset)
850
memmove(net->buff,net->buff+first_packet_offset,
851
buf_length-first_packet_offset);
852
buf_length-=first_packet_offset;
853
start_of_packet -= first_packet_offset;
854
first_packet_offset=0;
859
/* Move data down to read next data packet after current one */
860
if (first_packet_offset)
862
memmove(net->buff,net->buff+first_packet_offset,
863
buf_length-first_packet_offset);
864
buf_length-=first_packet_offset;
865
start_of_packet -= first_packet_offset;
866
first_packet_offset=0;
869
net->where_b=buf_length;
870
if ((packet_len = my_real_read(net,&complen)) == packet_error)
875
unsigned char * compbuf= (unsigned char *) malloc(complen);
878
uLongf tmp_complen= complen;
879
int error= uncompress((Bytef*) compbuf, &tmp_complen,
880
(Bytef*) (net->buff + net->where_b),
882
complen= tmp_complen;
886
net->error= 2; /* caller will close socket */
887
net->last_errno= CR_NET_UNCOMPRESS_ERROR;
891
memcpy((net->buff + net->where_b), compbuf, complen);
900
buf_length+= complen;
902
net->read_pos= net->buff+ first_packet_offset + NET_HEADER_SIZE;
903
net->buf_length= buf_length;
904
net->remain_in_buf= (uint32_t) (buf_length - start_of_packet);
905
len = ((uint32_t) (start_of_packet - first_packet_offset) - NET_HEADER_SIZE -
907
net->save_char= net->read_pos[len]; /* Must be saved */
908
net->read_pos[len]=0; /* Safeguard for drizzleclient_use_result */
914
void drizzleclient_net_set_read_timeout(NET *net, uint32_t timeout)
916
net->read_timeout= timeout;
919
drizzleclient_vio_timeout(net->vio, 0, timeout);
925
void drizzleclient_net_set_write_timeout(NET *net, uint32_t timeout)
927
net->write_timeout= timeout;
930
drizzleclient_vio_timeout(net->vio, 1, timeout);
935
Clear possible error state of struct NET
937
@param net clear the state of the argument
940
void drizzleclient_drizzleclient_net_clear_error(NET *net)
943
net->last_error[0]= '\0';
944
strcpy(net->sqlstate, drizzleclient_sqlstate_get_not_error());