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