Whamcloud - gitweb
LU-2740 utils: Add support for --version option
[fs/lustre-release.git] / lustre / utils / lctl.c
index 1c8772b..1da619c 100644 (file)
@@ -27,7 +27,7 @@
  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  *
- * Copyright (c) 2011, 2012, Intel Corporation.
+ * Copyright (c) 2012, 2013, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
 #include <lnet/lnetctl.h>
 #include "obdctl.h"
 #include <libcfs/libcfsutil.h>
-
-static int jt_quit(int argc, char **argv) {
-        Parser_quit(argc, argv);
-        return 0;
-}
+#include <lustre/lustre_idl.h>
 
 static int jt_noop(int argc, char **argv) {
         return 0;
@@ -79,11 +75,13 @@ command_t cmdlist[] = {
         {"lustre_build_version", jt_get_version, 0,
          "print the build version of lustre\n"
          "usage: lustre_build_version"},
-        {"exit", jt_quit, 0, "quit"},
-        {"quit", jt_quit, 0, "quit"},
+       {"exit", Parser_quit, 0, "quit"},
+       {"quit", Parser_quit, 0, "quit"},
+       {"--version", Parser_version, 0,
+        "output build version of the utility and exit"},
 
-        /* Network configuration commands */
-        {"===== network config =====", jt_noop, 0, "network config"},
+       /* Network configuration commands */
+       {"===== network config =====", jt_noop, 0, "network config"},
         {"--net", jt_opt_net, 0,"run <command> after setting network to <net>\n"
          "usage: --net <tcp/elan/o2ib/...> <command>"},
         {"network", jt_ptl_network, 0, "configure LNET"
@@ -134,10 +132,12 @@ command_t cmdlist[] = {
          "abort recovery on a restarting MDT or OST device\n"},
         {"set_timeout", jt_lcfg_set_timeout, 0,
          "usage: conf_param obd_timeout=<secs>\n"},
+#if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 0, 53, 0)
         {"conf_param", jt_lcfg_mgsparam, 0,"set a permanent config parameter.\n"
          "This command must be run on the MGS node\n"
          "usage: conf_param [-d] <target.keyword=val>\n"
          "  -d  Remove the permanent setting."},
+#endif
         {"local_param", jt_lcfg_param, 0, "set a temporary, local param\n"
          "usage: local_param <target.keyword=val>\n"},
         {"get_param", jt_lcfg_getparam, 0, "get the Lustre or LNET parameter\n"
@@ -150,10 +150,13 @@ command_t cmdlist[] = {
          "  -F  When -N specified, add '/', '@' or '=' for directories,\n"
          "      symlinks and writeable files, respectively."},
         {"set_param", jt_lcfg_setparam, 0, "set the Lustre or LNET parameter\n"
-         "usage: set_param [-n] <param_path1=value1 param_path2=value2 ...>\n"
-         "Set the value of the Lustre or LNET parameter at the specified path\n"
-         "  -n  Disable printing of the key name when printing values."},
-        {"list_param", jt_lcfg_listparam, 0,
+        "usage: set_param [-n] [-P] [-d]"
+        "<param_path1=value1 param_path2=value2 ...>\n"
+        "Set the value of the Lustre or LNET parameter at the specified path.\n"
+        "  -n  Disable printing of the key name when printing values.\n"
+        "  -P  Set the parameter permanently, filesystem-wide.\n"
+        "  -d  Remove the permanent setting (only with -P option).\n"},
+       {"list_param", jt_lcfg_listparam, 0,
          "list the Lustre or LNET parameter name\n"
          "usage: list_param [-F|-R] <param_path1 param_path2 ...>\n"
          "List the name of Lustre or LNET parameter from the specified path.\n"
@@ -209,19 +212,48 @@ command_t cmdlist[] = {
         {"===  Pools ==", jt_noop, 0, "pool management"},
         {"pool_new", jt_pool_cmd, 0,
          "add a new pool\n"
-         "usage pool_new <fsname>.<poolname>"},
-        {"pool_add", jt_pool_cmd, 0,
+        "usage: pool_new <fsname>.<poolname>"},
+       {"pool_add", jt_pool_cmd, 0,
          "add the named OSTs to the pool\n"
-         "usage pool_add <fsname>.<poolname> <ostname indexed list>"},
+        "usage: pool_add <fsname>.<poolname> <ostname indexed list>"},
         {"pool_remove", jt_pool_cmd, 0,
          "remove the named OST from the pool\n"
-         "usage pool_remove <fsname>.<poolname> <ostname indexed list>"},
+        "usage: pool_remove <fsname>.<poolname> <ostname indexed list>"},
         {"pool_destroy", jt_pool_cmd, 0,
          "destroy a pool\n"
-         "usage pool_destroy <fsname>.<poolname>"},
+        "usage: pool_destroy <fsname>.<poolname>"},
         {"pool_list", jt_pool_cmd, 0,
          "list pools and pools members\n"
-         "usage pool_list  <fsname>[.<poolname>] | <pathname>"},
+        "usage: pool_list  <fsname>[.<poolname>] | <pathname>"},
+
+       /* Nodemap commands */
+       {"=== Nodemap ===", jt_noop, 0, "nodemap management"},
+       {"nodemap_activate", jt_nodemap_activate, 0,
+        "activate nodemap idmapping functions\n"
+        "usage: nodemap_activate"},
+       {"nodemap_add", jt_nodemap_add, 0,
+        "add a new nodemap\n"
+        "usage: nodemap_add <nodemap_name>"},
+       {"nodemap_del", jt_nodemap_del, 0,
+        "remove a nodemap\n"
+        "usage: nodemap_del <nodemap_name>"},
+       {"nodemap_add_range", jt_nodemap_add_range, 0,
+        "add a range to a nodemap\n"
+        "usage: nodemap_add_range <NID range>"},
+       {"nodemap_del_range", jt_nodemap_del_range, 0,
+        "add a range to a nodemap\n"
+        "usage: nodemap_del_range <NID range>"},
+       {"nodemap_modify", jt_nodemap_modify, 0,
+        "modify a nodemap parameters"
+        "usage: nodemap_modify nodemap_name param value"},
+       {"nodemap_add_idmap", jt_nodemap_add_idmap, 0,
+        "add a UID or GID mapping to a nodemap"},
+       {"nodemap_del_idmap", jt_nodemap_del_idmap, 0,
+        "delete a UID or GID mapping from a nodemap"},
+       {"nodemap_test_nid", jt_nodemap_test_nid, 0,
+        "usage: nodemap_test_nid <nid>"},
+       {"nodemap_test_id", jt_nodemap_test_id, 0,
+        "Usage: nodemap_test_id --nid <nid> --idtype [uid|gid] --id <id>"},
 
         /* Changelog commands */
         {"===  Changelogs ==", jt_noop, 0, "changelog user management"},
@@ -310,7 +342,7 @@ command_t cmdlist[] = {
         {"test_setxattr", jt_obd_test_setxattr, 0,
          "Set EA for files/directory on MDT by echo client\n"
          "usage: test_setxattr [-d parent_baseid] <-D parent_count>"
-         "[-b child_base_id] [-x size] [-n count] <-t time>\n"},
+         "[-b child_base_id] [-n count] <-t time>\n"},
         {"test_md_getattr", jt_obd_test_md_getattr, 0,
          "getattr files on MDT by echo client\n"
          "usage: test_md_getattr [-d parent_basedir] <-D parent_count>"
@@ -336,10 +368,6 @@ command_t cmdlist[] = {
         {"test_brw", jt_obd_test_brw, 0,
          "do <num> bulk read/writes (<npages> per I/O, on OST object <objid>)\n"
          "usage: test_brw [t]<num> [write [verbose [npages [[t]objid]]]]"},
-        {"lwt", jt_ptl_lwt, 0,
-         "light-weight tracing\n"
-         "usage: lwt start\n"
-         "       lwt stop [file]"},
         {"memhog", jt_ptl_memhog, 0,
          "memory pressure testing\n"
          "usage: memhog <page count> [<gfp flags>]"},
@@ -351,66 +379,74 @@ command_t cmdlist[] = {
        /* LFSCK commands */
        {"==== LFSCK ====", jt_noop, 0, "LFSCK"},
        {"lfsck_start", jt_lfsck_start, 0, "start LFSCK\n"
-        "usage: lfsck_start <-M | --device MDT_device>\n"
-        "                   [-e | --error error_handle] [-h | --help]\n"
-        "                   [-n | --dryrun switch] [-r | --reset]\n"
-        "                   [-s | --speed speed_limit]\n"
-        "                   [-t | --type lfsck_type[,lfsck_type...]]"},
+        "usage: lfsck_start <-M | --device [MDT,OST]_device>\n"
+        "                   [-A | --all] [-c | --create_ostobj [on | off]]\n"
+        "                   [-e | --error {continue | abort}] [-h | --help]\n"
+        "                   [-n | --dryrun [on | off]] [-o | --orphan]\n"
+        "                   [-r | --reset] [-s | --speed speed_limit]\n"
+        "                   [-t | --type lfsck_type[,lfsck_type...]]\n"
+        "                   [-w | --window_size size]"},
        {"lfsck_stop", jt_lfsck_stop, 0, "stop lfsck(s)\n"
-        "usage: lfsck_stop <-M | --device MDT_device> [-h | --help]"},
+        "usage: lfsck_stop <-M | --device [MDT,OST]_device>\n"
+        "                  [-A | --all] [-h | --help]"},
 
-        {"==== obsolete (DANGEROUS) ====", jt_noop, 0, "obsolete (DANGEROUS)"},
-        /* some test scripts still use these */
-        {"cfg_device", jt_obd_device, 0,
-         "set current device to <name>\n"
-         "usage: device <name>"},
-        {"recover", jt_obd_recover, 0,
-         "try to restore a lost connection immediately\n"
-         "usage: recover [MDC/OSC device]"},
-        /* saving for sanity 44a */
-        {"lov_getconfig", jt_obd_lov_getconfig, 0,
-         "read lov configuration from an mds device\n"
-         "usage: lov_getconfig <mountpoint>"},
-        /* Llog operations */
-        {"llog_catlist", jt_llog_catlist, 0,
-         "list all catalog logs on current device.\n"
-         "usage: llog_catlist"},
-        {"llog_info", jt_llog_info, 0,
-         "print log header information.\n"
-         "usage: llog_info <$logname|#oid#ogr#ogen>\n"
-         "       oid, ogr and ogen are hexadecimal."},
-        {"llog_print", jt_llog_print, 0,
-         "print log content information.\n"
-         "usage: llog_print <$logname|#oid#ogr#ogen> [from] [to]\n"
-         "       oid, ogr and ogen are hexadecimal.\n"
-         "       print all records from index 1 by default."},
-        {"llog_check", jt_llog_check, 0,
-         "print log content information.\n"
-         "usage: llog_check <$logname|#oid#ogr#ogen> [from] [to]\n"
-         "       oid, ogr and ogen are hexadecimal.\n"
-         "       check all records from index 1 by default."},
-         {"llog_cancel", jt_llog_cancel, 0,
-         "cancel one record in log.\n"
-         "usage: llog_cancel <catalog id|catalog name> <log id> <index>"},
-        {"llog_remove", jt_llog_remove, 0,
-         "remove one log from catalog, erase it from disk.\n"
-         "usage: llog_remove <catalog id|catalog name> <log id>"},
-        /* network operations */
-        {"add_interface", jt_ptl_add_interface, 0, "add interface entry\n"
-         "usage: add_interface ip [netmask]"},
-        {"del_interface", jt_ptl_del_interface, 0, "del interface entry\n"
-         "usage: del_interface [ip]"},
-        {"add_route", jt_ptl_add_route, 0,
-         "add an entry to the portals routing table\n"
-         "usage: add_route <gateway> <target> [<target>]"},
-        {"del_route", jt_ptl_del_route, 0,
-         "delete route via gateway to targets from the portals routing table\n"
-         "usage: del_route <gateway> [<target>] [<target>]"},
-        {"set_route", jt_ptl_notify_router, 0,
-         "enable/disable routes via gateway in the portals routing table\n"
-         "usage: set_route <gateway> <up/down> [<time>]"},
+       {"==== obsolete (DANGEROUS) ====", jt_noop, 0, "obsolete (DANGEROUS)"},
+       /* some test scripts still use these */
+       {"cfg_device", jt_obd_device, 0,
+        "set current device to <name>\n"
+        "usage: device <name>"},
+       {"recover", jt_obd_recover, 0,
+        "try to restore a lost connection immediately\n"
+        "usage: recover [MDC/OSC device]"},
+       /* saving for sanity 44a */
+       {"lov_getconfig", jt_obd_lov_getconfig, 0,
+        "read lov configuration from an mds device\n"
+        "usage: lov_getconfig <mountpoint>"},
+       /* Llog operations */
+       {"llog_catlist", jt_llog_catlist, 0,
+        "list all catalog logs on current device.\n"
+        "usage: llog_catlist"},
+       {"llog_info", jt_llog_info, 0,
+        "print log header information.\n"
+        "usage: llog_info <$logname|#oid#ogr#ogen>\n"
+        "       oid, ogr and ogen are hexadecimal."},
+       {"llog_print", jt_llog_print, 0,
+        "print log content information.\n"
+        "usage: llog_print <$logname|#oid#ogr#ogen> [from] [to]\n"
+        "       oid, ogr and ogen are hexadecimal.\n"
+        "       print all records from index 1 by default."},
+       {"llog_check", jt_llog_check, 0,
+        "print log content information.\n"
+        "usage: llog_check <$logname|#oid#ogr#ogen> [from] [to]\n"
+        "       oid, ogr and ogen are hexadecimal.\n"
+        "       check all records from index 1 by default."},
+        {"llog_cancel", jt_llog_cancel, 0,
+        "cancel one record in log.\n"
+        "This command supports both positional and optional arguments\n"
+        "usage (positional args): "
+        "llog_cancel <catalog id|catalog name> [log id] <index>\n"
+        "usage (optional args): "
+        "llog_cancel --catalog <catalog id|catalog name> --log_id <log_id> "
+        "--log_idx <index>"},
+       {"llog_remove", jt_llog_remove, 0,
+        "remove one log from catalog or plain log, erase it from disk.\n"
+        "usage: llog_remove <catalog id|catalog name> <log id>"},
+       /* network operations */
+       {"add_interface", jt_ptl_add_interface, 0, "add interface entry\n"
+        "usage: add_interface ip [netmask]"},
+       {"del_interface", jt_ptl_del_interface, 0, "del interface entry\n"
+        "usage: del_interface [ip]"},
+       {"add_route", jt_ptl_add_route, 0,
+        "add an entry to the portals routing table\n"
+        "usage: add_route <gateway> [<hops> [<priority>]]"},
+       {"del_route", jt_ptl_del_route, 0,
+        "delete route via gateway to targets from the portals routing table\n"
+        "usage: del_route <gateway> [<target>] [<target>]"},
+       {"set_route", jt_ptl_notify_router, 0,
+        "enable/disable routes via gateway in the portals routing table\n"
+        "usage: set_route <gateway> <up/down> [<time>]"},
 
-        { 0, 0, 0, NULL }
+       { 0, 0, 0, NULL }
 };
 
 int lctl_main(int argc, char **argv)
@@ -425,7 +461,7 @@ int lctl_main(int argc, char **argv)
         if (dbg_initialize(argc, argv) < 0)
                 exit(3);
 
-        Parser_init("lctl > ", cmdlist);
+       Parser_init("lctl > ", cmdlist);
 
         if (argc > 1) {
                 rc = Parser_execarg(argc - 1, argv + 1, cmdlist);