dafs-vol-offline-race-20090127
[openafs.git] / src / vol / fssync-server.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
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
8  *
9  * Portions Copyright (c) 2006-2008 Sine Nomine Associates
10  */
11
12 /*
13         System:         VICE-TWO
14         Module:         fssync.c
15         Institution:    The Information Technology Center, Carnegie-Mellon University
16
17  */
18 #ifdef notdef
19
20 /* All this is going away in early 1989 */
21 int newVLDB;                    /* Compatibility flag */
22
23 #endif
24 static int newVLDB = 1;
25
26
27 #ifndef AFS_PTHREAD_ENV
28 #define USUAL_PRIORITY (LWP_MAX_PRIORITY - 2)
29
30 /*
31  * stack size increased from 8K because the HP machine seemed to have trouble
32  * with the smaller stack
33  */
34 #define USUAL_STACK_SIZE        (24 * 1024)
35 #endif /* !AFS_PTHREAD_ENV */
36
37 /*
38    fssync-server.c
39    File server synchronization with external volume utilities.
40    server-side implementation
41  */
42
43 /* This controls the size of an fd_set; it must be defined early before
44  * the system headers define that type and the macros that operate on it.
45  * Its value should be as large as the maximum file descriptor limit we
46  * are likely to run into on any platform.  Right now, that is 65536
47  * which is the default hard fd limit on Solaris 9 */
48 #ifndef _WIN32
49 #define FD_SETSIZE 65536
50 #endif
51
52 #include <afsconfig.h>
53 #include <afs/param.h>
54
55 RCSID
56     ("$Header$");
57
58 #include <sys/types.h>
59 #include <stdio.h>
60 #ifdef AFS_NT40_ENV
61 #include <winsock2.h>
62 #include <time.h>
63 #else
64 #include <sys/param.h>
65 #include <sys/socket.h>
66 #include <netinet/in.h>
67 #include <netdb.h>
68 #include <sys/time.h>
69 #endif
70 #include <errno.h>
71 #ifdef AFS_PTHREAD_ENV
72 #include <assert.h>
73 #else /* AFS_PTHREAD_ENV */
74 #include <afs/assert.h>
75 #endif /* AFS_PTHREAD_ENV */
76 #include <signal.h>
77 #include <string.h>
78
79 #include <rx/xdr.h>
80 #include <afs/afsint.h>
81 #include "nfs.h"
82 #include <afs/errors.h>
83 #include "daemon_com.h"
84 #include "fssync.h"
85 #include "lwp.h"
86 #include "lock.h"
87 #include <afs/afssyscalls.h>
88 #include "ihandle.h"
89 #include "vnode.h"
90 #include "volume.h"
91 #include "volume_inline.h"
92 #include "partition.h"
93
94 #ifdef HAVE_POLL
95 #include <sys/poll.h>
96 #endif /* HAVE_POLL */
97
98 #ifdef USE_UNIX_SOCKETS
99 #include <sys/un.h>
100 #include <afs/afsutil.h>
101 #endif /* USE_UNIX_SOCKETS */
102
103 #ifdef FSSYNC_BUILD_SERVER
104
105 /*@printflike@*/ extern void Log(const char *format, ...);
106
107 int (*V_BreakVolumeCallbacks) ();
108
109 #define MAXHANDLERS     4       /* Up to 4 clients; must be at least 2, so that
110                                  * move = dump+restore can run on single server */
111 #define MAXOFFLINEVOLUMES 128   /* This needs to be as big as the maximum
112                                  * number that would be offline for 1 operation.
113                                  * Current winner is salvage, which needs all
114                                  * cloned read-only copies offline when salvaging
115                                  * a single read-write volume */
116
117
118
119 static struct offlineInfo OfflineVolumes[MAXHANDLERS][MAXOFFLINEVOLUMES];
120
121 /**
122  * fssync server socket handle.
123  */
124 static SYNC_server_state_t fssync_server_state = 
125     { -1,                       /* file descriptor */
126       FSSYNC_ENDPOINT_DECL,     /* server endpoint */
127       FSYNC_PROTO_VERSION,      /* protocol version */
128       5,                        /* bind() retry limit */
129       100,                      /* listen() queue depth */
130       "FSSYNC",                 /* protocol name string */
131     };
132
133
134 /* Forward declarations */
135 static void * FSYNC_sync(void *);
136 static void FSYNC_newconnection();
137 static void FSYNC_com();
138 static void FSYNC_Drop();
139 static void AcceptOn();
140 static void AcceptOff();
141 static void InitHandler();
142 static int AddHandler();
143 static int FindHandler();
144 static int FindHandler_r();
145 static int RemoveHandler();
146 #if defined(HAVE_POLL) && defined (AFS_PTHREAD_ENV)
147 static void CallHandler(struct pollfd *fds, int nfds, int mask);
148 static void GetHandler(struct pollfd *fds, int maxfds, int events, int *nfds);
149 #else
150 static void CallHandler(fd_set * fdsetp);
151 static void GetHandler(fd_set * fdsetp, int *maxfdp);
152 #endif
153 extern int LogLevel;
154
155 static afs_int32 FSYNC_com_VolOp(int fd, SYNC_command * com, SYNC_response * res);
156
157 static afs_int32 FSYNC_com_VolError(FSSYNC_VolOp_command * com, SYNC_response * res);
158 static afs_int32 FSYNC_com_VolOn(FSSYNC_VolOp_command * com, SYNC_response * res);
159 static afs_int32 FSYNC_com_VolOff(FSSYNC_VolOp_command * com, SYNC_response * res);
160 static afs_int32 FSYNC_com_VolMove(FSSYNC_VolOp_command * com, SYNC_response * res);
161 static afs_int32 FSYNC_com_VolBreakCBKs(FSSYNC_VolOp_command * com, SYNC_response * res);
162 static afs_int32 FSYNC_com_VolDone(FSSYNC_VolOp_command * com, SYNC_response * res);
163 static afs_int32 FSYNC_com_VolQuery(FSSYNC_VolOp_command * com, SYNC_response * res);
164 static afs_int32 FSYNC_com_VolHdrQuery(FSSYNC_VolOp_command * com, SYNC_response * res);
165 #ifdef AFS_DEMAND_ATTACH_FS
166 static afs_int32 FSYNC_com_VolOpQuery(FSSYNC_VolOp_command * com, SYNC_response * res);
167 #endif /* AFS_DEMAND_ATTACH_FS */
168
169 static afs_int32 FSYNC_com_VnQry(int fd, SYNC_command * com, SYNC_response * res);
170
171 static afs_int32 FSYNC_com_StatsOp(int fd, SYNC_command * com, SYNC_response * res);
172
173 static afs_int32 FSYNC_com_StatsOpGeneral(FSSYNC_StatsOp_command * scom, SYNC_response * res);
174 static afs_int32 FSYNC_com_StatsOpViceP(FSSYNC_StatsOp_command * scom, SYNC_response * res);
175 static afs_int32 FSYNC_com_StatsOpHash(FSSYNC_StatsOp_command * scom, SYNC_response * res);
176 static afs_int32 FSYNC_com_StatsOpHdr(FSSYNC_StatsOp_command * scom, SYNC_response * res);
177 static afs_int32 FSYNC_com_StatsOpVLRU(FSSYNC_StatsOp_command * scom, SYNC_response * res);
178
179
180 static void FSYNC_com_to_info(FSSYNC_VolOp_command * vcom, FSSYNC_VolOp_info * info);
181
182 static int FSYNC_partMatch(FSSYNC_VolOp_command * vcom, Volume * vp, int match_anon);
183
184
185 /*
186  * This lock controls access to the handler array. The overhead
187  * is minimal in non-preemptive environments.
188  */
189 struct Lock FSYNC_handler_lock;
190
191 void
192 FSYNC_fsInit(void)
193 {
194 #ifdef AFS_PTHREAD_ENV
195     pthread_t tid;
196     pthread_attr_t tattr;
197 #else /* AFS_PTHREAD_ENV */
198     PROCESS pid;
199 #endif /* AFS_PTHREAD_ENV */
200
201     Lock_Init(&FSYNC_handler_lock);
202
203 #ifdef AFS_PTHREAD_ENV
204     assert(pthread_attr_init(&tattr) == 0);
205     assert(pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED) == 0);
206     assert(pthread_create(&tid, &tattr, FSYNC_sync, NULL) == 0);
207 #else /* AFS_PTHREAD_ENV */
208     assert(LWP_CreateProcess
209            (FSYNC_sync, USUAL_STACK_SIZE, USUAL_PRIORITY, (void *)0,
210             "FSYNC_sync", &pid) == LWP_SUCCESS);
211 #endif /* AFS_PTHREAD_ENV */
212 }
213
214 #if defined(HAVE_POLL) && defined(AFS_PTHREAD_ENV)
215 static struct pollfd FSYNC_readfds[MAXHANDLERS];
216 #else
217 static fd_set FSYNC_readfds;
218 #endif
219
220
221 static void *
222 FSYNC_sync(void * args)
223 {
224 #ifdef USE_UNIX_SOCKETS
225     char tbuffer[AFSDIR_PATH_MAX];
226 #endif /* USE_UNIX_SOCKETS */
227     int on = 1;
228     extern int VInit;
229     int code;
230     int numTries;
231 #ifdef AFS_PTHREAD_ENV
232     int tid;
233 #endif
234     SYNC_server_state_t * state = &fssync_server_state;
235 #ifdef AFS_DEMAND_ATTACH_FS
236     VThreadOptions_t * thread_opts;
237 #endif
238
239     SYNC_getAddr(&state->endpoint, &state->addr);
240     SYNC_cleanupSock(state);
241
242 #ifndef AFS_NT40_ENV
243     (void)signal(SIGPIPE, SIG_IGN);
244 #endif
245
246 #ifdef AFS_PTHREAD_ENV
247     /* set our 'thread-id' so that the host hold table works */
248     MUTEX_ENTER(&rx_stats_mutex);       /* protects rxi_pthread_hinum */
249     tid = ++rxi_pthread_hinum;
250     MUTEX_EXIT(&rx_stats_mutex);
251     pthread_setspecific(rx_thread_id_key, (void *)tid);
252     Log("Set thread id %d for FSYNC_sync\n", tid);
253 #endif /* AFS_PTHREAD_ENV */
254
255     while (!VInit) {
256         /* Let somebody else run until level > 0.  That doesn't mean that 
257          * all volumes have been attached. */
258 #ifdef AFS_PTHREAD_ENV
259         pthread_yield();
260 #else /* AFS_PTHREAD_ENV */
261         LWP_DispatchProcess();
262 #endif /* AFS_PTHREAD_ENV */
263     }
264     state->fd = SYNC_getSock(&state->endpoint);
265     code = SYNC_bindSock(state);
266     assert(!code);
267
268 #ifdef AFS_DEMAND_ATTACH_FS
269     /*
270      * make sure the volume package is incapable of recursively executing
271      * salvsync calls on this thread, since there is a possibility of
272      * deadlock.
273      */
274     thread_opts = malloc(sizeof(VThreadOptions_t));
275     if (thread_opts == NULL) {
276         Log("failed to allocate memory for thread-specific volume package options structure\n");
277         return NULL;
278     }
279     memcpy(thread_opts, &VThread_defaults, sizeof(VThread_defaults));
280     thread_opts->disallow_salvsync = 1;
281     assert(pthread_setspecific(VThread_key, thread_opts) == 0);
282 #endif
283
284     InitHandler();
285     AcceptOn();
286
287     for (;;) {
288 #if defined(HAVE_POLL) && defined(AFS_PTHREAD_ENV)
289         int nfds;
290         GetHandler(FSYNC_readfds, MAXHANDLERS, POLLIN|POLLPRI, &nfds);
291         if (poll(FSYNC_readfds, nfds, -1) >=1)
292             CallHandler(FSYNC_readfds, nfds, POLLIN|POLLPRI);
293 #else
294         int maxfd;
295         GetHandler(&FSYNC_readfds, &maxfd);
296         /* Note: check for >= 1 below is essential since IOMGR_select
297          * doesn't have exactly same semantics as select.
298          */
299 #ifdef AFS_PTHREAD_ENV
300         if (select(maxfd + 1, &FSYNC_readfds, NULL, NULL, NULL) >= 1)
301 #else /* AFS_PTHREAD_ENV */
302         if (IOMGR_Select(maxfd + 1, &FSYNC_readfds, NULL, NULL, NULL) >= 1)
303 #endif /* AFS_PTHREAD_ENV */
304             CallHandler(&FSYNC_readfds);
305 #endif
306     }
307 }
308
309 static void
310 FSYNC_newconnection(int afd)
311 {
312 #ifdef USE_UNIX_SOCKETS
313     struct sockaddr_un other;
314 #else  /* USE_UNIX_SOCKETS */
315     struct sockaddr_in other;
316 #endif
317     int junk, fd;
318     junk = sizeof(other);
319     fd = accept(afd, (struct sockaddr *)&other, &junk);
320     if (fd == -1) {
321         Log("FSYNC_newconnection:  accept failed, errno==%d\n", errno);
322         assert(1 == 2);
323     } else if (!AddHandler(fd, FSYNC_com)) {
324         AcceptOff();
325         assert(AddHandler(fd, FSYNC_com));
326     }
327 }
328
329 /* this function processes commands from an fssync file descriptor (fd) */
330 afs_int32 FS_cnt = 0;
331 static void
332 FSYNC_com(int fd)
333 {
334     SYNC_command com;
335     SYNC_response res;
336     SYNC_PROTO_BUF_DECL(com_buf);
337     SYNC_PROTO_BUF_DECL(res_buf);
338
339     memset(&res.hdr, 0, sizeof(res.hdr));
340
341     com.payload.buf = (void *)com_buf;
342     com.payload.len = SYNC_PROTO_MAX_LEN;
343     res.hdr.response_len = sizeof(res.hdr);
344     res.payload.len = SYNC_PROTO_MAX_LEN;
345     res.payload.buf = (void *)res_buf;
346
347     FS_cnt++;
348     if (SYNC_getCom(&fssync_server_state, fd, &com)) {
349         Log("FSYNC_com:  read failed; dropping connection (cnt=%d)\n", FS_cnt);
350         FSYNC_Drop(fd);
351         return;
352     }
353
354     if (com.recv_len < sizeof(com.hdr)) {
355         Log("FSSYNC_com:  invalid protocol message length (%u)\n", com.recv_len);
356         res.hdr.response = SYNC_COM_ERROR;
357         res.hdr.reason = SYNC_REASON_MALFORMED_PACKET;
358         res.hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
359         goto respond;
360     }
361
362     if (com.hdr.proto_version != FSYNC_PROTO_VERSION) {
363         Log("FSYNC_com:  invalid protocol version (%u)\n", com.hdr.proto_version);
364         res.hdr.response = SYNC_COM_ERROR;
365         res.hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
366         goto respond;
367     }
368
369     if (com.hdr.command == SYNC_COM_CHANNEL_CLOSE) {
370         res.hdr.response = SYNC_OK;
371         res.hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
372         goto respond;
373     }
374
375     res.hdr.com_seq = com.hdr.com_seq;
376
377     VOL_LOCK;
378     switch (com.hdr.command) {
379     case FSYNC_VOL_ON:
380     case FSYNC_VOL_ATTACH:
381     case FSYNC_VOL_LEAVE_OFF:
382     case FSYNC_VOL_OFF:
383     case FSYNC_VOL_FORCE_ERROR:
384     case FSYNC_VOL_LISTVOLUMES:
385     case FSYNC_VOL_NEEDVOLUME:
386     case FSYNC_VOL_MOVE:
387     case FSYNC_VOL_BREAKCBKS:
388     case FSYNC_VOL_DONE:
389     case FSYNC_VOL_QUERY:
390     case FSYNC_VOL_QUERY_HDR:
391     case FSYNC_VOL_QUERY_VOP:
392         res.hdr.response = FSYNC_com_VolOp(fd, &com, &res);
393         break;
394     case FSYNC_VOL_STATS_GENERAL:
395     case FSYNC_VOL_STATS_VICEP:
396     case FSYNC_VOL_STATS_HASH:
397     case FSYNC_VOL_STATS_HDR:
398     case FSYNC_VOL_STATS_VLRU:
399         res.hdr.response = FSYNC_com_StatsOp(fd, &com, &res);
400         break;
401     case FSYNC_VOL_QUERY_VNODE:
402         res.hdr.response = FSYNC_com_VnQry(fd, &com, &res);
403         break;
404     default:
405         res.hdr.response = SYNC_BAD_COMMAND;
406         break;
407     }
408     VOL_UNLOCK;
409
410  respond:
411     SYNC_putRes(&fssync_server_state, fd, &res);
412     if (res.hdr.flags & SYNC_FLAG_CHANNEL_SHUTDOWN) {
413         FSYNC_Drop(fd);
414     }
415 }
416
417 static afs_int32
418 FSYNC_com_VolOp(int fd, SYNC_command * com, SYNC_response * res)
419 {
420     int i;
421     afs_int32 code = SYNC_OK;
422     FSSYNC_VolOp_command vcom;
423
424     if (com->recv_len != (sizeof(com->hdr) + sizeof(FSSYNC_VolOp_hdr))) {
425         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
426         res->hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
427         return SYNC_COM_ERROR;
428     }
429
430     vcom.hdr = &com->hdr;
431     vcom.vop = (FSSYNC_VolOp_hdr *) com->payload.buf;
432     vcom.com = com;
433
434     vcom.volumes = OfflineVolumes[FindHandler(fd)];
435     for (vcom.v = NULL, i = 0; i < MAXOFFLINEVOLUMES; i++) {
436         if ((vcom.volumes[i].volumeID == vcom.vop->volume) &&
437             (strncmp(vcom.volumes[i].partName, vcom.vop->partName,
438                      sizeof(vcom.volumes[i].partName)) == 0)) {
439             vcom.v = &vcom.volumes[i];
440             break;
441         }
442     }
443
444     switch (com->hdr.command) {
445     case FSYNC_VOL_ON:
446     case FSYNC_VOL_ATTACH:
447     case FSYNC_VOL_LEAVE_OFF:
448         code = FSYNC_com_VolOn(&vcom, res);
449         break;
450     case FSYNC_VOL_OFF:
451     case FSYNC_VOL_NEEDVOLUME:
452         code = FSYNC_com_VolOff(&vcom, res);
453         break;
454     case FSYNC_VOL_LISTVOLUMES:
455         code = SYNC_OK;
456         break;
457     case FSYNC_VOL_MOVE:
458         code = FSYNC_com_VolMove(&vcom, res);
459         break;
460     case FSYNC_VOL_BREAKCBKS:
461         code = FSYNC_com_VolBreakCBKs(&vcom, res);
462         break;
463     case FSYNC_VOL_DONE:
464         code = FSYNC_com_VolDone(&vcom, res);
465         break;
466     case FSYNC_VOL_QUERY:
467         code = FSYNC_com_VolQuery(&vcom, res);
468         break;
469     case FSYNC_VOL_QUERY_HDR:
470         code = FSYNC_com_VolHdrQuery(&vcom, res);
471         break;
472 #ifdef AFS_DEMAND_ATTACH_FS
473     case FSYNC_VOL_FORCE_ERROR:
474         code = FSYNC_com_VolError(&vcom, res);
475         break;
476     case FSYNC_VOL_QUERY_VOP:
477         code = FSYNC_com_VolOpQuery(&vcom, res);
478         break;
479 #endif /* AFS_DEMAND_ATTACH_FS */
480     default:
481         code = SYNC_BAD_COMMAND;
482     }
483
484     return code;
485 }
486
487 /**
488  * service an FSYNC request to bring a volume online.
489  *
490  * @param[in]   vcom  pointer command object
491  * @param[out]  res   object in which to store response packet
492  *
493  * @return operation status
494  *   @retval SYNC_OK volume transitioned online
495  *   @retval SYNC_FAILED invalid command protocol message
496  *   @retval SYNC_DENIED operation could not be completed
497  *
498  * @note this is an FSYNC RPC server stub
499  *
500  * @note this procedure handles the following FSSYNC command codes:
501  *       - FSYNC_VOL_ON
502  *       - FSYNC_VOL_ATTACH
503  *       - FSYNC_VOL_LEAVE_OFF
504  *
505  * @note the supplementary reason code contains additional details.
506  *       When SYNC_DENIED is returned, the specific reason is
507  *       placed in the response packet reason field.
508  *
509  * @internal
510  */
511 static afs_int32
512 FSYNC_com_VolOn(FSSYNC_VolOp_command * vcom, SYNC_response * res)
513 {
514     afs_int32 code = SYNC_OK;
515     char tvolName[VMAXPATHLEN];
516     Volume * vp;
517     Error error;
518
519     if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
520         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
521         code = SYNC_FAILED;
522         goto done;
523     }
524
525     /* so, we need to attach the volume */
526
527 #ifdef AFS_DEMAND_ATTACH_FS
528     /* check DAFS permissions */
529     vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
530     if (vp &&
531         FSYNC_partMatch(vcom, vp, 1) &&
532         vp->pending_vol_op && 
533         (vcom->hdr->programType != vp->pending_vol_op->com.programType)) {
534         /* a different program has this volume checked out. deny. */
535         Log("FSYNC_VolOn: WARNING: program type %u has attempted to manipulate "
536             "state for volume %u using command code %u while the volume is " 
537             "checked out by program type %u for command code %u.\n",
538             vcom->hdr->programType,
539             vcom->vop->volume,
540             vcom->hdr->command,
541             vp->pending_vol_op->com.programType,
542             vp->pending_vol_op->com.command);
543         code = SYNC_DENIED;
544         res->hdr.reason = FSYNC_EXCLUSIVE;
545         goto done;
546     }
547 #endif
548
549     if (vcom->v)
550         vcom->v->volumeID = 0;
551
552
553     if (vcom->hdr->command == FSYNC_VOL_LEAVE_OFF) {
554         /* nothing much to do if we're leaving the volume offline */
555 #ifdef AFS_DEMAND_ATTACH_FS
556         if (vp) {
557             if (FSYNC_partMatch(vcom, vp, 1)) {
558                 if ((V_attachState(vp) == VOL_STATE_UNATTACHED) ||
559                     (V_attachState(vp) == VOL_STATE_PREATTACHED)) {
560                     VChangeState_r(vp, VOL_STATE_UNATTACHED);
561                     VDeregisterVolOp_r(vp);
562                 } else {
563                     code = SYNC_DENIED;
564                     res->hdr.reason = FSYNC_BAD_STATE;
565                 }
566             } else {
567                 code = SYNC_DENIED;
568                 res->hdr.reason = FSYNC_WRONG_PART;
569             }
570         } else {
571             code = SYNC_DENIED;
572             res->hdr.reason = FSYNC_UNKNOWN_VOLID;
573         }
574 #endif
575         goto done;
576     }
577
578 #ifdef AFS_DEMAND_ATTACH_FS
579     /* first, check to see whether we have such a volume defined */
580     vp = VPreAttachVolumeById_r(&error,
581                                 vcom->vop->partName,
582                                 vcom->vop->volume);
583     if (vp) {
584         VDeregisterVolOp_r(vp);
585     }
586 #else /* !AFS_DEMAND_ATTACH_FS */
587     tvolName[0] = '/';
588     snprintf(&tvolName[1], sizeof(tvolName)-1, VFORMAT, vcom->vop->volume);
589     tvolName[sizeof(tvolName)-1] = '\0';
590
591     vp = VAttachVolumeByName_r(&error, vcom->vop->partName, tvolName,
592                                V_VOLUPD);
593     if (vp)
594         VPutVolume_r(vp);
595     if (error) {
596         code = SYNC_DENIED;
597         res->hdr.reason = error;
598     }
599 #endif /* !AFS_DEMAND_ATTACH_FS */
600
601  done:
602     return code;
603 }
604
605 /**
606  * service an FSYNC request to take a volume offline.
607  *
608  * @param[in]   vcom  pointer command object
609  * @param[out]  res   object in which to store response packet
610  *
611  * @return operation status
612  *   @retval SYNC_OK volume transitioned offline
613  *   @retval SYNC_FAILED invalid command protocol message
614  *   @retval SYNC_DENIED operation could not be completed
615  *
616  * @note this is an FSYNC RPC server stub
617  *
618  * @note this procedure handles the following FSSYNC command codes:
619  *       - FSYNC_VOL_OFF 
620  *       - FSYNC_VOL_NEEDVOLUME
621  *
622  * @note the supplementary reason code contains additional details.
623  *       When SYNC_DENIED is returned, the specific reason is
624  *       placed in the response packet reason field.
625  *
626  * @internal
627  */
628 static afs_int32
629 FSYNC_com_VolOff(FSSYNC_VolOp_command * vcom, SYNC_response * res)
630 {
631     FSSYNC_VolOp_info info;
632     afs_int32 code = SYNC_OK;
633     int i;
634     Volume * vp, * nvp;
635     Error error;
636 #ifdef AFS_DEMAND_ATTACH_FS
637     int reserved = 0;
638 #endif
639
640     if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
641         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
642         code = SYNC_FAILED;
643         goto done;
644     }
645
646     /* not already offline, we need to find a slot for newly offline volume */
647     if (vcom->hdr->programType == debugUtility) {
648         /* debug utilities do not have their operations tracked */
649         vcom->v = NULL;
650     } else {
651         if (!vcom->v) {
652             for (i = 0; i < MAXOFFLINEVOLUMES; i++) {
653                 if (vcom->volumes[i].volumeID == 0) {
654                     vcom->v = &vcom->volumes[i];
655                     break;
656                 }
657             }
658         }
659         if (!vcom->v) {
660             goto deny;
661         }
662     }
663
664     FSYNC_com_to_info(vcom, &info);
665
666 #ifdef AFS_DEMAND_ATTACH_FS
667     vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
668 #else
669     vp = VGetVolume_r(&error, vcom->vop->volume);
670 #endif
671
672     if (vp) {
673             if (!FSYNC_partMatch(vcom, vp, 1)) {
674             /* volume on desired partition is not online, so we
675              * should treat this as an offline volume.
676              */
677 #ifndef AFS_DEMAND_ATTACH_FS
678             VPutVolume_r(vp);
679 #endif
680             vp = NULL;
681             goto done;
682         }
683     }
684
685 #ifdef AFS_DEMAND_ATTACH_FS
686     if (vp) {
687         ProgramType type = (ProgramType) vcom->hdr->programType;
688
689         /* do initial filtering of requests */
690
691         /* enforce mutual exclusion for volume ops */
692         if (vp->pending_vol_op) {
693             if (vp->pending_vol_op->com.programType != type) {
694                 Log("volume %u already checked out\n", vp->hashid);
695                 /* XXX debug */
696                 Log("vp->vop = { com = { ver=%u, prog=%d, com=%d, reason=%d, len=%u, flags=0x%x }, vop = { vol=%u, part='%s' } }\n",
697                     vp->pending_vol_op->com.proto_version, 
698                     vp->pending_vol_op->com.programType,
699                     vp->pending_vol_op->com.command,
700                     vp->pending_vol_op->com.reason,
701                     vp->pending_vol_op->com.command_len,
702                     vp->pending_vol_op->com.flags,
703                     vp->pending_vol_op->vop.volume,
704                     vp->pending_vol_op->vop.partName );
705                 Log("vcom = { com = { ver=%u, prog=%d, com=%d, reason=%d, len=%u, flags=0x%x } , vop = { vol=%u, part='%s' } }\n",
706                     vcom->hdr->proto_version,
707                     vcom->hdr->programType,
708                     vcom->hdr->command,
709                     vcom->hdr->reason,
710                     vcom->hdr->command_len,
711                     vcom->hdr->flags,
712                     vcom->vop->volume,
713                     vcom->vop->partName);
714                 res->hdr.reason = FSYNC_EXCLUSIVE;
715                 goto deny;
716             } else {
717                 Log("warning: volume %u recursively checked out by programType id %d\n",
718                     vp->hashid, vcom->hdr->programType);
719             }
720         }
721
722         /* filter based upon requestor
723          *
724          * volume utilities are not allowed to check out volumes
725          * which are in an error state
726          *
727          * unknown utility programs will be denied on principal
728          */
729         switch (type) {
730         case salvageServer:
731             /* it is possible for the salvageserver to checkout a 
732              * volume for salvage before its scheduling request
733              * has been sent to the salvageserver */
734             if (vp->salvage.requested && !vp->salvage.scheduled) {
735                 vp->salvage.scheduled = 1;
736             }
737         case debugUtility:
738             break;
739
740         case volumeUtility:
741             if (VIsErrorState(V_attachState(vp))) {
742                 goto deny;
743             }
744             if (vp->salvage.requested) {
745                 goto deny;
746             }
747             break;
748
749         default:
750             Log("bad program type passed to FSSYNC\n");
751             goto deny;
752         }
753
754         /* short circuit for offline volume states
755          * so we can avoid I/O penalty of attachment */
756         switch (V_attachState(vp)) {
757         case VOL_STATE_UNATTACHED:
758         case VOL_STATE_PREATTACHED:
759         case VOL_STATE_SALVAGING:
760         case VOL_STATE_ERROR:
761             /* register the volume operation metadata with the volume
762              *
763              * if the volume is currently pre-attached, attach2()
764              * will evaluate the vol op metadata to determine whether
765              * attaching the volume would be safe */
766             VRegisterVolOp_r(vp, &info);
767             vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningUnknown;
768             goto done;
769         default:
770             break;
771         }
772
773         /* convert to heavyweight ref */
774         nvp = VGetVolumeByVp_r(&error, vp);
775
776         if (!nvp) {
777             Log("FSYNC_com_VolOff: failed to get heavyweight reference to volume %u\n",
778                 vcom->vop->volume);
779             res->hdr.reason = FSYNC_VOL_PKG_ERROR;
780             goto deny;
781         } else if (nvp != vp) {
782             /* i don't think this should ever happen, but just in case... */
783             Log("FSYNC_com_VolOff: warning: potentially dangerous race detected\n");
784             vp = nvp;
785         }
786
787         /* register the volume operation metadata with the volume */
788         VRegisterVolOp_r(vp, &info);
789
790     }
791 #endif /* AFS_DEMAND_ATTACH_FS */
792
793     if (vp) {
794         if (VVolOpLeaveOnline_r(vp, &info)) {
795             VUpdateVolume_r(&error, vp, VOL_UPDATE_WAIT);       /* At least get volume stats right */
796             if (LogLevel) {
797                 Log("FSYNC: Volume %u (%s) was left on line for an external %s request\n", 
798                     V_id(vp), V_name(vp), 
799                     vcom->hdr->reason == V_CLONE ? "clone" : 
800                     vcom->hdr->reason == V_READONLY ? "readonly" : 
801                     vcom->hdr->reason == V_DUMP ? "dump" : 
802                     "UNKNOWN");
803             }
804 #ifdef AFS_DEMAND_ATTACH_FS
805             vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOnline;
806 #endif
807             VPutVolume_r(vp);
808         } else {
809             if (VVolOpSetVBusy_r(vp, &info)) {
810                 vp->specialStatus = VBUSY;
811             }
812
813             /* remember what volume we got, so we can keep track of how
814              * many volumes the volserver or whatever is using.  Note that
815              * vp is valid since leaveonline is only set when vp is valid.
816              */
817             if (vcom->v) {
818                 vcom->v->volumeID = vcom->vop->volume;
819                 strlcpy(vcom->v->partName, vp->partition->name, sizeof(vcom->v->partName));
820             }
821
822 #ifdef AFS_DEMAND_ATTACH_FS
823             VOfflineForVolOp_r(&error, vp, "A volume utility is running.");
824             if (error==0) {
825                 assert(vp->nUsers==0);
826                 vp->pending_vol_op->vol_op_state = FSSYNC_VolOpRunningOffline; 
827             }
828             else {
829                 VDeregisterVolOp_r(vp);
830                 code = SYNC_DENIED;
831             }
832 #else
833             VOffline_r(vp, "A volume utility is running.");
834 #endif
835             vp = NULL;
836         }
837     }
838
839  done:
840     return code;
841
842  deny:
843     return SYNC_DENIED;
844 }
845
846 /**
847  * service an FSYNC request to mark a volume as moved.
848  *
849  * @param[in]   vcom  pointer command object
850  * @param[out]  res   object in which to store response packet
851  *
852  * @return operation status
853  *   @retval SYNC_OK volume marked as moved to a remote server
854  *   @retval SYNC_FAILED invalid command protocol message
855  *   @retval SYNC_DENIED current volume state does not permit this operation
856  *
857  * @note this is an FSYNC RPC server stub
858  *
859  * @note this operation also breaks all callbacks for the given volume
860  *
861  * @note this procedure handles the following FSSYNC command codes:
862  *       - FSYNC_VOL_MOVE
863  *
864  * @note the supplementary reason code contains additional details.  For
865  *       instance, SYNC_OK is still returned when the partition specified
866  *       does not match the one registered in the volume object -- reason
867  *       will be FSYNC_WRONG_PART in this case.
868  *
869  * @internal
870  */
871 static afs_int32
872 FSYNC_com_VolMove(FSSYNC_VolOp_command * vcom, SYNC_response * res)
873 {
874     afs_int32 code = SYNC_DENIED;
875     Error error;
876     Volume * vp;
877
878     if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
879         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
880         code = SYNC_FAILED;
881         goto done;
882     }
883
884     /* Yuch:  the "reason" for the move is the site it got moved to... */
885     /* still set specialStatus so we stop sending back VBUSY.
886      * also should still break callbacks.  Note that I don't know
887      * how to tell if we should break all or not, so we just do it
888      * since it doesn't matter much if we do an extra break
889      * volume callbacks on a volume move within the same server */
890 #ifdef AFS_DEMAND_ATTACH_FS
891     vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
892 #else
893     vp = VGetVolume_r(&error, vcom->vop->volume);
894 #endif
895     if (vp) {
896         if (FSYNC_partMatch(vcom, vp, 1)) {
897 #ifdef AFS_DEMAND_ATTACH_FS
898             if ((V_attachState(vp) == VOL_STATE_UNATTACHED) ||
899                 (V_attachState(vp) == VOL_STATE_PREATTACHED)) {
900 #endif
901                 code = SYNC_OK;
902                 vp->specialStatus = VMOVED;
903 #ifdef AFS_DEMAND_ATTACH_FS
904             } else {
905                 res->hdr.reason = FSYNC_BAD_STATE;
906             }
907 #endif
908         } else {
909             res->hdr.reason = FSYNC_WRONG_PART;
910         }
911         VPutVolume_r(vp);
912     } else {
913         res->hdr.reason = FSYNC_UNKNOWN_VOLID;
914     }
915
916     if ((code == SYNC_OK) && (V_BreakVolumeCallbacks != NULL)) {
917         Log("fssync: volume %u moved to %x; breaking all call backs\n",
918             vcom->vop->volume, vcom->hdr->reason);
919         VOL_UNLOCK;
920         (*V_BreakVolumeCallbacks) (vcom->vop->volume);
921         VOL_LOCK;
922     }
923
924
925  done:
926     return code;
927 }
928
929 /**
930  * service an FSYNC request to mark a volume as destroyed.
931  *
932  * @param[in]   vcom  pointer command object
933  * @param[out]  res   object in which to store response packet
934  *
935  * @return operation status
936  *   @retval SYNC_OK volume marked as destroyed
937  *   @retval SYNC_FAILED invalid command protocol message
938  *   @retval SYNC_DENIED current volume state does not permit this operation
939  *
940  * @note this is an FSYNC RPC server stub
941  *
942  * @note this procedure handles the following FSSYNC command codes:
943  *       - FSYNC_VOL_DONE
944  *
945  * @note the supplementary reason code contains additional details.  For
946  *       instance, SYNC_OK is still returned when the partition specified
947  *       does not match the one registered in the volume object -- reason
948  *       will be FSYNC_WRONG_PART in this case.
949  *
950  * @internal
951  */
952 static afs_int32
953 FSYNC_com_VolDone(FSSYNC_VolOp_command * vcom, SYNC_response * res)
954 {
955     afs_int32 code = SYNC_FAILED;
956 #ifdef AFS_DEMAND_ATTACH_FS
957     Error error;
958     Volume * vp;
959 #endif
960
961     if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
962         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
963         goto done;
964     }
965
966     /* don't try to put online, this call is made only after deleting
967      * a volume, in which case we want to remove the vol # from the
968      * OfflineVolumes array only */
969     if (vcom->v)
970         vcom->v->volumeID = 0;
971
972 #ifdef AFS_DEMAND_ATTACH_FS
973     vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
974     if (vp) {
975         if (FSYNC_partMatch(vcom, vp, 1)) {
976             if ((V_attachState(vp) == VOL_STATE_UNATTACHED) ||
977                 (V_attachState(vp) == VOL_STATE_PREATTACHED)) {
978                 VChangeState_r(vp, VOL_STATE_UNATTACHED);
979                 VDeregisterVolOp_r(vp);
980                 code = SYNC_OK;
981             } else {
982                 code = SYNC_DENIED;
983                 res->hdr.reason = FSYNC_BAD_STATE;
984             }
985         } else {
986             code = SYNC_OK; /* XXX is this really a good idea? */
987             res->hdr.reason = FSYNC_WRONG_PART;
988         }
989     } else {
990         res->hdr.reason = FSYNC_UNKNOWN_VOLID;
991     }
992 #endif
993
994  done:
995     return code;
996 }
997
998 #ifdef AFS_DEMAND_ATTACH_FS
999 /**
1000  * service an FSYNC request to transition a volume to the hard error state.
1001  *
1002  * @param[in]   vcom  pointer command object
1003  * @param[out]  res   object in which to store response packet
1004  *
1005  * @return operation status
1006  *   @retval SYNC_OK volume transitioned to hard error state
1007  *   @retval SYNC_FAILED invalid command protocol message
1008  *   @retval SYNC_DENIED (see note)
1009  *
1010  * @note this is an FSYNC RPC server stub
1011  *
1012  * @note this procedure handles the following FSSYNC command codes:
1013  *       - FSYNC_VOL_FORCE_ERROR
1014  *
1015  * @note SYNC_DENIED is returned in the following cases:
1016  *        - no partition name is specified (reason field set to
1017  *          FSYNC_WRONG_PART).
1018  *        - volume id not known to fileserver (reason field set
1019  *          to FSYNC_UNKNOWN_VOLID).
1020  *
1021  * @note demand attach fileserver only
1022  *
1023  * @internal
1024  */
1025 static afs_int32
1026 FSYNC_com_VolError(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1027 {
1028     Error error;
1029     Volume * vp;
1030     afs_int32 code = SYNC_FAILED;
1031
1032     if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1033         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1034         goto done;
1035     }
1036
1037     vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1038     if (vp) {
1039         if (FSYNC_partMatch(vcom, vp, 0)) {
1040             /* null out salvsync control state, as it's no longer relevant */
1041             memset(&vp->salvage, 0, sizeof(vp->salvage));
1042             VChangeState_r(vp, VOL_STATE_ERROR);
1043             code = SYNC_OK;
1044         } else {
1045             res->hdr.reason = FSYNC_WRONG_PART;
1046         }
1047     } else {
1048         res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1049     }
1050
1051  done:
1052     return code;
1053 }
1054 #endif /* AFS_DEMAND_ATTACH_FS */
1055
1056 /**
1057  * service an FSYNC request to break all callbacks for this volume.
1058  *
1059  * @param[in]   vcom  pointer command object
1060  * @param[out]  res   object in which to store response packet
1061  *
1062  * @return operation status
1063  *   @retval SYNC_OK callback breaks scheduled for volume
1064  *
1065  * @note this is an FSYNC RPC server stub
1066  *
1067  * @note this procedure handles the following FSSYNC command codes:
1068  *       - FSYNC_VOL_BREAKCBKS
1069  *
1070  * @note demand attach fileserver only
1071  *
1072  * @todo should do partition matching
1073  *
1074  * @internal
1075  */
1076 static afs_int32
1077 FSYNC_com_VolBreakCBKs(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1078 {
1079     /* if the volume is being restored, break all callbacks on it */
1080     if (V_BreakVolumeCallbacks) {
1081         Log("fssync: breaking all call backs for volume %u\n",
1082             vcom->vop->volume);
1083         VOL_UNLOCK;
1084         (*V_BreakVolumeCallbacks) (vcom->vop->volume);
1085         VOL_LOCK;
1086     }
1087     return SYNC_OK;
1088 }
1089
1090 /**
1091  * service an FSYNC request to return the Volume object.
1092  *
1093  * @param[in]   vcom  pointer command object
1094  * @param[out]  res   object in which to store response packet
1095  *
1096  * @return operation status
1097  *   @retval SYNC_OK      volume object returned to caller
1098  *   @retval SYNC_FAILED  bad command packet, or failed to locate volume object
1099  *
1100  * @note this is an FSYNC RPC server stub
1101  *
1102  * @note this procedure handles the following FSSYNC command codes:
1103  *       - FSYNC_VOL_QUERY
1104  *
1105  * @internal
1106  */
1107 static afs_int32
1108 FSYNC_com_VolQuery(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1109 {
1110     afs_int32 code = SYNC_FAILED;
1111     Error error;
1112     Volume * vp;
1113
1114     if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1115         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1116         goto done;
1117     }
1118
1119 #ifdef AFS_DEMAND_ATTACH_FS
1120     vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1121 #else /* !AFS_DEMAND_ATTACH_FS */
1122     vp = VGetVolume_r(&error, vcom->vop->volume);
1123 #endif /* !AFS_DEMAND_ATTACH_FS */
1124
1125     if (vp) {
1126         if (FSYNC_partMatch(vcom, vp, 1)) {
1127             if (res->payload.len >= sizeof(Volume)) {
1128                 memcpy(res->payload.buf, vp, sizeof(Volume));
1129                 res->hdr.response_len += sizeof(Volume);
1130                 code = SYNC_OK;
1131             } else {
1132                 res->hdr.reason = SYNC_REASON_PAYLOAD_TOO_BIG;
1133             }
1134         } else {
1135             res->hdr.reason = FSYNC_WRONG_PART;
1136         }
1137 #ifndef AFS_DEMAND_ATTACH_FS
1138         VPutVolume_r(vp);
1139 #endif
1140     } else {
1141         res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1142     }
1143
1144  done:
1145     return code;
1146 }
1147
1148 /**
1149  * service an FSYNC request to return the Volume header.
1150  *
1151  * @param[in]   vcom  pointer command object
1152  * @param[out]  res   object in which to store response packet
1153  *
1154  * @return operation status
1155  *   @retval SYNC_OK volume header returned to caller
1156  *   @retval SYNC_FAILED  bad command packet, or failed to locate volume header
1157  *
1158  * @note this is an FSYNC RPC server stub
1159  *
1160  * @note this procedure handles the following FSSYNC command codes:
1161  *       - FSYNC_VOL_QUERY_HDR
1162  *
1163  * @internal
1164  */
1165 static afs_int32
1166 FSYNC_com_VolHdrQuery(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1167 {
1168     afs_int32 code = SYNC_FAILED;
1169     Error error;
1170     Volume * vp;
1171     int hdr_ok = 0;
1172
1173     if (SYNC_verifyProtocolString(vcom->vop->partName, sizeof(vcom->vop->partName))) {
1174         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1175         goto done;
1176     }
1177     if (res->payload.len < sizeof(VolumeDiskData)) {
1178         res->hdr.reason = SYNC_REASON_PAYLOAD_TOO_BIG;
1179         goto done;
1180     }
1181
1182 #ifdef AFS_DEMAND_ATTACH_FS
1183     vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1184 #else /* !AFS_DEMAND_ATTACH_FS */
1185     vp = VGetVolume_r(&error, vcom->vop->volume);
1186 #endif
1187
1188     if (vp) {
1189         if (FSYNC_partMatch(vcom, vp, 1)) {
1190 #ifdef AFS_DEMAND_ATTACH_FS
1191             if ((vp->header == NULL) ||
1192                 !(V_attachFlags(vp) & VOL_HDR_ATTACHED) ||
1193                 !(V_attachFlags(vp) & VOL_HDR_LOADED)) {
1194                 res->hdr.reason = FSYNC_HDR_NOT_ATTACHED;
1195                 goto done;
1196             }
1197 #else /* !AFS_DEMAND_ATTACH_FS */
1198             if (!vp || !vp->header) {
1199                 res->hdr.reason = FSYNC_HDR_NOT_ATTACHED;
1200                 goto done;
1201             }
1202 #endif /* !AFS_DEMAND_ATTACH_FS */
1203         } else {
1204             res->hdr.reason = FSYNC_WRONG_PART;
1205             goto done;
1206         }
1207     } else {
1208         res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1209         goto done;
1210     }
1211
1212  load_done:
1213     memcpy(res->payload.buf, &V_disk(vp), sizeof(VolumeDiskData));
1214     res->hdr.response_len += sizeof(VolumeDiskData);
1215 #ifndef AFS_DEMAND_ATTACH_FS
1216     VPutVolume_r(vp);
1217 #endif
1218     code = SYNC_OK;
1219
1220  done:
1221     return code;
1222 }
1223
1224 #ifdef AFS_DEMAND_ATTACH_FS
1225 static afs_int32
1226 FSYNC_com_VolOpQuery(FSSYNC_VolOp_command * vcom, SYNC_response * res)
1227 {
1228     afs_int32 code = SYNC_OK;
1229     Error error;
1230     Volume * vp;
1231
1232     vp = VLookupVolume_r(&error, vcom->vop->volume, NULL);
1233
1234     if (vp && vp->pending_vol_op) {
1235         assert(sizeof(FSSYNC_VolOp_info) <= res->payload.len);
1236         memcpy(res->payload.buf, vp->pending_vol_op, sizeof(FSSYNC_VolOp_info));
1237         res->hdr.response_len += sizeof(FSSYNC_VolOp_info);
1238     } else {
1239         if (vp) {
1240             res->hdr.reason = FSYNC_NO_PENDING_VOL_OP;
1241         } else {
1242             res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1243         }
1244         code = SYNC_FAILED;
1245     }
1246     return code;
1247 }
1248 #endif /* AFS_DEMAND_ATTACH_FS */
1249
1250 static afs_int32
1251 FSYNC_com_VnQry(int fd, SYNC_command * com, SYNC_response * res)
1252 {
1253     afs_int32 code = SYNC_OK;
1254     FSSYNC_VnQry_hdr * qry = com->payload.buf;
1255     Volume * vp;
1256     Vnode * vnp;
1257     Error error;
1258
1259     if (com->recv_len != (sizeof(com->hdr) + sizeof(FSSYNC_VnQry_hdr))) {
1260         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1261         res->hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
1262         return SYNC_COM_ERROR;
1263     }
1264
1265 #ifdef AFS_DEMAND_ATTACH_FS
1266     vp = VLookupVolume_r(&error, qry->volume, NULL);
1267 #else /* !AFS_DEMAND_ATTACH_FS */
1268     vp = VGetVolume_r(&error, qry->volume);
1269 #endif /* !AFS_DEMAND_ATTACH_FS */
1270
1271     if (!vp) {
1272         res->hdr.reason = FSYNC_UNKNOWN_VOLID;
1273         code = SYNC_FAILED;
1274         goto done;
1275     }
1276
1277     vnp = VLookupVnode(vp, qry->vnode);
1278     if (!vnp) {
1279         res->hdr.reason = FSYNC_UNKNOWN_VNID;
1280         code = SYNC_FAILED;
1281         goto cleanup;
1282     }
1283
1284     if (Vn_class(vnp)->residentSize > res->payload.len) {
1285         res->hdr.reason = SYNC_REASON_ENCODING_ERROR;
1286         code = SYNC_FAILED;
1287         goto cleanup;
1288     }
1289
1290     memcpy(res->payload.buf, vnp, Vn_class(vnp)->residentSize);
1291     res->hdr.response_len += Vn_class(vnp)->residentSize;
1292
1293  cleanup:
1294 #ifndef AFS_DEMAND_ATTACH_FS
1295     VPutVolume_r(vp);
1296 #endif
1297
1298  done:
1299     return code;
1300 }
1301
1302 static afs_int32
1303 FSYNC_com_StatsOp(int fd, SYNC_command * com, SYNC_response * res)
1304 {
1305     afs_int32 code = SYNC_OK;
1306     FSSYNC_StatsOp_command scom;
1307
1308     if (com->recv_len != (sizeof(com->hdr) + sizeof(FSSYNC_StatsOp_hdr))) {
1309         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1310         res->hdr.flags |= SYNC_FLAG_CHANNEL_SHUTDOWN;
1311         return SYNC_COM_ERROR;
1312     }
1313
1314     scom.hdr = &com->hdr;
1315     scom.sop = (FSSYNC_StatsOp_hdr *) com->payload.buf;
1316     scom.com = com;
1317
1318     switch (com->hdr.command) {
1319     case FSYNC_VOL_STATS_GENERAL:
1320         code = FSYNC_com_StatsOpGeneral(&scom, res);
1321         break;
1322 #ifdef AFS_DEMAND_ATTACH_FS
1323         /* statistics for the following subsystems are only tracked
1324          * for demand attach fileservers */
1325     case FSYNC_VOL_STATS_VICEP:
1326         code = FSYNC_com_StatsOpViceP(&scom, res);
1327         break;
1328     case FSYNC_VOL_STATS_HASH:
1329         code = FSYNC_com_StatsOpHash(&scom, res);
1330         break;
1331     case FSYNC_VOL_STATS_HDR:
1332         code = FSYNC_com_StatsOpHdr(&scom, res);
1333         break;
1334     case FSYNC_VOL_STATS_VLRU:
1335         code = FSYNC_com_StatsOpVLRU(&scom, res);
1336         break;
1337 #endif /* AFS_DEMAND_ATTACH_FS */
1338     default:
1339         code = SYNC_BAD_COMMAND;
1340     }
1341
1342     return code;
1343 }
1344
1345 static afs_int32
1346 FSYNC_com_StatsOpGeneral(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1347 {
1348     afs_int32 code = SYNC_OK;
1349
1350     memcpy(res->payload.buf, &VStats, sizeof(VStats));
1351     res->hdr.response_len += sizeof(VStats);
1352
1353     return code;
1354 }
1355
1356 #ifdef AFS_DEMAND_ATTACH_FS
1357 static afs_int32
1358 FSYNC_com_StatsOpViceP(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1359 {
1360     afs_int32 code = SYNC_OK;
1361     struct DiskPartition64 * dp;
1362     struct DiskPartitionStats64 * stats;
1363
1364     if (SYNC_verifyProtocolString(scom->sop->args.partName, sizeof(scom->sop->args.partName))) {
1365         res->hdr.reason = SYNC_REASON_MALFORMED_PACKET;
1366         code = SYNC_FAILED;
1367         goto done;
1368     }
1369
1370     dp = VGetPartition_r(scom->sop->args.partName, 0);
1371     if (!dp) {
1372         code = SYNC_FAILED;
1373     } else {
1374         stats = (struct DiskPartitionStats64 *) res->payload.buf;
1375         stats->free = dp->free;
1376         stats->totalUsable = dp->totalUsable;
1377         stats->minFree = dp->minFree;
1378         stats->f_files = dp->f_files;
1379         stats->vol_list_len = dp->vol_list.len;
1380         
1381         res->hdr.response_len += sizeof(struct DiskPartitionStats64);
1382     }
1383
1384  done:
1385     return code;
1386 }
1387
1388 static afs_int32
1389 FSYNC_com_StatsOpHash(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1390 {
1391     afs_int32 code = SYNC_OK;
1392     struct VolumeHashChainStats * stats;
1393     struct VolumeHashChainHead * head;
1394
1395     if (scom->sop->args.hash_bucket >= VolumeHashTable.Size) {
1396         return SYNC_FAILED;
1397     }
1398
1399     head = &VolumeHashTable.Table[scom->sop->args.hash_bucket];
1400     stats = (struct VolumeHashChainStats *) res->payload.buf;
1401     stats->table_size = VolumeHashTable.Size;
1402     stats->chain_len = head->len;
1403     stats->chain_cacheCheck = head->cacheCheck;
1404     stats->chain_busy = head->busy;
1405     AssignInt64(head->looks, &stats->chain_looks);
1406     AssignInt64(head->gets, &stats->chain_gets);
1407     AssignInt64(head->reorders, &stats->chain_reorders);
1408
1409     res->hdr.response_len += sizeof(struct VolumeHashChainStats);
1410     
1411     return code;
1412 }
1413
1414 static afs_int32
1415 FSYNC_com_StatsOpHdr(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1416 {
1417     afs_int32 code = SYNC_OK;
1418
1419     memcpy(res->payload.buf, &volume_hdr_LRU.stats, sizeof(volume_hdr_LRU.stats));
1420     res->hdr.response_len += sizeof(volume_hdr_LRU.stats);
1421
1422     return code;
1423 }
1424
1425 static afs_int32
1426 FSYNC_com_StatsOpVLRU(FSSYNC_StatsOp_command * scom, SYNC_response * res)
1427 {
1428     afs_int32 code = SYNC_OK;
1429
1430     code = SYNC_BAD_COMMAND;
1431
1432     return code;
1433 }
1434 #endif /* AFS_DEMAND_ATTACH_FS */
1435
1436 /**
1437  * populate an FSSYNC_VolOp_info object from a command packet object.
1438  *
1439  * @param[in]   vcom  pointer to command packet
1440  * @param[out]  info  pointer to info object which will be populated
1441  *
1442  * @note FSSYNC_VolOp_info objects are attached to Volume objects when
1443  *       a volume operation is commenced.
1444  *
1445  * @internal
1446  */
1447 static void
1448 FSYNC_com_to_info(FSSYNC_VolOp_command * vcom, FSSYNC_VolOp_info * info)
1449 {
1450     memcpy(&info->com, vcom->hdr, sizeof(SYNC_command_hdr));
1451     memcpy(&info->vop, vcom->vop, sizeof(FSSYNC_VolOp_hdr));
1452     info->vol_op_state = FSSYNC_VolOpPending;
1453 }
1454
1455 /**
1456  * check whether command packet partition name matches volume 
1457  * object's partition name.
1458  *
1459  * @param[in] vcom        pointer to command packet
1460  * @param[in] vp          pointer to volume object
1461  * @param[in] match_anon  anon matching control flag (see note below)
1462  *
1463  * @return whether partitions match
1464  *   @retval 0  partitions do NOT match
1465  *   @retval 1  partitions match
1466  *
1467  * @note if match_anon is non-zero, then this function will return a
1468  *       positive match for a zero-length partition string in the
1469  *       command packet.
1470  *
1471  * @internal
1472  */
1473 static int 
1474 FSYNC_partMatch(FSSYNC_VolOp_command * vcom, Volume * vp, int match_anon)
1475 {
1476     return ((match_anon && vcom->vop->partName[0] == 0) ||
1477             (strncmp(vcom->vop->partName, V_partition(vp)->name, 
1478                      sizeof(vcom->vop->partName)) == 0));
1479 }
1480
1481
1482 static void
1483 FSYNC_Drop(int fd)
1484 {
1485     struct offlineInfo *p;
1486     int i;
1487     Error error;
1488     char tvolName[VMAXPATHLEN];
1489
1490     VOL_LOCK;
1491     p = OfflineVolumes[FindHandler(fd)];
1492     for (i = 0; i < MAXOFFLINEVOLUMES; i++) {
1493         if (p[i].volumeID) {
1494
1495             Volume *vp;
1496
1497             tvolName[0] = '/';
1498             sprintf(&tvolName[1], VFORMAT, p[i].volumeID);
1499             vp = VAttachVolumeByName_r(&error, p[i].partName, tvolName,
1500                                        V_VOLUPD);
1501             if (vp)
1502                 VPutVolume_r(vp);
1503             p[i].volumeID = 0;
1504         }
1505     }
1506     VOL_UNLOCK;
1507     RemoveHandler(fd);
1508 #ifdef AFS_NT40_ENV
1509     closesocket(fd);
1510 #else
1511     close(fd);
1512 #endif
1513     AcceptOn();
1514 }
1515
1516 static int AcceptHandler = -1;  /* handler id for accept, if turned on */
1517
1518 static void
1519 AcceptOn()
1520 {
1521     if (AcceptHandler == -1) {
1522         assert(AddHandler(fssync_server_state.fd, FSYNC_newconnection));
1523         AcceptHandler = FindHandler(fssync_server_state.fd);
1524     }
1525 }
1526
1527 static void
1528 AcceptOff()
1529 {
1530     if (AcceptHandler != -1) {
1531         assert(RemoveHandler(fssync_server_state.fd));
1532         AcceptHandler = -1;
1533     }
1534 }
1535
1536 /* The multiple FD handling code. */
1537
1538 static int HandlerFD[MAXHANDLERS];
1539 static int (*HandlerProc[MAXHANDLERS]) ();
1540
1541 static void
1542 InitHandler()
1543 {
1544     register int i;
1545     ObtainWriteLock(&FSYNC_handler_lock);
1546     for (i = 0; i < MAXHANDLERS; i++) {
1547         HandlerFD[i] = -1;
1548         HandlerProc[i] = 0;
1549     }
1550     ReleaseWriteLock(&FSYNC_handler_lock);
1551 }
1552
1553 #if defined(HAVE_POLL) && defined(AFS_PTHREAD_ENV)
1554 static void
1555 CallHandler(struct pollfd *fds, int nfds, int mask)
1556 {
1557     int i;
1558     int handler;
1559     ObtainReadLock(&FSYNC_handler_lock);
1560     for (i = 0; i < nfds; i++) {
1561         if (fds[i].revents & mask) {
1562             handler = FindHandler_r(fds[i].fd);
1563             ReleaseReadLock(&FSYNC_handler_lock);
1564             (*HandlerProc[handler]) (fds[i].fd);
1565             ObtainReadLock(&FSYNC_handler_lock);
1566         }
1567     }
1568     ReleaseReadLock(&FSYNC_handler_lock);
1569 }
1570 #else
1571 static void
1572 CallHandler(fd_set * fdsetp)
1573 {
1574     register int i;
1575     ObtainReadLock(&FSYNC_handler_lock);
1576     for (i = 0; i < MAXHANDLERS; i++) {
1577         if (HandlerFD[i] >= 0 && FD_ISSET(HandlerFD[i], fdsetp)) {
1578             ReleaseReadLock(&FSYNC_handler_lock);
1579             (*HandlerProc[i]) (HandlerFD[i]);
1580             ObtainReadLock(&FSYNC_handler_lock);
1581         }
1582     }
1583     ReleaseReadLock(&FSYNC_handler_lock);
1584 }
1585 #endif
1586
1587 static int
1588 AddHandler(int afd, int (*aproc) ())
1589 {
1590     register int i;
1591     ObtainWriteLock(&FSYNC_handler_lock);
1592     for (i = 0; i < MAXHANDLERS; i++)
1593         if (HandlerFD[i] == -1)
1594             break;
1595     if (i >= MAXHANDLERS) {
1596         ReleaseWriteLock(&FSYNC_handler_lock);
1597         return 0;
1598     }
1599     HandlerFD[i] = afd;
1600     HandlerProc[i] = aproc;
1601     ReleaseWriteLock(&FSYNC_handler_lock);
1602     return 1;
1603 }
1604
1605 static int
1606 FindHandler(register int afd)
1607 {
1608     register int i;
1609     ObtainReadLock(&FSYNC_handler_lock);
1610     for (i = 0; i < MAXHANDLERS; i++)
1611         if (HandlerFD[i] == afd) {
1612             ReleaseReadLock(&FSYNC_handler_lock);
1613             return i;
1614         }
1615     ReleaseReadLock(&FSYNC_handler_lock);       /* just in case */
1616     assert(1 == 2);
1617     return -1;                  /* satisfy compiler */
1618 }
1619
1620 static int
1621 FindHandler_r(register int afd)
1622 {
1623     register int i;
1624     for (i = 0; i < MAXHANDLERS; i++)
1625         if (HandlerFD[i] == afd) {
1626             return i;
1627         }
1628     assert(1 == 2);
1629     return -1;                  /* satisfy compiler */
1630 }
1631
1632 static int
1633 RemoveHandler(register int afd)
1634 {
1635     ObtainWriteLock(&FSYNC_handler_lock);
1636     HandlerFD[FindHandler_r(afd)] = -1;
1637     ReleaseWriteLock(&FSYNC_handler_lock);
1638     return 1;
1639 }
1640
1641 #if defined(HAVE_POLL) && defined(AFS_PTHREAD_ENV)
1642 static void
1643 GetHandler(struct pollfd *fds, int maxfds, int events, int *nfds)
1644 {
1645     int i;
1646     int fdi = 0;
1647     ObtainReadLock(&FSYNC_handler_lock);
1648     for (i = 0; i < MAXHANDLERS; i++)
1649         if (HandlerFD[i] != -1) {
1650             assert(fdi<maxfds);
1651             fds[fdi].fd = HandlerFD[i];
1652             fds[fdi].events = events;
1653             fds[fdi].revents = 0;
1654             fdi++;
1655         }
1656     *nfds = fdi;
1657     ReleaseReadLock(&FSYNC_handler_lock);
1658 }
1659 #else
1660 static void
1661 GetHandler(fd_set * fdsetp, int *maxfdp)
1662 {
1663     register int i;
1664     register int maxfd = -1;
1665     FD_ZERO(fdsetp);
1666     ObtainReadLock(&FSYNC_handler_lock);        /* just in case */
1667     for (i = 0; i < MAXHANDLERS; i++)
1668         if (HandlerFD[i] != -1) {
1669             FD_SET(HandlerFD[i], fdsetp);
1670             if (maxfd < HandlerFD[i])
1671                 maxfd = HandlerFD[i];
1672         }
1673     *maxfdp = maxfd;
1674     ReleaseReadLock(&FSYNC_handler_lock);       /* just in case */
1675 }
1676 #endif /* HAVE_POLL && AFS_PTHREAD_ENV */
1677
1678 #endif /* FSSYNC_BUILD_SERVER */