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
;
53 while (--loop_max
) // Should only loop on cases of ERESTART or EINTR
55 error
= poll(fds
, 1, ptr
->root
->connect_timeout
);
62 socklen_t len
= sizeof (err
);
63 (void)getsockopt(ptr
->fd
, SOL_SOCKET
, SO_ERROR
, &err
, &len
);
65 // We check the value to see what happened wth the socket.
68 return MEMCACHED_SUCCESS
;
72 ptr
->cached_errno
= errno
;
74 return MEMCACHED_ERRNO
;
78 return MEMCACHED_TIMEOUT
;
79 default: // A real error occurred and we need to completely bail
80 WATCHPOINT_ERRNO(get_socket_errno());
81 switch (get_socket_errno())
83 #ifdef TARGET_OS_LINUX
89 if (fds
[0].revents
& POLLERR
)
92 socklen_t len
= sizeof (err
);
93 (void)getsockopt(ptr
->fd
, SOL_SOCKET
, SO_ERROR
, &err
, &len
);
94 ptr
->cached_errno
= (err
== 0) ? get_socket_errno() : err
;
98 ptr
->cached_errno
= get_socket_errno();
101 (void)closesocket(ptr
->fd
);
102 ptr
->fd
= INVALID_SOCKET
;
104 return MEMCACHED_ERRNO
;
109 // This should only be possible from ERESTART or EINTR;
110 ptr
->cached_errno
= get_socket_errno();
112 return MEMCACHED_ERRNO
;
115 static memcached_return_t
set_hostinfo(memcached_server_st
*server
)
117 char str_port
[NI_MAXSERV
];
119 assert(! server
->address_info
); // We cover the case where a programming mistake has been made.
120 if (server
->address_info
)
122 freeaddrinfo(server
->address_info
);
123 server
->address_info
= NULL
;
124 server
->address_info_next
= NULL
;
127 int length
= snprintf(str_port
, NI_MAXSERV
, "%u", (uint32_t)server
->port
);
128 if (length
>= NI_MAXSERV
|| length
< 0)
129 return MEMCACHED_FAILURE
;
131 struct addrinfo hints
;
132 memset(&hints
, 0, sizeof(struct addrinfo
));
135 hints
.ai_family
= AF_INET
;
137 if (server
->type
== MEMCACHED_CONNECTION_UDP
)
139 hints
.ai_protocol
= IPPROTO_UDP
;
140 hints
.ai_socktype
= SOCK_DGRAM
;
144 hints
.ai_socktype
= SOCK_STREAM
;
145 hints
.ai_protocol
= IPPROTO_TCP
;
149 switch(errcode
= getaddrinfo(server
->hostname
, str_port
, &hints
, &server
->address_info
))
155 return memcached_set_error(*server
, MEMCACHED_TIMEOUT
, MEMCACHED_AT
, memcached_string_make_from_cstr(gai_strerror(errcode
)));
158 return memcached_set_errno(*server
, errno
, MEMCACHED_AT
, memcached_literal_param("getaddrinfo(EAI_SYSTEM)"));
161 return memcached_set_error(*server
, MEMCACHED_INVALID_ARGUMENTS
, MEMCACHED_AT
, memcached_literal_param("getaddrinfo(EAI_BADFLAGS)"));
164 return memcached_set_error(*server
, MEMCACHED_ERRNO
, MEMCACHED_AT
, memcached_literal_param("getaddrinfo(EAI_MEMORY)"));
168 WATCHPOINT_STRING(server
->hostname
);
169 WATCHPOINT_STRING(gai_strerror(e
));
170 return memcached_set_error(*server
, MEMCACHED_HOST_LOOKUP_FAILURE
, MEMCACHED_AT
, memcached_string_make_from_cstr(gai_strerror(errcode
)));
173 server
->address_info_next
= server
->address_info
;
175 return MEMCACHED_SUCCESS
;
178 static inline memcached_return_t
set_socket_nonblocking(memcached_server_st
*ptr
)
182 if (ioctlsocket(ptr
->fd
, FIONBIO
, &arg
) == SOCKET_ERROR
)
184 return memcached_set_errno(*ptr
, get_socket_errno(), NULL
);
191 flags
= fcntl(ptr
->fd
, F_GETFL
, 0);
193 while (flags
== -1 && (errno
== EINTR
|| errno
== EAGAIN
));
195 unlikely (flags
== -1)
197 return memcached_set_errno(*ptr
, errno
, NULL
);
199 else if ((flags
& O_NONBLOCK
) == 0)
205 rval
= fcntl(ptr
->fd
, F_SETFL
, flags
| O_NONBLOCK
);
207 while (rval
== -1 && (errno
== EINTR
|| errno
== EAGAIN
));
209 unlikely (rval
== -1)
211 return memcached_set_errno(*ptr
, errno
, NULL
);
215 return MEMCACHED_SUCCESS
;
218 static memcached_return_t
set_socket_options(memcached_server_st
*ptr
)
220 WATCHPOINT_ASSERT(ptr
->fd
!= -1);
222 if (ptr
->type
== MEMCACHED_CONNECTION_UDP
)
223 return MEMCACHED_SUCCESS
;
226 if (ptr
->root
->snd_timeout
)
229 struct timeval waittime
;
232 waittime
.tv_usec
= ptr
->root
->snd_timeout
;
234 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_SNDTIMEO
,
235 &waittime
, (socklen_t
)sizeof(struct timeval
));
236 WATCHPOINT_ASSERT(error
== 0);
238 return MEMCACHED_FAILURE
;
243 if (ptr
->root
->rcv_timeout
)
246 struct timeval waittime
;
249 waittime
.tv_usec
= ptr
->root
->rcv_timeout
;
251 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_RCVTIMEO
,
252 &waittime
, (socklen_t
)sizeof(struct timeval
));
253 WATCHPOINT_ASSERT(error
== 0);
255 return MEMCACHED_FAILURE
;
260 #if defined(__MACH__) && defined(__APPLE__) || defined(__FreeBSD__)
263 int error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_NOSIGPIPE
, (void *)&set
, sizeof(int));
265 // This is not considered a fatal error
268 WATCHPOINT_ERRNO(get_socket_errno());
269 perror("setsockopt(SO_NOSIGPIPE)");
274 if (ptr
->root
->flags
.no_block
)
277 struct linger linger
;
280 linger
.l_linger
= 0; /* By default on close() just drop the socket */
281 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_LINGER
,
282 &linger
, (socklen_t
)sizeof(struct linger
));
283 WATCHPOINT_ASSERT(error
== 0);
285 return MEMCACHED_FAILURE
;
288 if (ptr
->root
->flags
.tcp_nodelay
)
293 error
= setsockopt(ptr
->fd
, IPPROTO_TCP
, TCP_NODELAY
,
294 &flag
, (socklen_t
)sizeof(int));
295 WATCHPOINT_ASSERT(error
== 0);
297 return MEMCACHED_FAILURE
;
300 if (ptr
->root
->flags
.tcp_keepalive
)
305 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_KEEPALIVE
,
306 &flag
, (socklen_t
)sizeof(int));
307 WATCHPOINT_ASSERT(error
== 0);
309 return MEMCACHED_FAILURE
;
313 if (ptr
->root
->tcp_keepidle
> 0)
317 error
= setsockopt(ptr
->fd
, IPPROTO_TCP
, TCP_KEEPIDLE
,
318 &ptr
->root
->tcp_keepidle
, (socklen_t
)sizeof(int));
319 WATCHPOINT_ASSERT(error
== 0);
321 return MEMCACHED_FAILURE
;
325 if (ptr
->root
->send_size
> 0)
329 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_SNDBUF
,
330 &ptr
->root
->send_size
, (socklen_t
)sizeof(int));
331 WATCHPOINT_ASSERT(error
== 0);
333 return MEMCACHED_FAILURE
;
336 if (ptr
->root
->recv_size
> 0)
340 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_RCVBUF
,
341 &ptr
->root
->recv_size
, (socklen_t
)sizeof(int));
342 WATCHPOINT_ASSERT(error
== 0);
344 return MEMCACHED_FAILURE
;
348 /* libmemcached will always use nonblocking IO to avoid write deadlocks */
349 return set_socket_nonblocking(ptr
);
352 static memcached_return_t
unix_socket_connect(memcached_server_st
*ptr
)
355 WATCHPOINT_ASSERT(ptr
->fd
== -1);
357 if ((ptr
->fd
= socket(AF_UNIX
, SOCK_STREAM
, 0)) < 0)
359 return memcached_set_errno(*ptr
, errno
, NULL
);
362 struct sockaddr_un servAddr
;
364 memset(&servAddr
, 0, sizeof (struct sockaddr_un
));
365 servAddr
.sun_family
= AF_UNIX
;
366 strncpy(servAddr
.sun_path
, ptr
->hostname
, sizeof(servAddr
.sun_path
)); /* Copy filename */
370 (struct sockaddr
*)&servAddr
,
371 sizeof(servAddr
)) < 0)
379 case EISCONN
: /* We were spinning waiting on connect */
382 WATCHPOINT_ERRNO(errno
);
383 ptr
->cached_errno
= errno
;
384 return MEMCACHED_ERRNO
;
388 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
390 return MEMCACHED_SUCCESS
;
393 return MEMCACHED_NOT_SUPPORTED
;
397 static memcached_return_t
network_connect(memcached_server_st
*ptr
)
399 bool timeout_error_occured
= false;
401 WATCHPOINT_ASSERT(ptr
->fd
== INVALID_SOCKET
);
402 WATCHPOINT_ASSERT(ptr
->cursor_active
== 0);
404 if (not ptr
->address_info
)
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 (void)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
))
452 /* An error occurred */
453 ptr
->cached_errno
= get_socket_errno();
454 switch (ptr
->cached_errno
)
457 case EINPROGRESS
: // nonblocking mode - first return
458 case EALREADY
: // nonblocking mode - subsequent returns
460 memcached_return_t rc
;
461 rc
= connect_poll(ptr
);
463 if (rc
== MEMCACHED_TIMEOUT
)
464 timeout_error_occured
= true;
466 if (rc
== MEMCACHED_SUCCESS
)
470 case EISCONN
: // we are connected :-)
473 case EINTR
: // Special case, we retry ai_addr
474 (void)closesocket(ptr
->fd
);
475 ptr
->fd
= INVALID_SOCKET
;
479 (void)closesocket(ptr
->fd
);
480 ptr
->fd
= INVALID_SOCKET
;
481 ptr
->address_info_next
= ptr
->address_info_next
->ai_next
;
486 if (ptr
->fd
== INVALID_SOCKET
)
488 WATCHPOINT_STRING("Never got a good file descriptor");
490 /* Failed to connect. schedule next retry */
491 if (ptr
->root
->retry_timeout
)
493 struct timeval next_time
;
495 if (gettimeofday(&next_time
, NULL
) == 0)
496 ptr
->next_retry
= next_time
.tv_sec
+ ptr
->root
->retry_timeout
;
499 if (timeout_error_occured
)
500 return MEMCACHED_TIMEOUT
;
502 return MEMCACHED_ERRNO
; /* The last error should be from connect() */
505 return MEMCACHED_SUCCESS
; /* The last error should be from connect() */
508 void set_last_disconnected_host(memcached_server_write_instance_st ptr
)
511 memcached_st
*root
= (memcached_st
*)ptr
->root
;
514 WATCHPOINT_STRING(ptr
->hostname
);
515 WATCHPOINT_NUMBER(ptr
->port
);
516 WATCHPOINT_ERRNO(ptr
->cached_errno
);
518 if (root
->last_disconnected_server
)
519 memcached_server_free(root
->last_disconnected_server
);
520 root
->last_disconnected_server
= memcached_server_clone(NULL
, ptr
);
523 memcached_return_t
memcached_connect(memcached_server_write_instance_st ptr
)
525 memcached_return_t rc
= MEMCACHED_NO_SERVERS
;
527 if (ptr
->fd
!= INVALID_SOCKET
)
528 return MEMCACHED_SUCCESS
;
530 LIBMEMCACHED_MEMCACHED_CONNECT_START();
532 /* both retry_timeout and server_failure_limit must be set in order to delay retrying a server on error. */
533 WATCHPOINT_ASSERT(ptr
->root
);
534 if (ptr
->root
->retry_timeout
&& ptr
->next_retry
)
536 struct timeval curr_time
;
538 gettimeofday(&curr_time
, NULL
);
540 // We should optimize this to remove the allocation if the server was
541 // the last server to die
542 if (ptr
->next_retry
> curr_time
.tv_sec
)
544 set_last_disconnected_host(ptr
);
546 return MEMCACHED_SERVER_MARKED_DEAD
;
550 // If we are over the counter failure, we just fail. Reject host only
551 // works if you have a set number of failures.
552 if (ptr
->root
->server_failure_limit
&& ptr
->server_failure_counter
>= ptr
->root
->server_failure_limit
)
554 set_last_disconnected_host(ptr
);
556 // @todo fix this by fixing behavior to no longer make use of
558 if (_is_auto_eject_host(ptr
->root
))
560 run_distribution((memcached_st
*)ptr
->root
);
563 return MEMCACHED_SERVER_MARKED_DEAD
;
566 /* We need to clean up the multi startup piece */
569 case MEMCACHED_CONNECTION_UNKNOWN
:
570 WATCHPOINT_ASSERT(0);
571 rc
= MEMCACHED_NOT_SUPPORTED
;
573 case MEMCACHED_CONNECTION_UDP
:
574 case MEMCACHED_CONNECTION_TCP
:
575 rc
= network_connect(ptr
);
576 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
577 if (ptr
->fd
!= INVALID_SOCKET
&& ptr
->root
->sasl
.callbacks
)
579 rc
= memcached_sasl_authenticate_connection(ptr
);
580 if (memcached_failed(rc
))
582 (void)closesocket(ptr
->fd
);
583 ptr
->fd
= INVALID_SOCKET
;
588 case MEMCACHED_CONNECTION_UNIX_SOCKET
:
589 rc
= unix_socket_connect(ptr
);
591 case MEMCACHED_CONNECTION_MAX
:
593 WATCHPOINT_ASSERT(0);
596 if (rc
== MEMCACHED_SUCCESS
)
598 ptr
->server_failure_counter
= 0;
603 ptr
->server_failure_counter
++;
605 set_last_disconnected_host(ptr
);
608 LIBMEMCACHED_MEMCACHED_CONNECT_END();