2 * Copyright 2006-2008, Sine Nomine Associates and others.
5 * This software has been released under the terms of the IBM Public
6 * License. For details, see the LICENSE file in the top-level source
7 * directory or online at http://www.openafs.org/dl/license10.html
11 * localhost interprocess communication for servers
13 * currently handled by a localhost socket
14 * (yes, this needs to be replaced someday)
18 #define FD_SETSIZE 65536
21 #include <afsconfig.h>
22 #include <afs/param.h>
27 #include <afs/afs_assert.h>
29 #include <afs/afsint.h>
30 #include <afs/errors.h>
33 #include "daemon_com.h"
36 #include <afs/afssyscalls.h>
40 #include "partition.h"
42 #include <rx/rx_queue.h>
44 #ifdef USE_UNIX_SOCKETS
45 #include <afs/afsutil.h>
49 int (*V_BreakVolumeCallbacks) (VolumeId);
51 #define MAXHANDLERS 4 /* Up to 4 clients; must be at least 2, so that
52 * move = dump+restore can run on single server */
54 #define MAX_BIND_TRIES 5 /* Number of times to retry socket bind */
56 static int SYNC_ask_internal(SYNC_client_state * state, SYNC_command * com, SYNC_response * res);
60 * On AIX, connect() and bind() require use of SUN_LEN() macro;
61 * sizeof(struct sockaddr_un) will not suffice.
63 #if defined(AFS_AIX_ENV) && defined(USE_UNIX_SOCKETS)
64 #define AFS_SOCKADDR_LEN(sa) SUN_LEN(sa)
66 #define AFS_SOCKADDR_LEN(sa) sizeof(*sa)
70 /* daemon com SYNC general interfaces */
73 * fill in sockaddr structure.
75 * @param[in] endpoint pointer to sync endpoint object
76 * @param[out] addr pointer to sockaddr structure
78 * @post sockaddr structure populated using information from
82 SYNC_getAddr(SYNC_endpoint_t * endpoint, SYNC_sockaddr_t * addr)
84 #ifdef USE_UNIX_SOCKETS
85 char tbuffer[AFSDIR_PATH_MAX];
86 #endif /* USE_UNIX_SOCKETS */
88 memset(addr, 0, sizeof(*addr));
90 #ifdef USE_UNIX_SOCKETS
91 strcompose(tbuffer, AFSDIR_PATH_MAX, AFSDIR_SERVER_LOCAL_DIRPATH, "/",
93 addr->sun_family = AF_UNIX;
94 strncpy(addr->sun_path, tbuffer, (sizeof(struct sockaddr_un) - sizeof(short)));
95 #else /* !USE_UNIX_SOCKETS */
96 #ifdef STRUCT_SOCKADDR_HAS_SA_LEN
97 addr->sin_len = sizeof(struct sockaddr_in);
99 addr->sin_addr.s_addr = htonl(0x7f000001);
100 addr->sin_family = AF_INET; /* was localhost->h_addrtype */
101 addr->sin_port = htons(endpoint->in); /* XXXX htons not _really_ neccessary */
102 #endif /* !USE_UNIX_SOCKETS */
106 * get a socket descriptor of the appropriate domain.
108 * @param[in] endpoint pointer to sync endpoint object
110 * @return socket descriptor
112 * @post socket of domain specified in endpoint structure is created and
113 * returned to caller.
116 SYNC_getSock(SYNC_endpoint_t * endpoint)
119 osi_Assert((sd = socket(endpoint->domain, SOCK_STREAM, 0)) >= 0);
123 /* daemon com SYNC client interface */
126 * open a client connection to a sync server
128 * @param[in] state pointer to sync client handle
130 * @return operation status
133 * @note at present, this routine aborts rather than returning an error code
136 SYNC_connect(SYNC_client_state * state)
138 SYNC_sockaddr_t addr;
139 /* I can't believe the following is needed for localhost connections!! */
140 static time_t backoff[] =
141 { 3, 3, 3, 5, 5, 5, 7, 15, 16, 24, 32, 40, 48, 0 };
142 time_t *timeout = &backoff[0];
144 if (state->fd != OSI_NULLSOCKET) {
148 SYNC_getAddr(&state->endpoint, &addr);
151 state->fd = SYNC_getSock(&state->endpoint);
152 if (connect(state->fd, (struct sockaddr *)&addr, AFS_SOCKADDR_LEN(&addr)) >= 0)
157 Log("SYNC_connect: temporary failure on circuit '%s' (will retry)\n",
159 SYNC_disconnect(state);
162 perror("SYNC_connect failed (giving up!)");
167 * forcibly disconnect a sync client handle.
169 * @param[in] state pointer to sync client handle
171 * @retval operation status
175 SYNC_disconnect(SYNC_client_state * state)
177 rk_closesocket(state->fd);
178 state->fd = OSI_NULLSOCKET;
183 * gracefully disconnect a sync client handle.
185 * @param[in] state pointer to sync client handle
187 * @return operation status
188 * @retval SYNC_OK success
191 SYNC_closeChannel(SYNC_client_state * state)
195 SYNC_PROTO_BUF_DECL(ores);
197 if (state->fd == OSI_NULLSOCKET)
200 memset(&com, 0, sizeof(com));
201 memset(&res, 0, sizeof(res));
203 res.payload.len = SYNC_PROTO_MAX_LEN;
204 res.payload.buf = ores;
206 com.hdr.command = SYNC_COM_CHANNEL_CLOSE;
207 com.hdr.command_len = sizeof(SYNC_command_hdr);
208 com.hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
210 /* in case the other end dropped, don't do any retries */
211 state->retry_limit = 0;
212 state->hard_timeout = 0;
214 SYNC_ask(state, &com, &res);
215 SYNC_disconnect(state);
221 * forcibly break a client connection, and then create a new connection.
223 * @param[in] state pointer to sync client handle
225 * @post old connection dropped; new connection established
227 * @return @see SYNC_connect()
230 SYNC_reconnect(SYNC_client_state * state)
232 SYNC_disconnect(state);
233 return SYNC_connect(state);
237 * send a command to a sync server and wait for a response.
239 * @param[in] state pointer to sync client handle
240 * @param[in] com command object
241 * @param[out] res response object
243 * @return operation status
244 * @retval SYNC_OK success
245 * @retval SYNC_COM_ERROR communications error
246 * @retval SYNC_BAD_COMMAND server did not recognize command code
248 * @note this routine merely handles error processing; SYNC_ask_internal()
249 * handles the low-level details of communicating with the SYNC server.
251 * @see SYNC_ask_internal
254 SYNC_ask(SYNC_client_state * state, SYNC_command * com, SYNC_response * res)
257 afs_uint32 now, timeout, code=SYNC_OK;
259 if (state->fatal_error) {
260 return SYNC_COM_ERROR;
263 if (state->fd == OSI_NULLSOCKET) {
267 if (state->fd == OSI_NULLSOCKET) {
268 state->fatal_error = 1;
269 return SYNC_COM_ERROR;
272 #ifdef AFS_DEMAND_ATTACH_FS
273 com->hdr.flags |= SYNC_FLAG_DAFS_EXTENSIONS;
276 now = FT_ApproxTime();
277 timeout = now + state->hard_timeout;
279 (tries <= state->retry_limit) && (now <= timeout);
280 tries++, now = FT_ApproxTime()) {
281 code = SYNC_ask_internal(state, com, res);
282 if (code == SYNC_OK) {
284 } else if (code == SYNC_BAD_COMMAND) {
285 Log("SYNC_ask: protocol mismatch on circuit '%s'; make sure "
286 "fileserver, volserver, salvageserver and salvager are same "
287 "version\n", state->proto_name);
289 } else if ((code == SYNC_COM_ERROR) && (tries < state->retry_limit)) {
290 Log("SYNC_ask: protocol communications failure on circuit '%s'; "
291 "attempting reconnect to server\n", state->proto_name);
292 SYNC_reconnect(state);
296 * unknown (probably protocol-specific) response code, pass it up to
297 * the caller, and let them deal with it
303 if (code == SYNC_COM_ERROR) {
304 Log("SYNC_ask: fatal protocol error on circuit '%s'; disabling sync "
305 "protocol until next server restart\n",
307 state->fatal_error = 1;
314 * send a command to a sync server and wait for a response.
316 * @param[in] state pointer to sync client handle
317 * @param[in] com command object
318 * @param[out] res response object
320 * @return operation status
321 * @retval SYNC_OK success
322 * @retval SYNC_COM_ERROR communications error
327 SYNC_ask_internal(SYNC_client_state * state, SYNC_command * com, SYNC_response * res)
330 SYNC_PROTO_BUF_DECL(buf);
336 if (state->fd == OSI_NULLSOCKET) {
337 Log("SYNC_ask: invalid sync file descriptor on circuit '%s'\n",
339 res->hdr.response = SYNC_COM_ERROR;
343 if (com->hdr.command_len > SYNC_PROTO_MAX_LEN) {
344 Log("SYNC_ask: internal SYNC buffer too small on circuit '%s'; "
345 "please file a bug\n", state->proto_name);
346 res->hdr.response = SYNC_COM_ERROR;
351 * fill in some common header fields
353 com->hdr.proto_version = state->proto_version;
354 com->hdr.pkt_seq = ++state->pkt_seq;
355 com->hdr.com_seq = ++state->com_seq;
360 com->hdr.pid = getpid();
361 #ifdef AFS_PTHREAD_ENV
362 com->hdr.tid = afs_pointer_to_int(pthread_self());
365 PROCESS handle = LWP_ThreadId();
366 com->hdr.tid = (handle) ? handle->index : 0;
368 #endif /* !AFS_PTHREAD_ENV */
369 #endif /* !AFS_NT40_ENV */
371 memcpy(buf, &com->hdr, sizeof(com->hdr));
372 if (com->payload.len) {
373 memcpy(buf + sizeof(com->hdr), com->payload.buf,
374 com->hdr.command_len - sizeof(com->hdr));
378 n = send(state->fd, buf, com->hdr.command_len, 0);
379 if (n != com->hdr.command_len) {
380 Log("SYNC_ask: write failed on circuit '%s'\n", state->proto_name);
381 res->hdr.response = SYNC_COM_ERROR;
385 if (com->hdr.command == SYNC_COM_CHANNEL_CLOSE) {
386 /* short circuit close channel requests */
387 res->hdr.response = SYNC_OK;
391 n = recv(state->fd, buf, SYNC_PROTO_MAX_LEN, 0);
392 if (n == 0 || (n < 0 && WSAEINTR != WSAGetLastError())) {
393 Log("SYNC_ask: No response on circuit '%s'\n", state->proto_name);
394 res->hdr.response = SYNC_COM_ERROR;
397 #else /* !AFS_NT40_ENV */
398 n = write(state->fd, buf, com->hdr.command_len);
399 if (com->hdr.command_len != n) {
400 Log("SYNC_ask: write failed on circuit '%s'\n", state->proto_name);
401 res->hdr.response = SYNC_COM_ERROR;
405 if (com->hdr.command == SYNC_COM_CHANNEL_CLOSE) {
406 /* short circuit close channel requests */
407 res->hdr.response = SYNC_OK;
411 /* receive the response */
412 iov[0].iov_base = (char *)&res->hdr;
413 iov[0].iov_len = sizeof(res->hdr);
414 if (res->payload.len) {
415 iov[1].iov_base = (char *)res->payload.buf;
416 iov[1].iov_len = res->payload.len;
421 n = readv(state->fd, iov, iovcnt);
422 if (n == 0 || (n < 0 && errno != EINTR)) {
423 Log("SYNC_ask: No response on circuit '%s'\n", state->proto_name);
424 res->hdr.response = SYNC_COM_ERROR;
427 #endif /* !AFS_NT40_ENV */
431 if (n < sizeof(res->hdr)) {
432 Log("SYNC_ask: response too short on circuit '%s'\n",
434 res->hdr.response = SYNC_COM_ERROR;
438 memcpy(&res->hdr, buf, sizeof(res->hdr));
441 if ((n - sizeof(res->hdr)) > res->payload.len) {
442 Log("SYNC_ask: response too long on circuit '%s'\n",
444 res->hdr.response = SYNC_COM_ERROR;
448 memcpy(res->payload.buf, buf + sizeof(res->hdr), n - sizeof(res->hdr));
451 if (res->hdr.response_len != n) {
452 Log("SYNC_ask: length field in response inconsistent "
453 "on circuit '%s'\n", state->proto_name);
454 res->hdr.response = SYNC_COM_ERROR;
457 if (res->hdr.response == SYNC_DENIED) {
458 Log("SYNC_ask: negative response on circuit '%s'\n", state->proto_name);
462 return res->hdr.response;
467 * daemon com SYNC server-side interfaces
471 * receive a command structure off a sync socket.
473 * @param[in] state pointer to server-side state object
474 * @param[in] fd file descriptor on which to perform i/o
475 * @param[out] com sync command object to be populated
477 * @return operation status
478 * @retval SYNC_OK command received
479 * @retval SYNC_COM_ERROR there was a socket communications error
482 SYNC_getCom(SYNC_server_state_t * state,
487 afs_int32 code = SYNC_OK;
489 SYNC_PROTO_BUF_DECL(buf);
496 n = recv(fd, buf, SYNC_PROTO_MAX_LEN, 0);
498 if (n == 0 || (n < 0 && WSAEINTR != WSAGetLastError())) {
499 Log("SYNC_getCom: error receiving command\n");
500 code = SYNC_COM_ERROR;
503 #else /* !AFS_NT40_ENV */
504 iov[0].iov_base = (char *)&com->hdr;
505 iov[0].iov_len = sizeof(com->hdr);
506 if (com->payload.len) {
507 iov[1].iov_base = (char *)com->payload.buf;
508 iov[1].iov_len = com->payload.len;
514 n = readv(fd, iov, iovcnt);
515 if (n == 0 || (n < 0 && errno != EINTR)) {
516 Log("SYNC_getCom: error receiving command\n");
517 code = SYNC_COM_ERROR;
520 #endif /* !AFS_NT40_ENV */
524 if (n < sizeof(com->hdr)) {
525 Log("SYNC_getCom: command too short\n");
526 code = SYNC_COM_ERROR;
530 memcpy(&com->hdr, buf, sizeof(com->hdr));
533 if ((n - sizeof(com->hdr)) > com->payload.len) {
534 Log("SYNC_getCom: command too long\n");
535 code = SYNC_COM_ERROR;
539 memcpy(com->payload.buf, buf + sizeof(com->hdr), n - sizeof(com->hdr));
547 * write a response structure to a sync socket.
549 * @param[in] state handle to server-side state object
550 * @param[in] fd file descriptor on which to perform i/o
551 * @param[in] res handle to response packet
553 * @return operation status
555 * @retval SYNC_COM_ERROR
558 SYNC_putRes(SYNC_server_state_t * state,
563 afs_int32 code = SYNC_OK;
564 SYNC_PROTO_BUF_DECL(buf);
566 if (res->hdr.response_len > (sizeof(res->hdr) + res->payload.len)) {
567 Log("SYNC_putRes: response_len field in response header inconsistent\n");
568 code = SYNC_COM_ERROR;
572 if (res->hdr.response_len > SYNC_PROTO_MAX_LEN) {
573 Log("SYNC_putRes: internal SYNC buffer too small; please file a bug\n");
574 code = SYNC_COM_ERROR;
578 #ifdef AFS_DEMAND_ATTACH_FS
579 res->hdr.flags |= SYNC_FLAG_DAFS_EXTENSIONS;
581 res->hdr.proto_version = state->proto_version;
582 res->hdr.pkt_seq = ++state->pkt_seq;
583 res->hdr.res_seq = ++state->res_seq;
585 memcpy(buf, &res->hdr, sizeof(res->hdr));
586 if (res->payload.len) {
587 memcpy(buf + sizeof(res->hdr), res->payload.buf,
588 res->hdr.response_len - sizeof(res->hdr));
592 n = send(fd, buf, res->hdr.response_len, 0);
593 #else /* !AFS_NT40_ENV */
594 n = write(fd, buf, res->hdr.response_len);
595 #endif /* !AFS_NT40_ENV */
597 if (res->hdr.response_len != n) {
598 Log("SYNC_putRes: write failed\n");
599 res->hdr.response = SYNC_COM_ERROR;
607 /* return 0 for legal (null-terminated) string,
608 * 1 for illegal (unterminated) string */
610 SYNC_verifyProtocolString(char * buf, size_t len)
614 s_len = strnlen(buf, len);
616 return (s_len == len) ? 1 : 0;
620 * clean up old sockets.
622 * @param[in] state server state object
624 * @post unix domain sockets are cleaned up
627 SYNC_cleanupSock(SYNC_server_state_t * state)
629 #ifdef USE_UNIX_SOCKETS
630 remove(state->addr.sun_path);
635 * bind socket and set it to listen state.
637 * @param[in] state server state object
639 * @return operation status
641 * @retval nonzero failure
643 * @post socket bound and set to listen state
646 SYNC_bindSock(SYNC_server_state_t * state)
652 /* Reuseaddr needed because system inexplicably leaves crud lying around */
654 setsockopt(state->fd, SOL_SOCKET, SO_REUSEADDR, (char *)&on,
657 Log("SYNC_bindSock: setsockopt failed with (%d)\n", errno);
659 for (numTries = 0; numTries < state->bind_retry_limit; numTries++) {
660 code = bind(state->fd,
661 (struct sockaddr *)&state->addr,
662 AFS_SOCKADDR_LEN(&state->addr));
665 Log("SYNC_bindSock: bind failed with (%d), will sleep and retry\n",
669 listen(state->fd, state->listen_depth);