1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2010 Brian Aker All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include <libmemcached/common.h>
44 static memcached_return_t
connect_poll(memcached_server_st
*ptr
)
48 fds
[0].events
= POLLOUT
;
52 if (ptr
->root
->poll_timeout
== 0)
54 return memcached_set_error(*ptr
, MEMCACHED_TIMEOUT
, MEMCACHED_AT
);
57 while (--loop_max
) // Should only loop on cases of ERESTART or EINTR
59 int error
= poll(fds
, 1, ptr
->root
->connect_timeout
);
65 socklen_t len
= sizeof (err
);
66 (void)getsockopt(ptr
->fd
, SOL_SOCKET
, SO_ERROR
, &err
, &len
);
68 // We check the value to see what happened wth the socket.
71 return MEMCACHED_SUCCESS
;
74 return memcached_set_errno(*ptr
, err
, MEMCACHED_AT
);
78 return memcached_set_error(*ptr
, MEMCACHED_TIMEOUT
, MEMCACHED_AT
);
81 default: // A real error occurred and we need to completely bail
82 WATCHPOINT_ERRNO(get_socket_errno());
83 switch (get_socket_errno())
85 #ifdef TARGET_OS_LINUX
93 return memcached_set_error(*ptr
, MEMCACHED_MEMORY_ALLOCATION_FAILURE
, MEMCACHED_AT
);
96 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"));
98 default: // This should not happen
99 if (fds
[0].revents
& POLLERR
)
102 socklen_t len
= sizeof (err
);
103 (void)getsockopt(ptr
->fd
, SOL_SOCKET
, SO_ERROR
, &err
, &len
);
104 memcached_set_errno(*ptr
, (err
== 0) ? get_socket_errno() : err
, MEMCACHED_AT
);
108 memcached_set_errno(*ptr
, get_socket_errno(), MEMCACHED_AT
);
111 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
112 (void)closesocket(ptr
->fd
);
113 ptr
->fd
= INVALID_SOCKET
;
114 ptr
->state
= MEMCACHED_SERVER_STATE_NEW
;
116 return memcached_set_errno(*ptr
, get_socket_errno(), MEMCACHED_AT
);
121 // This should only be possible from ERESTART or EINTR;
122 return memcached_set_errno(*ptr
, get_socket_errno(), MEMCACHED_AT
);
125 static memcached_return_t
set_hostinfo(memcached_server_st
*server
)
127 WATCHPOINT_ASSERT(not server
->address_info
); // We cover the case where a programming mistake has been made.
128 if (server
->address_info
)
130 freeaddrinfo(server
->address_info
);
131 server
->address_info
= NULL
;
132 server
->address_info_next
= NULL
;
135 char str_port
[NI_MAXSERV
];
136 int length
= snprintf(str_port
, NI_MAXSERV
, "%u", (uint32_t)server
->port
);
137 if (length
>= NI_MAXSERV
|| length
< 0)
139 return MEMCACHED_FAILURE
;
142 struct addrinfo hints
;
143 memset(&hints
, 0, sizeof(struct addrinfo
));
146 hints
.ai_family
= AF_INET
;
148 if (server
->type
== MEMCACHED_CONNECTION_UDP
)
150 hints
.ai_protocol
= IPPROTO_UDP
;
151 hints
.ai_socktype
= SOCK_DGRAM
;
155 hints
.ai_socktype
= SOCK_STREAM
;
156 hints
.ai_protocol
= IPPROTO_TCP
;
160 switch(errcode
= getaddrinfo(server
->hostname
, str_port
, &hints
, &server
->address_info
))
166 return memcached_set_error(*server
, MEMCACHED_TIMEOUT
, MEMCACHED_AT
, memcached_string_make_from_cstr(gai_strerror(errcode
)));
169 return memcached_set_errno(*server
, errno
, MEMCACHED_AT
, memcached_literal_param("getaddrinfo(EAI_SYSTEM)"));
172 return memcached_set_error(*server
, MEMCACHED_INVALID_ARGUMENTS
, MEMCACHED_AT
, memcached_literal_param("getaddrinfo(EAI_BADFLAGS)"));
175 return memcached_set_error(*server
, MEMCACHED_MEMORY_ALLOCATION_FAILURE
, MEMCACHED_AT
, memcached_literal_param("getaddrinfo(EAI_MEMORY)"));
179 WATCHPOINT_STRING(server
->hostname
);
180 WATCHPOINT_STRING(gai_strerror(errcode
));
181 return memcached_set_error(*server
, MEMCACHED_HOST_LOOKUP_FAILURE
, MEMCACHED_AT
, memcached_string_make_from_cstr(gai_strerror(errcode
)));
184 server
->address_info_next
= server
->address_info
;
185 server
->state
= MEMCACHED_SERVER_STATE_ADDRINFO
;
187 return MEMCACHED_SUCCESS
;
190 static inline void set_socket_nonblocking(memcached_server_st
*ptr
)
194 if (ioctlsocket(ptr
->fd
, FIONBIO
, &arg
) == SOCKET_ERROR
)
196 memcached_set_errno(*ptr
, get_socket_errno(), NULL
);
203 flags
= fcntl(ptr
->fd
, F_GETFL
, 0);
204 } while (flags
== -1 && (errno
== EINTR
|| errno
== EAGAIN
));
208 memcached_set_errno(*ptr
, errno
, NULL
);
210 else if ((flags
& O_NONBLOCK
) == 0)
216 rval
= fcntl(ptr
->fd
, F_SETFL
, flags
| O_NONBLOCK
);
217 } while (rval
== -1 && (errno
== EINTR
|| errno
== EAGAIN
));
219 unlikely (rval
== -1)
221 memcached_set_errno(*ptr
, errno
, NULL
);
227 static void set_socket_options(memcached_server_st
*ptr
)
229 WATCHPOINT_ASSERT(ptr
->fd
!= -1);
231 if (ptr
->type
== MEMCACHED_CONNECTION_UDP
)
235 if (ptr
->root
->snd_timeout
)
238 struct timeval waittime
;
241 waittime
.tv_usec
= ptr
->root
->snd_timeout
;
243 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_SNDTIMEO
,
244 &waittime
, (socklen_t
)sizeof(struct timeval
));
245 WATCHPOINT_ASSERT(error
== 0);
250 if (ptr
->root
->rcv_timeout
)
253 struct timeval waittime
;
256 waittime
.tv_usec
= ptr
->root
->rcv_timeout
;
258 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_RCVTIMEO
,
259 &waittime
, (socklen_t
)sizeof(struct timeval
));
260 WATCHPOINT_ASSERT(error
== 0);
265 #if defined(__MACH__) && defined(__APPLE__) || defined(__FreeBSD__)
268 int error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_NOSIGPIPE
, (void *)&set
, sizeof(int));
270 // This is not considered a fatal error
273 WATCHPOINT_ERRNO(get_socket_errno());
274 perror("setsockopt(SO_NOSIGPIPE)");
279 if (ptr
->root
->flags
.no_block
)
282 struct linger linger
;
285 linger
.l_linger
= 0; /* By default on close() just drop the socket */
286 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_LINGER
,
287 &linger
, (socklen_t
)sizeof(struct linger
));
288 WATCHPOINT_ASSERT(error
== 0);
291 if (ptr
->root
->flags
.tcp_nodelay
)
296 error
= setsockopt(ptr
->fd
, IPPROTO_TCP
, TCP_NODELAY
,
297 &flag
, (socklen_t
)sizeof(int));
298 WATCHPOINT_ASSERT(error
== 0);
301 if (ptr
->root
->flags
.tcp_keepalive
)
306 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_KEEPALIVE
,
307 &flag
, (socklen_t
)sizeof(int));
308 WATCHPOINT_ASSERT(error
== 0);
312 if (ptr
->root
->tcp_keepidle
> 0)
316 error
= setsockopt(ptr
->fd
, IPPROTO_TCP
, TCP_KEEPIDLE
,
317 &ptr
->root
->tcp_keepidle
, (socklen_t
)sizeof(int));
318 WATCHPOINT_ASSERT(error
== 0);
322 if (ptr
->root
->send_size
> 0)
326 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_SNDBUF
,
327 &ptr
->root
->send_size
, (socklen_t
)sizeof(int));
328 WATCHPOINT_ASSERT(error
== 0);
331 if (ptr
->root
->recv_size
> 0)
335 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_RCVBUF
,
336 &ptr
->root
->recv_size
, (socklen_t
)sizeof(int));
337 WATCHPOINT_ASSERT(error
== 0);
341 /* libmemcached will always use nonblocking IO to avoid write deadlocks */
342 set_socket_nonblocking(ptr
);
345 static memcached_return_t
unix_socket_connect(memcached_server_st
*ptr
)
348 WATCHPOINT_ASSERT(ptr
->fd
== -1);
350 if ((ptr
->fd
= socket(AF_UNIX
, SOCK_STREAM
, 0)) < 0)
352 memcached_set_errno(*ptr
, errno
, NULL
);
353 return MEMCACHED_CONNECTION_FAILURE
;
356 struct sockaddr_un servAddr
;
358 memset(&servAddr
, 0, sizeof (struct sockaddr_un
));
359 servAddr
.sun_family
= AF_UNIX
;
360 strncpy(servAddr
.sun_path
, ptr
->hostname
, sizeof(servAddr
.sun_path
)); /* Copy filename */
363 if (connect(ptr
->fd
, (struct sockaddr
*)&servAddr
, sizeof(servAddr
)) < 0)
372 case EISCONN
: /* We were spinning waiting on connect */
374 WATCHPOINT_ASSERT(0); // Programmer error
379 WATCHPOINT_ERRNO(errno
);
380 memcached_set_errno(*ptr
, errno
, MEMCACHED_AT
);
381 return MEMCACHED_CONNECTION_FAILURE
;
385 ptr
->state
= MEMCACHED_SERVER_STATE_CONNECTED
;
387 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
389 return MEMCACHED_SUCCESS
;
392 return MEMCACHED_NOT_SUPPORTED
;
396 static memcached_return_t
network_connect(memcached_server_st
*ptr
)
398 bool timeout_error_occured
= false;
400 WATCHPOINT_ASSERT(ptr
->fd
== INVALID_SOCKET
);
401 WATCHPOINT_ASSERT(ptr
->cursor_active
== 0);
403 if (not ptr
->address_info
)
405 WATCHPOINT_ASSERT(ptr
->state
== MEMCACHED_SERVER_STATE_NEW
);
406 memcached_return_t rc
;
410 if ((rc
= set_hostinfo(ptr
)) != MEMCACHED_TIMEOUT
)
414 struct timespec dream
, rem
;
419 nanosleep(&dream
, &rem
);
423 if (memcached_failed(rc
))
427 /* Create the socket */
428 while (ptr
->address_info_next
&& ptr
->fd
== INVALID_SOCKET
)
430 /* Memcache server does not support IPV6 in udp mode, so skip if not ipv4 */
431 if (ptr
->type
== MEMCACHED_CONNECTION_UDP
&& ptr
->address_info_next
->ai_family
!= AF_INET
)
433 ptr
->address_info_next
= ptr
->address_info_next
->ai_next
;
437 if ((ptr
->fd
= socket(ptr
->address_info_next
->ai_family
,
438 ptr
->address_info_next
->ai_socktype
,
439 ptr
->address_info_next
->ai_protocol
)) < 0)
441 return memcached_set_errno(*ptr
, get_socket_errno(), NULL
);
444 set_socket_options(ptr
);
446 /* connect to server */
447 if ((connect(ptr
->fd
, ptr
->address_info_next
->ai_addr
, ptr
->address_info_next
->ai_addrlen
) != SOCKET_ERROR
))
449 ptr
->state
= MEMCACHED_SERVER_STATE_CONNECTED
;
453 /* An error occurred */
454 switch (get_socket_errno())
457 timeout_error_occured
= true;
461 case EINPROGRESS
: // nonblocking mode - first return
462 case EALREADY
: // nonblocking mode - subsequent returns
464 ptr
->state
= MEMCACHED_SERVER_STATE_IN_PROGRESS
;
465 memcached_return_t rc
= connect_poll(ptr
);
467 if (memcached_success(rc
))
469 ptr
->state
= MEMCACHED_SERVER_STATE_CONNECTED
;
470 return MEMCACHED_SUCCESS
;
473 // A timeout here is treated as an error, we will not retry
474 if (rc
== MEMCACHED_TIMEOUT
)
476 timeout_error_occured
= true;
481 case EISCONN
: // we are connected :-)
482 WATCHPOINT_ASSERT(0); // This is a programmer's error
485 case EINTR
: // Special case, we retry ai_addr
486 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
487 (void)closesocket(ptr
->fd
);
488 ptr
->fd
= INVALID_SOCKET
;
495 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
496 (void)closesocket(ptr
->fd
);
497 ptr
->fd
= INVALID_SOCKET
;
498 ptr
->address_info_next
= ptr
->address_info_next
->ai_next
;
501 WATCHPOINT_ASSERT(ptr
->fd
== INVALID_SOCKET
);
503 if (timeout_error_occured
)
505 if (ptr
->fd
!= INVALID_SOCKET
)
507 (void)closesocket(ptr
->fd
);
508 ptr
->fd
= INVALID_SOCKET
;
512 WATCHPOINT_STRING("Never got a good file descriptor");
513 /* Failed to connect. schedule next retry */
514 if (ptr
->root
->retry_timeout
)
516 struct timeval next_time
;
518 if (gettimeofday(&next_time
, NULL
) == 0)
519 ptr
->next_retry
= next_time
.tv_sec
+ ptr
->root
->retry_timeout
;
522 if (timeout_error_occured
)
523 return memcached_set_error(*ptr
, MEMCACHED_TIMEOUT
, MEMCACHED_AT
);
525 return memcached_set_error(*ptr
, MEMCACHED_CONNECTION_FAILURE
, MEMCACHED_AT
); /* The last error should be from connect() */
528 void set_last_disconnected_host(memcached_server_write_instance_st self
)
531 memcached_st
*root
= (memcached_st
*)self
->root
;
534 WATCHPOINT_STRING(self
->hostname
);
535 WATCHPOINT_NUMBER(self
->port
);
536 WATCHPOINT_ERRNO(self
->cached_errno
);
538 memcached_server_free(root
->last_disconnected_server
);
539 root
->last_disconnected_server
= memcached_server_clone(NULL
, self
);
542 memcached_return_t
memcached_connect(memcached_server_write_instance_st ptr
)
544 memcached_return_t rc
= MEMCACHED_NO_SERVERS
;
546 if (ptr
->fd
!= INVALID_SOCKET
)
548 return MEMCACHED_SUCCESS
;
551 LIBMEMCACHED_MEMCACHED_CONNECT_START();
553 /* both retry_timeout and server_failure_limit must be set in order to delay retrying a server on error. */
554 WATCHPOINT_ASSERT(ptr
->root
);
555 if (ptr
->root
->retry_timeout
&& ptr
->next_retry
)
557 struct timeval curr_time
;
559 gettimeofday(&curr_time
, NULL
);
561 // We should optimize this to remove the allocation if the server was
562 // the last server to die
563 if (ptr
->next_retry
> curr_time
.tv_sec
)
565 set_last_disconnected_host(ptr
);
567 return memcached_set_error(*ptr
, MEMCACHED_SERVER_MARKED_DEAD
, MEMCACHED_AT
);
571 // If we are over the counter failure, we just fail. Reject host only
572 // works if you have a set number of failures.
573 if (ptr
->root
->server_failure_limit
&& ptr
->server_failure_counter
>= ptr
->root
->server_failure_limit
)
575 set_last_disconnected_host(ptr
);
577 // @todo fix this by fixing behavior to no longer make use of
579 if (_is_auto_eject_host(ptr
->root
))
581 run_distribution((memcached_st
*)ptr
->root
);
584 return memcached_set_error(*ptr
, MEMCACHED_SERVER_MARKED_DEAD
, MEMCACHED_AT
);
587 /* We need to clean up the multi startup piece */
590 case MEMCACHED_CONNECTION_UNKNOWN
:
591 WATCHPOINT_ASSERT(0);
592 rc
= MEMCACHED_NOT_SUPPORTED
;
595 case MEMCACHED_CONNECTION_UDP
:
596 case MEMCACHED_CONNECTION_TCP
:
597 rc
= network_connect(ptr
);
598 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
599 if (ptr
->fd
!= INVALID_SOCKET
and ptr
->root
->sasl
.callbacks
)
601 rc
= memcached_sasl_authenticate_connection(ptr
);
602 if (memcached_failed(rc
) and ptr
->fd
!= INVALID_SOCKET
)
604 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
605 (void)closesocket(ptr
->fd
);
606 ptr
->fd
= INVALID_SOCKET
;
612 case MEMCACHED_CONNECTION_UNIX_SOCKET
:
613 rc
= unix_socket_connect(ptr
);
616 case MEMCACHED_CONNECTION_MAX
:
618 WATCHPOINT_ASSERT(0);
621 if (memcached_success(rc
))
623 ptr
->server_failure_counter
= 0;
628 memcached_set_error(*ptr
, rc
, MEMCACHED_AT
);
629 ptr
->server_failure_counter
++;
630 set_last_disconnected_host(ptr
);
633 LIBMEMCACHED_MEMCACHED_CONNECT_END();