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