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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/utils/lctl.c
  37  *
  38  * Author: Peter J. Braam <braam@clusterfs.com>
  39  * Author: Phil Schwan <phil@clusterfs.com>
  40  * Author: Robert Read <rread@clusterfs.com>
  41  */
  42
  43 #include <stdlib.h>
  44 #include <stdio.h>
  45 #include <lnet/lnetctl.h>
  46 #include "obdctl.h"
  47 #include <libcfs/libcfsutil.h>
  48
  49 static int jt_quit(int argc, char **argv) {
  50         Parser_quit(argc, argv);
  51         return 0;
  52 }
  53
  54 static int jt_noop(int argc, char **argv) {
  55         return 0;
  56 }
  57
  58 static int jt_opt_ignore_errors(int argc, char **argv) {
  59         Parser_ignore_errors(1);
  60         return 0;
  61 }
  62
  63 command_t cmdlist[] = {
  64         /* Metacommands */
  65         {"===== metacommands =======", jt_noop, 0, "metacommands"},
  66         {"--device", jt_opt_device, 0,
  67          "run <command> after connecting to device <devno>\n"
  68          "--device <devno> <command [args ...]>"},
  69         {"--ignore_errors", jt_opt_ignore_errors, 0,
  70          "ignore errors that occur during script processing\n"
  71          "--ignore_errors"},
  72         {"ignore_errors", jt_opt_ignore_errors, 0,
  73          "ignore errors that occur during script processing\n"
  74          "ignore_errors"},
  75
  76         /* User interface commands */
  77         {"======== control =========", jt_noop, 0, "control commands"},
  78         {"help", Parser_help, 0, "help"},
  79         {"lustre_build_version", jt_get_version, 0,
  80          "print the build version of lustre\n"
  81          "usage: lustre_build_version"},
  82         {"exit", jt_quit, 0, "quit"},
  83         {"quit", jt_quit, 0, "quit"},
  84
  85         /* Network configuration commands */
  86         {"===== network config =====", jt_noop, 0, "network config"},
  87         {"--net", jt_opt_net, 0,"run <command> after setting network to <net>\n"
  88          "usage: --net <tcp/elan/o2ib/...> <command>"},
  89         {"network", jt_ptl_network, 0, "configure LNET"
  90          "usage: network up|down"},
  91         {"net", jt_ptl_network, 0, "configure LNET"
  92          "usage: net up|down"},
  93         {"list_nids", jt_ptl_list_nids, 0, "list local NIDs"
  94          "usage: list_nids [all]"},
  95         {"which_nid", jt_ptl_which_nid, 0, "choose a NID"
  96          "usage: which_nid NID [NID...]"},
  97         {"replace_nids", jt_replace_nids, 0,
  98          "replace primary NIDs for a device\n"
  99          "usage: replace_nids <device> <nid1>[,nid2,nid3]"},
 100         {"interface_list", jt_ptl_print_interfaces,0,"print interface entries\n"
 101          "usage: interface_list"},
 102         {"peer_list", jt_ptl_print_peers, 0, "print peer entries\n"
 103          "usage: peer_list"},
 104         {"conn_list", jt_ptl_print_connections, 0,
 105          "print all the connected remote nid\n"
 106          "usage: conn_list"},
 107         {"active_tx", jt_ptl_print_active_txs, 0, "print active transmits\n"
 108          "usage: active_tx"},
 109         {"route_list", jt_ptl_print_routes, 0,
 110          "print the portals routing table, same as show_route\n"
 111          "usage: route_list"},
 112         {"show_route", jt_ptl_print_routes, 0,
 113          "print the portals routing table, same as route_list\n"
 114          "usage: show_route"},
 115         {"ping", jt_ptl_ping, 0, "Check LNET connectivity\n"
 116          "usage: ping nid [timeout] [pid]"},
 117
 118         /* Device selection commands */
 119         {"==== obd device selection ====", jt_noop, 0, "device selection"},
 120         {"device", jt_obd_device, 0,
 121          "set current device to <name|devno>\n"
 122          "usage: device <%name|$name|devno>"},
 123         {"device_list", jt_obd_list, 0, "show all devices\n"
 124          "usage: device_list"},
 125         {"dl", jt_obd_list, 0, "show all devices\n"
 126          "usage: dl [-t]"},
 127
 128         /* Device operations */
 129         {"==== obd device operations ====", jt_noop, 0, "device operations"},
 130         {"activate", jt_obd_activate, 0, "activate an import\n"},
 131         {"deactivate", jt_obd_deactivate, 0, "deactivate an import. "
 132          "This command should be used on failed OSC devices in an MDT LOV.\n"},
 133         {"abort_recovery", jt_obd_abort_recovery, 0,
 134          "abort recovery on a restarting MDT or OST device\n"},
 135         {"set_timeout", jt_lcfg_set_timeout, 0,
 136          "usage: conf_param obd_timeout=<secs>\n"},
 137 #if LUSTRE_VERSION >= OBD_OCD_VERSION(3,0,53,0)
 138 #warning "remove conf_param option"
 139 #else
 140         {"conf_param", jt_lcfg_mgsparam, 0,"set a permanent config parameter.\n"
 141          "This command must be run on the MGS node\n"
 142          "usage: conf_param [-d] <target.keyword=val>\n"
 143          "  -d  Remove the permanent setting."},
 144 #endif
 145         {"local_param", jt_lcfg_param, 0, "set a temporary, local param\n"
 146          "usage: local_param <target.keyword=val>\n"},
 147         {"get_param", jt_lcfg_getparam, 0, "get the Lustre or LNET parameter\n"
 148          "usage: get_param [-n|-N|-F] <param_path1 param_path2 ...>\n"
 149          "Get the value of Lustre or LNET parameter from the specified path.\n"
 150          "The path can contain shell-style filename patterns.\n"
 151          "  -n  Print only the value and not parameter name.\n"
 152          "  -N  Print only matched parameter names and not the values.\n"
 153          "      (Especially useful when using patterns.)\n"
 154          "  -F  When -N specified, add '/', '@' or '=' for directories,\n"
 155          "      symlinks and writeable files, respectively."},
 156         {"set_param", jt_lcfg_setparam, 0, "set the Lustre or LNET parameter\n"
 157          "usage: set_param [-n] [-P] [-d]"
 158          "<param_path1=value1 param_path2=value2 ...>\n"
 159          "Set the value of the Lustre or LNET parameter at the specified path.\n"
 160          "  -n  Disable printing of the key name when printing values.\n"
 161          "  -P  Set the parameter permanently, filesystem-wide.\n"
 162          "  -d  Remove the permanent setting (only with -P option).\n"},
 163         {"list_param", jt_lcfg_listparam, 0,
 164          "list the Lustre or LNET parameter name\n"
 165          "usage: list_param [-F|-R] <param_path1 param_path2 ...>\n"
 166          "List the name of Lustre or LNET parameter from the specified path.\n"
 167          "  -F  Add '/', '@' or '=' for dirs, symlinks and writeable files,\n"
 168                 "respectively.\n"
 169          "  -R  Recursively list all parameters under the specified path.\n"},
 170
 171         /* Debug commands */
 172         {"==== debugging control ====", jt_noop, 0, "debug"},
 173         {"debug_daemon", jt_dbg_debug_daemon, 0,
 174          "debug daemon control and dump to a file\n"
 175          "usage: debug_daemon {start file [#MB]|stop}"},
 176         {"debug_kernel", jt_dbg_debug_kernel, 0,
 177          "get debug buffer and dump to a file, same as dk\n"
 178          "usage: debug_kernel [file] [raw]"},
 179         {"dk", jt_dbg_debug_kernel, 0,
 180          "get debug buffer and dump to a file, same as debug_kernel\n"
 181          "usage: dk [file] [raw]"},
 182         {"debug_file", jt_dbg_debug_file, 0,
 183          "convert a binary debug file dumped by the kernel to ASCII text\n"
 184          "usage: debug_file <input> [output]"},
 185         {"df", jt_dbg_debug_file, 0,
 186          "read debug buffer from input and dump to output, same as debug_file\n"
 187          "usage: df <input> [output]"},
 188         {"clear", jt_dbg_clear_debug_buf, 0, "clear kernel debug buffer\n"
 189          "usage: clear"},
 190         {"mark", jt_dbg_mark_debug_buf, 0,
 191          "insert marker text in kernel debug buffer\n"
 192          "usage: mark <text>"},
 193         {"filter", jt_dbg_filter, 0, "filter message type\n"
 194          "usage: filter <subsystem id/debug mask>"},
 195         {"show", jt_dbg_show, 0, "Show specific type of messages\n"
 196          "usage: show <subsystem id/debug mask>"},
 197         {"debug_list", jt_dbg_list, 0, "list subsystem and debug types\n"
 198          "usage: debug_list <subs/types>"},
 199         {"modules", jt_dbg_modules, 0,
 200          "provide gdb-friendly module information\n"
 201          "usage: modules <path>"},
 202
 203         /* virtual block operations */
 204         {"==== virtual block device ====", jt_noop, 0, "virtual block device"},
 205         {"blockdev_attach", jt_blockdev_attach, 0,
 206          "attach a lustre regular file to a virtual block device\n"
 207          "usage: blockdev_attach <file_name> <device_name>"},
 208         {"blockdev_detach", jt_blockdev_detach, 0,
 209          "detach a lustre regular file from a virtual block device\n"
 210          "usage: blockdev_detach <device_name>"},
 211         {"blockdev_info", jt_blockdev_info, 0,
 212          "get the device info of a attached file\n"
 213          "usage: blockdev_info <device_name>"},
 214
 215         /* Pool commands */
 216         {"===  Pools ==", jt_noop, 0, "pool management"},
 217         {"pool_new", jt_pool_cmd, 0,
 218          "add a new pool\n"
 219          "usage pool_new <fsname>.<poolname>"},
 220         {"pool_add", jt_pool_cmd, 0,
 221          "add the named OSTs to the pool\n"
 222          "usage pool_add <fsname>.<poolname> <ostname indexed list>"},
 223         {"pool_remove", jt_pool_cmd, 0,
 224          "remove the named OST from the pool\n"
 225          "usage pool_remove <fsname>.<poolname> <ostname indexed list>"},
 226         {"pool_destroy", jt_pool_cmd, 0,
 227          "destroy a pool\n"
 228          "usage pool_destroy <fsname>.<poolname>"},
 229         {"pool_list", jt_pool_cmd, 0,
 230          "list pools and pools members\n"
 231          "usage pool_list  <fsname>[.<poolname>] | <pathname>"},
 232
 233         /* Changelog commands */
 234         {"===  Changelogs ==", jt_noop, 0, "changelog user management"},
 235         {"changelog_register", jt_changelog_register, 0,
 236          "register a new persistent changelog user, returns id\n"
 237          "usage:\tdevice <mdtname>\n\tchangelog_register [-n]"},
 238         {"changelog_deregister", jt_changelog_deregister, 0,
 239          "deregister an existing changelog user\n"
 240          "usage:\tdevice <mdtname>\n\tchangelog_deregister <id>"},
 241
 242         /* Device configuration commands */
 243         {"== device setup (these are not normally used post 1.4) ==",
 244                 jt_noop, 0, "device config"},
 245         {"attach", jt_lcfg_attach, 0,
 246          "set the type, name, and uuid of the current device\n"
 247          "usage: attach type name uuid"},
 248         {"detach", jt_obd_detach, 0,
 249          "remove driver (and name and uuid) from current device\n"
 250          "usage: detach"},
 251         {"setup", jt_lcfg_setup, 0,
 252          "type specific device configuration information\n"
 253          "usage: setup <args...>"},
 254         {"cleanup", jt_obd_cleanup, 0, "cleanup previously setup device\n"
 255          "usage: cleanup [force | failover]"},
 256         {"dump_cfg", jt_cfg_dump_log, 0,
 257          "print log of recorded commands for this config to kernel debug log\n"
 258          "usage: dump_cfg config-uuid-name"},
 259
 260         /* Test only commands */
 261         {"==== testing (DANGEROUS) ====", jt_noop, 0, "testing (DANGEROUS)"},
 262         {"--threads", jt_opt_threads, 0,
 263          "run <threads> separate instances of <command> on device <devno>\n"
 264          "--threads <threads> <verbose> <devno> <command [args ...]>"},
 265         {"lookup", jt_obd_mdc_lookup, 0, "report file mode info\n"
 266          "usage: lookup <directory> <file>"},
 267         {"readonly", jt_obd_set_readonly, 0,
 268          "disable writes to the underlying device\n"},
 269         {"notransno", jt_obd_no_transno, 0,
 270          "disable sending of committed-transno updates\n"},
 271         {"add_uuid", jt_lcfg_add_uuid, 0, "associate a UUID with a nid\n"
 272          "usage: add_uuid <uuid> <nid>"},
 273         {"del_uuid", jt_lcfg_del_uuid, 0, "delete a UUID association\n"
 274          "usage: del_uuid <uuid>"},
 275         {"add_peer", jt_ptl_add_peer, 0, "add an peer entry\n"
 276          "usage: add_peer <nid> <host> <port>"},
 277         {"del_peer", jt_ptl_del_peer, 0, "remove an peer entry\n"
 278          "usage: del_peer [<nid>] [<ipaddr|pid>]"},
 279         {"add_conn ", jt_lcfg_add_conn, 0,
 280          "usage: add_conn <conn_uuid> [priority]\n"},
 281         {"del_conn ", jt_lcfg_del_conn, 0,
 282          "usage: del_conn <conn_uuid> \n"},
 283         {"disconnect", jt_ptl_disconnect, 0, "disconnect from a remote nid\n"
 284          "usage: disconnect [<nid>]"},
 285         {"push", jt_ptl_push_connection, 0, "flush connection to a remote nid\n"
 286          "usage: push [<nid>]"},
 287         {"mynid", jt_ptl_mynid, 0, "inform the socknal of the local nid. "
 288          "The nid defaults to hostname for tcp networks and is automatically "
 289          "setup for elan/myrinet networks.\n"
 290          "usage: mynid [<nid>]"},
 291         {"fail", jt_ptl_fail_nid, 0, "fail/restore communications.\n"
 292          "Omitting the count means indefinitely, 0 means restore, "
 293          "otherwise fail 'count' messages.\n"
 294          "usage: fail nid|_all_ [count]"},
 295
 296         /*Test commands for echo client*/
 297         {"test_create", jt_obd_test_create, 0,
 298          "create files on MDT by echo client\n"
 299          "usage: test_create [-d parent_basedir] <-D parent_count> "
 300          "[-b child_base_id] <-c stripe_count> <-n count> <-t time>\n"},
 301         {"test_mkdir", jt_obd_test_mkdir, 0,
 302          "mkdir on MDT by echo client\n"
 303          "usage: test_mkdir [-d parent_basedir] <-D parent_count>"
 304          "[-b child_base_id] [-n count] <-t time>\n"},
 305         {"test_destroy", jt_obd_test_destroy, 0,
 306          "Destroy files on MDT by echo client\n"
 307          "usage: test_destroy [-d parent_basedir] <-D parent_count>"
 308          "[-b child_base_id] [-n count] <-t time>\n"},
 309         {"test_rmdir", jt_obd_test_rmdir, 0,
 310          "rmdir on MDT by echo client\n"
 311          "usage: test_rmdir [-d parent_basedir] <-D parent_count>"
 312          "[-b child_base_id] [-n count] <-t time>\n"},
 313         {"test_lookup", jt_obd_test_lookup, 0,
 314          "lookup files on MDT by echo client\n"
 315          "usage: test_lookup [-d parent_basedir] <-D parent_count>"
 316          "[-b child_base_id] [-n count] <-t time>\n"},
 317         {"test_setxattr", jt_obd_test_setxattr, 0,
 318          "Set EA for files/directory on MDT by echo client\n"
 319          "usage: test_setxattr [-d parent_baseid] <-D parent_count>"
 320          "[-b child_base_id] [-n count] <-t time>\n"},
 321         {"test_md_getattr", jt_obd_test_md_getattr, 0,
 322          "getattr files on MDT by echo client\n"
 323          "usage: test_md_getattr [-d parent_basedir] <-D parent_count>"
 324          "[-b child_base_id] [-n count] <-t time>\n"},
 325         {"getattr", jt_obd_getattr, 0,
 326          "get attribute for OST object <objid>\n"
 327          "usage: getattr <objid>"},
 328         {"setattr", jt_obd_setattr, 0,
 329          "set mode attribute for OST object <objid>\n"
 330          "usage: setattr <objid> <mode>"},
 331         {"create", jt_obd_create, 0,
 332          "create <num> OST objects (with <mode>)\n"
 333          "usage: create [num [mode [verbose [lsm data]]]]"},
 334         {"destroy", jt_obd_destroy, 0,
 335          "destroy OST object <objid> [num [verbose]]\n"
 336          "usage: destroy <num> objects, starting at objid <objid>"},
 337         {"test_getattr", jt_obd_test_getattr, 0,
 338          "do <num> getattrs (on OST object <objid> (objid+1 on each thread))\n"
 339          "usage: test_getattr <num> [verbose [[t]objid]]"},
 340         {"test_setattr", jt_obd_test_setattr, 0,
 341          "do <num> setattrs (on OST object <objid> (objid+1 on each thread))\n"
 342          "usage: test_setattr <num> [verbose [[t]objid]]"},
 343         {"test_brw", jt_obd_test_brw, 0,
 344          "do <num> bulk read/writes (<npages> per I/O, on OST object <objid>)\n"
 345          "usage: test_brw [t]<num> [write [verbose [npages [[t]objid]]]]"},
 346         {"lwt", jt_ptl_lwt, 0,
 347          "light-weight tracing\n"
 348          "usage: lwt start\n"
 349          "       lwt stop [file]"},
 350         {"memhog", jt_ptl_memhog, 0,
 351          "memory pressure testing\n"
 352          "usage: memhog <page count> [<gfp flags>]"},
 353         {"getobjversion", jt_get_obj_version, 0,
 354          "get the version of an object on servers\n"
 355          "usage: getobjversion <fid>\n"
 356          "       getobjversion -i <id> -g <group>"},
 357
 358         /* LFSCK commands */
 359         {"==== LFSCK ====", jt_noop, 0, "LFSCK"},
 360         {"lfsck_start", jt_lfsck_start, 0, "start LFSCK\n"
 361          "usage: lfsck_start <-M | --device [MDT,OST]_device>\n"
 362          "                   [-e | --error error_handle] [-h | --help]\n"
 363          "                   [-n | --dryrun switch] [-r | --reset]\n"
 364          "                   [-s | --speed speed_limit]\n"
 365          "                   [-t | --type lfsck_type[,lfsck_type...]]"},
 366         {"lfsck_stop", jt_lfsck_stop, 0, "stop lfsck(s)\n"
 367          "usage: lfsck_stop <-M | --device [MDT,OST]_device> [-h | --help]"},
 368
 369         {"==== obsolete (DANGEROUS) ====", jt_noop, 0, "obsolete (DANGEROUS)"},
 370         /* some test scripts still use these */
 371         {"cfg_device", jt_obd_device, 0,
 372          "set current device to <name>\n"
 373          "usage: device <name>"},
 374         {"recover", jt_obd_recover, 0,
 375          "try to restore a lost connection immediately\n"
 376          "usage: recover [MDC/OSC device]"},
 377         /* saving for sanity 44a */
 378         {"lov_getconfig", jt_obd_lov_getconfig, 0,
 379          "read lov configuration from an mds device\n"
 380          "usage: lov_getconfig <mountpoint>"},
 381         /* Llog operations */
 382         {"llog_catlist", jt_llog_catlist, 0,
 383          "list all catalog logs on current device.\n"
 384          "usage: llog_catlist"},
 385         {"llog_info", jt_llog_info, 0,
 386          "print log header information.\n"
 387          "usage: llog_info <$logname|#oid#ogr#ogen>\n"
 388          "       oid, ogr and ogen are hexadecimal."},
 389         {"llog_print", jt_llog_print, 0,
 390          "print log content information.\n"
 391          "usage: llog_print <$logname|#oid#ogr#ogen> [from] [to]\n"
 392          "       oid, ogr and ogen are hexadecimal.\n"
 393          "       print all records from index 1 by default."},
 394         {"llog_check", jt_llog_check, 0,
 395          "print log content information.\n"
 396          "usage: llog_check <$logname|#oid#ogr#ogen> [from] [to]\n"
 397          "       oid, ogr and ogen are hexadecimal.\n"
 398          "       check all records from index 1 by default."},
 399          {"llog_cancel", jt_llog_cancel, 0,
 400          "cancel one record in log.\n"
 401          "This command supports both positional and optional arguments\n"
 402          "usage (positional args): "
 403          "llog_cancel <catalog id|catalog name> [log id] <index>\n"
 404          "usage (optional args): "
 405          "llog_cancel --catalog <catalog id|catalog name> --log_id <log_id> "
 406          "--log_idx <index>"},
 407         {"llog_remove", jt_llog_remove, 0,
 408          "remove one log from catalog or plain log, erase it from disk.\n"
 409          "usage: llog_remove <catalog id|catalog name> <log id>"},
 410         /* network operations */
 411         {"add_interface", jt_ptl_add_interface, 0, "add interface entry\n"
 412          "usage: add_interface ip [netmask]"},
 413         {"del_interface", jt_ptl_del_interface, 0, "del interface entry\n"
 414          "usage: del_interface [ip]"},
 415         {"add_route", jt_ptl_add_route, 0,
 416          "add an entry to the portals routing table\n"
 417          "usage: add_route <gateway> [<hops> [<priority>]]"},
 418         {"del_route", jt_ptl_del_route, 0,
 419          "delete route via gateway to targets from the portals routing table\n"
 420          "usage: del_route <gateway> [<target>] [<target>]"},
 421         {"set_route", jt_ptl_notify_router, 0,
 422          "enable/disable routes via gateway in the portals routing table\n"
 423          "usage: set_route <gateway> <up/down> [<time>]"},
 424
 425         { 0, 0, 0, NULL }
 426 };
 427
 428 int lctl_main(int argc, char **argv)
 429 {
 430         int rc;
 431
 432         setlinebuf(stdout);
 433
 434         ptl_initialize(argc, argv);
 435         if (obd_initialize(argc, argv) < 0)
 436                 exit(2);
 437         if (dbg_initialize(argc, argv) < 0)
 438                 exit(3);
 439
 440         Parser_init("lctl > ", cmdlist);
 441
 442         if (argc > 1) {
 443                 rc = Parser_execarg(argc - 1, argv + 1, cmdlist);
 444         } else {
 445                 rc = Parser_commands();
 446         }
 447
 448         obd_finalize(argc, argv);
 449         return rc < 0 ? -rc : rc;
 450 }
 451
 452 #ifndef LIBLUSTRE_TEST
 453 int main (int argc, char **argv)
 454 {
 455         return (lctl_main (argc, argv));
 456 }
 457 #endif