2 * Copyright 2000, International Business Machines Corporation 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
9 * Portions Copyright (c) 2006-2010 Sine Nomine Associates
15 Institution: The Information Technology Center, Carnegie-Mellon University
18 #ifndef AFS_PTHREAD_ENV
19 #define USUAL_PRIORITY (LWP_MAX_PRIORITY - 2)
22 * stack size increased from 8K because the HP machine seemed to have trouble
23 * with the smaller stack
25 #define USUAL_STACK_SIZE (24 * 1024)
26 #endif /* !AFS_PTHREAD_ENV */
30 File server synchronization with external volume utilities.
31 server-side implementation
34 /* This controls the size of an fd_set; it must be defined early before
35 * the system headers define that type and the macros that operate on it.
36 * Its value should be as large as the maximum file descriptor limit we
37 * are likely to run into on any platform. Right now, that is 65536
38 * which is the default hard fd limit on Solaris 9 */
40 #define FD_SETSIZE 65536
43 #include <afsconfig.h>
44 #include <afs/param.h>
49 #include <afs/afsint.h>
51 #include <afs/errors.h>
52 #include "daemon_com.h"
53 #include "daemon_com_inline.h"
55 #include "fssync_inline.h"
59 #include <afs/afssyscalls.h>
63 #include "volume_inline.h"
64 #include "partition.h"
70 #endif /* HAVE_POLL */
72 #ifdef USE_UNIX_SOCKETS
74 #include <afs/afsutil.h>
75 #endif /* USE_UNIX_SOCKETS */
77 #ifdef FSSYNC_BUILD_SERVER
79 int (*V_BreakVolumeCallbacks) (VolumeId volume);
81 #define MAXHANDLERS 4 /* Up to 4 clients; must be at least 2, so that
82 * move = dump+restore can run on single server */
83 #define MAXOFFLINEVOLUMES 128 /* This needs to be as big as the maximum
84 * number that would be offline for 1 operation.
85 * Current winner is salvage, which needs all
86 * cloned read-only copies offline when salvaging
87 * a single read-write volume */
91 static struct offlineInfo OfflineVolumes[MAXHANDLERS][MAXOFFLINEVOLUMES];
94 * fssync server socket handle.
96 static SYNC_server_state_t fssync_server_state =
97 { OSI_NULLSOCKET, /* file descriptor */
98 FSSYNC_ENDPOINT_DECL, /* server endpoint */
99 FSYNC_PROTO_VERSION, /* protocol version */
100 5, /* bind() retry limit */
101 100, /* listen() queue depth */
102 "FSSYNC", /* protocol name string */
105 #ifdef AFS_DEMAND_ATTACH_FS
107 * a queue of volume pointers to salvage in the background.
109 struct fsync_salv_node {
111 Volume *vp; /**< volume to salvage */
112 unsigned char update_salv_prio; /**< whether we should update the salvage priority or not */
115 struct rx_queue head;
119 static void * FSYNC_salvageThread(void *);
120 static void FSYNC_backgroundSalvage(Volume *vp);
121 #endif /* AFS_DEMAND_ATTACH_FS */
123 /* Forward declarations */
124 static void * FSYNC_sync(void *);
125 static void FSYNC_newconnection(osi_socket afd);
126 static void FSYNC_com(osi_socket fd);
127 static void FSYNC_Drop(osi_socket fd);
128 static void AcceptOn(void);
129 static void AcceptOff(void);
130 static void InitHandler(void);
131 static int AddHandler(osi_socket fd, void (*aproc)(osi_socket));
132 static int FindHandler(osi_socket afd);
133 static int FindHandler_r(osi_socket afd);
134 static int RemoveHandler(osi_socket afd);
135 #if defined(HAVE_POLL) && defined (AFS_PTHREAD_ENV)
136 static void CallHandler(struct pollfd *fds, int nfds, int mask);
137 static void GetHandler(struct pollfd *fds, int maxfds, int events, int *nfds);
139 static void CallHandler(fd_set * fdsetp);
140 static void GetHandler(fd_set * fdsetp, int *maxfdp);
144 static afs_int32 FSYNC_com_VolOp(osi_socket fd, SYNC_command * com, SYNC_response * res);
146 #ifdef AFS_DEMAND_ATTACH_FS
147 static afs_int32 FSYNC_com_VolError(FSSYNC_VolOp_command * com, SYNC_response * res);
149 static afs_int32 FSYNC_com_VolOn(FSSYNC_VolOp_command * com, SYNC_response * res);
150 static afs_int32 FSYNC_com_VolOff(FSSYNC_VolOp_command * com, SYNC_response * res);
151 static afs_int32 FSYNC_com_VolMove(FSSYNC_VolOp_command * com, SYNC_response * res);
152 static afs_int32 FSYNC_com_VolBreakCBKs(FSSYNC_VolOp_command * com, SYNC_response * res);
153 static afs_int32 FSYNC_com_VolDone(FSSYNC_VolOp_command * com, SYNC_response * res);
154 static afs_int32 FSYNC_com_VolQuery(FSSYNC_VolOp_command * com, SYNC_response * res);
155 static afs_int32 FSYNC_com_VolHdrQuery(FSSYNC_VolOp_command * com, SYNC_response * res);
156 #ifdef AFS_DEMAND_ATTACH_FS
157 static afs_int32 FSYNC_com_VGUpdate(osi_socket fd, SYNC_command * com, SYNC_response * res);
158 static afs_int32 FSYNC_com_VolOpQuery(FSSYNC_VolOp_command * com, SYNC_response * res);
159 static afs_int32 FSYNC_com_VGQuery(FSSYNC_VolOp_command * com, SYNC_response * res);
160 static afs_int32 FSYNC_com_VGScan(FSSYNC_VolOp_command * com, SYNC_response * res);
161 static afs_int32 FSYNC_com_VGScanAll(FSSYNC_VolOp_command * com, SYNC_response * res);
162 #endif /* AFS_DEMAND_ATTACH_FS */
164 static afs_int32 FSYNC_com_VnQry(osi_socket fd, SYNC_command * com, SYNC_response * res);
166 static afs_int32 FSYNC_com_StatsOp(osi_socket fd, SYNC_command * com, SYNC_response * res);
168 static afs_int32 FSYNC_com_StatsOpGeneral(FSSYNC_StatsOp_command * scom, SYNC_response * res);
170 #ifdef AFS_DEMAND_ATTACH_FS
171 static afs_int32 FSYNC_com_StatsOpViceP(FSSYNC_StatsOp_command * scom, SYNC_response * res);
172 static afs_int32 FSYNC_com_StatsOpHash(FSSYNC_StatsOp_command * scom, SYNC_response * res);
173 static afs_int32 FSYNC_com_StatsOpHdr(FSSYNC_StatsOp_command * scom, SYNC_response * res);
174 static afs_int32 FSYNC_com_StatsOpVLRU(FSSYNC_StatsOp_command * scom, SYNC_response * res);
177 static void FSYNC_com_to_info(FSSYNC_VolOp_command * vcom, FSSYNC_VolOp_info * info);
179 static int FSYNC_partMatch(FSSYNC_VolOp_command * vcom, Volume * vp, int match_anon);
183 * This lock controls access to the handler array. The overhead
184 * is minimal in non-preemptive environments.
186 struct Lock FSYNC_handler_lock;
191 #ifdef AFS_PTHREAD_ENV
193 pthread_attr_t tattr;
194 #else /* AFS_PTHREAD_ENV */
196 #endif /* AFS_PTHREAD_ENV */
198 Lock_Init(&FSYNC_handler_lock);
200 #ifdef AFS_PTHREAD_ENV
201 osi_Assert(pthread_attr_init(&tattr) == 0);
202 osi_Assert(pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED) == 0);
203 osi_Assert(pthread_create(&tid, &tattr, FSYNC_sync, NULL) == 0);
204 #else /* AFS_PTHREAD_ENV */
205 osi_Assert(LWP_CreateProcess
206 (FSYNC_sync, USUAL_STACK_SIZE, USUAL_PRIORITY, (void *)0,
207 "FSYNC_sync", &pid) == LWP_SUCCESS);
208 #endif /* AFS_PTHREAD_ENV */
210 #ifdef AFS_DEMAND_ATTACH_FS
211 queue_Init(&fsync_salv.head);
212 CV_INIT(&fsync_salv.cv, "fsync salv", CV_DEFAULT, 0);
213 osi_Assert(pthread_create(&tid, &tattr, FSYNC_salvageThread, NULL) == 0);
214 #endif /* AFS_DEMAND_ATTACH_FS */
217 #if defined(HAVE_POLL) && defined(AFS_PTHREAD_ENV)
218 static struct pollfd FSYNC_readfds[MAXHANDLERS];
220 static fd_set FSYNC_readfds;
225 FSYNC_sync(void * args)
229 #ifdef AFS_PTHREAD_ENV
232 SYNC_server_state_t * state = &fssync_server_state;
233 #ifdef AFS_DEMAND_ATTACH_FS
234 VThreadOptions_t * thread_opts;
238 * For non-DAFS, only wait until we begin attaching volumes (instead
239 * of waiting until all volumes are attached), since it can take
240 * awhile until VInit == 2.
243 #endif /* AFS_DEMAND_ATTACH_FS */
245 /* we must not be called before vol package initialization, since we use
246 * vol package mutexes and conds etc */
249 SYNC_getAddr(&state->endpoint, &state->addr);
250 SYNC_cleanupSock(state);
253 (void)signal(SIGPIPE, SIG_IGN);
256 #ifdef AFS_PTHREAD_ENV
257 /* set our 'thread-id' so that the host hold table works */
258 tid = rx_SetThreadNum();
259 Log("Set thread id %d for FSYNC_sync\n", tid);
260 afs_pthread_setname_self("FSYNC_sync");
261 #endif /* AFS_PTHREAD_ENV */
265 while (VInit < min_vinit) {
266 /* Let somebody else run until all volumes have been preattached
267 * (DAFS), or we have started attaching volumes (non-DAFS). This
268 * doesn't mean that all volumes have been attached.
270 #ifdef AFS_PTHREAD_ENV
271 VOL_CV_WAIT(&vol_vinit_cond);
272 #else /* AFS_PTHREAD_ENV */
273 LWP_DispatchProcess();
274 #endif /* AFS_PTHREAD_ENV */
279 state->fd = SYNC_getSock(&state->endpoint);
280 code = SYNC_bindSock(state);
283 #ifdef AFS_DEMAND_ATTACH_FS
285 * make sure the volume package is incapable of recursively executing
286 * salvsync calls on this thread, since there is a possibility of
289 thread_opts = malloc(sizeof(VThreadOptions_t));
290 if (thread_opts == NULL) {
291 Log("failed to allocate memory for thread-specific volume package options structure\n");
294 memcpy(thread_opts, &VThread_defaults, sizeof(VThread_defaults));
295 thread_opts->disallow_salvsync = 1;
296 osi_Assert(pthread_setspecific(VThread_key, thread_opts) == 0);
298 code = VVGCache_PkgInit();
299 osi_Assert(code == 0);
306 #if defined(HAVE_POLL) && defined(AFS_PTHREAD_ENV)
308 GetHandler(FSYNC_readfds, MAXHANDLERS, POLLIN|POLLPRI, &nfds);
309 if (poll(FSYNC_readfds, nfds, -1) >=1)
310 CallHandler(FSYNC_readfds, nfds, POLLIN|POLLPRI);
313 #ifdef AFS_PTHREAD_ENV
314 struct timeval s_timeout;
316 GetHandler(&FSYNC_readfds, &maxfd);
317 /* Note: check for >= 1 below is essential since IOMGR_select
318 * doesn't have exactly same semantics as select.
320 #ifdef AFS_PTHREAD_ENV
321 s_timeout.tv_sec = SYNC_SELECT_TIMEOUT;
322 s_timeout.tv_usec = 0;
323 if (select(maxfd + 1, &FSYNC_readfds, NULL, NULL, &s_timeout) >= 1)
324 #else /* AFS_PTHREAD_ENV */
325 if (IOMGR_Select(maxfd + 1, &FSYNC_readfds, NULL, NULL, NULL) >= 1)
326 #endif /* AFS_PTHREAD_ENV */
327 CallHandler(&FSYNC_readfds);
330 return NULL; /* hush now, little gcc */
333 #ifdef AFS_DEMAND_ATTACH_FS
335 * thread for salvaging volumes in the background.
337 * Since FSSYNC handlers cannot issue SALVSYNC requests in order to avoid
338 * deadlock issues, this thread exists so code in the FSSYNC handler thread
339 * can hand off volumes to be salvaged in the background.
341 * @param[in] args unused
343 * @note DEMAND_ATTACH_FS only
346 FSYNC_salvageThread(void * args)
349 struct fsync_salv_node *node;
354 while (queue_IsEmpty(&fsync_salv.head)) {
355 VOL_CV_WAIT(&fsync_salv.cv);
358 node = queue_First(&fsync_salv.head, fsync_salv_node);
362 if (node->update_salv_prio) {
363 if (VUpdateSalvagePriority_r(vp)) {
364 ViceLog(0, ("FSYNC_salvageThread: unable to raise salvage priority "
365 "for volume %lu\n", afs_printable_uint32_lu(vp->hashid)));
372 VCancelReservation_r(vp);
381 * salvage a volume in the background.
383 * Salvages cannot be scheduled directly from the main FSYNC thread, so
384 * instead call this function to schedule a salvage asynchronously in the
385 * FSYNC_salvageThread thread.
387 * @param[in] vp volume to pointer to salvage
391 * @note DEMAND_ATTACH_FS only
394 FSYNC_backgroundSalvage(Volume *vp)
396 struct fsync_salv_node *node;
399 VCreateReservation_r(vp);
401 node = malloc(sizeof(struct fsync_salv_node));
404 /* Save this value, to know if we should VUpdateSalvagePriority_r.
405 * We need to save it here, snce VRequestSalvage_r will change it. */
406 node->update_salv_prio = vp->salvage.requested;
408 if (VRequestSalvage_r(&ec, vp, SALVSYNC_ERROR, 0)) {
409 ViceLog(0, ("FSYNC_backgroundSalvage: unable to request salvage for volume %lu\n",
410 afs_printable_uint32_lu(vp->hashid)));
413 queue_Append(&fsync_salv.head, node);
414 CV_BROADCAST(&fsync_salv.cv);
416 #endif /* AFS_DEMAND_ATTACH_FS */
419 FSYNC_newconnection(osi_socket afd)
421 #ifdef USE_UNIX_SOCKETS
422 struct sockaddr_un other;
423 #else /* USE_UNIX_SOCKETS */
424 struct sockaddr_in other;
428 junk = sizeof(other);
429 fd = accept(afd, (struct sockaddr *)&other, &junk);
430 if (fd == OSI_NULLSOCKET) {
431 Log("FSYNC_newconnection: accept failed, errno==%d\n", errno);
433 } else if (!AddHandler(fd, FSYNC_com)) {
435 osi_Assert(AddHandler(fd, FSYNC_com));
439 /* this function processes commands from an fssync file descriptor (fd) */
440 afs_int32 FS_cnt = 0;
442 FSYNC_com(osi_socket fd)
446 SYNC_PROTO_BUF_DECL(com_buf);
447 SYNC_PROTO_BUF_DECL(res_buf);
449 memset(&res.hdr, 0, sizeof(res.hdr));
451 com.payload.buf = (void *)com_buf;
452 com.payload.len = SYNC_PROTO_MAX_LEN;
453 res.hdr.response_len = sizeof(res.hdr);
454 res.payload.len = SYNC_PROTO_MAX_LEN;
455 res.payload.buf = (void *)res_buf;
458 if (SYNC_getCom(&fssync_server_state, fd, &com)) {
459 Log("FSYNC_com: read failed; dropping connection (cnt=%d)\n", FS_cnt);
464 if (com.recv_len < sizeof(com.hdr)) {
465 Log("FSSYNC_com: invalid protocol message length (%u)\n", com.recv_len);
466 res.hdr.response = SYNC_COM_ERROR;
467 res.hdr.reason = SYNC_REASON_MALFORMED_PACKET;
468 res.hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
472 if (com.hdr.proto_version != FSYNC_PROTO_VERSION) {
473 Log("FSYNC_com: invalid protocol version (%u)\n", com.hdr.proto_version);
474 res.hdr.response = SYNC_COM_ERROR;
475 res.hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
479 if (com.hdr.command == SYNC_COM_CHANNEL_CLOSE) {
480 res.hdr.response = SYNC_OK;
481 res.hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
483 /* don't respond, just drop; senders of SYNC_COM_CHANNEL_CLOSE
484 * never wait for a response. */
488 ViceLog(125, ("FSYNC_com: from fd %d got command %ld (%s) reason %ld (%s) "
489 "pt %ld (%s) pid %ld\n", (int)fd,
490 afs_printable_int32_ld(com.hdr.command),
491 FSYNC_com2string(com.hdr.command),
492 afs_printable_int32_ld(com.hdr.reason),
493 FSYNC_reason2string(com.hdr.reason),
494 afs_printable_int32_ld(com.hdr.programType),
495 VPTypeToString(com.hdr.programType),
496 afs_printable_int32_ld(com.hdr.pid)));
498 res.hdr.com_seq = com.hdr.com_seq;
501 switch (com.hdr.command) {
503 case FSYNC_VOL_ATTACH:
504 case FSYNC_VOL_LEAVE_OFF:
506 case FSYNC_VOL_FORCE_ERROR:
507 case FSYNC_VOL_LISTVOLUMES:
508 case FSYNC_VOL_NEEDVOLUME:
510 case FSYNC_VOL_BREAKCBKS:
512 case FSYNC_VOL_QUERY:
513 case FSYNC_VOL_QUERY_HDR:
514 #ifdef AFS_DEMAND_ATTACH_FS
515 case FSYNC_VOL_QUERY_VOP:
518 case FSYNC_VG_SCAN_ALL:
520 res.hdr.response = FSYNC_com_VolOp(fd, &com, &res);
522 case FSYNC_VOL_STATS_GENERAL:
523 case FSYNC_VOL_STATS_VICEP:
524 case FSYNC_VOL_STATS_HASH:
525 case FSYNC_VOL_STATS_HDR:
526 case FSYNC_VOL_STATS_VLRU:
527 res.hdr.response = FSYNC_com_StatsOp(fd, &com, &res);
529 case FSYNC_VOL_QUERY_VNODE:
530 res.hdr.response = FSYNC_com_VnQry(fd, &com, &res);
532 #ifdef AFS_DEMAND_ATTACH_FS
535 res.hdr.response = FSYNC_com_VGUpdate(fd, &com, &res);
539 res.hdr.response = SYNC_BAD_COMMAND;
544 ViceLog(125, ("FSYNC_com: fd %d responding with code %ld (%s) reason %ld "
546 afs_printable_int32_ld(res.hdr.response),
547 SYNC_res2string(res.hdr.response),
548 afs_printable_int32_ld(res.hdr.reason),
549 FSYNC_reason2string(res.hdr.reason)));
552 SYNC_putRes(&fssync_server_state, fd, &res);
555 if (res.hdr.flags & SYNC_FLAG_CHANNEL_SHUTDOWN) {
561 FSYNC_com_VolOp(osi_socket fd, SYNC_command * com, SYNC_response * res)
564 afs_int32 code = SYNC_OK;
565 FSSYNC_VolOp_command vcom;
567 if (com->recv_len != (sizeof(com->hdr) + sizeof(FSSYNC_VolOp_hdr))) {
568 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
569 res->hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
570 return SYNC_COM_ERROR;
573 vcom.hdr = &com->hdr;
574 vcom.vop = (FSSYNC_VolOp_hdr *) com->payload.buf;
577 vcom.volumes = OfflineVolumes[FindHandler(fd)];
578 for (vcom.v = NULL, i = 0; i < MAXOFFLINEVOLUMES; i++) {
579 if ((vcom.volumes[i].volumeID == vcom.vop->volume) &&
580 (strncmp(vcom.volumes[i].partName, vcom.vop->partName,
581 sizeof(vcom.volumes[i].partName)) == 0)) {
582 vcom.v = &vcom.volumes[i];
587 ViceLog(125, ("FSYNC_com_VolOp: fd %d got command for vol %lu part %.16s\n",
588 (int)fd, afs_printable_uint32_lu(vcom.vop->volume),
589 vcom.vop->partName));
591 switch (com->hdr.command) {
593 case FSYNC_VOL_ATTACH:
594 case FSYNC_VOL_LEAVE_OFF:
595 code = FSYNC_com_VolOn(&vcom, res);
598 case FSYNC_VOL_NEEDVOLUME:
599 code = FSYNC_com_VolOff(&vcom, res);
601 case FSYNC_VOL_LISTVOLUMES:
605 code = FSYNC_com_VolMove(&vcom, res);
607 case FSYNC_VOL_BREAKCBKS:
608 code = FSYNC_com_VolBreakCBKs(&vcom, res);
611 code = FSYNC_com_VolDone(&vcom, res);
613 case FSYNC_VOL_QUERY:
614 code = FSYNC_com_VolQuery(&vcom, res);
616 case FSYNC_VOL_QUERY_HDR:
617 code = FSYNC_com_VolHdrQuery(&vcom, res);
619 #ifdef AFS_DEMAND_ATTACH_FS
620 case FSYNC_VOL_FORCE_ERROR:
621 code = FSYNC_com_VolError(&vcom, res);
623 case FSYNC_VOL_QUERY_VOP:
624 code = FSYNC_com_VolOpQuery(&vcom, res);
627 code = FSYNC_com_VGQuery(&vcom, res);
630 code = FSYNC_com_VGScan(&vcom, res);
632 case FSYNC_VG_SCAN_ALL:
633 code = FSYNC_com_VGScanAll(&vcom, res);
635 #endif /* AFS_DEMAND_ATTACH_FS */
637 code = SYNC_BAD_COMMAND;
644 * service an FSYNC request to bring a volume online.
646 * @param[in] vcom pointer command object
647 * @param[out] res object in which to store response packet
649 * @return operation status
650 * @retval SYNC_OK volume transitioned online
651 * @retval SYNC_FAILED invalid command protocol message
652 * @retval SYNC_DENIED operation could not be completed
654 * @note this is an FSYNC RPC server stub
656 * @note this procedure handles the following FSSYNC command codes:
659 * - FSYNC_VOL_LEAVE_OFF
661 * @note the supplementary reason code contains additional details.
662 * When SYNC_DENIED is returned, the specific reason is
663 * placed in the response packet reason field.
668 FSYNC_com_VolOn(FSSYNC_VolOp_command * vcom, SYNC_response * res)
670 afs_int32 code = SYNC_OK;
671 #ifndef AFS_DEMAND_ATTACH_FS
672 char tvolName[VMAXPATHLEN];
677 /* Verify the partition name is null terminated. */
678 if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
679 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
684 /* so, we need to attach the volume */
686 #ifdef AFS_DEMAND_ATTACH_FS
687 /* Verify the partition name is not empty. */
688 if (*vcom->vop->partName == 0) {
689 res->hdr.reason = FSYNC_BAD_PART;
694 /* check DAFS permissions */
695 vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
697 FSYNC_partMatch(vcom, vp, 1) &&
698 vp->pending_vol_op &&
699 (vcom->hdr->programType != vp->pending_vol_op->com.programType)) {
700 /* a different program has this volume checked out. deny. */
701 Log("FSYNC_VolOn: WARNING: program type %u has attempted to manipulate "
702 "state for volume %u using command code %u while the volume is "
703 "checked out by program type %u for command code %u.\n",
704 vcom->hdr->programType,
707 vp->pending_vol_op->com.programType,
708 vp->pending_vol_op->com.command);
710 res->hdr.reason = FSYNC_EXCLUSIVE;
716 vcom->v->volumeID = 0;
719 if (vcom->hdr->command == FSYNC_VOL_LEAVE_OFF) {
720 /* nothing much to do if we're leaving the volume offline */
721 #ifdef AFS_DEMAND_ATTACH_FS
723 VCreateReservation_r(vp);
724 VWaitExclusiveState_r(vp);
726 if (vp && V_attachState(vp) != VOL_STATE_DELETED) {
727 if (FSYNC_partMatch(vcom, vp, 1)) {
728 if ((V_attachState(vp) == VOL_STATE_UNATTACHED) ||
729 (V_attachState(vp) == VOL_STATE_PREATTACHED)) {
730 VChangeState_r(vp, VOL_STATE_UNATTACHED);
731 VDeregisterVolOp_r(vp);
734 res->hdr.reason = FSYNC_BAD_STATE;
738 res->hdr.reason = FSYNC_WRONG_PART;
742 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
746 VCancelReservation_r(vp);
753 #ifdef AFS_DEMAND_ATTACH_FS
756 FSYNC_partMatch(vcom, vp, 0) &&
757 vp->pending_vol_op &&
758 vp->pending_vol_op->vol_op_state == FSSYNC_VolOpRunningOnline &&
759 V_attachState(vp) == VOL_STATE_ATTACHED) {
761 /* noop; the volume stayed online for the volume operation and we were
762 * simply told that the vol op is done. The vp we already have is fine,
763 * so avoid confusing volume routines with trying to preattach an
764 * attached volume. */
767 /* first, check to see whether we have such a volume defined */
768 vp = VPreAttachVolumeById_r(&error,
774 VCreateReservation_r(vp);
775 VWaitExclusiveState_r(vp);
776 VDeregisterVolOp_r(vp);
777 VCancelReservation_r(vp);
780 #else /* !AFS_DEMAND_ATTACH_FS */
781 tvolName[0] = OS_DIRSEPC;
782 snprintf(&tvolName[1], sizeof(tvolName)-1, VFORMAT, afs_printable_uint32_lu(vcom->vop->volume));
783 tvolName[sizeof(tvolName)-1] = '\0';
785 vp = VAttachVolumeByName_r(&error, vcom->vop->partName, tvolName,
789 #endif /* !AFS_DEMAND_ATTACH_FS */
792 res->hdr.reason = error;
800 * service an FSYNC request to take a volume offline.
802 * @param[in] vcom pointer command object
803 * @param[out] res object in which to store response packet
805 * @return operation status
806 * @retval SYNC_OK volume transitioned offline
807 * @retval SYNC_FAILED invalid command protocol message
808 * @retval SYNC_DENIED operation could not be completed
810 * @note this is an FSYNC RPC server stub
812 * @note this procedure handles the following FSSYNC command codes:
814 * - FSYNC_VOL_NEEDVOLUME
816 * @note the supplementary reason code contains additional details.
817 * When SYNC_DENIED is returned, the specific reason is
818 * placed in the response packet reason field.
823 FSYNC_com_VolOff(FSSYNC_VolOp_command * vcom, SYNC_response * res)
825 FSSYNC_VolOp_info info;
826 afs_int32 code = SYNC_OK;
830 #ifdef AFS_DEMAND_ATTACH_FS
831 Volume *nvp, *rvp = NULL;
834 if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
835 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
840 /* not already offline, we need to find a slot for newly offline volume */
841 if (vcom->hdr->programType == debugUtility) {
842 /* debug utilities do not have their operations tracked */
846 for (i = 0; i < MAXOFFLINEVOLUMES; i++) {
847 if (vcom->volumes[i].volumeID == 0) {
848 vcom->v = &vcom->volumes[i];
858 FSYNC_com_to_info(vcom, &info);
860 #ifdef AFS_DEMAND_ATTACH_FS
861 vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
863 vp = VGetVolume_r(&error, vcom->vop->volume);
867 if (!FSYNC_partMatch(vcom, vp, 1)) {
868 /* volume on desired partition is not online, so we
869 * should treat this as an offline volume.
871 #ifndef AFS_DEMAND_ATTACH_FS
879 #ifdef AFS_DEMAND_ATTACH_FS
881 ProgramType type = (ProgramType) vcom->hdr->programType;
883 /* do initial filtering of requests */
885 /* enforce mutual exclusion for volume ops */
886 if (vp->pending_vol_op) {
887 if (vp->pending_vol_op->com.programType != type) {
888 if (vp->pending_vol_op->com.command == FSYNC_VOL_OFF &&
889 vp->pending_vol_op->com.reason == FSYNC_SALVAGE) {
891 Log("denying offline request for volume %lu; volume is salvaging\n",
892 afs_printable_uint32_lu(vp->hashid));
894 res->hdr.reason = FSYNC_SALVAGE;
897 Log("volume %u already checked out\n", vp->hashid);
899 Log("vp->vop = { com = { ver=%u, prog=%d, com=%d, reason=%d, len=%u, flags=0x%x }, vop = { vol=%u, part='%s' } }\n",
900 vp->pending_vol_op->com.proto_version,
901 vp->pending_vol_op->com.programType,
902 vp->pending_vol_op->com.command,
903 vp->pending_vol_op->com.reason,
904 vp->pending_vol_op->com.command_len,
905 vp->pending_vol_op->com.flags,
906 vp->pending_vol_op->vop.volume,
907 vp->pending_vol_op->vop.partName );
908 Log("vcom = { com = { ver=%u, prog=%d, com=%d, reason=%d, len=%u, flags=0x%x } , vop = { vol=%u, part='%s' } }\n",
909 vcom->hdr->proto_version,
910 vcom->hdr->programType,
913 vcom->hdr->command_len,
916 vcom->vop->partName);
917 res->hdr.reason = FSYNC_EXCLUSIVE;
920 Log("warning: volume %u recursively checked out by programType id %d\n",
921 vp->hashid, vcom->hdr->programType);
925 /* wait for exclusive ops, so we have an accurate picture of the
926 * vol attach state */
927 VCreateReservation_r(vp);
928 VWaitExclusiveState_r(vp);
931 /* filter based upon requestor
933 * volume utilities / volserver are not allowed to check out
934 * volumes which are in an error state
936 * unknown utility programs will be denied on principal
941 /* it is possible for the salvageserver to checkout a
942 * volume for salvage before its scheduling request
943 * has been sent to the salvageserver */
944 if (vp->salvage.requested && !vp->salvage.scheduled) {
945 vp->salvage.scheduled = 1;
948 /* If the volume is in VOL_STATE_SALVAGE_REQ, we need to wait
949 * for the vol to go offline before we can give it away. Also
950 * make sure we don't come out with vp in an excl state. */
951 while (V_attachState(vp) == VOL_STATE_SALVAGE_REQ ||
952 VIsExclusiveState(V_attachState(vp))) {
954 VOL_CV_WAIT(&V_attachCV(vp));
962 if (VIsSalvaging(vp)) {
963 Log("denying offline request for volume %lu; volume is in salvaging state\n",
964 afs_printable_uint32_lu(vp->hashid));
965 res->hdr.reason = FSYNC_SALVAGE;
967 /* the volume hasn't been checked out yet by the salvager,
968 * but we think the volume is salvaging; schedule a
969 * a salvage to update the salvage priority */
970 FSYNC_backgroundSalvage(vp);
974 if (VIsErrorState(V_attachState(vp))) {
980 Log("bad program type passed to FSSYNC\n");
984 /* short circuit for offline volume states
985 * so we can avoid I/O penalty of attachment */
986 switch (V_attachState(vp)) {
987 case VOL_STATE_UNATTACHED:
988 case VOL_STATE_PREATTACHED:
989 case VOL_STATE_SALVAGING:
990 case VOL_STATE_ERROR:
991 /* register the volume operation metadata with the volume
993 * if the volume is currently pre-attached, attach2()
994 * will evaluate the vol op metadata to determine whether
995 * attaching the volume would be safe */
996 VRegisterVolOp_r(vp, &info);
997 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningUnknown;
1000 case VOL_STATE_DELETED:
1006 /* convert to heavyweight ref */
1007 nvp = VGetVolumeByVp_r(&error, vp);
1010 * It's possible for VGetVolumeByVp_r to have dropped and
1011 * re-acquired VOL_LOCK, so volume state may have changed
1012 * back to one of the states we tested for above. Since
1013 * GetVolume can return NULL in some of those states, just
1014 * test for the states again here.
1016 switch (V_attachState(vp)) {
1017 case VOL_STATE_UNATTACHED:
1018 case VOL_STATE_PREATTACHED:
1019 case VOL_STATE_SALVAGING:
1020 case VOL_STATE_ERROR:
1021 /* register the volume operation metadata with the volume
1023 * if the volume is currently pre-attached, attach2()
1024 * will evaluate the vol op metadata to determine whether
1025 * attaching the volume would be safe */
1026 VRegisterVolOp_r(vp, &info);
1027 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningUnknown;
1030 case VOL_STATE_DELETED:
1036 Log("FSYNC_com_VolOff: failed to get heavyweight reference to volume %u (state=%u, flags=0x%x)\n",
1037 vcom->vop->volume, V_attachState(vp), V_attachFlags(vp));
1038 res->hdr.reason = FSYNC_VOL_PKG_ERROR;
1040 } else if (nvp != vp) {
1041 /* i don't think this should ever happen, but just in case... */
1042 Log("FSYNC_com_VolOff: warning: potentially dangerous race detected\n");
1046 /* kill off lightweight ref to ensure we can't deadlock against ourselves later... */
1047 VCancelReservation_r(rvp);
1050 /* register the volume operation metadata with the volume */
1051 VRegisterVolOp_r(vp, &info);
1054 #endif /* AFS_DEMAND_ATTACH_FS */
1057 if (VVolOpLeaveOnline_r(vp, &info)) {
1058 VUpdateVolume_r(&error, vp, VOL_UPDATE_WAIT); /* At least get volume stats right */
1060 Log("FSYNC: Volume %u (%s) was left on line for an external %s request\n",
1061 V_id(vp), V_name(vp),
1062 vcom->hdr->reason == V_CLONE ? "clone" :
1063 vcom->hdr->reason == V_READONLY ? "readonly" :
1064 vcom->hdr->reason == V_DUMP ? "dump" :
1065 vcom->hdr->reason == FSYNC_SALVAGE ? "salvage" :
1068 #ifdef AFS_DEMAND_ATTACH_FS
1069 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOnline;
1073 if (VVolOpSetVBusy_r(vp, &info)) {
1074 vp->specialStatus = VBUSY;
1077 /* remember what volume we got, so we can keep track of how
1078 * many volumes the volserver or whatever is using. Note that
1079 * vp is valid since leaveonline is only set when vp is valid.
1082 vcom->v->volumeID = vcom->vop->volume;
1083 strlcpy(vcom->v->partName, vp->partition->name, sizeof(vcom->v->partName));
1086 #ifdef AFS_DEMAND_ATTACH_FS
1087 VCreateReservation_r(vp);
1088 VOfflineForVolOp_r(&error, vp, "A volume utility is running.");
1090 osi_Assert(vp->nUsers==0);
1091 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOffline;
1094 VWaitExclusiveState_r(vp);
1095 VDeregisterVolOp_r(vp);
1098 VCancelReservation_r(vp);
1100 VOffline_r(vp, "A volume utility is running.");
1111 #ifdef AFS_DEMAND_ATTACH_FS
1113 VCancelReservation_r(rvp);
1120 * service an FSYNC request to mark a volume as moved.
1122 * @param[in] vcom pointer command object
1123 * @param[out] res object in which to store response packet
1125 * @return operation status
1126 * @retval SYNC_OK volume marked as moved to a remote server
1127 * @retval SYNC_FAILED invalid command protocol message
1128 * @retval SYNC_DENIED current volume state does not permit this operation
1130 * @note this is an FSYNC RPC server stub
1132 * @note this operation also breaks all callbacks for the given volume
1134 * @note this procedure handles the following FSSYNC command codes:
1137 * @note the supplementary reason code contains additional details. For
1138 * instance, SYNC_OK is still returned when the partition specified
1139 * does not match the one registered in the volume object -- reason
1140 * will be FSYNC_WRONG_PART in this case.
1145 FSYNC_com_VolMove(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1147 afs_int32 code = SYNC_DENIED;
1151 if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1152 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1157 /* Yuch: the "reason" for the move is the site it got moved to... */
1158 /* still set specialStatus so we stop sending back VBUSY.
1159 * also should still break callbacks. Note that I don't know
1160 * how to tell if we should break all or not, so we just do it
1161 * since it doesn't matter much if we do an extra break
1162 * volume callbacks on a volume move within the same server */
1163 #ifdef AFS_DEMAND_ATTACH_FS
1164 vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1166 vp = VGetVolume_r(&error, vcom->vop->volume);
1169 if (FSYNC_partMatch(vcom, vp, 1)) {
1170 #ifdef AFS_DEMAND_ATTACH_FS
1171 if ((V_attachState(vp) == VOL_STATE_UNATTACHED) ||
1172 (V_attachState(vp) == VOL_STATE_PREATTACHED)) {
1175 vp->specialStatus = VMOVED;
1176 #ifdef AFS_DEMAND_ATTACH_FS
1178 res->hdr.reason = FSYNC_BAD_STATE;
1182 res->hdr.reason = FSYNC_WRONG_PART;
1184 #ifndef AFS_DEMAND_ATTACH_FS
1186 #endif /* !AFS_DEMAND_ATTACH_FS */
1188 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1191 if ((code == SYNC_OK) && (V_BreakVolumeCallbacks != NULL)) {
1192 Log("fssync: volume %u moved to %x; breaking all call backs\n",
1193 vcom->vop->volume, vcom->hdr->reason);
1195 (*V_BreakVolumeCallbacks) (vcom->vop->volume);
1205 * service an FSYNC request to mark a volume as destroyed.
1207 * @param[in] vcom pointer command object
1208 * @param[out] res object in which to store response packet
1210 * @return operation status
1211 * @retval SYNC_OK volume marked as destroyed
1212 * @retval SYNC_FAILED invalid command protocol message
1213 * @retval SYNC_DENIED current volume state does not permit this operation
1215 * @note this is an FSYNC RPC server stub
1217 * @note this procedure handles the following FSSYNC command codes:
1220 * @note the supplementary reason code contains additional details. For
1221 * instance, SYNC_OK is still returned when the partition specified
1222 * does not match the one registered in the volume object -- reason
1223 * will be FSYNC_WRONG_PART in this case.
1228 FSYNC_com_VolDone(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1230 afs_int32 code = SYNC_FAILED;
1234 if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1235 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1239 /* don't try to put online, this call is made only after deleting
1240 * a volume, in which case we want to remove the vol # from the
1241 * OfflineVolumes array only */
1243 vcom->v->volumeID = 0;
1245 vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1247 if (FSYNC_partMatch(vcom, vp, 1)) {
1248 #ifdef AFS_DEMAND_ATTACH_FS
1249 VCreateReservation_r(vp);
1250 VWaitExclusiveState_r(vp);
1252 if ((V_attachState(vp) == VOL_STATE_UNATTACHED) ||
1253 (V_attachState(vp) == VOL_STATE_PREATTACHED) ||
1254 VIsErrorState(V_attachState(vp))) {
1256 /* Change state to DELETED, not UNATTACHED, so clients get
1257 * a VNOVOL error when they try to access from now on. */
1259 VChangeState_r(vp, VOL_STATE_DELETED);
1260 VDeregisterVolOp_r(vp);
1262 /* Volume is gone; clear out old salvage stats */
1263 memset(&vp->salvage, 0, sizeof(vp->salvage));
1265 /* Someday we should free the vp, too, after about 2 hours,
1266 * possibly by putting the vp back on the VLRU. */
1269 } else if (V_attachState(vp) == VOL_STATE_DELETED) {
1270 VDeregisterVolOp_r(vp);
1271 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1275 res->hdr.reason = FSYNC_BAD_STATE;
1278 VCancelReservation_r(vp);
1280 #else /* AFS_DEMAND_ATTACH_FS */
1281 if (!vp->specialStatus) {
1282 vp->specialStatus = VNOVOL;
1285 #endif /* !AFS_DEMAND_ATTACH_FS */
1287 code = SYNC_OK; /* XXX is this really a good idea? */
1288 res->hdr.reason = FSYNC_WRONG_PART;
1291 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1298 #ifdef AFS_DEMAND_ATTACH_FS
1300 * service an FSYNC request to transition a volume to the hard error state.
1302 * @param[in] vcom pointer command object
1303 * @param[out] res object in which to store response packet
1305 * @return operation status
1306 * @retval SYNC_OK volume transitioned to hard error state
1307 * @retval SYNC_FAILED invalid command protocol message
1308 * @retval SYNC_DENIED (see note)
1310 * @note this is an FSYNC RPC server stub
1312 * @note this procedure handles the following FSSYNC command codes:
1313 * - FSYNC_VOL_FORCE_ERROR
1315 * @note SYNC_DENIED is returned in the following cases:
1316 * - no partition name is specified (reason field set to
1317 * FSYNC_WRONG_PART).
1318 * - volume id not known to fileserver (reason field set
1319 * to FSYNC_UNKNOWN_VOLID).
1321 * @note demand attach fileserver only
1326 FSYNC_com_VolError(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1330 afs_int32 code = SYNC_FAILED;
1332 if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1333 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1337 vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1339 if (!vp && vcom->hdr->reason == FSYNC_SALVAGE) {
1340 /* The requested volume doesn't seem to exist. However, it is possible
1341 * that this is triggered by trying to create or clone a volume that
1342 * was prevented from succeeding by a half-created volume in the way.
1343 * (e.g. we tried to create volume X, but volume X exists except that
1344 * its .vol header was deleted for some reason) So, still try to
1345 * a salvage for that volume ID. */
1347 Log("FSYNC_com_VolError: attempting to schedule salvage for unknown "
1348 "volume %lu part %s\n", afs_printable_uint32_lu(vcom->vop->volume),
1349 vcom->vop->partName);
1350 vp = VPreAttachVolumeById_r(&error, vcom->vop->partName,
1355 if (FSYNC_partMatch(vcom, vp, 0)) {
1356 VCreateReservation_r(vp);
1357 VWaitExclusiveState_r(vp);
1358 VDeregisterVolOp_r(vp);
1360 if (vcom->hdr->reason == FSYNC_SALVAGE) {
1361 FSYNC_backgroundSalvage(vp);
1363 /* null out salvsync control state, as it's no longer relevant */
1364 memset(&vp->salvage, 0, sizeof(vp->salvage));
1365 VChangeState_r(vp, VOL_STATE_ERROR);
1368 VCancelReservation_r(vp);
1373 res->hdr.reason = FSYNC_WRONG_PART;
1376 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1382 #endif /* AFS_DEMAND_ATTACH_FS */
1385 * service an FSYNC request to break all callbacks for this volume.
1387 * @param[in] vcom pointer command object
1388 * @param[out] res object in which to store response packet
1390 * @return operation status
1391 * @retval SYNC_OK callback breaks scheduled for volume
1393 * @note this is an FSYNC RPC server stub
1395 * @note this procedure handles the following FSSYNC command codes:
1396 * - FSYNC_VOL_BREAKCBKS
1398 * @note demand attach fileserver only
1400 * @todo should do partition matching
1405 FSYNC_com_VolBreakCBKs(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1407 /* if the volume is being restored, break all callbacks on it */
1408 if (V_BreakVolumeCallbacks) {
1409 Log("fssync: breaking all call backs for volume %u\n",
1412 (*V_BreakVolumeCallbacks) (vcom->vop->volume);
1419 * service an FSYNC request to return the Volume object.
1421 * @param[in] vcom pointer command object
1422 * @param[out] res object in which to store response packet
1424 * @return operation status
1425 * @retval SYNC_OK volume object returned to caller
1426 * @retval SYNC_FAILED bad command packet, or failed to locate volume object
1428 * @note this is an FSYNC RPC server stub
1430 * @note this procedure handles the following FSSYNC command codes:
1436 FSYNC_com_VolQuery(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1438 afs_int32 code = SYNC_FAILED;
1442 if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1443 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1447 #ifdef AFS_DEMAND_ATTACH_FS
1448 vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1449 #else /* !AFS_DEMAND_ATTACH_FS */
1450 vp = VGetVolume_r(&error, vcom->vop->volume);
1451 #endif /* !AFS_DEMAND_ATTACH_FS */
1454 if (FSYNC_partMatch(vcom, vp, 1)) {
1455 if (res->payload.len >= sizeof(Volume)) {
1456 memcpy(res->payload.buf, vp, sizeof(Volume));
1457 res->hdr.response_len += sizeof(Volume);
1460 res->hdr.reason = SYNC_REASON_PAYLOAD_TOO_BIG;
1463 res->hdr.reason = FSYNC_WRONG_PART;
1465 #ifndef AFS_DEMAND_ATTACH_FS
1469 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1477 * service an FSYNC request to return the Volume header.
1479 * @param[in] vcom pointer command object
1480 * @param[out] res object in which to store response packet
1482 * @return operation status
1483 * @retval SYNC_OK volume header returned to caller
1484 * @retval SYNC_FAILED bad command packet, or failed to locate volume header
1486 * @note this is an FSYNC RPC server stub
1488 * @note this procedure handles the following FSSYNC command codes:
1489 * - FSYNC_VOL_QUERY_HDR
1494 FSYNC_com_VolHdrQuery(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1496 afs_int32 code = SYNC_FAILED;
1500 if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1501 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1504 if (res->payload.len < sizeof(VolumeDiskData)) {
1505 res->hdr.reason = SYNC_REASON_PAYLOAD_TOO_BIG;
1509 #ifdef AFS_DEMAND_ATTACH_FS
1510 vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1511 #else /* !AFS_DEMAND_ATTACH_FS */
1512 vp = VGetVolume_r(&error, vcom->vop->volume);
1516 if (FSYNC_partMatch(vcom, vp, 1)) {
1517 #ifdef AFS_DEMAND_ATTACH_FS
1518 if ((vp->header == NULL) ||
1519 !(V_attachFlags(vp) & VOL_HDR_ATTACHED) ||
1520 !(V_attachFlags(vp) & VOL_HDR_LOADED)) {
1521 res->hdr.reason = FSYNC_HDR_NOT_ATTACHED;
1524 #else /* !AFS_DEMAND_ATTACH_FS */
1525 if (!vp || !vp->header) {
1526 res->hdr.reason = FSYNC_HDR_NOT_ATTACHED;
1529 #endif /* !AFS_DEMAND_ATTACH_FS */
1531 res->hdr.reason = FSYNC_WRONG_PART;
1535 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1539 memcpy(res->payload.buf, &V_disk(vp), sizeof(VolumeDiskData));
1540 res->hdr.response_len += sizeof(VolumeDiskData);
1544 #ifndef AFS_DEMAND_ATTACH_FS
1552 #ifdef AFS_DEMAND_ATTACH_FS
1554 FSYNC_com_VolOpQuery(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1556 afs_int32 code = SYNC_OK;
1560 vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1563 VCreateReservation_r(vp);
1564 VWaitExclusiveState_r(vp);
1567 if (vp && vp->pending_vol_op) {
1568 if (!FSYNC_partMatch(vcom, vp, 1)) {
1569 res->hdr.reason = FSYNC_WRONG_PART;
1572 osi_Assert(sizeof(FSSYNC_VolOp_info) <= res->payload.len);
1573 memcpy(res->payload.buf, vp->pending_vol_op, sizeof(FSSYNC_VolOp_info));
1574 res->hdr.response_len += sizeof(FSSYNC_VolOp_info);
1577 if (!vp || V_attachState(vp) == VOL_STATE_DELETED) {
1578 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1579 } else if (!FSYNC_partMatch(vcom, vp, 1)) {
1580 res->hdr.reason = FSYNC_WRONG_PART;
1582 res->hdr.reason = FSYNC_NO_PENDING_VOL_OP;
1588 VCancelReservation_r(vp);
1594 FSYNC_com_VGQuery(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1596 afs_int32 code = SYNC_FAILED;
1598 struct DiskPartition64 * dp;
1600 if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1601 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1605 dp = VGetPartition_r(vcom->vop->partName, 0);
1607 res->hdr.reason = FSYNC_BAD_PART;
1611 osi_Assert(sizeof(FSSYNC_VGQry_response_t) <= res->payload.len);
1613 rc = VVGCache_query_r(dp, vcom->vop->volume, res->payload.buf);
1616 res->hdr.response_len += sizeof(FSSYNC_VGQry_response_t);
1620 res->hdr.reason = FSYNC_PART_SCANNING;
1623 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1634 FSYNC_com_VGUpdate(osi_socket fd, SYNC_command * com, SYNC_response * res)
1636 afs_int32 code = SYNC_FAILED;
1637 struct DiskPartition64 * dp;
1638 FSSYNC_VGUpdate_command_t * vgucom;
1641 if (com->recv_len != (sizeof(com->hdr) + sizeof(*vgucom))) {
1642 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1643 res->hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
1644 code = SYNC_COM_ERROR;
1648 vgucom = com->payload.buf;
1650 ViceLog(125, ("FSYNC_com_VGUpdate: fd %d got command for parent %lu child "
1651 "%lu partName %.16s\n", (int)fd,
1652 afs_printable_uint32_lu(vgucom->parent),
1653 afs_printable_uint32_lu(vgucom->child),
1656 if (SYNC_verifyProtocolString(vgucom->partName, sizeof(vgucom->partName))) {
1657 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1661 dp = VGetPartition_r(vgucom->partName, 0);
1663 res->hdr.reason = FSYNC_BAD_PART;
1667 switch(com->hdr.command) {
1669 rc = VVGCache_entry_add_r(dp, vgucom->parent, vgucom->child, NULL);
1673 rc = VVGCache_entry_del_r(dp, vgucom->parent, vgucom->child);
1677 Log("FSYNC_com_VGUpdate called improperly\n");
1682 /* EINVAL means the partition VGC doesn't exist at all; not really
1684 if (rc == 0 || rc == EINVAL) {
1689 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1691 res->hdr.reason = FSYNC_WHATEVER;
1699 FSYNC_com_VGScan(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1701 afs_int32 code = SYNC_FAILED;
1702 struct DiskPartition64 * dp;
1704 if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1705 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1709 dp = VGetPartition_r(vcom->vop->partName, 0);
1711 res->hdr.reason = FSYNC_BAD_PART;
1715 if (VVGCache_scanStart_r(dp) == 0) {
1724 FSYNC_com_VGScanAll(FSSYNC_VolOp_command * com, SYNC_response * res)
1726 afs_int32 code = SYNC_FAILED;
1728 if (VVGCache_scanStart_r(NULL) == 0) {
1734 #endif /* AFS_DEMAND_ATTACH_FS */
1737 FSYNC_com_VnQry(osi_socket fd, SYNC_command * com, SYNC_response * res)
1739 afs_int32 code = SYNC_OK;
1740 FSSYNC_VnQry_hdr * qry = com->payload.buf;
1745 if (com->recv_len != (sizeof(com->hdr) + sizeof(FSSYNC_VnQry_hdr))) {
1746 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1747 res->hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
1748 return SYNC_COM_ERROR;
1751 ViceLog(125, ("FSYNC_com_VnQry: fd %d got command for vol %lu vnode %lu "
1752 "uniq %lu spare %lu partName %.16s\n", (int)fd,
1753 afs_printable_uint32_lu(qry->volume),
1754 afs_printable_uint32_lu(qry->vnode),
1755 afs_printable_uint32_lu(qry->unique),
1756 afs_printable_uint32_lu(qry->spare),
1759 #ifdef AFS_DEMAND_ATTACH_FS
1760 vp = VLookupVolume_r(&error, qry->volume, NULL);
1761 #else /* !AFS_DEMAND_ATTACH_FS */
1762 vp = VGetVolume_r(&error, qry->volume);
1763 #endif /* !AFS_DEMAND_ATTACH_FS */
1766 res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1771 vnp = VLookupVnode(vp, qry->vnode);
1773 res->hdr.reason = FSYNC_UNKNOWN_VNID;
1778 if (Vn_class(vnp)->residentSize > res->payload.len) {
1779 res->hdr.reason = SYNC_REASON_ENCODING_ERROR;
1784 memcpy(res->payload.buf, vnp, Vn_class(vnp)->residentSize);
1785 res->hdr.response_len += Vn_class(vnp)->residentSize;
1788 #ifndef AFS_DEMAND_ATTACH_FS
1797 FSYNC_com_StatsOp(osi_socket fd, SYNC_command * com, SYNC_response * res)
1799 afs_int32 code = SYNC_OK;
1800 FSSYNC_StatsOp_command scom;
1802 if (com->recv_len != (sizeof(com->hdr) + sizeof(FSSYNC_StatsOp_hdr))) {
1803 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1804 res->hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
1805 return SYNC_COM_ERROR;
1808 scom.hdr = &com->hdr;
1809 scom.sop = (FSSYNC_StatsOp_hdr *) com->payload.buf;
1812 ViceLog(125, ("FSYNC_com_StatsOp: fd %d got command for stats: "
1813 "{vlru_generation = %lu, hash_bucket = %lu, partName = "
1814 "%.16s}\n", (int)fd,
1815 afs_printable_uint32_lu(scom.sop->args.vlru_generation),
1816 afs_printable_uint32_lu(scom.sop->args.hash_bucket),
1817 scom.sop->args.partName));
1819 switch (com->hdr.command) {
1820 case FSYNC_VOL_STATS_GENERAL:
1821 code = FSYNC_com_StatsOpGeneral(&scom, res);
1823 #ifdef AFS_DEMAND_ATTACH_FS
1824 /* statistics for the following subsystems are only tracked
1825 * for demand attach fileservers */
1826 case FSYNC_VOL_STATS_VICEP:
1827 code = FSYNC_com_StatsOpViceP(&scom, res);
1829 case FSYNC_VOL_STATS_HASH:
1830 code = FSYNC_com_StatsOpHash(&scom, res);
1832 case FSYNC_VOL_STATS_HDR:
1833 code = FSYNC_com_StatsOpHdr(&scom, res);
1835 case FSYNC_VOL_STATS_VLRU:
1836 code = FSYNC_com_StatsOpVLRU(&scom, res);
1838 #endif /* AFS_DEMAND_ATTACH_FS */
1840 code = SYNC_BAD_COMMAND;
1847 FSYNC_com_StatsOpGeneral(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1849 afs_int32 code = SYNC_OK;
1851 memcpy(res->payload.buf, &VStats, sizeof(VStats));
1852 res->hdr.response_len += sizeof(VStats);
1857 #ifdef AFS_DEMAND_ATTACH_FS
1859 FSYNC_com_StatsOpViceP(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1861 afs_int32 code = SYNC_OK;
1862 struct DiskPartition64 * dp;
1863 struct DiskPartitionStats64 * stats;
1865 if (SYNC_verifyProtocolString(scom->sop->args.partName, sizeof(scom->sop->args.partName))) {
1866 res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1871 dp = VGetPartition_r(scom->sop->args.partName, 0);
1875 stats = (struct DiskPartitionStats64 *) res->payload.buf;
1876 stats->free = dp->free;
1877 stats->totalUsable = dp->totalUsable;
1878 stats->minFree = dp->minFree;
1879 stats->f_files = dp->f_files;
1880 stats->vol_list_len = dp->vol_list.len;
1882 res->hdr.response_len += sizeof(struct DiskPartitionStats64);
1890 FSYNC_com_StatsOpHash(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1892 afs_int32 code = SYNC_OK;
1893 struct VolumeHashChainStats * stats;
1894 struct VolumeHashChainHead * head;
1896 if (scom->sop->args.hash_bucket >= VolumeHashTable.Size) {
1900 head = &VolumeHashTable.Table[scom->sop->args.hash_bucket];
1901 stats = (struct VolumeHashChainStats *) res->payload.buf;
1902 stats->table_size = VolumeHashTable.Size;
1903 stats->chain_len = head->len;
1904 stats->chain_cacheCheck = head->cacheCheck;
1905 stats->chain_busy = head->busy;
1906 AssignInt64(head->looks, &stats->chain_looks);
1907 AssignInt64(head->gets, &stats->chain_gets);
1908 AssignInt64(head->reorders, &stats->chain_reorders);
1910 res->hdr.response_len += sizeof(struct VolumeHashChainStats);
1916 FSYNC_com_StatsOpHdr(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1918 afs_int32 code = SYNC_OK;
1920 memcpy(res->payload.buf, &volume_hdr_LRU.stats, sizeof(volume_hdr_LRU.stats));
1921 res->hdr.response_len += sizeof(volume_hdr_LRU.stats);
1927 FSYNC_com_StatsOpVLRU(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1929 afs_int32 code = SYNC_OK;
1931 code = SYNC_BAD_COMMAND;
1935 #endif /* AFS_DEMAND_ATTACH_FS */
1938 * populate an FSSYNC_VolOp_info object from a command packet object.
1940 * @param[in] vcom pointer to command packet
1941 * @param[out] info pointer to info object which will be populated
1943 * @note FSSYNC_VolOp_info objects are attached to Volume objects when
1944 * a volume operation is commenced.
1949 FSYNC_com_to_info(FSSYNC_VolOp_command * vcom, FSSYNC_VolOp_info * info)
1951 memcpy(&info->com, vcom->hdr, sizeof(SYNC_command_hdr));
1952 memcpy(&info->vop, vcom->vop, sizeof(FSSYNC_VolOp_hdr));
1953 info->vol_op_state = FSSYNC_VolOpPending;
1957 * check whether command packet partition name matches volume
1958 * object's partition name.
1960 * @param[in] vcom pointer to command packet
1961 * @param[in] vp pointer to volume object
1962 * @param[in] match_anon anon matching control flag (see note below)
1964 * @return whether partitions match
1965 * @retval 0 partitions do NOT match
1966 * @retval 1 partitions match
1968 * @note if match_anon is non-zero, then this function will return a
1969 * positive match for a zero-length partition string in the
1975 FSYNC_partMatch(FSSYNC_VolOp_command * vcom, Volume * vp, int match_anon)
1977 return ((match_anon && vcom->vop->partName[0] == 0) ||
1978 (strncmp(vcom->vop->partName, V_partition(vp)->name,
1979 sizeof(vcom->vop->partName)) == 0));
1984 FSYNC_Drop(osi_socket fd)
1986 struct offlineInfo *p;
1989 char tvolName[VMAXPATHLEN];
1992 p = OfflineVolumes[FindHandler(fd)];
1993 for (i = 0; i < MAXOFFLINEVOLUMES; i++) {
1994 if (p[i].volumeID) {
1998 tvolName[0] = OS_DIRSEPC;
1999 sprintf(&tvolName[1], VFORMAT, afs_printable_uint32_lu(p[i].volumeID));
2000 vp = VAttachVolumeByName_r(&error, p[i].partName, tvolName,
2013 static int AcceptHandler = -1; /* handler id for accept, if turned on */
2018 if (AcceptHandler == -1) {
2019 osi_Assert(AddHandler(fssync_server_state.fd, FSYNC_newconnection));
2020 AcceptHandler = FindHandler(fssync_server_state.fd);
2027 if (AcceptHandler != -1) {
2028 osi_Assert(RemoveHandler(fssync_server_state.fd));
2033 /* The multiple FD handling code. */
2035 static osi_socket HandlerFD[MAXHANDLERS];
2036 static void (*HandlerProc[MAXHANDLERS]) (osi_socket);
2042 ObtainWriteLock(&FSYNC_handler_lock);
2043 for (i = 0; i < MAXHANDLERS; i++) {
2044 HandlerFD[i] = OSI_NULLSOCKET;
2047 ReleaseWriteLock(&FSYNC_handler_lock);
2050 #if defined(HAVE_POLL) && defined(AFS_PTHREAD_ENV)
2052 CallHandler(struct pollfd *fds, int nfds, int mask)
2056 ObtainReadLock(&FSYNC_handler_lock);
2057 for (i = 0; i < nfds; i++) {
2058 if (fds[i].revents & mask) {
2059 handler = FindHandler_r(fds[i].fd);
2060 ReleaseReadLock(&FSYNC_handler_lock);
2061 (*HandlerProc[handler]) (fds[i].fd);
2062 ObtainReadLock(&FSYNC_handler_lock);
2065 ReleaseReadLock(&FSYNC_handler_lock);
2069 CallHandler(fd_set * fdsetp)
2072 ObtainReadLock(&FSYNC_handler_lock);
2073 for (i = 0; i < MAXHANDLERS; i++) {
2074 if (HandlerFD[i] >= 0 && FD_ISSET(HandlerFD[i], fdsetp)) {
2075 ReleaseReadLock(&FSYNC_handler_lock);
2076 (*HandlerProc[i]) (HandlerFD[i]);
2077 ObtainReadLock(&FSYNC_handler_lock);
2080 ReleaseReadLock(&FSYNC_handler_lock);
2085 AddHandler(osi_socket afd, void (*aproc) (osi_socket))
2088 ObtainWriteLock(&FSYNC_handler_lock);
2089 for (i = 0; i < MAXHANDLERS; i++)
2090 if (HandlerFD[i] == OSI_NULLSOCKET)
2092 if (i >= MAXHANDLERS) {
2093 ReleaseWriteLock(&FSYNC_handler_lock);
2097 HandlerProc[i] = aproc;
2098 ReleaseWriteLock(&FSYNC_handler_lock);
2103 FindHandler(osi_socket afd)
2106 ObtainReadLock(&FSYNC_handler_lock);
2107 for (i = 0; i < MAXHANDLERS; i++)
2108 if (HandlerFD[i] == afd) {
2109 ReleaseReadLock(&FSYNC_handler_lock);
2112 ReleaseReadLock(&FSYNC_handler_lock); /* just in case */
2114 return -1; /* satisfy compiler */
2118 FindHandler_r(osi_socket afd)
2121 for (i = 0; i < MAXHANDLERS; i++)
2122 if (HandlerFD[i] == afd) {
2126 return -1; /* satisfy compiler */
2130 RemoveHandler(osi_socket afd)
2132 ObtainWriteLock(&FSYNC_handler_lock);
2133 HandlerFD[FindHandler_r(afd)] = OSI_NULLSOCKET;
2134 ReleaseWriteLock(&FSYNC_handler_lock);
2138 #if defined(HAVE_POLL) && defined(AFS_PTHREAD_ENV)
2140 GetHandler(struct pollfd *fds, int maxfds, int events, int *nfds)
2144 ObtainReadLock(&FSYNC_handler_lock);
2145 for (i = 0; i < MAXHANDLERS; i++)
2146 if (HandlerFD[i] != OSI_NULLSOCKET) {
2147 osi_Assert(fdi<maxfds);
2148 fds[fdi].fd = HandlerFD[i];
2149 fds[fdi].events = events;
2150 fds[fdi].revents = 0;
2154 ReleaseReadLock(&FSYNC_handler_lock);
2158 GetHandler(fd_set * fdsetp, int *maxfdp)
2163 ObtainReadLock(&FSYNC_handler_lock); /* just in case */
2164 for (i = 0; i < MAXHANDLERS; i++)
2165 if (HandlerFD[i] != OSI_NULLSOCKET) {
2166 FD_SET(HandlerFD[i], fdsetp);
2167 #ifndef AFS_NT40_ENV
2168 /* On Windows the nfds parameter to select() is ignored */
2169 if (maxfd < HandlerFD[i] || maxfd == (int)-1)
2170 maxfd = HandlerFD[i];
2171 #endif /* AFS_NT40_ENV */
2174 ReleaseReadLock(&FSYNC_handler_lock); /* just in case */
2176 #endif /* HAVE_POLL && AFS_PTHREAD_ENV */
2178 #endif /* FSSYNC_BUILD_SERVER */