lustre/utils/lctl.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/utils/lctl.c
  33  *
  34  * Author: Peter J. Braam <braam@clusterfs.com>
  35  * Author: Phil Schwan <phil@clusterfs.com>
  36  * Author: Robert Read <rread@clusterfs.com>
  37  */
  38
  39 #include <errno.h>
  40 #include <limits.h>
  41 #include <stdlib.h>
  42 #include <stdio.h>
  43 #include <string.h>
  44 #include <libcfs/util/parser.h>
  45 #include <linux/lnet/lnetctl.h>
  46 #include "obdctl.h"
  47 #include <linux/lustre/lustre_ver.h>
  48 #include <lustre/lustreapi.h>
  49
  50 static int lctl_list_commands(int argc, char **argv);
  51
  52 static int jt_opt_ignore_errors(int argc, char **argv) {
  53         Parser_ignore_errors(1);
  54         return 0;
  55 }
  56
  57 command_t cmdlist[] = {
  58         /* Metacommands */
  59         {"===== metacommands =======", NULL, 0, "metacommands"},
  60         {"--device", jt_opt_device, 0,
  61          "run <command> after connecting to device <devno>\n"
  62          "--device <devno> <command [args ...]>"},
  63         {"--ignore_errors", jt_opt_ignore_errors, 0,
  64          "ignore errors that occur during script processing\n"
  65          "--ignore_errors"},
  66         {"ignore_errors", jt_opt_ignore_errors, 0,
  67          "ignore errors that occur during script processing\n"
  68          "ignore_errors"},
  69
  70         /* User interface commands */
  71         {"======== control =========", NULL, 0, "control commands"},
  72         {"help", Parser_help, 0, "help"},
  73         {"lustre_build_version", jt_get_version, 0,
  74          "print version of Lustre modules\n"
  75          "usage: lustre_build_version"},
  76         {"exit", Parser_quit, 0, "quit"},
  77         {"quit", Parser_quit, 0, "quit"},
  78         {"--version", Parser_version, 0,
  79          "print build version of this utility and exit"},
  80         {"--list-commands", lctl_list_commands, 0,
  81          "list commands supported by this utility and exit"},
  82
  83         /* Network configuration commands */
  84         {"===== network config =====", NULL, 0, "network config"},
  85         {"--net", jt_opt_net, 0, "run <command> after selecting network <net>\n"
  86          "usage: --net <tcp/o2ib/...> <command>"},
  87         {"network", jt_ptl_network, 0, "configure LNET"
  88          "usage: network up|down"},
  89         {"net", jt_ptl_network, 0, "configure LNET"
  90          "usage: net up|down"},
  91         {"list_nids", jt_ptl_list_nids, 0, "list local NIDs"
  92          "usage: list_nids [all]"},
  93         {"which_nid", jt_ptl_which_nid, 0, "choose a NID"
  94          "usage: which_nid NID [NID...]"},
  95         {"replace_nids", jt_replace_nids, 0,
  96          "replace primary NIDs for a device\n"
  97          "usage: replace_nids <device> <nid1>[,nid2,nid3:nid4,nid5:nid6]"},
  98         {"interface_list", jt_ptl_print_interfaces, 0,
  99          "print network interface entries\n"
 100          "usage: interface_list"},
 101         {"peer_list", jt_ptl_print_peers, 0, "print peer LNet NIDs\n"
 102          "usage: peer_list"},
 103         {"conn_list", jt_ptl_print_connections, 0,
 104          "print all the remote LNet connections\n"
 105          "usage: conn_list"},
 106         {"route_list", jt_ptl_print_routes, 0,
 107          "print the LNet routing table, same as show_route\n"
 108          "usage: route_list"},
 109         {"show_route", jt_ptl_print_routes, 0,
 110          "print the LNet routing table, same as route_list\n"
 111          "usage: show_route"},
 112         {"ping", jt_ptl_ping, 0, "Check LNET connectivity\n"
 113          "usage: ping nid [timeout] [pid]"},
 114         {"net_drop_add", jt_ptl_drop_add, 0, "Add LNet drop rule\n"
 115          "usage: net_drop_add <-s | --source NID>\n"
 116          "                    <-d | --dest NID>\n"
 117          "                    <<-r | --rate DROP_RATE> |\n"
 118          "                    <-i | --interval SECONDS>>\n"
 119          "                    [<-p | --portal> PORTAL...]\n"
 120          "                    [<-m | --message> <PUT|ACK|GET|REPLY>...]\n"
 121          "                    [< -e | --health_error]\n"},
 122         {"net_drop_del", jt_ptl_drop_del, 0, "remove LNet drop rule\n"
 123          "usage: net_drop_del <[-a | --all] |\n"
 124          "                    <-s | --source NID>\n"
 125          "                    <-d | --dest NID>>\n"},
 126         {"net_drop_reset", jt_ptl_drop_reset, 0, "reset drop rule stats\n"
 127          "usage: net_drop_reset"},
 128         {"net_drop_list", jt_ptl_drop_list, 0, "list LNet drop rules\n"
 129          "usage: net_drop_list"},
 130         {"net_delay_add", jt_ptl_delay_add, 0, "Add LNet delay rule\n"
 131          "usage: net_delay_add <-s | --source NID>\n"
 132          "                     <-d | --dest NID>\n"
 133          "                     <<-r | --rate DROP_RATE> |\n"
 134          "                      <-i | --interval SECONDS>>\n"
 135          "                     <-l | --latency SECONDS>\n"
 136          "                     [<-p | --portal> PORTAL...]\n"
 137          "                     [<-m | --message> <PUT|ACK|GET|REPLY>...]\n"},
 138         {"net_delay_del", jt_ptl_delay_del, 0, "remove LNet delay rule\n"
 139          "usage: net_delay_del <[-a | --all] |\n"
 140          "                     <-s | --source NID>\n"
 141          "                     <-d | --dest NID>>\n"},
 142         {"net_delay_reset", jt_ptl_delay_reset, 0, "reset delay rule stats\n"
 143          "usage: net_delay_reset"},
 144         {"net_delay_list", jt_ptl_delay_list, 0, "list LNet delay rules\n"
 145          "usage: net_delay_list"},
 146
 147         /* Device selection commands */
 148         {"==== obd device selection ====", NULL, 0, "device selection"},
 149         {"device", jt_obd_device, 0,
 150          "set current device to <name|devno>\n"
 151          "usage: device <%name|$name|devno>"},
 152         {"device_list", jt_obd_list, 0, "show all devices\n"
 153          "usage: device_list"},
 154         {"dl", jt_obd_list, 0, "show all devices\n"
 155          "usage: dl [-t]"},
 156
 157         /* Device operations */
 158         {"==== obd device operations ====", NULL, 0, "device operations"},
 159         {"activate", jt_obd_activate, 0, "activate an import\n"},
 160         {"deactivate", jt_obd_deactivate, 0, "deactivate an import. "
 161          "This command should be used on failed OSC devices in an MDT LOV.\n"},
 162         {"abort_recovery", jt_obd_abort_recovery, 0,
 163          "abort recovery on a restarting MDT or OST device\n"},
 164         {"set_timeout", jt_lcfg_set_timeout, 0,
 165          "usage: conf_param obd_timeout=<secs>\n"},
 166 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 0, 53, 0)
 167         {"conf_param", jt_lcfg_confparam, 0,
 168          "set a permanent config parameter.\n"
 169          "This command must be run on the MGS node\n"
 170          "usage: conf_param [-d] <target.keyword=val>\n"
 171          "  -d  Delete the permanent setting from the configuration."},
 172 #endif
 173         {"local_param", jt_lcfg_param, 0, "set a temporary, local param\n"
 174          "usage: local_param <target.keyword=val>\n"},
 175         {"get_param", jt_lcfg_getparam, 0, "get the Lustre or LNET parameter\n"
 176          "usage: get_param [-F|n|-N|-R] <param_path1 param_path2 ...>\n"
 177          "Get the value of Lustre or LNET parameter from the specified path.\n"
 178          "The path can contain shell-style filename patterns.\n"
 179          "  -F  When -N specified, add '/', '@' or '=' for directories,\n"
 180          "      symlinks and writeable files, respectively.\n"
 181          "  -n  Print only the value and not parameter name.\n"
 182          "  -N  Print only matched parameter names and not the values.\n"
 183          "      (Especially useful when using patterns.)\n"
 184          "  -R  Get parameters recursively from the specified entry.\n"},
 185         {"set_param", jt_lcfg_setparam, 0, "set the Lustre or LNET parameter\n"
 186          "usage: set_param [-n] [-P] [-d] [-F]"
 187          "<param_path1=value1 param_path2=value2 ...>\n"
 188          "Set the value of the Lustre or LNET parameter at the specified path.\n"
 189          "  -n  Disable printing of the key name when printing values.\n"
 190          "  -P  Set the parameter permanently, filesystem-wide.\n"
 191          "  -d  Remove the permanent setting (only with -P option).\n"
 192          "  -F  Read permanent configuration from a YAML file.\n"},
 193         {"list_param", jt_lcfg_listparam, 0,
 194          "list the Lustre or LNET parameter name\n"
 195          "usage: list_param [-F|-R|-D] <param_path1 param_path2 ...>\n"
 196          "List the name of Lustre or LNET parameter from the specified path.\n"
 197          "  -F  Add '/', '@' or '=' for dirs, symlinks and writeable files,\n"
 198                 "respectively.\n"
 199          "  -D  Only list directories.\n"
 200          "  -R  Recursively list all parameters under the specified path.\n"},
 201
 202         /* Debug commands */
 203         {"==== debugging control ====", NULL, 0, "debug"},
 204         {"debug_daemon", jt_dbg_debug_daemon, 0,
 205          "debug daemon control and dump to a file\n"
 206          "usage: debug_daemon {start file [#MB]|stop}"},
 207         {"debug_kernel", jt_dbg_debug_kernel, 0,
 208          "get debug buffer and dump to a file, same as dk\n"
 209          "usage: debug_kernel [file] [raw]"},
 210         {"dk", jt_dbg_debug_kernel, 0,
 211          "get debug buffer and dump to a file, same as debug_kernel\n"
 212          "usage: dk [file] [raw]"},
 213         {"debug_file", jt_dbg_debug_file, 0,
 214          "convert a binary debug file dumped by the kernel to ASCII text\n"
 215          "usage: debug_file <input> [output]"},
 216         {"df", jt_dbg_debug_file, 0,
 217          "read debug buffer from input and dump to output, same as debug_file\n"
 218          "usage: df <input> [output]"},
 219         {"clear", jt_dbg_clear_debug_buf, 0, "clear kernel debug buffer\n"
 220          "usage: clear"},
 221         {"mark", jt_dbg_mark_debug_buf, 0,
 222          "insert marker text in kernel debug buffer\n"
 223          "usage: mark <text>"},
 224         {"filter", jt_dbg_filter, 0, "filter message type\n"
 225          "usage: filter <subsystem id/debug mask>"},
 226         {"show", jt_dbg_show, 0, "Show specific type of messages\n"
 227          "usage: show <subsystem id/debug mask>"},
 228         {"debug_list", jt_dbg_list, 0, "list subsystem and debug types\n"
 229          "usage: debug_list <subs/types>"},
 230         {"modules", jt_dbg_modules, 0,
 231          "provide gdb-friendly module information\n"
 232          "usage: modules <path>"},
 233
 234         /* Pool commands */
 235         {"===  Pools ==", NULL, 0, "pool management"},
 236         {"pool_new", jt_pool_cmd, 0,
 237          "add a new pool\n"
 238          "usage: pool_new <fsname>.<poolname>"},
 239         {"pool_add", jt_pool_cmd, 0,
 240          "add the named OSTs to the pool\n"
 241          "usage: pool_add <fsname>.<poolname> <ostname indexed list>"},
 242         {"pool_remove", jt_pool_cmd, 0,
 243          "remove the named OST from the pool\n"
 244          "usage: pool_remove <fsname>.<poolname> <ostname indexed list>"},
 245         {"pool_destroy", jt_pool_cmd, 0,
 246          "destroy a pool\n"
 247          "usage: pool_destroy <fsname>.<poolname>"},
 248         {"pool_list", jt_pool_cmd, 0,
 249          "list pools and pools members\n"
 250          "usage: pool_list  <fsname>[.<poolname>] | <pathname>"},
 251
 252 #ifdef HAVE_SERVER_SUPPORT
 253         /* Barrier commands */
 254         {"===  Barrier ==", NULL, 0, "barrier management"},
 255         {"barrier_freeze", jt_barrier_freeze, 0,
 256          "freeze write barrier on MDTs\n"
 257          "usage: barrier_freeze <fsname> [timeout (in seconds)]"},
 258         {"barrier_thaw", jt_barrier_thaw, 0,
 259          "thaw write barrier on MDTs\n"
 260          "usage: barrier_thaw <fsname>"},
 261         {"barrier_stat", jt_barrier_stat, 0,
 262          "query write barrier status on MDTs\n"
 263          "usage: barrier_stat [--state|-s] [--timeout|-t] <fsname>"},
 264         {"barrier_rescan", jt_barrier_rescan, 0,
 265          "rescan the system to filter out inactive MDT(s) for barrier\n"
 266          "usage: barrier_rescan <fsname> [timeout (in seconds)]"},
 267
 268         /* Snapshot commands */
 269         {"===  Snapshot ==", NULL, 0, "Snapshot management"},
 270         {"snapshot_create", jt_snapshot_create, 0,
 271          "create the snapshot\n"
 272          "usage: snapshot_create [-b | --barrier [on | off]]\n"
 273          "                       [-c | --comment comment]\n"
 274          "                       <-F | --fsname fsname>\n"
 275          "                       [-h | --help] <-n | --name ssname>\n"
 276          "                       [-r | --rsh remote_shell]\n"
 277          "                       [-t | --timeout timeout]"},
 278         {"snapshot_destroy", jt_snapshot_destroy, 0,
 279          "destroy the snapshot\n"
 280          "usage: snapshot_destroy [-f | --force]\n"
 281          "                        <-F | --fsname fsname> [-h | --help]\n"
 282          "                        <-n | --name ssname>\n"
 283          "                        [-r | --rsh remote_shell]"},
 284         {"snapshot_modify", jt_snapshot_modify, 0,
 285          "modify the snapshot\n"
 286          "usage: snapshot_modify [-c | --comment comment]\n"
 287          "                       <-F | --fsname fsname> [-h | --help]\n"
 288          "                       <-n | --name ssname> [-N | --new new_ssname]\n"
 289          "                       [-r | --rsh remote_shell]"},
 290         {"snapshot_list", jt_snapshot_list, 0,
 291          "query the snapshot(s)\n"
 292          "usage: snapshot_list [-d | --detail]\n"
 293          "                     <-F | --fsname fsname> [-h | --help]\n"
 294          "                     [-n | --name ssname] [-r | --rsh remote_shell]"},
 295         {"snapshot_mount", jt_snapshot_mount, 0,
 296          "mount the snapshot\n"
 297          "usage: snapshot_mount <-F | --fsname fsname> [-h | --help]\n"
 298          "                      <-n | --name ssname>\n"
 299          "                      [-r | --rsh remote_shell]"},
 300         {"snapshot_umount", jt_snapshot_umount, 0,
 301          "umount the snapshot\n"
 302          "usage: snapshot_umount <-F | --fsname fsname> [-h | --help]\n"
 303          "                       <-n | --name ssname>\n"
 304          "                       [-r | --rsh remote_shell]"},
 305 #endif /* HAVE_SERVER_SUPPORT */
 306         /* Nodemap commands */
 307         {"=== Nodemap ===", NULL, 0, "nodemap management"},
 308         {"nodemap_activate", jt_nodemap_activate, 0,
 309          "activate nodemap idmapping functions\n"
 310          "usage: nodemap_activate {0|1}"},
 311         {"nodemap_add", jt_nodemap_add, 0,
 312          "add a new nodemap\n"
 313          "usage: nodemap_add <nodemap_name>"},
 314         {"nodemap_del", jt_nodemap_del, 0,
 315          "remove a nodemap\n"
 316          "usage: nodemap_del <nodemap_name>"},
 317         {"nodemap_add_range", jt_nodemap_add_range, 0,
 318          "add a range to a nodemap\n"
 319          "usage: nodemap_add_range <nid_range>"},
 320         {"nodemap_del_range", jt_nodemap_del_range, 0,
 321          "add a range to a nodemap\n"
 322          "usage: nodemap_del_range <nid_range>"},
 323         {"nodemap_modify", jt_nodemap_modify, 0,
 324          "modify a nodemap parameters"
 325          "usage: nodemap_modify nodemap_name param value"},
 326         {"nodemap_add_idmap", jt_nodemap_add_idmap, 0,
 327          "add a UID or GID mapping to a nodemap"},
 328         {"nodemap_del_idmap", jt_nodemap_del_idmap, 0,
 329          "delete a UID or GID mapping from a nodemap"},
 330         {"nodemap_set_fileset", jt_nodemap_set_fileset, 0,
 331          "set a fileset on a nodemap\n"
 332          "usage: nodemap_set_fileset <fileset>"},
 333         {"nodemap_set_sepol", jt_nodemap_set_sepol, 0,
 334          "set SELinux policy info on a nodemap\n"
 335          "usage: nodemap_set_sepol <SELinux policy info>"},
 336         {"nodemap_test_nid", jt_nodemap_test_nid, 0,
 337          "usage: nodemap_test_nid <nid>"},
 338         {"nodemap_test_id", jt_nodemap_test_id, 0,
 339          "Usage: nodemap_test_id --nid <nid> --idtype [uid|gid] --id <id>"},
 340         {"nodemap_info", jt_nodemap_info, 0,
 341          "Usage: nodemap_info [list|nodemap_name|all]"},
 342
 343         /* Changelog commands */
 344         {"===  Changelogs ==", NULL, 0, "changelog user management"},
 345         {"changelog_register", jt_changelog_register, 0,
 346          "register a new persistent changelog user, returns id\n"
 347          "usage: --device <mdtname> changelog_register [-n]"},
 348         {"changelog_deregister", jt_changelog_deregister, 0,
 349          "deregister an existing changelog user\n"
 350          "usage: --device <mdtname> changelog_deregister <id>"},
 351
 352         /* Device configuration commands */
 353         {"== device setup (these are not normally used post 1.4) ==",
 354                 NULL, 0, "device config"},
 355         {"attach", jt_lcfg_attach, 0,
 356          "set the type, name, and uuid of the current device\n"
 357          "usage: attach type name uuid"},
 358         {"detach", jt_obd_detach, 0,
 359          "remove driver (and name and uuid) from current device\n"
 360          "usage: detach"},
 361         {"setup", jt_lcfg_setup, 0,
 362          "type specific device configuration information\n"
 363          "usage: setup <args...>"},
 364         {"cleanup", jt_obd_cleanup, 0, "cleanup previously setup device\n"
 365          "usage: cleanup [force | failover]"},
 366         {"clear_conf", jt_lcfg_clear, 0,
 367          "drop unused config logs for a device or filesystem\n"
 368          "usage: clear_conf <device|fsname>"},
 369         {"fork_lcfg", jt_lcfg_fork, 0,
 370          "copy configuration files for named filesystem with given name\n"
 371          "usage: fork_lcfg <fsname> <newname>"},
 372         {"erase_lcfg", jt_lcfg_erase, 0,
 373          "permanently erase configuration for the named filesystem\n"
 374          "usage: erase_lcfg <fsname>"},
 375
 376         /* Test only commands */
 377         {"==== testing (DANGEROUS) ====", NULL, 0, "testing (DANGEROUS)"},
 378         {"--threads", jt_opt_threads, 0,
 379          "run <threads> separate instances of <command> on device <devno>\n"
 380          "--threads <threads> <verbose> <devno> <command [args ...]>"},
 381         {"lookup", jt_obd_mdc_lookup, 0, "report file mode info\n"
 382          "usage: lookup <directory> <file>"},
 383         {"readonly", jt_obd_set_readonly, 0,
 384          "disable writes to the underlying device\n"},
 385         {"notransno", jt_obd_no_transno, 0,
 386          "disable sending of committed-transno updates\n"},
 387         {"add_uuid", jt_lcfg_add_uuid, 0, "associate a UUID with a NID\n"
 388          "usage: add_uuid <uuid> <nid>"},
 389         {"del_uuid", jt_lcfg_del_uuid, 0, "delete a UUID association\n"
 390          "usage: del_uuid <uuid>"},
 391         {"add_peer", jt_ptl_add_peer, 0, "add an peer entry\n"
 392          "usage: add_peer <nid> <host> <port>"},
 393         {"del_peer", jt_ptl_del_peer, 0, "remove an peer entry\n"
 394          "usage: del_peer [<nid>] [<ipaddr|pid>]"},
 395         {"add_conn ", jt_lcfg_add_conn, 0,
 396          "usage: add_conn <conn_uuid> [priority]\n"},
 397         {"del_conn ", jt_lcfg_del_conn, 0,
 398          "usage: del_conn <conn_uuid>"},
 399         {"disconnect", jt_ptl_disconnect, 0, "disconnect from a remote NID\n"
 400          "usage: disconnect [<nid>]"},
 401         {"push", jt_ptl_push_connection, 0, "flush connection to a remote NID\n"
 402          "usage: push [<nid>]"},
 403         {"mynid", jt_ptl_mynid, 0, "inform the LND of the local NID. "
 404          "The NID defaults to hostname for TCP networks.\n"
 405          "usage: mynid [<nid>]"},
 406         {"fail", jt_ptl_fail_nid, 0, "fail/restore network communications\n"
 407          "Omitting the count means indefinitely, 0 means restore, "
 408          "otherwise fail 'count' messages.\n"
 409          "usage: fail nid|_all_ [count]"},
 410
 411         /*Test commands for echo client*/
 412         {"test_create", jt_obd_test_create, 0,
 413          "create files on MDT by echo client\n"
 414          "usage: test_create [-d parent_basedir] <-D parent_count> "
 415          "[-b child_base_id] <-c stripe_count> <-n count> <-t time>\n"},
 416         {"test_mkdir", jt_obd_test_mkdir, 0,
 417          "mkdir on MDT by echo client\n"
 418          "usage: test_mkdir [-d parent_basedir] <-D parent_count>"
 419          "[-b child_base_id] [-n count] <-t time>\n"},
 420         {"test_destroy", jt_obd_test_destroy, 0,
 421          "Destroy files on MDT by echo client\n"
 422          "usage: test_destroy [-d parent_basedir] <-D parent_count>"
 423          "[-b child_base_id] [-n count] <-t time>\n"},
 424         {"test_rmdir", jt_obd_test_rmdir, 0,
 425          "rmdir on MDT by echo client\n"
 426          "usage: test_rmdir [-d parent_basedir] <-D parent_count>"
 427          "[-b child_base_id] [-n count] <-t time>\n"},
 428         {"test_lookup", jt_obd_test_lookup, 0,
 429          "lookup files on MDT by echo client\n"
 430          "usage: test_lookup [-d parent_basedir] <-D parent_count>"
 431          "[-b child_base_id] [-n count] <-t time>\n"},
 432         {"test_setxattr", jt_obd_test_setxattr, 0,
 433          "Set EA for files/directory on MDT by echo client\n"
 434          "usage: test_setxattr [-d parent_baseid] <-D parent_count>"
 435          "[-b child_base_id] [-n count] <-t time>\n"},
 436         {"test_md_getattr", jt_obd_test_md_getattr, 0,
 437          "getattr files on MDT by echo client\n"
 438          "usage: test_md_getattr [-d parent_basedir] <-D parent_count>"
 439          "[-b child_base_id] [-n count] <-t time>\n"},
 440         {"getattr", jt_obd_getattr, 0,
 441          "get attribute for OST object <objid>\n"
 442          "usage: getattr <objid>"},
 443         {"setattr", jt_obd_setattr, 0,
 444          "set mode attribute for OST object <objid>\n"
 445          "usage: setattr <objid> <mode>"},
 446         {"create", jt_obd_create, 0,
 447          "create <num> OST objects (with <mode>)\n"
 448          "usage: create [num [mode [verbose [lsm data]]]]"},
 449         {"destroy", jt_obd_destroy, 0,
 450          "destroy OST object <objid> [num [verbose]]\n"
 451          "usage: destroy <num> objects, starting at objid <objid>"},
 452         {"test_getattr", jt_obd_test_getattr, 0,
 453          "do <num> getattrs (on OST object <objid> (objid+1 on each thread))\n"
 454          "usage: test_getattr <num> [verbose [[t]objid]]"},
 455         {"test_setattr", jt_obd_test_setattr, 0,
 456          "do <num> setattrs (on OST object <objid> (objid+1 on each thread))\n"
 457          "usage: test_setattr <num> [verbose [[t]objid]]"},
 458         {"test_brw", jt_obd_test_brw, 0,
 459          "do <num> bulk read/writes (<npages> per I/O, on OST object <objid>)\n"
 460          "usage: test_brw [t]<num> [write [verbose [npages [[t]objid]]]]"},
 461         {"getobjversion", jt_get_obj_version, 0,
 462          "get the version of an object on servers\n"
 463          "usage: getobjversion <fid>\n"
 464          "       getobjversion -i <id> -g <group>"},
 465 #ifdef HAVE_SERVER_SUPPORT
 466         /* LFSCK commands */
 467         {"==== LFSCK ====", NULL, 0, "LFSCK"},
 468         {"lfsck_start", jt_lfsck_start, 0, "start LFSCK\n"
 469          "usage: lfsck_start [-M | --device [MDT,OST]_device]\n"
 470          "                   [-A | --all] [-c | --create-ostobj [on | off]]\n"
 471          "                   [-C | --create-mdtobj [on | off]]\n"
 472          "                   [-d | --delay-create-ostobj [on | off]]\n"
 473          "                   [-e | --error {continue | abort}] [-h | --help]\n"
 474          "                   [-n | --dryrun [on | off]] [-o | --orphan]\n"
 475          "                   [-r | --reset] [-s | --speed speed_limit]\n"
 476          "                   [-t | --type lfsck_type[,lfsck_type...]]\n"
 477          "                   [-w | --window-size size]"},
 478         {"lfsck_stop", jt_lfsck_stop, 0, "stop lfsck(s)\n"
 479          "usage: lfsck_stop [-M | --device [MDT,OST]_device]\n"
 480          "                  [-A | --all] [-h | --help]"},
 481         {"lfsck_query", jt_lfsck_query, 0, "check lfsck(s) status\n"
 482          "usage: lfsck_query [-M | --device MDT_device] [-h | --help]\n"
 483          "                   [-t | --type lfsck_type[,lfsck_type...]]\n"
 484          "                   [-w | --wait]"},
 485 #endif /* HAVE_SERVER_SUPPORT */
 486         {"==== obsolete (DANGEROUS) ====", NULL, 0, "obsolete (DANGEROUS)"},
 487         /* some test scripts still use these */
 488         {"cfg_device", jt_obd_device, 0,
 489          "set current device to <name>\n"
 490          "usage: device <name>"},
 491         {"recover", jt_obd_recover, 0,
 492          "try to restore a lost connection immediately\n"
 493          "usage: recover [MDC/OSC device]"},
 494         /* saving for sanity 44a */
 495         {"lov_getconfig", jt_obd_lov_getconfig, 0,
 496          "read lov configuration from an mds device\n"
 497          "usage: lov_getconfig <mountpoint>"},
 498         /* Llog operations */
 499         {"llog_catlist", jt_llog_catlist, 0,
 500          "list all catalog logs on current device.\n"
 501          "usage: llog_catlist"},
 502         {"llog_info", jt_llog_info, 0,
 503          "print log header information.\n"
 504          "usage: llog_info <logname|[FID]>\n"
 505          "       oid, ogr and ogen are hexadecimal."},
 506         {"llog_print", jt_llog_print, 0,
 507          "print log content information.\n"
 508          "usage: llog_print <logname|[FID]> [start_index [end_index]]\n"
 509          "       print all records from index 1 by default."},
 510         {"llog_check", jt_llog_check, 0,
 511          "print log content information.\n"
 512          "usage: llog_check <logname|[FID]> [start_index] [end_index]\n"
 513          "       check all records from index 1 by default."},
 514         {"llog_cancel", jt_llog_cancel, 0,
 515          "cancel one record in log.\n"
 516          "This command supports both positional and optional arguments\n"
 517          "usage (positional args): "
 518          "llog_cancel <catalog name|[FID]> [log id] <index>\n"
 519          "usage (optional args): "
 520          "llog_cancel --catalog <catalog id|catalog name> --log_id <log_id> "
 521          "--log_idx <index>"},
 522         {"llog_remove", jt_llog_remove, 0,
 523          "remove one log from catalog or plain log, erase it from disk.\n"
 524          "usage: llog_remove <catalog name|[FID]> <log id>"},
 525         /* network operations */
 526         {"add_interface", jt_ptl_add_interface, 0, "add interface entry\n"
 527          "usage: add_interface ip [netmask]"},
 528         {"del_interface", jt_ptl_del_interface, 0, "del interface entry\n"
 529          "usage: del_interface [ip]"},
 530         {"add_route", jt_ptl_add_route, 0,
 531          "add an entry to the LNet routing table\n"
 532          "usage: add_route <gateway> [<hops> [<priority>]]"},
 533         {"del_route", jt_ptl_del_route, 0,
 534          "delete route via gateway to targets from the LNet routing table\n"
 535          "usage: del_route <gateway> [<target>] [<target>]"},
 536         {"set_route", jt_ptl_notify_router, 0,
 537          "enable/disable routes via gateway in the LNet routing table\n"
 538          "usage: set_route <gateway> <up/down> [<time>]"},
 539
 540         { 0, 0, 0, NULL }
 541 };
 542
 543 int lctl_main(int argc, char **argv)
 544 {
 545         int rc;
 546
 547         setlinebuf(stdout);
 548
 549         if (ptl_initialize(argc, argv) < 0)
 550                 exit(1);
 551         if (obd_initialize(argc, argv) < 0)
 552                 exit(2);
 553         if (dbg_initialize(argc, argv) < 0)
 554                 exit(3);
 555
 556         Parser_init("lctl > ", cmdlist);
 557
 558         if (argc > 1) {
 559                 llapi_set_command_name(argv[1]);
 560                 rc = Parser_execarg(argc - 1, argv + 1, cmdlist);
 561                 llapi_clear_command_name();
 562         } else {
 563                 rc = Parser_commands();
 564         }
 565
 566         obd_finalize(argc, argv);
 567         return rc < 0 ? -rc : rc;
 568 }
 569
 570 static int lctl_list_commands(int argc, char **argv)
 571 {
 572         char buffer[81] = ""; /* 80 printable chars + terminating NUL */
 573         command_t *cmd;
 574         int rc;
 575
 576         cmd = cmdlist;
 577         while (cmd->pc_name != NULL) {
 578                 printf("\n%s\n", cmd->pc_name); /* Command category */
 579                 cmd++;
 580                 rc = Parser_list_commands(cmd, buffer, sizeof(buffer), NULL,
 581                                          0, 4);
 582                 cmd += rc;
 583         }
 584
 585         return 0;
 586 }
 587
 588 int main(int argc, char **argv)
 589 {
 590         return lctl_main(argc, argv);
 591 }