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 if (ptr
->root
->poll_timeout
)
57 error
= poll(fds
, 1, ptr
->root
->connect_timeout
);
69 socklen_t len
= sizeof (err
);
70 (void)getsockopt(ptr
->fd
, SOL_SOCKET
, SO_ERROR
, &err
, &len
);
72 // We check the value to see what happened wth the socket.
75 return MEMCACHED_SUCCESS
;
79 ptr
->cached_errno
= errno
;
81 return MEMCACHED_ERRNO
;
85 return MEMCACHED_TIMEOUT
;
87 default: // A real error occurred and we need to completely bail
88 WATCHPOINT_ERRNO(get_socket_errno());
89 switch (get_socket_errno())
91 #ifdef TARGET_OS_LINUX
97 if (fds
[0].revents
& POLLERR
)
100 socklen_t len
= sizeof (err
);
101 (void)getsockopt(ptr
->fd
, SOL_SOCKET
, SO_ERROR
, &err
, &len
);
102 ptr
->cached_errno
= (err
== 0) ? get_socket_errno() : err
;
106 ptr
->cached_errno
= get_socket_errno();
109 (void)closesocket(ptr
->fd
);
110 ptr
->fd
= INVALID_SOCKET
;
112 return MEMCACHED_ERRNO
;
117 // This should only be possible from ERESTART or EINTR;
118 ptr
->cached_errno
= get_socket_errno();
120 return MEMCACHED_ERRNO
;
123 static memcached_return_t
set_hostinfo(memcached_server_st
*server
)
125 char str_port
[NI_MAXSERV
];
127 assert(! 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 int length
= snprintf(str_port
, NI_MAXSERV
, "%u", (uint32_t)server
->port
);
136 if (length
>= NI_MAXSERV
|| length
< 0)
137 return MEMCACHED_FAILURE
;
139 struct addrinfo hints
;
140 memset(&hints
, 0, sizeof(struct addrinfo
));
143 hints
.ai_family
= AF_INET
;
145 if (server
->type
== MEMCACHED_CONNECTION_UDP
)
147 hints
.ai_protocol
= IPPROTO_UDP
;
148 hints
.ai_socktype
= SOCK_DGRAM
;
152 hints
.ai_socktype
= SOCK_STREAM
;
153 hints
.ai_protocol
= IPPROTO_TCP
;
157 switch(errcode
= getaddrinfo(server
->hostname
, str_port
, &hints
, &server
->address_info
))
163 return memcached_set_error(*server
, MEMCACHED_TIMEOUT
, MEMCACHED_AT
, memcached_string_make_from_cstr(gai_strerror(errcode
)));
166 return memcached_set_errno(*server
, errno
, MEMCACHED_AT
, memcached_literal_param("getaddrinfo(EAI_SYSTEM)"));
169 return memcached_set_error(*server
, MEMCACHED_INVALID_ARGUMENTS
, MEMCACHED_AT
, memcached_literal_param("getaddrinfo(EAI_BADFLAGS)"));
172 return memcached_set_error(*server
, MEMCACHED_ERRNO
, MEMCACHED_AT
, memcached_literal_param("getaddrinfo(EAI_MEMORY)"));
176 WATCHPOINT_STRING(server
->hostname
);
177 WATCHPOINT_STRING(gai_strerror(e
));
178 return memcached_set_error(*server
, MEMCACHED_HOST_LOOKUP_FAILURE
, MEMCACHED_AT
, memcached_string_make_from_cstr(gai_strerror(errcode
)));
181 server
->address_info_next
= server
->address_info
;
183 return MEMCACHED_SUCCESS
;
186 static inline memcached_return_t
set_socket_nonblocking(memcached_server_st
*ptr
)
190 if (ioctlsocket(ptr
->fd
, FIONBIO
, &arg
) == SOCKET_ERROR
)
192 return memcached_set_errno(*ptr
, get_socket_errno(), NULL
);
199 flags
= fcntl(ptr
->fd
, F_GETFL
, 0);
201 while (flags
== -1 && (errno
== EINTR
|| errno
== EAGAIN
));
203 unlikely (flags
== -1)
205 return memcached_set_errno(*ptr
, errno
, NULL
);
207 else if ((flags
& O_NONBLOCK
) == 0)
213 rval
= fcntl(ptr
->fd
, F_SETFL
, flags
| O_NONBLOCK
);
215 while (rval
== -1 && (errno
== EINTR
|| errno
== EAGAIN
));
217 unlikely (rval
== -1)
219 return memcached_set_errno(*ptr
, errno
, NULL
);
223 return MEMCACHED_SUCCESS
;
226 static memcached_return_t
set_socket_options(memcached_server_st
*ptr
)
228 WATCHPOINT_ASSERT(ptr
->fd
!= -1);
230 if (ptr
->type
== MEMCACHED_CONNECTION_UDP
)
231 return MEMCACHED_SUCCESS
;
234 if (ptr
->root
->snd_timeout
)
237 struct timeval waittime
;
240 waittime
.tv_usec
= ptr
->root
->snd_timeout
;
242 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_SNDTIMEO
,
243 &waittime
, (socklen_t
)sizeof(struct timeval
));
244 WATCHPOINT_ASSERT(error
== 0);
246 return MEMCACHED_FAILURE
;
251 if (ptr
->root
->rcv_timeout
)
254 struct timeval waittime
;
257 waittime
.tv_usec
= ptr
->root
->rcv_timeout
;
259 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_RCVTIMEO
,
260 &waittime
, (socklen_t
)sizeof(struct timeval
));
261 WATCHPOINT_ASSERT(error
== 0);
263 return MEMCACHED_FAILURE
;
268 #if defined(__MACH__) && defined(__APPLE__) || defined(__FreeBSD__)
271 int error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_NOSIGPIPE
, (void *)&set
, sizeof(int));
273 // This is not considered a fatal error
276 WATCHPOINT_ERRNO(get_socket_errno());
277 perror("setsockopt(SO_NOSIGPIPE)");
282 if (ptr
->root
->flags
.no_block
)
285 struct linger linger
;
288 linger
.l_linger
= 0; /* By default on close() just drop the socket */
289 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_LINGER
,
290 &linger
, (socklen_t
)sizeof(struct linger
));
291 WATCHPOINT_ASSERT(error
== 0);
293 return MEMCACHED_FAILURE
;
296 if (ptr
->root
->flags
.tcp_nodelay
)
301 error
= setsockopt(ptr
->fd
, IPPROTO_TCP
, TCP_NODELAY
,
302 &flag
, (socklen_t
)sizeof(int));
303 WATCHPOINT_ASSERT(error
== 0);
305 return MEMCACHED_FAILURE
;
308 if (ptr
->root
->flags
.tcp_keepalive
)
313 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_KEEPALIVE
,
314 &flag
, (socklen_t
)sizeof(int));
315 WATCHPOINT_ASSERT(error
== 0);
317 return MEMCACHED_FAILURE
;
321 if (ptr
->root
->tcp_keepidle
> 0)
325 error
= setsockopt(ptr
->fd
, IPPROTO_TCP
, TCP_KEEPIDLE
,
326 &ptr
->root
->tcp_keepidle
, (socklen_t
)sizeof(int));
327 WATCHPOINT_ASSERT(error
== 0);
329 return MEMCACHED_FAILURE
;
333 if (ptr
->root
->send_size
> 0)
337 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_SNDBUF
,
338 &ptr
->root
->send_size
, (socklen_t
)sizeof(int));
339 WATCHPOINT_ASSERT(error
== 0);
341 return MEMCACHED_FAILURE
;
344 if (ptr
->root
->recv_size
> 0)
348 error
= setsockopt(ptr
->fd
, SOL_SOCKET
, SO_RCVBUF
,
349 &ptr
->root
->recv_size
, (socklen_t
)sizeof(int));
350 WATCHPOINT_ASSERT(error
== 0);
352 return MEMCACHED_FAILURE
;
356 /* libmemcached will always use nonblocking IO to avoid write deadlocks */
357 return set_socket_nonblocking(ptr
);
360 static memcached_return_t
unix_socket_connect(memcached_server_st
*ptr
)
363 WATCHPOINT_ASSERT(ptr
->fd
== -1);
365 if ((ptr
->fd
= socket(AF_UNIX
, SOCK_STREAM
, 0)) < 0)
367 return memcached_set_errno(*ptr
, errno
, NULL
);
370 struct sockaddr_un servAddr
;
372 memset(&servAddr
, 0, sizeof (struct sockaddr_un
));
373 servAddr
.sun_family
= AF_UNIX
;
374 strncpy(servAddr
.sun_path
, ptr
->hostname
, sizeof(servAddr
.sun_path
)); /* Copy filename */
378 (struct sockaddr
*)&servAddr
,
379 sizeof(servAddr
)) < 0)
387 case EISCONN
: /* We were spinning waiting on connect */
390 WATCHPOINT_ERRNO(errno
);
391 ptr
->cached_errno
= errno
;
392 return MEMCACHED_ERRNO
;
396 WATCHPOINT_ASSERT(ptr
->fd
!= INVALID_SOCKET
);
398 return MEMCACHED_SUCCESS
;
401 return MEMCACHED_NOT_SUPPORTED
;
405 static memcached_return_t
network_connect(memcached_server_st
*ptr
)
407 bool timeout_error_occured
= false;
409 WATCHPOINT_ASSERT(ptr
->fd
== INVALID_SOCKET
);
410 WATCHPOINT_ASSERT(ptr
->cursor_active
== 0);
412 if (not ptr
->address_info
)
414 memcached_return_t rc
;
418 if ((rc
= set_hostinfo(ptr
)) != MEMCACHED_TIMEOUT
)
422 struct timespec dream
, rem
;
427 nanosleep(&dream
, &rem
);
431 if (memcached_failed(rc
))
435 /* Create the socket */
436 while (ptr
->address_info_next
&& ptr
->fd
== INVALID_SOCKET
)
438 /* Memcache server does not support IPV6 in udp mode, so skip if not ipv4 */
439 if (ptr
->type
== MEMCACHED_CONNECTION_UDP
&& ptr
->address_info_next
->ai_family
!= AF_INET
)
441 ptr
->address_info_next
= ptr
->address_info_next
->ai_next
;
445 if ((ptr
->fd
= socket(ptr
->address_info_next
->ai_family
,
446 ptr
->address_info_next
->ai_socktype
,
447 ptr
->address_info_next
->ai_protocol
)) < 0)
449 return memcached_set_errno(*ptr
, get_socket_errno(), NULL
);
452 (void)set_socket_options(ptr
);
454 /* connect to server */
455 if ((connect(ptr
->fd
, ptr
->address_info_next
->ai_addr
, ptr
->address_info_next
->ai_addrlen
) != SOCKET_ERROR
))
460 /* An error occurred */
461 ptr
->cached_errno
= get_socket_errno();
462 switch (ptr
->cached_errno
)
465 case EINPROGRESS
: // nonblocking mode - first return
466 case EALREADY
: // nonblocking mode - subsequent returns
468 memcached_return_t rc
= connect_poll(ptr
);
470 if (rc
== MEMCACHED_TIMEOUT
)
471 timeout_error_occured
= true;
473 if (rc
== MEMCACHED_SUCCESS
)
477 case EISCONN
: // we are connected :-)
480 case EINTR
: // Special case, we retry ai_addr
481 (void)closesocket(ptr
->fd
);
482 ptr
->fd
= INVALID_SOCKET
;
486 (void)closesocket(ptr
->fd
);
487 ptr
->fd
= INVALID_SOCKET
;
488 ptr
->address_info_next
= ptr
->address_info_next
->ai_next
;
493 if (ptr
->fd
== INVALID_SOCKET
)
495 WATCHPOINT_STRING("Never got a good file descriptor");
497 /* Failed to connect. schedule next retry */
498 if (ptr
->root
->retry_timeout
)
500 struct timeval next_time
;
502 if (gettimeofday(&next_time
, NULL
) == 0)
503 ptr
->next_retry
= next_time
.tv_sec
+ ptr
->root
->retry_timeout
;
506 if (timeout_error_occured
)
507 return MEMCACHED_TIMEOUT
;
509 return MEMCACHED_ERRNO
; /* The last error should be from connect() */
512 return MEMCACHED_SUCCESS
; /* The last error should be from connect() */
515 void set_last_disconnected_host(memcached_server_write_instance_st self
)
518 memcached_st
*root
= (memcached_st
*)self
->root
;
521 WATCHPOINT_STRING(self
->hostname
);
522 WATCHPOINT_NUMBER(self
->port
);
523 WATCHPOINT_ERRNO(self
->cached_errno
);
525 memcached_server_free(root
->last_disconnected_server
);
526 root
->last_disconnected_server
= memcached_server_clone(NULL
, self
);
529 memcached_return_t
memcached_connect(memcached_server_write_instance_st ptr
)
531 memcached_return_t rc
= MEMCACHED_NO_SERVERS
;
533 if (ptr
->fd
!= INVALID_SOCKET
)
534 return MEMCACHED_SUCCESS
;
536 LIBMEMCACHED_MEMCACHED_CONNECT_START();
538 /* both retry_timeout and server_failure_limit must be set in order to delay retrying a server on error. */
539 WATCHPOINT_ASSERT(ptr
->root
);
540 if (ptr
->root
->retry_timeout
&& ptr
->next_retry
)
542 struct timeval curr_time
;
544 gettimeofday(&curr_time
, NULL
);
546 // We should optimize this to remove the allocation if the server was
547 // the last server to die
548 if (ptr
->next_retry
> curr_time
.tv_sec
)
550 set_last_disconnected_host(ptr
);
552 return memcached_set_error(*ptr
, MEMCACHED_SERVER_MARKED_DEAD
, MEMCACHED_AT
);
556 // If we are over the counter failure, we just fail. Reject host only
557 // works if you have a set number of failures.
558 if (ptr
->root
->server_failure_limit
&& ptr
->server_failure_counter
>= ptr
->root
->server_failure_limit
)
560 set_last_disconnected_host(ptr
);
562 // @todo fix this by fixing behavior to no longer make use of
564 if (_is_auto_eject_host(ptr
->root
))
566 run_distribution((memcached_st
*)ptr
->root
);
569 return memcached_set_error(*ptr
, MEMCACHED_SERVER_MARKED_DEAD
, MEMCACHED_AT
);
572 /* We need to clean up the multi startup piece */
575 case MEMCACHED_CONNECTION_UNKNOWN
:
576 WATCHPOINT_ASSERT(0);
577 rc
= MEMCACHED_NOT_SUPPORTED
;
580 case MEMCACHED_CONNECTION_UDP
:
581 case MEMCACHED_CONNECTION_TCP
:
582 rc
= network_connect(ptr
);
583 #ifdef LIBMEMCACHED_WITH_SASL_SUPPORT
584 if (ptr
->fd
!= INVALID_SOCKET
&& ptr
->root
->sasl
.callbacks
)
586 rc
= memcached_sasl_authenticate_connection(ptr
);
587 if (memcached_failed(rc
))
589 (void)closesocket(ptr
->fd
);
590 ptr
->fd
= INVALID_SOCKET
;
596 case MEMCACHED_CONNECTION_UNIX_SOCKET
:
597 rc
= unix_socket_connect(ptr
);
600 case MEMCACHED_CONNECTION_MAX
:
602 WATCHPOINT_ASSERT(0);
605 if (memcached_success(rc
))
607 ptr
->server_failure_counter
= 0;
612 memcached_set_error(*ptr
, rc
, MEMCACHED_AT
);
613 ptr
->server_failure_counter
++;
614 set_last_disconnected_host(ptr
);
617 LIBMEMCACHED_MEMCACHED_CONNECT_END();