1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are
13 * * Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * * Redistributions in binary form must reproduce the above
17 * copyright notice, this list of conditions and the following disclaimer
18 * in the documentation and/or other materials provided with the
21 * * The names of its contributors may not be used to endorse or
22 * promote products derived from this software without specific prior
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <libmemcached/common.h>
42 enum memc_read_or_write
{
48 * Try to fill the input buffer for a server with as much
51 * @param ptr the server to pack
53 static bool repack_input_buffer(memcached_server_write_instance_st ptr
)
55 if (ptr
->read_ptr
!= ptr
->read_buffer
)
57 /* Move all of the data to the beginning of the buffer so
58 ** that we can fit more data into the buffer...
60 memmove(ptr
->read_buffer
, ptr
->read_ptr
, ptr
->read_buffer_length
);
61 ptr
->read_ptr
= ptr
->read_buffer
;
62 ptr
->read_data_length
= ptr
->read_buffer_length
;
65 /* There is room in the buffer, try to fill it! */
66 if (ptr
->read_buffer_length
!= MEMCACHED_MAX_BUFFER
)
69 /* Just try a single read to grab what's available */
70 ssize_t nr
= recv(ptr
->fd
,
71 ptr
->read_ptr
+ ptr
->read_data_length
,
72 MEMCACHED_MAX_BUFFER
- ptr
->read_data_length
,
79 switch (get_socket_errno())
84 #if EWOULDBLOCK != EAGAIN
88 #ifdef TARGET_OS_LINUX
91 break; // No IO is fine, we can just move on
94 memcached_set_errno(*ptr
, get_socket_errno(), MEMCACHED_AT
);
99 case 0: // Shutdown on the socket has occurred
101 memcached_set_error(*ptr
, MEMCACHED_CONNECTION_FAILURE
, MEMCACHED_AT
);
107 ptr
->read_data_length
+= size_t(nr
);
108 ptr
->read_buffer_length
+= size_t(nr
);
119 * If the we have callbacks connected to this server structure
120 * we may start process the input queue and fire the callbacks
121 * for the incomming messages. This function is _only_ called
122 * when the input buffer is full, so that we _know_ that we have
123 * at least _one_ message to process.
125 * @param ptr the server to star processing iput messages for
126 * @return true if we processed anything, false otherwise
128 static bool process_input_buffer(memcached_server_write_instance_st ptr
)
131 ** We might be able to process some of the response messages if we
132 ** have a callback set up
134 if (ptr
->root
->callbacks
!= NULL
)
137 * We might have responses... try to read them out and fire
140 memcached_callback_st cb
= *ptr
->root
->callbacks
;
142 memcached_set_processing_input((memcached_st
*)ptr
->root
, true);
144 char buffer
[MEMCACHED_DEFAULT_COMMAND_SIZE
];
145 memcached_st
*root
= (memcached_st
*)ptr
->root
;
146 memcached_return_t error
= memcached_response(ptr
, buffer
, sizeof(buffer
), &root
->result
);
148 memcached_set_processing_input(root
, false);
150 if (error
== MEMCACHED_SUCCESS
)
152 for (unsigned int x
= 0; x
< cb
.number_of_callback
; x
++)
154 error
= (*cb
.callback
[x
])(ptr
->root
, &root
->result
, cb
.context
);
155 if (error
!= MEMCACHED_SUCCESS
)
161 /* @todo what should I do with the error message??? */
163 /* @todo what should I do with other error messages?? */
170 static memcached_return_t
io_wait(memcached_server_write_instance_st ptr
,
171 const memc_read_or_write read_or_write
)
174 ** We are going to block on write, but at least on Solaris we might block
175 ** on write if we haven't read anything from our input buffer..
176 ** Try to purge the input buffer if we don't do any flow control in the
177 ** application layer (just sending a lot of data etc)
178 ** The test is moved down in the purge function to avoid duplication of
181 if (read_or_write
== MEM_WRITE
)
183 if (memcached_fatal(memcached_purge(ptr
)))
185 return MEMCACHED_FAILURE
;
190 memset(&fds
, 0, sizeof(pollfd
));
194 if (read_or_write
== MEM_WRITE
) /* write */
197 ptr
->io_wait_count
.write
++;
201 ptr
->io_wait_count
.read
++;
204 if (ptr
->root
->poll_timeout
== 0) // Mimic 0 causes timeout behavior (not all platforms do this)
206 return memcached_set_error(*ptr
, MEMCACHED_TIMEOUT
, MEMCACHED_AT
);
211 while (--loop_max
) // While loop is for ERESTART or EINTR
213 int active_fd
= poll(&fds
, 1, ptr
->root
->poll_timeout
);
217 assert_msg(active_fd
== 1 , "poll() returned an unexpected value");
218 return MEMCACHED_SUCCESS
;
220 else if (active_fd
== 0)
222 ptr
->io_wait_count
.timeouts
++;
223 return memcached_set_error(*ptr
, MEMCACHED_TIMEOUT
, MEMCACHED_AT
);
226 // Only an error should result in this code being called.
227 local_errno
= get_socket_errno(); // We cache in case memcached_quit_server() modifies errno
228 assert_msg(active_fd
== -1 , "poll() returned an unexpected value");
231 #ifdef TARGET_OS_LINUX
239 return memcached_set_error(*ptr
, MEMCACHED_MEMORY_ALLOCATION_FAILURE
, MEMCACHED_AT
);
242 return memcached_set_error(*ptr
, MEMCACHED_MEMORY_ALLOCATION_FAILURE
, MEMCACHED_AT
, memcached_literal_param("RLIMIT_NOFILE exceeded, or if OSX the timeout value was invalid"));
245 if (fds
.revents
& POLLERR
)
248 socklen_t len
= sizeof (err
);
249 if (getsockopt(ptr
->fd
, SOL_SOCKET
, SO_ERROR
, &err
, &len
) == 0)
251 if (err
== 0) // treat this as EINTR
261 break; // should only occur from poll error
264 memcached_quit_server(ptr
, true);
266 return memcached_set_errno(*ptr
, local_errno
, MEMCACHED_AT
);
269 static bool io_flush(memcached_server_write_instance_st ptr
,
270 const bool with_flush
,
271 memcached_return_t
& error
)
274 ** We might want to purge the input buffer if we haven't consumed
275 ** any output yet... The test for the limits is the purge is inline
276 ** in the purge function to avoid duplicating the logic..
279 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
280 memcached_return_t rc
= memcached_purge(ptr
);
282 if (rc
!= MEMCACHED_SUCCESS
and rc
!= MEMCACHED_STORED
)
287 char *local_write_ptr
= ptr
->write_buffer
;
288 size_t write_length
= ptr
->write_buffer_offset
;
290 error
= MEMCACHED_SUCCESS
;
292 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
294 /* Looking for memory overflows */
296 if (write_length
== MEMCACHED_MAX_BUFFER
)
297 WATCHPOINT_ASSERT(ptr
->write_buffer
== local_write_ptr
);
298 WATCHPOINT_ASSERT((ptr
->write_buffer
+ MEMCACHED_MAX_BUFFER
) >= (local_write_ptr
+ write_length
));
303 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
304 WATCHPOINT_ASSERT(write_length
> 0);
306 int flags
= with_flush
? MSG_NOSIGNAL
|MSG_DONTWAIT
: MSG_NOSIGNAL
|MSG_DONTWAIT
|MSG_MORE
;
307 ssize_t sent_length
= ::send(ptr
->fd
, local_write_ptr
, write_length
, flags
);
309 if (sent_length
== SOCKET_ERROR
)
311 #if 0 // @todo I should look at why we hit this bit of code hard frequently
312 WATCHPOINT_ERRNO(get_socket_errno());
313 WATCHPOINT_NUMBER(get_socket_errno());
315 switch (get_socket_errno())
320 #if EWOULDBLOCK != EAGAIN
326 * We may be blocked on write because the input buffer
327 * is full. Let's check if we have room in our input
328 * buffer for more data and retry the write before
331 if (repack_input_buffer(ptr
) or process_input_buffer(ptr
))
336 memcached_return_t rc
= io_wait(ptr
, MEM_WRITE
);
337 if (memcached_success(rc
))
341 else if (rc
== MEMCACHED_TIMEOUT
)
343 ptr
->io_wait_count
.timeouts
++;
344 error
= memcached_set_error(*ptr
, MEMCACHED_TIMEOUT
, MEMCACHED_AT
);
348 memcached_quit_server(ptr
, true);
349 error
= memcached_set_errno(*ptr
, get_socket_errno(), MEMCACHED_AT
);
355 memcached_quit_server(ptr
, true);
356 error
= memcached_set_errno(*ptr
, get_socket_errno(), MEMCACHED_AT
);
357 WATCHPOINT_ASSERT(ptr
->fd
== INVALID_SOCKET
);
362 ptr
->io_bytes_sent
+= uint32_t(sent_length
);
364 local_write_ptr
+= sent_length
;
365 write_length
-= uint32_t(sent_length
);
368 WATCHPOINT_ASSERT(write_length
== 0);
369 ptr
->write_buffer_offset
= 0;
374 memcached_return_t
memcached_io_wait_for_write(memcached_server_write_instance_st ptr
)
376 return io_wait(ptr
, MEM_WRITE
);
379 memcached_return_t
memcached_io_read(memcached_server_write_instance_st ptr
,
380 void *buffer
, size_t length
, ssize_t
& nread
)
382 assert(memcached_is_udp(ptr
->root
) == false);
383 assert_msg(ptr
, "Programmer error, memcached_io_read() recieved an invalid memcached_server_write_instance_st"); // Programmer error
384 char *buffer_ptr
= static_cast<char *>(buffer
);
386 if (ptr
->fd
== INVALID_SOCKET
)
389 assert_msg(int(ptr
->state
) <= int(MEMCACHED_SERVER_STATE_ADDRINFO
), "Programmer error, invalid socket state");
391 return MEMCACHED_CONNECTION_FAILURE
;
396 if (ptr
->read_buffer_length
== 0)
401 data_read
= ::recv(ptr
->fd
, ptr
->read_buffer
, MEMCACHED_MAX_BUFFER
, MSG_DONTWAIT
);
402 if (data_read
== SOCKET_ERROR
)
404 switch (get_socket_errno())
406 case EINTR
: // We just retry
409 case ETIMEDOUT
: // OSX
410 #if EWOULDBLOCK != EAGAIN
414 #ifdef TARGET_OS_LINUX
418 memcached_return_t io_wait_ret
;
419 if (memcached_success(io_wait_ret
= io_wait(ptr
, MEM_READ
)))
429 case ENOTCONN
: // Programmer Error
430 WATCHPOINT_ASSERT(0);
432 WATCHPOINT_ASSERT(0);
434 assert_msg(ptr
->fd
!= INVALID_SOCKET
, "Programmer error, invalid socket");
440 memcached_quit_server(ptr
, true);
442 return memcached_set_errno(*ptr
, get_socket_errno(), MEMCACHED_AT
);
446 else if (data_read
== 0)
449 EOF. Any data received so far is incomplete
450 so discard it. This always reads by byte in case of TCP
451 and protocol enforcement happens at memcached_response()
452 looking for '\n'. We do not care for UDB which requests 8 bytes
453 at once. Generally, this means that connection went away. Since
454 for blocking I/O we do not return 0 and for non-blocking case
455 it will return EGAIN if data is not immediatly available.
457 WATCHPOINT_STRING("We had a zero length recv()");
458 memcached_quit_server(ptr
, true);
460 return memcached_set_error(*ptr
, MEMCACHED_CONNECTION_FAILURE
, MEMCACHED_AT
,
461 memcached_literal_param("::rec() returned zero, server has disconnected"));
463 } while (data_read
<= 0);
465 ptr
->io_bytes_sent
= 0;
466 ptr
->read_data_length
= (size_t) data_read
;
467 ptr
->read_buffer_length
= (size_t) data_read
;
468 ptr
->read_ptr
= ptr
->read_buffer
;
475 difference
= (length
> ptr
->read_buffer_length
) ? ptr
->read_buffer_length
: length
;
477 memcpy(buffer_ptr
, ptr
->read_ptr
, difference
);
478 length
-= difference
;
479 ptr
->read_ptr
+= difference
;
480 ptr
->read_buffer_length
-= difference
;
481 buffer_ptr
+= difference
;
485 *buffer_ptr
= *ptr
->read_ptr
;
487 ptr
->read_buffer_length
--;
493 nread
= ssize_t(buffer_ptr
- (char*)buffer
);
495 return MEMCACHED_SUCCESS
;
498 memcached_return_t
memcached_io_slurp(memcached_server_write_instance_st ptr
)
500 assert_msg(ptr
, "Programmer error, invalid memcached_server_write_instance_st");
501 assert(memcached_is_udp(ptr
->root
) == false);
503 if (ptr
->fd
== INVALID_SOCKET
)
505 assert_msg(int(ptr
->state
) <= int(MEMCACHED_SERVER_STATE_ADDRINFO
), "Invalid socket state");
506 return MEMCACHED_CONNECTION_FAILURE
;
510 char buffer
[MEMCACHED_MAX_BUFFER
];
513 data_read
= recv(ptr
->fd
, ptr
->read_buffer
, sizeof(buffer
), MSG_DONTWAIT
);
514 if (data_read
== SOCKET_ERROR
)
516 switch (get_socket_errno())
518 case EINTR
: // We just retry
521 case ETIMEDOUT
: // OSX
522 #if EWOULDBLOCK != EAGAIN
526 #ifdef TARGET_OS_LINUX
529 if (memcached_success(io_wait(ptr
, MEM_READ
)))
533 return MEMCACHED_IN_PROGRESS
;
537 case ENOTCONN
: // Programmer Error
538 WATCHPOINT_ASSERT(0);
540 WATCHPOINT_ASSERT(0);
542 assert_msg(ptr
->fd
!= INVALID_SOCKET
, "Invalid socket state");
547 return MEMCACHED_CONNECTION_FAILURE
; // We want this!
550 } while (data_read
> 0);
552 return MEMCACHED_CONNECTION_FAILURE
;
555 static ssize_t
_io_write(memcached_server_write_instance_st ptr
,
556 const void *buffer
, size_t length
, bool with_flush
)
558 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
559 assert(memcached_is_udp(ptr
->root
) == false);
561 size_t original_length
= length
;
562 const char *buffer_ptr
= static_cast<const char *>(buffer
);
567 size_t buffer_end
= MEMCACHED_MAX_BUFFER
;
568 size_t should_write
= buffer_end
-ptr
->write_buffer_offset
;
569 should_write
= (should_write
< length
) ? should_write
: length
;
571 write_ptr
= ptr
->write_buffer
+ ptr
->write_buffer_offset
;
572 memcpy(write_ptr
, buffer_ptr
, should_write
);
573 ptr
->write_buffer_offset
+= should_write
;
574 buffer_ptr
+= should_write
;
575 length
-= should_write
;
577 if (ptr
->write_buffer_offset
== buffer_end
)
579 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
581 memcached_return_t rc
;
582 if (io_flush(ptr
, with_flush
, rc
) == false)
591 memcached_return_t rc
;
592 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
593 if (io_flush(ptr
, with_flush
, rc
) == false)
599 return ssize_t(original_length
);
602 bool memcached_io_write(memcached_server_write_instance_st ptr
)
604 return (_io_write(ptr
, NULL
, 0, true) >= 0);
607 ssize_t
memcached_io_write(memcached_server_write_instance_st ptr
,
608 const void *buffer
, const size_t length
, const bool with_flush
)
610 return _io_write(ptr
, buffer
, length
, with_flush
);
613 ssize_t
memcached_io_writev(memcached_server_write_instance_st ptr
,
614 libmemcached_io_vector_st vector
[],
615 const size_t number_of
, const bool with_flush
)
619 for (size_t x
= 0; x
< number_of
; x
++, vector
++)
625 if ((returnable
= _io_write(ptr
, vector
->buffer
, vector
->length
, false)) == -1)
635 if (memcached_io_write(ptr
) == false)
645 void memcached_io_close(memcached_server_write_instance_st ptr
)
647 if (ptr
->fd
== INVALID_SOCKET
)
652 /* in case of death shutdown to avoid blocking at close() */
653 if (shutdown(ptr
->fd
, SHUT_RDWR
) == SOCKET_ERROR
&& get_socket_errno() != ENOTCONN
)
655 WATCHPOINT_NUMBER(ptr
->fd
);
656 WATCHPOINT_ERRNO(get_socket_errno());
657 WATCHPOINT_ASSERT(get_socket_errno());
660 if (closesocket(ptr
->fd
) == SOCKET_ERROR
)
662 WATCHPOINT_ERRNO(get_socket_errno());
664 ptr
->state
= MEMCACHED_SERVER_STATE_NEW
;
665 ptr
->fd
= INVALID_SOCKET
;
668 memcached_server_write_instance_st
memcached_io_get_readable_server(memcached_st
*memc
)
670 #define MAX_SERVERS_TO_POLL 100
671 struct pollfd fds
[MAX_SERVERS_TO_POLL
];
672 nfds_t host_index
= 0;
674 for (uint32_t x
= 0; x
< memcached_server_count(memc
) and host_index
< MAX_SERVERS_TO_POLL
; ++x
)
676 memcached_server_write_instance_st instance
= memcached_server_instance_fetch(memc
, x
);
678 if (instance
->read_buffer_length
> 0) /* I have data in the buffer */
683 if (memcached_server_response_count(instance
) > 0)
685 fds
[host_index
].events
= POLLIN
;
686 fds
[host_index
].revents
= 0;
687 fds
[host_index
].fd
= instance
->fd
;
694 /* We have 0 or 1 server with pending events.. */
695 for (uint32_t x
= 0; x
< memcached_server_count(memc
); ++x
)
697 memcached_server_write_instance_st instance
=
698 memcached_server_instance_fetch(memc
, x
);
700 if (memcached_server_response_count(instance
) > 0)
709 int error
= poll(fds
, host_index
, memc
->poll_timeout
);
713 memcached_set_errno(*memc
, get_socket_errno(), MEMCACHED_AT
);
719 for (nfds_t x
= 0; x
< host_index
; ++x
)
721 if (fds
[x
].revents
& POLLIN
)
723 for (uint32_t y
= 0; y
< memcached_server_count(memc
); ++y
)
725 memcached_server_write_instance_st instance
= memcached_server_instance_fetch(memc
, y
);
727 if (instance
->fd
== fds
[x
].fd
)
740 Eventually we will just kill off the server with the problem.
742 void memcached_io_reset(memcached_server_write_instance_st ptr
)
744 memcached_quit_server(ptr
, true);
748 * Read a given number of bytes from the server and place it into a specific
749 * buffer. Reset the IO channel on this server if an error occurs.
751 memcached_return_t
memcached_safe_read(memcached_server_write_instance_st ptr
,
756 char *data
= static_cast<char *>(dta
);
758 while (offset
< size
)
761 memcached_return_t rc
;
763 while (memcached_continue(rc
= memcached_io_read(ptr
, data
+ offset
, size
- offset
, nread
))) { };
765 if (memcached_failed(rc
))
770 offset
+= size_t(nread
);
773 return MEMCACHED_SUCCESS
;
776 memcached_return_t
memcached_io_readline(memcached_server_write_instance_st ptr
,
782 bool line_complete
= false;
784 while (line_complete
== false)
786 if (ptr
->read_buffer_length
== 0)
789 * We don't have any data in the buffer, so let's fill the read
790 * buffer. Call the standard read function to avoid duplicating
794 memcached_return_t rc
= memcached_io_read(ptr
, buffer_ptr
, 1, nread
);
795 if (memcached_failed(rc
) and rc
== MEMCACHED_IN_PROGRESS
)
797 memcached_quit_server(ptr
, true);
798 return memcached_set_error(*ptr
, rc
, MEMCACHED_AT
);
800 else if (memcached_failed(rc
))
805 if (*buffer_ptr
== '\n')
814 /* Now let's look in the buffer and copy as we go! */
815 while (ptr
->read_buffer_length
&& total_nr
< size
&& !line_complete
)
817 *buffer_ptr
= *ptr
->read_ptr
;
818 if (*buffer_ptr
== '\n')
820 line_complete
= true;
822 --ptr
->read_buffer_length
;
828 if (total_nr
== size
)
830 return MEMCACHED_PROTOCOL_ERROR
;
834 return MEMCACHED_SUCCESS
;