vol: remove OPENAFS_VOL_STATS
[openafs.git] / src / vol / fssync-debug.c
1 /*
2  * Copyright 2006-2010, Sine Nomine Associates 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
10 /* Main program file. Define globals. */
11 #define MAIN 1
12
13 /*
14  * fssync administration tool
15  */
16
17
18 #include <afsconfig.h>
19 #include <afs/param.h>
20
21 #include <roken.h>
22
23 #ifdef AFS_NT40_ENV
24 #include <WINNT/afsevent.h>
25 #endif
26
27 #include <rx/xdr.h>
28 #include <afs/afsint.h>
29
30 #ifndef AFS_NT40_ENV
31 #include <afs/osi_inode.h>
32 #endif
33
34 #include <afs/cmd.h>
35 #include <afs/dir.h>
36 #include <afs/afsutil.h>
37 #include <afs/fileutil.h>
38
39 #include "nfs.h"
40 #include "lwp.h"
41 #include "lock.h"
42 #include "ihandle.h"
43 #include "vnode.h"
44 #include "volume.h"
45 #include "volume_inline.h"
46 #include "partition.h"
47 #include "daemon_com.h"
48 #include "daemon_com_inline.h"
49 #include "fssync.h"
50 #include "fssync_inline.h"
51 #include "vg_cache.h"
52 #ifdef AFS_NT40_ENV
53 #include <pthread.h>
54 #endif
55
56 int VolumeChanged; /* hack to make dir package happy */
57
58
59 struct volop_state {
60     afs_uint32 volume;
61     afs_uint32 vnode;
62     afs_uint32 unique;
63     char partName[16];
64 };
65
66 struct fssync_state {
67     afs_int32 reason;
68     struct volop_state * vop;
69 };
70
71 #ifndef AFS_DEMAND_ATTACH_FS
72 /* remember argv/argc for later, if we need to re-exec */
73 static char **fssd_argv;
74 static int fssd_argc;
75 #endif
76
77 static int common_prolog(struct cmd_syndesc *, struct fssync_state *);
78 static int common_volop_prolog(struct cmd_syndesc *, struct fssync_state *);
79
80 static int do_volop(struct fssync_state *, afs_int32 command,
81                     SYNC_response * res);
82
83 static int VolOnline(struct cmd_syndesc * as, void * rock);
84 static int VolOffline(struct cmd_syndesc * as, void * rock);
85 static int VolMode(struct cmd_syndesc * as, void * rock);
86 static int VolDetach(struct cmd_syndesc * as, void * rock);
87 static int VolBreakCBKs(struct cmd_syndesc * as, void * rock);
88 static int VolMove(struct cmd_syndesc * as, void * rock);
89 static int VolList(struct cmd_syndesc * as, void * rock);
90 static int VolLeaveOff(struct cmd_syndesc * as, void * rock);
91 static int VolForceAttach(struct cmd_syndesc * as, void * rock);
92 static int VolForceError(struct cmd_syndesc * as, void * rock);
93 static int VolQuery(struct cmd_syndesc * as, void * rock);
94 static int VolHdrQuery(struct cmd_syndesc * as, void * rock);
95 static int VolOpQuery(struct cmd_syndesc * as, void * rock);
96 static int StatsQuery(struct cmd_syndesc * as, void * rock);
97 static int VnQuery(struct cmd_syndesc * as, void * rock);
98
99 static int VGCQuery(struct cmd_syndesc * as, void * rock);
100 static int VGCAdd(struct cmd_syndesc * as, void * rock);
101 static int VGCDel(struct cmd_syndesc * as, void * rock);
102 static int VGCScan(struct cmd_syndesc * as, void * rock);
103 static int VGCScanAll(struct cmd_syndesc * as, void * rock);
104
105 static void print_vol_stats_general(VolPkgStats * stats);
106 static void print_vol_stats_viceP(struct DiskPartitionStats64 * stats);
107 static void print_vol_stats_hash(struct VolumeHashChainStats * stats);
108 #ifdef AFS_DEMAND_ATTACH_FS
109 static void print_vol_stats_hdr(struct volume_hdr_LRU_stats * stats);
110 #endif
111
112 #ifndef AFS_NT40_ENV
113 #include "AFS_component_version_number.c"
114 #endif
115 #define MAX_ARGS 128
116
117 #define COMMON_PARMS_OFFSET    12
118 #define COMMON_PARMS(ts) \
119     cmd_Seek(ts, COMMON_PARMS_OFFSET); \
120     cmd_AddParm(ts, "-reason", CMD_SINGLE, CMD_OPTIONAL, "sync protocol reason code"); \
121     cmd_AddParm(ts, "-programtype", CMD_SINGLE, CMD_OPTIONAL, "program type code")
122
123 #define COMMON_VOLOP_PARMS_OFFSET    10
124 #define COMMON_VOLOP_PARMS(ts) \
125     cmd_Seek(ts, COMMON_VOLOP_PARMS_OFFSET); \
126     cmd_AddParm(ts, "-volumeid", CMD_SINGLE, 0, "volume id"); \
127     cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_OPTIONAL, "partition name")
128
129 #define CUSTOM_PARMS_OFFSET 1
130
131
132 #define VOLOP_PARMS_DECL(ts) \
133     COMMON_VOLOP_PARMS(ts); \
134     COMMON_PARMS(ts)
135 #define COMMON_PARMS_DECL(ts) \
136     COMMON_PARMS(ts)
137
138 int
139 main(int argc, char **argv)
140 {
141     struct cmd_syndesc *ts;
142     int err = 0;
143
144     /* Initialize directory paths */
145     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
146 #ifdef AFS_NT40_ENV
147         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
148 #endif
149         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
150                 argv[0]);
151         exit(2);
152     }
153
154 #ifndef AFS_DEMAND_ATTACH_FS
155     fssd_argv = argv;
156     fssd_argc = argc;
157 #endif
158
159     ts = cmd_CreateSyntax("online", VolOnline, NULL, "bring a volume online (FSYNC_VOL_ON opcode)");
160     VOLOP_PARMS_DECL(ts);
161
162     ts = cmd_CreateSyntax("offline", VolOffline, NULL, "take a volume offline (FSYNC_VOL_OFF opcode)");
163     VOLOP_PARMS_DECL(ts);
164
165     ts = cmd_CreateSyntax("mode", VolMode, NULL, "change volume attach mode (FSYNC_VOL_NEEDVOLUME opcode)");
166     VOLOP_PARMS_DECL(ts);
167     cmd_CreateAlias(ts, "needvolume");
168
169     ts = cmd_CreateSyntax("detach", VolDetach, NULL, "detach a volume (FSYNC_VOL_DONE opcode)");
170     VOLOP_PARMS_DECL(ts);
171
172     ts = cmd_CreateSyntax("callback", VolBreakCBKs, NULL, "break callbacks for volume (FSYNC_VOL_BREAKCBKS opcode)");
173     VOLOP_PARMS_DECL(ts);
174     cmd_CreateAlias(ts, "cbk");
175
176     ts = cmd_CreateSyntax("move", VolMove, NULL, "set volume moved flag (FSYNC_VOL_MOVE opcode)");
177     VOLOP_PARMS_DECL(ts);
178
179     ts = cmd_CreateSyntax("list", VolList, NULL, "sync local volume list (FSYNC_VOL_LISTVOLUMES opcode)");
180     VOLOP_PARMS_DECL(ts);
181     cmd_CreateAlias(ts, "ls");
182
183     ts = cmd_CreateSyntax("leaveoff", VolLeaveOff, 0, "leave volume offline (FSYNC_VOL_LEAVE_OFF opcode)");
184     VOLOP_PARMS_DECL(ts);
185
186     ts = cmd_CreateSyntax("attach", VolForceAttach, 0, "force full attachment (FSYNC_VOL_ATTACH opcode)");
187     VOLOP_PARMS_DECL(ts);
188
189     ts = cmd_CreateSyntax("error", VolForceError, 0, "force into hard error state (FSYNC_VOL_FORCE_ERROR opcode)");
190     VOLOP_PARMS_DECL(ts);
191
192     ts = cmd_CreateSyntax("query", VolQuery, NULL, "get volume structure (FSYNC_VOL_QUERY opcode)");
193     VOLOP_PARMS_DECL(ts);
194     cmd_CreateAlias(ts, "qry");
195
196     ts = cmd_CreateSyntax("header", VolHdrQuery, NULL, "get volume disk data structure (FSYNC_VOL_QUERY_HDR opcode)");
197     VOLOP_PARMS_DECL(ts);
198     cmd_CreateAlias(ts, "hdr");
199
200     ts = cmd_CreateSyntax("volop", VolOpQuery, NULL, "get pending volume operation info (FSYNC_VOL_QUERY_VOP opcode)");
201     VOLOP_PARMS_DECL(ts);
202     cmd_CreateAlias(ts, "vop");
203
204     ts = cmd_CreateSyntax("vnode", VnQuery, NULL, "get vnode structure (FSYNC_VOL_QUERY_VNODE opcode)");
205     cmd_Seek(ts, CUSTOM_PARMS_OFFSET);
206     cmd_AddParm(ts, "-volumeid", CMD_SINGLE, 0, "volume id");
207     cmd_AddParm(ts, "-vnodeid", CMD_SINGLE, 0, "vnode id");
208     cmd_AddParm(ts, "-unique", CMD_SINGLE, 0, "uniquifier");
209     cmd_AddParm(ts, "-partition", CMD_SINGLE, 0, "partition name");
210     COMMON_PARMS_DECL(ts);
211
212     ts = cmd_CreateSyntax("stats", StatsQuery, NULL, "see 'stats help' for more information");
213     cmd_Seek(ts, CUSTOM_PARMS_OFFSET);
214     cmd_AddParm(ts, "-cmd", CMD_SINGLE, 0, "subcommand");
215     cmd_AddParm(ts, "-arg1", CMD_SINGLE, CMD_OPTIONAL, "arg1");
216     cmd_AddParm(ts, "-arg2", CMD_SINGLE, CMD_OPTIONAL, "arg2");
217     COMMON_PARMS_DECL(ts);
218
219     ts = cmd_CreateSyntax("vgcquery", VGCQuery, 0, "query volume group cache (FSYNC_VG_QUERY opcode)");
220     cmd_Seek(ts, CUSTOM_PARMS_OFFSET);
221     cmd_AddParm(ts, "-partition", CMD_SINGLE, 0, "partition name");
222     cmd_AddParm(ts, "-volumeid", CMD_SINGLE, 0, "volume id");
223     COMMON_PARMS_DECL(ts);
224     cmd_CreateAlias(ts, "vgcqry");
225
226     ts = cmd_CreateSyntax("vgcadd", VGCAdd, 0, "add entry to volume group cache (FSYNC_VG_ADD opcode)");
227     cmd_Seek(ts, CUSTOM_PARMS_OFFSET);
228     cmd_AddParm(ts, "-partition", CMD_SINGLE, 0, "partition name");
229     cmd_AddParm(ts, "-parent", CMD_SINGLE, 0, "parent volume id");
230     cmd_AddParm(ts, "-child", CMD_SINGLE, 0, "child volume id");
231     COMMON_PARMS_DECL(ts);
232
233     ts = cmd_CreateSyntax("vgcdel", VGCDel, 0, "delete entry from volume group cache (FSYNC_VG_DEL opcode)");
234     cmd_Seek(ts, CUSTOM_PARMS_OFFSET);
235     cmd_AddParm(ts, "-partition", CMD_SINGLE, 0, "partition name");
236     cmd_AddParm(ts, "-parent", CMD_SINGLE, 0, "parent volume id");
237     cmd_AddParm(ts, "-child", CMD_SINGLE, 0, "child volume id");
238     COMMON_PARMS_DECL(ts);
239
240     ts = cmd_CreateSyntax("vgcscan", VGCScan, 0,
241                           "start volume group cache re-scan"
242                           " (FSYNC_VG_SCAN opcode)");
243     cmd_Seek(ts, CUSTOM_PARMS_OFFSET);
244     cmd_AddParm(ts, "-partition", CMD_SINGLE, 0, "partition name");
245     COMMON_PARMS_DECL(ts);
246
247     ts = cmd_CreateSyntax("vgcscanall", VGCScanAll, 0,
248                           "start whole-server volume group cache re-scan"
249                           " (FSYNC_VG_SCAN_ALL opcode)");
250     COMMON_PARMS_DECL(ts);
251
252     err = cmd_Dispatch(argc, argv);
253     exit(err);
254 }
255
256 #ifdef AFS_DEMAND_ATTACH_FS
257 # define dafs_prolog()
258 #else
259 /* Try to detect if the fileserver is DAFS, and if so, re-exec as the
260  * DAFS-enabled fssync-debug (dafssync_debug). If we fail to detect or
261  * exec, just try to proceed anyway as if the server is not DAFS */
262 static void
263 dafs_prolog(void)
264 {
265     SYNC_response res;
266     SYNC_PROTO_BUF_DECL(res_buf);
267     afs_int32 code;
268     char *dfssd;
269
270     res.payload.len = SYNC_PROTO_MAX_LEN;
271     res.payload.buf = res_buf;
272
273     /* LISTVOLUMES is a no-op; we just want to get the response header flags
274      * to see if the server reports itself as DAFS or not */
275     code = FSYNC_VolOp(0, NULL, FSYNC_VOL_LISTVOLUMES, FSYNC_WHATEVER, &res);
276     if (code) {
277         /* probably failed to contact the fileserver; later code will provide
278          * some warning/error indication */
279         return;
280     }
281
282     if (!(res.hdr.flags & SYNC_FLAG_DAFS_EXTENSIONS)) {
283         /* fileserver is not DAFS, so we don't need to do anything */
284         return;
285     }
286
287     dfssd = afs_exec_alt(fssd_argc, fssd_argv, "da", NULL);
288
289     fprintf(stderr, "\n*** server asserted demand attach extensions, but we failed\n"
290                     "*** to exec a DAFS-enabled fssync-debug '%s' (errno=%d);\n"
291                     "*** attempting to proceed without it.\n\n", dfssd, errno);
292
293     free(dfssd);
294 }
295 #endif /* !AFS_DEMAND_ATTACH_FS */
296
297 static int
298 common_prolog(struct cmd_syndesc * as, struct fssync_state * state)
299 {
300     struct cmd_item *ti;
301     VolumePackageOptions opts;
302
303 #ifdef AFS_NT40_ENV
304     if (afs_winsockInit() < 0) {
305         Exit(1);
306     }
307 #endif
308
309     VOptDefaults(debugUtility, &opts);
310     if (VInitVolumePackage2(debugUtility, &opts)) {
311         /* VInitVolumePackage2 can fail on e.g. partition attachment errors,
312          * but we don't really care, since all we're doing is trying to use
313          * FSSYNC */
314         fprintf(stderr, "errors encountered initializing volume package, but "
315                         "trying to continue anyway\n");
316     }
317     DInit(1);
318
319     if ((ti = as->parms[COMMON_PARMS_OFFSET].items)) {  /* -reason */
320         state->reason = atoi(ti->data);
321     } else {
322         state->reason = FSYNC_WHATEVER;
323     }
324
325     if ((ti = as->parms[COMMON_PARMS_OFFSET+1].items)) {        /* -programtype */
326         if (!strcmp(ti->data, "fileServer")) {
327             programType = fileServer;
328         } else if (!strcmp(ti->data, "volumeUtility")) {
329             programType = volumeUtility;
330         } else if (!strcmp(ti->data, "salvager")) {
331             programType = salvager;
332         } else if (!strcmp(ti->data, "salvageServer")) {
333             programType = salvageServer;
334         } else if (!strcmp(ti->data, "volumeServer")) {
335             programType = volumeServer;
336         } else if (!strcmp(ti->data, "volumeSalvager")) {
337             programType = volumeSalvager;
338         } else {
339             programType = (ProgramType) atoi(ti->data);
340         }
341     }
342
343     VConnectFS();
344
345     return 0;
346 }
347
348 static int
349 common_volop_prolog(struct cmd_syndesc * as, struct fssync_state * state)
350 {
351     struct cmd_item *ti;
352
353     state->vop = (struct volop_state *) calloc(1, sizeof(struct volop_state));
354     osi_Assert(state->vop != NULL);
355
356     if ((ti = as->parms[COMMON_VOLOP_PARMS_OFFSET].items)) {    /* -volumeid */
357         state->vop->volume = atoi(ti->data);
358     } else {
359         fprintf(stderr, "required argument -volumeid not given\n");
360     }
361
362     if ((ti = as->parms[COMMON_VOLOP_PARMS_OFFSET+1].items)) {  /* -partition */
363         strlcpy(state->vop->partName, ti->data, sizeof(state->vop->partName));
364     } else {
365         memset(state->vop->partName, 0, sizeof(state->vop->partName));
366     }
367
368     return 0;
369 }
370
371 static int
372 debug_response(afs_int32 code, SYNC_response * res)
373 {
374     switch (code) {
375     case SYNC_OK:
376     case SYNC_DENIED:
377         break;
378     default:
379         fprintf(stderr, "warning: response code indicates possible protocol error.\n");
380     }
381
382     fprintf(stderr, "FSSYNC service returned %d (%s)\n", code, SYNC_res2string(code));
383
384     if (res) {
385         fprintf(stderr, "protocol header response code was %d (%s)\n",
386                 res->hdr.response, SYNC_res2string(res->hdr.response));
387         fprintf(stderr, "protocol reason code was %d (%s)\n",
388                 res->hdr.reason, FSYNC_reason2string(res->hdr.reason));
389     }
390
391     return 0;
392 }
393
394 static int
395 do_volop(struct fssync_state * state, afs_int32 command, SYNC_response * res)
396 {
397     afs_int32 code;
398     SYNC_PROTO_BUF_DECL(res_buf);
399     SYNC_response res_l;
400
401     if (!res) {
402         res = &res_l;
403         res->payload.len = SYNC_PROTO_MAX_LEN;
404         res->payload.buf = res_buf;
405     }
406
407     fprintf(stderr, "calling FSYNC_VolOp with command code %d (%s)\n",
408             command, FSYNC_com2string(command));
409
410     code = FSYNC_VolOp(state->vop->volume,
411                        state->vop->partName,
412                        command,
413                        state->reason,
414                        res);
415
416     debug_response(code, res);
417
418     VDisconnectFS();
419
420     return 0;
421
422 }
423
424
425 #define ENUMTOSTRING(en)  #en
426 #define ENUMCASE(en) \
427     case en: return ENUMTOSTRING(en)
428
429 #define FLAGTOSTRING(fl)  #fl
430 #define FLAGCASE(bitstr, fl, str, count) \
431     do { \
432         if ((bitstr) & (fl)) { \
433             if (count) \
434                 strlcat((str), " | ", sizeof(str)); \
435             strlcat((str), FLAGTOSTRING(fl), sizeof(str)); \
436             (count)++; \
437         } \
438     } while (0)
439
440 static int
441 VolOnline(struct cmd_syndesc * as, void * rock)
442 {
443     struct fssync_state state;
444
445     common_prolog(as, &state);
446     common_volop_prolog(as, &state);
447
448     if (state.vop->partName==0 || *(state.vop->partName)==0) {
449         fprintf(stderr, "required argument -partition not given\n");
450         return -1;
451     }
452     do_volop(&state, FSYNC_VOL_ON, NULL);
453
454     return 0;
455 }
456
457 static int
458 VolOffline(struct cmd_syndesc * as, void * rock)
459 {
460     struct fssync_state state;
461
462     common_prolog(as, &state);
463     common_volop_prolog(as, &state);
464
465     do_volop(&state, FSYNC_VOL_OFF, NULL);
466
467     return 0;
468 }
469
470 static int
471 VolMode(struct cmd_syndesc * as, void * rock)
472 {
473     struct fssync_state state;
474
475     common_prolog(as, &state);
476     common_volop_prolog(as, &state);
477
478     do_volop(&state, FSYNC_VOL_NEEDVOLUME, NULL);
479
480     return 0;
481 }
482
483 static int
484 VolDetach(struct cmd_syndesc * as, void * rock)
485 {
486     struct fssync_state state;
487
488     common_prolog(as, &state);
489     common_volop_prolog(as, &state);
490
491     do_volop(&state, FSYNC_VOL_DONE, NULL);
492
493     return 0;
494 }
495
496 static int
497 VolBreakCBKs(struct cmd_syndesc * as, void * rock)
498 {
499     struct fssync_state state;
500
501     common_prolog(as, &state);
502     common_volop_prolog(as, &state);
503
504     do_volop(&state, FSYNC_VOL_BREAKCBKS, NULL);
505
506     return 0;
507 }
508
509 static int
510 VolMove(struct cmd_syndesc * as, void * rock)
511 {
512     struct fssync_state state;
513
514     common_prolog(as, &state);
515     common_volop_prolog(as, &state);
516
517     do_volop(&state, FSYNC_VOL_MOVE, NULL);
518
519     return 0;
520 }
521
522 static int
523 VolList(struct cmd_syndesc * as, void * rock)
524 {
525     struct fssync_state state;
526
527     common_prolog(as, &state);
528     common_volop_prolog(as, &state);
529
530     do_volop(&state, FSYNC_VOL_LISTVOLUMES, NULL);
531
532     return 0;
533 }
534
535 static int
536 VolLeaveOff(struct cmd_syndesc * as, void * rock)
537 {
538     struct fssync_state state;
539
540     common_prolog(as, &state);
541     common_volop_prolog(as, &state);
542
543     do_volop(&state, FSYNC_VOL_LEAVE_OFF, NULL);
544
545     return 0;
546 }
547
548 static int
549 VolForceAttach(struct cmd_syndesc * as, void * rock)
550 {
551     struct fssync_state state;
552
553     common_prolog(as, &state);
554     common_volop_prolog(as, &state);
555
556     do_volop(&state, FSYNC_VOL_ATTACH, NULL);
557
558     return 0;
559 }
560
561 static int
562 VolForceError(struct cmd_syndesc * as, void * rock)
563 {
564     struct fssync_state state;
565
566     common_prolog(as, &state);
567     common_volop_prolog(as, &state);
568
569     do_volop(&state, FSYNC_VOL_FORCE_ERROR, NULL);
570
571     return 0;
572 }
573
574 #ifdef AFS_DEMAND_ATTACH_FS
575 static char *
576 vol_state_to_string(VolState state)
577 {
578     switch (state) {
579         ENUMCASE(VOL_STATE_UNATTACHED);
580         ENUMCASE(VOL_STATE_PREATTACHED);
581         ENUMCASE(VOL_STATE_ATTACHING);
582         ENUMCASE(VOL_STATE_ATTACHED);
583         ENUMCASE(VOL_STATE_UPDATING);
584         ENUMCASE(VOL_STATE_GET_BITMAP);
585         ENUMCASE(VOL_STATE_HDR_LOADING);
586         ENUMCASE(VOL_STATE_HDR_ATTACHING);
587         ENUMCASE(VOL_STATE_SHUTTING_DOWN);
588         ENUMCASE(VOL_STATE_GOING_OFFLINE);
589         ENUMCASE(VOL_STATE_OFFLINING);
590         ENUMCASE(VOL_STATE_DETACHING);
591         ENUMCASE(VOL_STATE_SALVSYNC_REQ);
592         ENUMCASE(VOL_STATE_SALVAGING);
593         ENUMCASE(VOL_STATE_ERROR);
594         ENUMCASE(VOL_STATE_VNODE_ALLOC);
595         ENUMCASE(VOL_STATE_VNODE_GET);
596         ENUMCASE(VOL_STATE_VNODE_CLOSE);
597         ENUMCASE(VOL_STATE_VNODE_RELEASE);
598         ENUMCASE(VOL_STATE_VLRU_ADD);
599         ENUMCASE(VOL_STATE_DELETED);
600         ENUMCASE(VOL_STATE_SALVAGE_REQ);
601         ENUMCASE(VOL_STATE_FREED);
602     default:
603         return "**UNKNOWN**";
604     }
605 }
606
607 static char *
608 vol_flags_to_string(afs_uint16 flags)
609 {
610     static char str[256];
611     int count = 0;
612     str[0]='\0';
613
614     FLAGCASE(flags, VOL_HDR_ATTACHED, str, count);
615     FLAGCASE(flags, VOL_HDR_LOADED, str, count);
616     FLAGCASE(flags, VOL_HDR_IN_LRU, str, count);
617     FLAGCASE(flags, VOL_IN_HASH, str, count);
618     FLAGCASE(flags, VOL_ON_VBYP_LIST, str, count);
619     FLAGCASE(flags, VOL_IS_BUSY, str, count);
620     FLAGCASE(flags, VOL_ON_VLRU, str, count);
621     FLAGCASE(flags, VOL_HDR_DONTSALV, str, count);
622     FLAGCASE(flags, VOL_LOCKED, str, count);
623
624     return str;
625 }
626
627 static char *
628 vlru_idx_to_string(int idx)
629 {
630     switch (idx) {
631         ENUMCASE(VLRU_QUEUE_NEW);
632         ENUMCASE(VLRU_QUEUE_MID);
633         ENUMCASE(VLRU_QUEUE_OLD);
634         ENUMCASE(VLRU_QUEUE_CANDIDATE);
635         ENUMCASE(VLRU_QUEUE_HELD);
636         ENUMCASE(VLRU_QUEUE_INVALID);
637     default:
638         return "**UNKNOWN**";
639     }
640 }
641
642
643 static char *
644 vn_state_to_string(VnState state)
645 {
646     switch (state) {
647         ENUMCASE(VN_STATE_INVALID);
648         ENUMCASE(VN_STATE_RELEASING);
649         ENUMCASE(VN_STATE_CLOSING);
650         ENUMCASE(VN_STATE_ALLOC);
651         ENUMCASE(VN_STATE_ONLINE);
652         ENUMCASE(VN_STATE_LOAD);
653         ENUMCASE(VN_STATE_EXCLUSIVE);
654         ENUMCASE(VN_STATE_STORE);
655         ENUMCASE(VN_STATE_READ);
656         ENUMCASE(VN_STATE_ERROR);
657     default:
658         return "**UNKNOWN**";
659     }
660 }
661
662 static char *
663 vn_flags_to_string(afs_uint32 flags)
664 {
665     static char str[128];
666     int count = 0;
667     str[0]='\0';
668
669     FLAGCASE(flags, VN_ON_HASH, str, count);
670     FLAGCASE(flags, VN_ON_LRU, str, count);
671     FLAGCASE(flags, VN_ON_VVN, str, count);
672
673     return str;
674 }
675 #endif
676
677 static int
678 VolQuery(struct cmd_syndesc * as, void * rock)
679 {
680     struct fssync_state state;
681     SYNC_PROTO_BUF_DECL(res_buf);
682     SYNC_response res;
683     Volume v;
684
685     dafs_prolog();
686
687     res.hdr.response_len = sizeof(res.hdr);
688     res.payload.buf = res_buf;
689     res.payload.len = SYNC_PROTO_MAX_LEN;
690
691     common_prolog(as, &state);
692     common_volop_prolog(as, &state);
693
694     do_volop(&state, FSYNC_VOL_QUERY, &res);
695
696     if (res.hdr.response == SYNC_OK) {
697         memcpy(&v, res.payload.buf, sizeof(Volume));
698
699         printf("volume = {\n");
700         printf("\thashid          = %u\n", v.hashid);
701         printf("\theader          = %p\n", v.header);
702         printf("\tdevice          = %d\n", v.device);
703         printf("\tpartition       = %p\n", v.partition);
704         printf("\tlinkHandle      = %p\n", v.linkHandle);
705         printf("\tnextVnodeUnique = %u\n", v.nextVnodeUnique);
706         printf("\tdiskDataHandle  = %p\n", v.diskDataHandle);
707         printf("\tvnodeHashOffset = %u\n", v.vnodeHashOffset);
708         printf("\tshuttingDown    = %d\n", v.shuttingDown);
709         printf("\tgoingOffline    = %d\n", v.goingOffline);
710         printf("\tcacheCheck      = %u\n", v.cacheCheck);
711         printf("\tnUsers          = %d\n", v.nUsers);
712         printf("\tneedsPutBack    = %d\n", v.needsPutBack);
713         printf("\tspecialStatus   = %d\n", v.specialStatus);
714         printf("\tupdateTime      = %u\n", v.updateTime);
715
716         printf("\tvnodeIndex[vSmall] = {\n");
717         printf("\t\thandle       = %p\n", v.vnodeIndex[vSmall].handle);
718         printf("\t\tbitmap       = %p\n", v.vnodeIndex[vSmall].bitmap);
719         printf("\t\tbitmapSize   = %u\n", v.vnodeIndex[vSmall].bitmapSize);
720         printf("\t\tbitmapOffset = %u\n", v.vnodeIndex[vSmall].bitmapOffset);
721         printf("\t}\n");
722         printf("\tvnodeIndex[vLarge] = {\n");
723         printf("\t\thandle       = %p\n", v.vnodeIndex[vLarge].handle);
724         printf("\t\tbitmap       = %p\n", v.vnodeIndex[vLarge].bitmap);
725         printf("\t\tbitmapSize   = %u\n", v.vnodeIndex[vLarge].bitmapSize);
726         printf("\t\tbitmapOffset = %u\n", v.vnodeIndex[vLarge].bitmapOffset);
727         printf("\t}\n");
728 #ifdef AFS_DEMAND_ATTACH_FS
729         if (res.hdr.flags & SYNC_FLAG_DAFS_EXTENSIONS) {
730             printf("\tupdateTime      = %u\n", v.updateTime);
731             printf("\tattach_state    = %s\n", vol_state_to_string(v.attach_state));
732             printf("\tattach_flags    = %s\n", vol_flags_to_string(v.attach_flags));
733             printf("\tnWaiters        = %d\n", v.nWaiters);
734             printf("\tchainCacheCheck = %d\n", v.chainCacheCheck);
735
736             /* online salvage structure */
737             printf("\tsalvage = {\n");
738             printf("\t\tprio      = %u\n", v.salvage.prio);
739             printf("\t\treason    = %d\n", v.salvage.reason);
740             printf("\t\trequested = %d\n", v.salvage.requested);
741             printf("\t\tscheduled = %d\n", v.salvage.scheduled);
742             printf("\t}\n");
743
744             /* statistics structure */
745             printf("\tstats = {\n");
746
747             printf("\t\thash_lookups = %"AFS_INT64_FMT"\n",
748                    v.stats.hash_lookups);
749             printf("\t\thash_short_circuits = %"AFS_INT64_FMT"\n",
750                    v.stats.hash_short_circuits);
751             printf("\t\thdr_loads = %"AFS_INT64_FMT"\n",
752                    v.stats.hdr_loads);
753             printf("\t\thdr_gets = %"AFS_INT64_FMT"\n",
754                    v.stats.hdr_gets);
755             printf("\t\t}\n");
756
757             printf("\t\tattaches         = %u\n", v.stats.attaches);
758             printf("\t\tsoft_detaches    = %u\n", v.stats.soft_detaches);
759             printf("\t\tsalvages         = %u\n", v.stats.salvages);
760             printf("\t\tvol_ops          = %u\n", v.stats.vol_ops);
761
762             printf("\t\tlast_attach      = %u\n", v.stats.last_attach);
763             printf("\t\tlast_get         = %u\n", v.stats.last_get);
764             printf("\t\tlast_promote     = %u\n", v.stats.last_promote);
765             printf("\t\tlast_hdr_get     = %u\n", v.stats.last_hdr_get);
766             printf("\t\tlast_hdr_load    = %u\n", v.stats.last_hdr_load);
767             printf("\t\tlast_salvage     = %u\n", v.stats.last_salvage);
768             printf("\t\tlast_salvage_req = %u\n", v.stats.last_salvage_req);
769             printf("\t\tlast_vol_op      = %u\n", v.stats.last_vol_op);
770             printf("\t}\n");
771
772             /* VLRU state */
773             printf("\tvlru = {\n");
774             printf("\t\tidx = %d (%s)\n",
775                    v.vlru.idx, vlru_idx_to_string(v.vlru.idx));
776             printf("\t}\n");
777
778             /* volume op state */
779             printf("\tpending_vol_op  = %p\n", v.pending_vol_op);
780         }
781 #else /* !AFS_DEMAND_ATTACH_FS */
782         if (res.hdr.flags & SYNC_FLAG_DAFS_EXTENSIONS) {
783             printf("*** server asserted demand attach extensions. this fssync-debug\n"
784                    "*** is not built to recognize those extensions. please use an\n"
785                    "*** fssync-debug with demand attach if you need to dump dafs\n"
786                    "*** extended state.\n");
787         }
788 #endif /* !AFS_DEMAND_ATTACH_FS */
789         printf("}\n");
790     }
791
792     return 0;
793 }
794
795 static int
796 VolHdrQuery(struct cmd_syndesc * as, void * rock)
797 {
798     struct fssync_state state;
799     SYNC_PROTO_BUF_DECL(res_buf);
800     SYNC_response res;
801     VolumeDiskData v;
802     int i;
803
804     res.hdr.response_len = sizeof(res.hdr);
805     res.payload.buf = res_buf;
806     res.payload.len = SYNC_PROTO_MAX_LEN;
807
808     common_prolog(as, &state);
809     common_volop_prolog(as, &state);
810
811     do_volop(&state, FSYNC_VOL_QUERY_HDR, &res);
812
813     if (res.hdr.response == SYNC_OK) {
814         memcpy(&v, res.payload.buf, sizeof(VolumeDiskData));
815
816         printf("VolumeDiskData = {\n");
817         printf("\tstamp = {\n");
818         printf("\t\tmagic   = 0x%x\n", v.stamp.magic);
819         printf("\t\tversion = %u\n", v.stamp.version);
820         printf("\t}\n");
821
822         printf("\tid               = %u\n", v.id);
823         printf("\tname             = '%s'\n", v.name);
824         if (v.inUse != 0) {
825             printf("\tinUse            = %d (%s)\n", v.inUse, VPTypeToString(v.inUse));
826         } else {
827             printf("\tinUse            = %d (no)\n", v.inUse);
828         }
829         printf("\tinService        = %d\n", v.inService);
830         printf("\tblessed          = %d\n", v.blessed);
831         printf("\tneedsSalvaged    = %d\n", v.needsSalvaged);
832         printf("\tuniquifier       = %u\n", v.uniquifier);
833         printf("\ttype             = %d\n", v.type);
834         printf("\tparentId         = %u\n", v.parentId);
835         printf("\tcloneId          = %u\n", v.cloneId);
836         printf("\tbackupId         = %u\n", v.backupId);
837         printf("\trestoredFromId   = %u\n", v.restoredFromId);
838         printf("\tneedsCallback    = %d\n", v.needsCallback);
839         printf("\tdestroyMe        = %d\n", v.destroyMe);
840         printf("\tdontSalvage      = %d\n", v.dontSalvage);
841         printf("\tmaxquota         = %d\n", v.maxquota);
842         printf("\tminquota         = %d\n", v.minquota);
843         printf("\tmaxfiles         = %d\n", v.maxfiles);
844         printf("\taccountNumber    = %u\n", v.accountNumber);
845         printf("\towner            = %u\n", v.owner);
846         printf("\tfilecount        = %d\n", v.filecount);
847         printf("\tdiskused         = %d\n", v.diskused);
848         printf("\tdayUse           = %d\n", v.dayUse);
849         for (i = 0; i < 7; i++) {
850             printf("\tweekUse[%d]       = %d\n", i, v.weekUse[i]);
851         }
852         printf("\tdayUseDate       = %u\n", v.dayUseDate);
853         printf("\tcreationDate     = %u\n", v.creationDate);
854         printf("\taccessDate       = %u\n", v.accessDate);
855         printf("\tupdateDate       = %u\n", v.updateDate);
856         printf("\texpirationDate   = %u\n", v.expirationDate);
857         printf("\tbackupDate       = %u\n", v.backupDate);
858         printf("\tcopyDate         = %u\n", v.copyDate);
859         printf("\tstat_initialized = %d\n", v.stat_initialized);
860         printf("}\n");
861     }
862
863     return 0;
864 }
865
866 static int
867 VolOpQuery(struct cmd_syndesc * as, void * rock)
868 {
869     struct fssync_state state;
870     SYNC_PROTO_BUF_DECL(res_buf);
871     SYNC_response res;
872     FSSYNC_VolOp_info vop;
873
874     res.hdr.response_len = sizeof(res.hdr);
875     res.payload.buf = res_buf;
876     res.payload.len = SYNC_PROTO_MAX_LEN;
877
878     common_prolog(as, &state);
879     common_volop_prolog(as, &state);
880
881     do_volop(&state, FSYNC_VOL_QUERY_VOP, &res);
882
883     if (!(res.hdr.flags & SYNC_FLAG_DAFS_EXTENSIONS)) {
884         printf("*** file server not compiled with demand attach extensions.\n");
885         printf("*** pending volume operation metadata not available.\n");
886     }
887
888     if (res.hdr.response == SYNC_OK) {
889         memcpy(&vop, res.payload.buf, sizeof(FSSYNC_VolOp_info));
890
891         printf("pending_vol_op = {\n");
892
893         printf("\tcom = {\n");
894         printf("\t\tproto_version  = %u\n", vop.com.proto_version);
895         printf("\t\tpkt_seq        = %u\n", vop.com.pkt_seq);
896         printf("\t\tcom_seq        = %u\n", vop.com.com_seq);
897         printf("\t\tprogramType    = %d (%s)\n",
898                vop.com.programType, VPTypeToString(vop.com.programType));
899         printf("\t\tpid            = %d\n", vop.com.pid);
900         printf("\t\ttid            = %d\n", vop.com.tid);
901         printf("\t\tcommand        = %d (%s)\n",
902                vop.com.command, FSYNC_com2string(vop.com.command));
903         printf("\t\treason         = %d (%s)\n",
904                vop.com.reason, FSYNC_reason2string(vop.com.reason));
905         printf("\t\tcommand_len    = %u\n", vop.com.command_len);
906         printf("\t\tflags          = 0x%lux\n", afs_printable_uint32_lu(vop.com.flags));
907         printf("\t}\n");
908
909         printf("\tvop = {\n");
910         printf("\t\tvolume         = %u\n", vop.vop.volume);
911         if (strnlen(vop.vop.partName, sizeof(vop.vop.partName)) <
912             sizeof(vop.vop.partName)) {
913             printf("\t\tpartName       = '%s'\n", vop.vop.partName);
914         } else {
915             printf("\t\tpartName       = (illegal string)\n");
916         }
917         printf("\t}\n");
918
919         printf("}\n");
920     }
921
922     return 0;
923 }
924
925 static int
926 vn_prolog(struct cmd_syndesc * as, struct fssync_state * state)
927 {
928     struct cmd_item *ti;
929
930     state->vop = (struct volop_state *) calloc(1, sizeof(struct volop_state));
931     osi_Assert(state->vop != NULL);
932
933     if ((ti = as->parms[CUSTOM_PARMS_OFFSET].items)) {  /* -volumeid */
934         state->vop->volume = atoi(ti->data);
935     } else {
936         fprintf(stderr, "required argument -volumeid not given\n");
937     }
938
939     if ((ti = as->parms[CUSTOM_PARMS_OFFSET+1].items)) {        /* -vnodeid */
940         state->vop->vnode = atoi(ti->data);
941     } else {
942         fprintf(stderr, "required argument -vnodeid not given\n");
943     }
944
945     if ((ti = as->parms[CUSTOM_PARMS_OFFSET+2].items)) {        /* -unique */
946         state->vop->unique = atoi(ti->data);
947     } else {
948         state->vop->unique = 0;
949     }
950
951     if ((ti = as->parms[COMMON_VOLOP_PARMS_OFFSET+3].items)) {  /* -partition */
952         strlcpy(state->vop->partName, ti->data, sizeof(state->vop->partName));
953     } else {
954         memset(state->vop->partName, 0, sizeof(state->vop->partName));
955     }
956
957     return 0;
958 }
959
960 static int
961 do_vnqry(struct fssync_state * state, SYNC_response * res)
962 {
963     afs_int32 code;
964     int command = FSYNC_VOL_QUERY_VNODE;
965     FSSYNC_VnQry_hdr qry;
966
967     qry.volume = state->vop->volume;
968     qry.vnode = state->vop->vnode;
969     qry.unique = state->vop->unique;
970     qry.spare = 0;
971     strlcpy(qry.partName, state->vop->partName, sizeof(qry.partName));
972
973     fprintf(stderr, "calling FSYNC_GenericOp with command code %d (%s)\n",
974             command, FSYNC_com2string(command));
975
976     code = FSYNC_GenericOp(&qry, sizeof(qry), command, FSYNC_OPERATOR, res);
977
978     debug_response(code, res);
979
980     VDisconnectFS();
981
982     return 0;
983 }
984
985 static int
986 VnQuery(struct cmd_syndesc * as, void * rock)
987 {
988     struct fssync_state state;
989     SYNC_PROTO_BUF_DECL(res_buf);
990     SYNC_response res;
991     Vnode v;
992
993     dafs_prolog();
994
995     res.hdr.response_len = sizeof(res.hdr);
996     res.payload.buf = res_buf;
997     res.payload.len = SYNC_PROTO_MAX_LEN;
998
999     common_prolog(as, &state);
1000     vn_prolog(as, &state);
1001
1002     do_vnqry(&state, &res);
1003
1004     if (res.hdr.response == SYNC_OK) {
1005         memcpy(&v, res.payload.buf, sizeof(Vnode));
1006
1007         printf("vnode = {\n");
1008
1009         printf("\tvid_hash = {\n");
1010         printf("\t\tnext = %p\n", v.vid_hash.next);
1011         printf("\t\tprev = %p\n", v.vid_hash.prev);
1012         printf("\t}\n");
1013
1014         printf("\thashNext        = %p\n", v.hashNext);
1015         printf("\tlruNext         = %p\n", v.lruNext);
1016         printf("\tlruPrev         = %p\n", v.lruPrev);
1017         printf("\thashIndex       = %hu\n", v.hashIndex);
1018         printf("\tchanged_newTime = %u\n", (unsigned int) v.changed_newTime);
1019         printf("\tchanged_oldTime = %u\n", (unsigned int) v.changed_oldTime);
1020         printf("\tdelete          = %u\n", (unsigned int) v.delete);
1021         printf("\tvnodeNumber     = %u\n", v.vnodeNumber);
1022         printf("\tvolumePtr       = %p\n", v.volumePtr);
1023         printf("\tnUsers          = %u\n", v.nUsers);
1024         printf("\tcacheCheck      = %u\n", v.cacheCheck);
1025
1026 #ifdef AFS_DEMAND_ATTACH_FS
1027         if (!(res.hdr.flags & SYNC_FLAG_DAFS_EXTENSIONS)) {
1028             printf("*** this fssync-debug is built to expect demand attach extensions.\n"
1029                    "*** server asserted that is was not compiled with demand attach.\n"
1030                    "*** please use an fssync-debug without demand attach to match your\n"
1031                    "*** server.\n");
1032             goto done;
1033         }
1034
1035         printf("\tnReaders        = %u\n", v.nReaders);
1036         printf("\tvn_state_flags  = %s\n", vn_flags_to_string(v.vn_state_flags));
1037         printf("\tvn_state        = %s\n", vn_state_to_string(v.vn_state));
1038 #else
1039         if (res.hdr.flags & SYNC_FLAG_DAFS_EXTENSIONS) {
1040             printf("*** server asserted demand attach extensions. this fssync-debug is not\n"
1041                    "*** built to recognize those extensions. please use an fssync-debug\n"
1042                    "*** with demand attach to match your server.\n");
1043             goto done;
1044         }
1045 #endif /* !AFS_DEMAND_ATTACH_FS */
1046
1047         printf("\tvcp             = %p\n", v.vcp);
1048         printf("\thandle          = %p\n", v.handle);
1049
1050         printf("\tdisk = {\n");
1051         printf("\t\ttype              = %u\n", v.disk.type);
1052         printf("\t\tcloned            = %u\n", v.disk.cloned);
1053         printf("\t\tmodeBits          = %u\n", v.disk.modeBits);
1054         printf("\t\tlinkCount         = %d\n", v.disk.linkCount);
1055         printf("\t\tlength            = %u\n", v.disk.length);
1056         printf("\t\tuniquifier        = %u\n", v.disk.uniquifier);
1057         printf("\t\tdataVersion       = %u\n", v.disk.dataVersion);
1058         printf("\t\tvn_ino_lo         = %u\n", v.disk.vn_ino_lo);
1059         printf("\t\tunixModifyTime    = %u\n", v.disk.unixModifyTime);
1060         printf("\t\tauthor            = %u\n", v.disk.author);
1061         printf("\t\towner             = %u\n", v.disk.owner);
1062         printf("\t\tparent            = %u\n", v.disk.parent);
1063         printf("\t\tvnodeMagic        = %u\n", v.disk.vnodeMagic);
1064
1065         printf("\t\tlock = {\n");
1066         printf("\t\t\tlockCount   = %d\n", v.disk.lock.lockCount);
1067         printf("\t\t\tlockTime    = %d\n", v.disk.lock.lockTime);
1068         printf("\t\t}\n");
1069
1070         printf("\t\tserverModifyTime  = %u\n", v.disk.serverModifyTime);
1071         printf("\t\tgroup             = %d\n", v.disk.group);
1072         printf("\t\tvn_ino_hi         = %d\n", v.disk.vn_ino_hi);
1073         printf("\t\tvn_length_hi      = %u\n", v.disk.vn_length_hi);
1074         printf("\t}\n");
1075
1076         printf("}\n");
1077     }
1078
1079  done:
1080     return 0;
1081 }
1082
1083
1084 static int
1085 StatsQuery(struct cmd_syndesc * as, void * rock)
1086 {
1087     afs_int32 code;
1088     int command;
1089     struct cmd_item *ti;
1090     struct fssync_state state;
1091     SYNC_PROTO_BUF_DECL(res_buf);
1092     SYNC_response res;
1093     FSSYNC_StatsOp_hdr scom;
1094
1095     res.hdr.response_len = sizeof(res.hdr);
1096     res.payload.buf = res_buf;
1097     res.payload.len = SYNC_PROTO_MAX_LEN;
1098
1099     if ((ti = as->parms[CUSTOM_PARMS_OFFSET].items)) {  /* -subcommand */
1100         if (!strcasecmp(ti->data, "vicep")) {
1101             command = FSYNC_VOL_STATS_VICEP;
1102         } else if (!strcasecmp(ti->data, "hash")) {
1103             command = FSYNC_VOL_STATS_HASH;
1104 #ifdef AFS_DEMAND_ATTACH_FS
1105         } else if (!strcasecmp(ti->data, "hdr")) {
1106             command = FSYNC_VOL_STATS_HDR;
1107         } else if (!strcasecmp(ti->data, "vlru")) {
1108             command = FSYNC_VOL_STATS_VLRU;
1109 #endif
1110         } else if (!strcasecmp(ti->data, "pkg")) {
1111             command = FSYNC_VOL_STATS_GENERAL;
1112         } else if (!strcasecmp(ti->data, "help")) {
1113             fprintf(stderr, "fssync-debug stats subcommands:\n");
1114             fprintf(stderr, "\tpkg\tgeneral volume package stats\n");
1115             fprintf(stderr, "\tvicep\tvice partition stats\n");
1116             fprintf(stderr, "\thash\tvolume hash chain stats\n");
1117 #ifdef AFS_DEMAND_ATTACH_FS
1118             fprintf(stderr, "\thdr\tvolume header cache stats\n");
1119             fprintf(stderr, "\tvlru\tvlru generation stats\n");
1120 #endif
1121             exit(0);
1122         } else {
1123             fprintf(stderr, "invalid stats subcommand");
1124             exit(1);
1125         }
1126     } else {
1127         command = FSYNC_VOL_STATS_GENERAL;
1128     }
1129
1130     if ((ti = as->parms[CUSTOM_PARMS_OFFSET+1].items)) {        /* -arg1 */
1131         switch (command) {
1132         case FSYNC_VOL_STATS_VICEP:
1133             strlcpy(scom.args.partName, ti->data, sizeof(state.vop->partName));
1134             break;
1135         case FSYNC_VOL_STATS_HASH:
1136             scom.args.hash_bucket = atoi(ti->data);
1137             break;
1138         case FSYNC_VOL_STATS_VLRU:
1139             scom.args.vlru_generation = atoi(ti->data);
1140             break;
1141         default:
1142             fprintf(stderr, "unrecognized arguments\n");
1143             exit(1);
1144         }
1145     } else {
1146         switch (command) {
1147         case FSYNC_VOL_STATS_VICEP:
1148         case FSYNC_VOL_STATS_HASH:
1149         case FSYNC_VOL_STATS_VLRU:
1150             fprintf(stderr, "this subcommand requires more parameters\n");
1151             exit(1);
1152         }
1153     }
1154
1155     common_prolog(as, &state);
1156
1157     fprintf(stderr, "calling FSYNC_askfs with command code %d (%s)\n",
1158             command, FSYNC_com2string(command));
1159
1160     code = FSYNC_StatsOp(&scom, command, FSYNC_WHATEVER, &res);
1161
1162     switch (code) {
1163     case SYNC_OK:
1164     case SYNC_DENIED:
1165         break;
1166     default:
1167         fprintf(stderr, "possible sync protocol error. return code was %d\n", code);
1168     }
1169
1170     fprintf(stderr, "FSYNC_VolOp returned %d (%s)\n", code, SYNC_res2string(code));
1171     fprintf(stderr, "protocol response code was %d (%s)\n",
1172             res.hdr.response, SYNC_res2string(res.hdr.response));
1173     fprintf(stderr, "protocol reason code was %d (%s)\n",
1174             res.hdr.reason, FSYNC_reason2string(res.hdr.reason));
1175
1176     VDisconnectFS();
1177
1178     if (res.hdr.response == SYNC_OK) {
1179         switch (command) {
1180         case FSYNC_VOL_STATS_GENERAL:
1181             {
1182                 struct VolPkgStats vol_stats;
1183                 memcpy(&vol_stats, res_buf, sizeof(vol_stats));
1184                 print_vol_stats_general(&vol_stats);
1185                 break;
1186             }
1187         case FSYNC_VOL_STATS_VICEP:
1188             {
1189                 struct DiskPartitionStats64 vicep_stats;
1190                 memcpy(&vicep_stats, res_buf, sizeof(vicep_stats));
1191                 print_vol_stats_viceP(&vicep_stats);
1192                 break;
1193             }
1194         case FSYNC_VOL_STATS_HASH:
1195             {
1196                 struct VolumeHashChainStats hash_stats;
1197                 memcpy(&hash_stats, res_buf, sizeof(hash_stats));
1198                 print_vol_stats_hash(&hash_stats);
1199                 break;
1200             }
1201 #ifdef AFS_DEMAND_ATTACH_FS
1202         case FSYNC_VOL_STATS_HDR:
1203             {
1204                 struct volume_hdr_LRU_stats hdr_stats;
1205                 memcpy(&hdr_stats, res_buf, sizeof(hdr_stats));
1206                 print_vol_stats_hdr(&hdr_stats);
1207                 break;
1208             }
1209 #endif /* AFS_DEMAND_ATTACH_FS */
1210         }
1211     }
1212
1213     return 0;
1214 }
1215
1216 static void
1217 print_vol_stats_general(VolPkgStats * stats)
1218 {
1219 #ifdef AFS_DEMAND_ATTACH_FS
1220     int i;
1221 #endif
1222
1223     printf("VolPkgStats = {\n");
1224 #ifdef AFS_DEMAND_ATTACH_FS
1225     for (i = 0; i < VOL_STATE_COUNT; i++) {
1226         printf("\tvol_state_count[%s] = %d\n",
1227                vol_state_to_string(i),
1228                stats->state_levels[i]);
1229     }
1230
1231     printf("\thash_looks = %"AFS_INT64_FMT"\n",
1232            stats->hash_looks);
1233     printf("\thash_reorders = %"AFS_INT64_FMT"\n",
1234            stats->hash_reorders);
1235     printf("\tsalvages = %"AFS_INT64_FMT"\n",
1236            stats->salvages);
1237     printf("\tvol_ops = %"AFS_INT64_FMT"\n",
1238            stats->vol_ops);
1239 #endif
1240     printf("\thdr_loads = %"AFS_INT64_FMT"\n",
1241            stats->hdr_loads);
1242     printf("\thdr_gets = %"AFS_INT64_FMT"\n",
1243            stats->hdr_gets);
1244     printf("\tattaches = %"AFS_INT64_FMT"\n",
1245            stats->attaches);
1246     printf("\tsoft_detaches = %"AFS_INT64_FMT"\n",
1247            stats->soft_detaches);
1248     printf("\thdr_cache_size = %d\n", stats->hdr_cache_size);
1249
1250     printf("}\n");
1251 }
1252
1253 static void
1254 print_vol_stats_viceP(struct DiskPartitionStats64 * stats)
1255 {
1256     printf("DiskPartitionStats64 = {\n");
1257     printf("\tfree = %" AFS_INT64_FMT "\n", stats->free);
1258     printf("\tminFree = %" AFS_INT64_FMT "\n", stats->minFree);
1259     printf("\ttotalUsable = %" AFS_INT64_FMT "\n", stats->totalUsable);
1260     printf("\tf_files = %" AFS_INT64_FMT "\n", stats->f_files);
1261 #ifdef AFS_DEMAND_ATTACH_FS
1262     printf("\tvol_list_len = %d\n", stats->vol_list_len);
1263 #endif
1264     printf("}\n");
1265 }
1266
1267 static void
1268 print_vol_stats_hash(struct VolumeHashChainStats * stats)
1269 {
1270     printf("DiskPartitionStats = {\n");
1271     printf("\ttable_size = %d\n", stats->table_size);
1272     printf("\tchain_len = %d\n", stats->chain_len);
1273
1274 #ifdef AFS_DEMAND_ATTACH_FS
1275     printf("\tchain_cacheCheck = %d\n", stats->chain_cacheCheck);
1276     printf("\tchain_busy = %d\n", stats->chain_busy);
1277
1278     printf("\tchain_looks = %"AFS_INT64_FMT"\n",
1279            stats->chain_looks);
1280     printf("\tchain_gets = %"AFS_INT64_FMT"\n",
1281            stats->chain_gets);
1282     printf("\tchain_reorders = %"AFS_INT64_FMT"\n",
1283            stats->chain_reorders);
1284 #endif /* AFS_DEMAND_ATTACH_FS */
1285
1286     printf("}\n");
1287 }
1288
1289
1290 #ifdef AFS_DEMAND_ATTACH_FS
1291 static void
1292 print_vol_stats_hdr(struct volume_hdr_LRU_stats * stats)
1293 {
1294     printf("volume_hdr_LRU_stats = {\n");
1295     printf("\tfree = %d\n", stats->free);
1296     printf("\tused = %d\n", stats->used);
1297     printf("\tattached = %d\n", stats->attached);
1298     printf("}\n");
1299 }
1300 #endif /* AFS_DEMAND_ATTACH_FS */
1301
1302
1303 /**
1304  * query VGC.
1305  *
1306  * @notes args:
1307  *    - CUSTOM_PARMS_OFFSET+0 is partition string
1308  *    - CUSTOM_PARMS_OFFSET+1 is volume id
1309  *
1310  * @return operation status
1311  *    @retval 0 success
1312  */
1313 static int
1314 VGCQuery(struct cmd_syndesc * as, void * rock)
1315 {
1316     afs_int32 code;
1317     struct fssync_state state;
1318     char * partName;
1319     VolumeId volid;
1320     FSSYNC_VGQry_response_t q_res;
1321     SYNC_response res;
1322     int i;
1323     struct cmd_item *ti;
1324
1325     if (!(ti = as->parms[CUSTOM_PARMS_OFFSET+0].items)) {       /* -partition */
1326         return -1;
1327     }
1328     partName = ti->data;
1329
1330     if (!(ti = as->parms[CUSTOM_PARMS_OFFSET+1].items)) {       /* -volumeid */
1331         return -1;
1332     }
1333     volid = atoi(ti->data);
1334
1335     common_prolog(as, &state);
1336
1337     fprintf(stderr, "calling FSYNC_VCGQuery\n");
1338
1339     code = FSYNC_VGCQuery(partName, volid, &q_res, &res);
1340
1341     debug_response(code, &res);
1342
1343     if (code == SYNC_OK) {
1344         printf("VG = {\n");
1345         printf("\trw\t=\t%u\n", q_res.rw);
1346         printf("\tchildren\t= (\n");
1347         for (i = 0; i < VOL_VG_MAX_VOLS; i++) {
1348             if (q_res.children[i]) {
1349                 printf("\t\t%u\n", q_res.children[i]);
1350             }
1351         }
1352         printf("\t)\n");
1353     }
1354
1355     VDisconnectFS();
1356
1357     return 0;
1358 }
1359
1360 static int
1361 VGCAdd(struct cmd_syndesc * as, void * rock)
1362 {
1363     afs_int32 code;
1364     struct fssync_state state;
1365     char * partName;
1366     VolumeId parent, child;
1367     struct cmd_item *ti;
1368     SYNC_response res;
1369
1370     if (!(ti = as->parms[CUSTOM_PARMS_OFFSET+0].items)) {       /* -partition */
1371         return -1;
1372     }
1373     partName = ti->data;
1374
1375     if (!(ti = as->parms[CUSTOM_PARMS_OFFSET+1].items)) {       /* -parent */
1376         return -1;
1377     }
1378     parent = atoi(ti->data);
1379
1380     if (!(ti = as->parms[CUSTOM_PARMS_OFFSET+2].items)) {       /* -child */
1381         return -1;
1382     }
1383     child = atoi(ti->data);
1384
1385     common_prolog(as, &state);
1386     fprintf(stderr, "calling FSYNC_VCGAdd\n");
1387     code = FSYNC_VGCAdd(partName, parent, child, state.reason, &res);
1388     debug_response(code, &res);
1389
1390     VDisconnectFS();
1391
1392     return 0;
1393 }
1394
1395 static int
1396 VGCDel(struct cmd_syndesc * as, void * rock)
1397 {
1398     afs_int32 code;
1399     struct fssync_state state;
1400     char * partName;
1401     VolumeId parent, child;
1402     struct cmd_item *ti;
1403     SYNC_response res;
1404
1405     if (!(ti = as->parms[CUSTOM_PARMS_OFFSET+0].items)) {       /* -partition */
1406         return -1;
1407     }
1408     partName = ti->data;
1409
1410     if (!(ti = as->parms[CUSTOM_PARMS_OFFSET+1].items)) {       /* -parent */
1411         return -1;
1412     }
1413     parent = atoi(ti->data);
1414
1415     if (!(ti = as->parms[CUSTOM_PARMS_OFFSET+2].items)) {       /* -child */
1416         return -1;
1417     }
1418     child = atoi(ti->data);
1419
1420     common_prolog(as, &state);
1421     fprintf(stderr, "calling FSYNC_VCGDel\n");
1422     code = FSYNC_VGCDel(partName, parent, child, state.reason, &res);
1423     debug_response(code, &res);
1424
1425     VDisconnectFS();
1426
1427     return 0;
1428 }
1429
1430 static int
1431 VGCScan(struct cmd_syndesc * as, void * rock)
1432 {
1433     afs_int32 code;
1434     struct fssync_state state;
1435     char * partName;
1436     struct cmd_item *ti;
1437
1438     if (!(ti = as->parms[CUSTOM_PARMS_OFFSET+0].items)) {       /* -partition */
1439         return -1;
1440     }
1441     partName = ti->data;
1442
1443     common_prolog(as, &state);
1444     fprintf(stderr, "calling FSYNC_VCGScan\n");
1445     code = FSYNC_VGCScan(partName, state.reason);
1446     debug_response(code, NULL);
1447
1448     VDisconnectFS();
1449
1450     return 0;
1451 }
1452
1453 static int
1454 VGCScanAll(struct cmd_syndesc * as, void * rock)
1455 {
1456     afs_int32 code;
1457     struct fssync_state state;
1458
1459     common_prolog(as, &state);
1460     fprintf(stderr, "calling FSYNC_VCGScanAll\n");
1461     code = FSYNC_VGCScan(NULL, state.reason);
1462     debug_response(code, NULL);
1463
1464     VDisconnectFS();
1465
1466     return 0;
1467 }