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