4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
38 * Author: Peter J. Braam <braam@clusterfs.com>
39 * Author: Phil Schwan <phil@clusterfs.com>
40 * Author: Robert Read <rread@clusterfs.com>
45 #include <lnet/lnetctl.h>
47 #include <libcfs/libcfsutil.h>
49 static int jt_quit(int argc, char **argv) {
50 Parser_quit(argc, argv);
54 static int jt_noop(int argc, char **argv) {
58 static int jt_opt_ignore_errors(int argc, char **argv) {
59 Parser_ignore_errors(1);
63 command_t cmdlist[] = {
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"
72 {"ignore_errors", jt_opt_ignore_errors, 0,
73 "ignore errors that occur during script processing\n"
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"},
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"
104 {"conn_list", jt_ptl_print_connections, 0,
105 "print all the connected remote nid\n"
107 {"active_tx", jt_ptl_print_active_txs, 0, "print active transmits\n"
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]"},
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"
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_CODE < OBD_OCD_VERSION(3, 0, 53, 0)
138 {"conf_param", jt_lcfg_mgsparam, 0,"set a permanent config parameter.\n"
139 "This command must be run on the MGS node\n"
140 "usage: conf_param [-d] <target.keyword=val>\n"
141 " -d Remove the permanent setting."},
143 {"local_param", jt_lcfg_param, 0, "set a temporary, local param\n"
144 "usage: local_param <target.keyword=val>\n"},
145 {"get_param", jt_lcfg_getparam, 0, "get the Lustre or LNET parameter\n"
146 "usage: get_param [-n|-N|-F] <param_path1 param_path2 ...>\n"
147 "Get the value of Lustre or LNET parameter from the specified path.\n"
148 "The path can contain shell-style filename patterns.\n"
149 " -n Print only the value and not parameter name.\n"
150 " -N Print only matched parameter names and not the values.\n"
151 " (Especially useful when using patterns.)\n"
152 " -F When -N specified, add '/', '@' or '=' for directories,\n"
153 " symlinks and writeable files, respectively."},
154 {"set_param", jt_lcfg_setparam, 0, "set the Lustre or LNET parameter\n"
155 "usage: set_param [-n] [-P] [-d]"
156 "<param_path1=value1 param_path2=value2 ...>\n"
157 "Set the value of the Lustre or LNET parameter at the specified path.\n"
158 " -n Disable printing of the key name when printing values.\n"
159 " -P Set the parameter permanently, filesystem-wide.\n"
160 " -d Remove the permanent setting (only with -P option).\n"},
161 {"list_param", jt_lcfg_listparam, 0,
162 "list the Lustre or LNET parameter name\n"
163 "usage: list_param [-F|-R] <param_path1 param_path2 ...>\n"
164 "List the name of Lustre or LNET parameter from the specified path.\n"
165 " -F Add '/', '@' or '=' for dirs, symlinks and writeable files,\n"
167 " -R Recursively list all parameters under the specified path.\n"},
170 {"==== debugging control ====", jt_noop, 0, "debug"},
171 {"debug_daemon", jt_dbg_debug_daemon, 0,
172 "debug daemon control and dump to a file\n"
173 "usage: debug_daemon {start file [#MB]|stop}"},
174 {"debug_kernel", jt_dbg_debug_kernel, 0,
175 "get debug buffer and dump to a file, same as dk\n"
176 "usage: debug_kernel [file] [raw]"},
177 {"dk", jt_dbg_debug_kernel, 0,
178 "get debug buffer and dump to a file, same as debug_kernel\n"
179 "usage: dk [file] [raw]"},
180 {"debug_file", jt_dbg_debug_file, 0,
181 "convert a binary debug file dumped by the kernel to ASCII text\n"
182 "usage: debug_file <input> [output]"},
183 {"df", jt_dbg_debug_file, 0,
184 "read debug buffer from input and dump to output, same as debug_file\n"
185 "usage: df <input> [output]"},
186 {"clear", jt_dbg_clear_debug_buf, 0, "clear kernel debug buffer\n"
188 {"mark", jt_dbg_mark_debug_buf, 0,
189 "insert marker text in kernel debug buffer\n"
190 "usage: mark <text>"},
191 {"filter", jt_dbg_filter, 0, "filter message type\n"
192 "usage: filter <subsystem id/debug mask>"},
193 {"show", jt_dbg_show, 0, "Show specific type of messages\n"
194 "usage: show <subsystem id/debug mask>"},
195 {"debug_list", jt_dbg_list, 0, "list subsystem and debug types\n"
196 "usage: debug_list <subs/types>"},
197 {"modules", jt_dbg_modules, 0,
198 "provide gdb-friendly module information\n"
199 "usage: modules <path>"},
201 /* virtual block operations */
202 {"==== virtual block device ====", jt_noop, 0, "virtual block device"},
203 {"blockdev_attach", jt_blockdev_attach, 0,
204 "attach a lustre regular file to a virtual block device\n"
205 "usage: blockdev_attach <file_name> <device_name>"},
206 {"blockdev_detach", jt_blockdev_detach, 0,
207 "detach a lustre regular file from a virtual block device\n"
208 "usage: blockdev_detach <device_name>"},
209 {"blockdev_info", jt_blockdev_info, 0,
210 "get the device info of a attached file\n"
211 "usage: blockdev_info <device_name>"},
214 {"=== Pools ==", jt_noop, 0, "pool management"},
215 {"pool_new", jt_pool_cmd, 0,
217 "usage: pool_new <fsname>.<poolname>"},
218 {"pool_add", jt_pool_cmd, 0,
219 "add the named OSTs to the pool\n"
220 "usage: pool_add <fsname>.<poolname> <ostname indexed list>"},
221 {"pool_remove", jt_pool_cmd, 0,
222 "remove the named OST from the pool\n"
223 "usage: pool_remove <fsname>.<poolname> <ostname indexed list>"},
224 {"pool_destroy", jt_pool_cmd, 0,
226 "usage: pool_destroy <fsname>.<poolname>"},
227 {"pool_list", jt_pool_cmd, 0,
228 "list pools and pools members\n"
229 "usage: pool_list <fsname>[.<poolname>] | <pathname>"},
231 /* Nodemap commands */
232 {"=== Nodemap ===", jt_noop, 0, "nodemap management"},
233 {"nodemap_activate", jt_nodemap_activate, 0,
234 "activate nodemap idmapping functions\n"
235 "usage: nodemap_activate"},
236 {"nodemap_add", jt_nodemap_add, 0,
237 "add a new nodemap\n"
238 "usage: nodemap_add <nodemap_name>"},
239 {"nodemap_del", jt_nodemap_del, 0,
241 "usage: nodemap_del <nodemap_name>"},
242 {"nodemap_add_range", jt_nodemap_add_range, 0,
243 "add a range to a nodemap\n"
244 "usage: nodemap_add_range <NID range>"},
245 {"nodemap_del_range", jt_nodemap_del_range, 0,
246 "add a range to a nodemap\n"
247 "usage: nodemap_del_range <NID range>"},
248 {"nodemap_modify", jt_nodemap_modify, 0,
249 "modify a nodemap parameters"
250 "usage: nodemap_modify nodemap_name param value"},
251 {"nodemap_add_idmap", jt_nodemap_add_idmap, 0,
252 "add a UID or GID mapping to a nodemap"},
253 {"nodemap_del_idmap", jt_nodemap_del_idmap, 0,
254 "delete a UID or GID mapping from a nodemap"},
255 {"nodemap_test_nid", jt_nodemap_test_nid, 0,
256 "usage: nodemap_test_nid <nid>"},
257 {"nodemap_test_id", jt_nodemap_test_id, 0,
258 "Usage: nodemap_test_id --nid <nid> --idtype [uid|gid] --id <id>"},
260 /* Changelog commands */
261 {"=== Changelogs ==", jt_noop, 0, "changelog user management"},
262 {"changelog_register", jt_changelog_register, 0,
263 "register a new persistent changelog user, returns id\n"
264 "usage:\tdevice <mdtname>\n\tchangelog_register [-n]"},
265 {"changelog_deregister", jt_changelog_deregister, 0,
266 "deregister an existing changelog user\n"
267 "usage:\tdevice <mdtname>\n\tchangelog_deregister <id>"},
269 /* Device configuration commands */
270 {"== device setup (these are not normally used post 1.4) ==",
271 jt_noop, 0, "device config"},
272 {"attach", jt_lcfg_attach, 0,
273 "set the type, name, and uuid of the current device\n"
274 "usage: attach type name uuid"},
275 {"detach", jt_obd_detach, 0,
276 "remove driver (and name and uuid) from current device\n"
278 {"setup", jt_lcfg_setup, 0,
279 "type specific device configuration information\n"
280 "usage: setup <args...>"},
281 {"cleanup", jt_obd_cleanup, 0, "cleanup previously setup device\n"
282 "usage: cleanup [force | failover]"},
283 {"dump_cfg", jt_cfg_dump_log, 0,
284 "print log of recorded commands for this config to kernel debug log\n"
285 "usage: dump_cfg config-uuid-name"},
287 /* Test only commands */
288 {"==== testing (DANGEROUS) ====", jt_noop, 0, "testing (DANGEROUS)"},
289 {"--threads", jt_opt_threads, 0,
290 "run <threads> separate instances of <command> on device <devno>\n"
291 "--threads <threads> <verbose> <devno> <command [args ...]>"},
292 {"lookup", jt_obd_mdc_lookup, 0, "report file mode info\n"
293 "usage: lookup <directory> <file>"},
294 {"readonly", jt_obd_set_readonly, 0,
295 "disable writes to the underlying device\n"},
296 {"notransno", jt_obd_no_transno, 0,
297 "disable sending of committed-transno updates\n"},
298 {"add_uuid", jt_lcfg_add_uuid, 0, "associate a UUID with a nid\n"
299 "usage: add_uuid <uuid> <nid>"},
300 {"del_uuid", jt_lcfg_del_uuid, 0, "delete a UUID association\n"
301 "usage: del_uuid <uuid>"},
302 {"add_peer", jt_ptl_add_peer, 0, "add an peer entry\n"
303 "usage: add_peer <nid> <host> <port>"},
304 {"del_peer", jt_ptl_del_peer, 0, "remove an peer entry\n"
305 "usage: del_peer [<nid>] [<ipaddr|pid>]"},
306 {"add_conn ", jt_lcfg_add_conn, 0,
307 "usage: add_conn <conn_uuid> [priority]\n"},
308 {"del_conn ", jt_lcfg_del_conn, 0,
309 "usage: del_conn <conn_uuid> \n"},
310 {"disconnect", jt_ptl_disconnect, 0, "disconnect from a remote nid\n"
311 "usage: disconnect [<nid>]"},
312 {"push", jt_ptl_push_connection, 0, "flush connection to a remote nid\n"
313 "usage: push [<nid>]"},
314 {"mynid", jt_ptl_mynid, 0, "inform the socknal of the local nid. "
315 "The nid defaults to hostname for tcp networks and is automatically "
316 "setup for elan/myrinet networks.\n"
317 "usage: mynid [<nid>]"},
318 {"fail", jt_ptl_fail_nid, 0, "fail/restore communications.\n"
319 "Omitting the count means indefinitely, 0 means restore, "
320 "otherwise fail 'count' messages.\n"
321 "usage: fail nid|_all_ [count]"},
323 /*Test commands for echo client*/
324 {"test_create", jt_obd_test_create, 0,
325 "create files on MDT by echo client\n"
326 "usage: test_create [-d parent_basedir] <-D parent_count> "
327 "[-b child_base_id] <-c stripe_count> <-n count> <-t time>\n"},
328 {"test_mkdir", jt_obd_test_mkdir, 0,
329 "mkdir on MDT by echo client\n"
330 "usage: test_mkdir [-d parent_basedir] <-D parent_count>"
331 "[-b child_base_id] [-n count] <-t time>\n"},
332 {"test_destroy", jt_obd_test_destroy, 0,
333 "Destroy files on MDT by echo client\n"
334 "usage: test_destroy [-d parent_basedir] <-D parent_count>"
335 "[-b child_base_id] [-n count] <-t time>\n"},
336 {"test_rmdir", jt_obd_test_rmdir, 0,
337 "rmdir on MDT by echo client\n"
338 "usage: test_rmdir [-d parent_basedir] <-D parent_count>"
339 "[-b child_base_id] [-n count] <-t time>\n"},
340 {"test_lookup", jt_obd_test_lookup, 0,
341 "lookup files on MDT by echo client\n"
342 "usage: test_lookup [-d parent_basedir] <-D parent_count>"
343 "[-b child_base_id] [-n count] <-t time>\n"},
344 {"test_setxattr", jt_obd_test_setxattr, 0,
345 "Set EA for files/directory on MDT by echo client\n"
346 "usage: test_setxattr [-d parent_baseid] <-D parent_count>"
347 "[-b child_base_id] [-n count] <-t time>\n"},
348 {"test_md_getattr", jt_obd_test_md_getattr, 0,
349 "getattr files on MDT by echo client\n"
350 "usage: test_md_getattr [-d parent_basedir] <-D parent_count>"
351 "[-b child_base_id] [-n count] <-t time>\n"},
352 {"getattr", jt_obd_getattr, 0,
353 "get attribute for OST object <objid>\n"
354 "usage: getattr <objid>"},
355 {"setattr", jt_obd_setattr, 0,
356 "set mode attribute for OST object <objid>\n"
357 "usage: setattr <objid> <mode>"},
358 {"create", jt_obd_create, 0,
359 "create <num> OST objects (with <mode>)\n"
360 "usage: create [num [mode [verbose [lsm data]]]]"},
361 {"destroy", jt_obd_destroy, 0,
362 "destroy OST object <objid> [num [verbose]]\n"
363 "usage: destroy <num> objects, starting at objid <objid>"},
364 {"test_getattr", jt_obd_test_getattr, 0,
365 "do <num> getattrs (on OST object <objid> (objid+1 on each thread))\n"
366 "usage: test_getattr <num> [verbose [[t]objid]]"},
367 {"test_setattr", jt_obd_test_setattr, 0,
368 "do <num> setattrs (on OST object <objid> (objid+1 on each thread))\n"
369 "usage: test_setattr <num> [verbose [[t]objid]]"},
370 {"test_brw", jt_obd_test_brw, 0,
371 "do <num> bulk read/writes (<npages> per I/O, on OST object <objid>)\n"
372 "usage: test_brw [t]<num> [write [verbose [npages [[t]objid]]]]"},
373 {"memhog", jt_ptl_memhog, 0,
374 "memory pressure testing\n"
375 "usage: memhog <page count> [<gfp flags>]"},
376 {"getobjversion", jt_get_obj_version, 0,
377 "get the version of an object on servers\n"
378 "usage: getobjversion <fid>\n"
379 " getobjversion -i <id> -g <group>"},
382 {"==== LFSCK ====", jt_noop, 0, "LFSCK"},
383 {"lfsck_start", jt_lfsck_start, 0, "start LFSCK\n"
384 "usage: lfsck_start <-M | --device [MDT,OST]_device>\n"
385 " [-e | --error error_handle] [-h | --help]\n"
386 " [-n | --dryrun switch] [-r | --reset]\n"
387 " [-s | --speed speed_limit] [-A | --all]\n"
388 " [-t | --type lfsck_type[,lfsck_type...]]\n"
389 " [-w | --windows win_size] [-o | --orphan]"},
390 {"lfsck_stop", jt_lfsck_stop, 0, "stop lfsck(s)\n"
391 "usage: lfsck_stop <-M | --device [MDT,OST]_device>\n"
392 " [-A | --all] [-h | --help]"},
394 {"==== obsolete (DANGEROUS) ====", jt_noop, 0, "obsolete (DANGEROUS)"},
395 /* some test scripts still use these */
396 {"cfg_device", jt_obd_device, 0,
397 "set current device to <name>\n"
398 "usage: device <name>"},
399 {"recover", jt_obd_recover, 0,
400 "try to restore a lost connection immediately\n"
401 "usage: recover [MDC/OSC device]"},
402 /* saving for sanity 44a */
403 {"lov_getconfig", jt_obd_lov_getconfig, 0,
404 "read lov configuration from an mds device\n"
405 "usage: lov_getconfig <mountpoint>"},
406 /* Llog operations */
407 {"llog_catlist", jt_llog_catlist, 0,
408 "list all catalog logs on current device.\n"
409 "usage: llog_catlist"},
410 {"llog_info", jt_llog_info, 0,
411 "print log header information.\n"
412 "usage: llog_info <$logname|#oid#ogr#ogen>\n"
413 " oid, ogr and ogen are hexadecimal."},
414 {"llog_print", jt_llog_print, 0,
415 "print log content information.\n"
416 "usage: llog_print <$logname|#oid#ogr#ogen> [from] [to]\n"
417 " oid, ogr and ogen are hexadecimal.\n"
418 " print all records from index 1 by default."},
419 {"llog_check", jt_llog_check, 0,
420 "print log content information.\n"
421 "usage: llog_check <$logname|#oid#ogr#ogen> [from] [to]\n"
422 " oid, ogr and ogen are hexadecimal.\n"
423 " check all records from index 1 by default."},
424 {"llog_cancel", jt_llog_cancel, 0,
425 "cancel one record in log.\n"
426 "This command supports both positional and optional arguments\n"
427 "usage (positional args): "
428 "llog_cancel <catalog id|catalog name> [log id] <index>\n"
429 "usage (optional args): "
430 "llog_cancel --catalog <catalog id|catalog name> --log_id <log_id> "
431 "--log_idx <index>"},
432 {"llog_remove", jt_llog_remove, 0,
433 "remove one log from catalog or plain log, erase it from disk.\n"
434 "usage: llog_remove <catalog id|catalog name> <log id>"},
435 /* network operations */
436 {"add_interface", jt_ptl_add_interface, 0, "add interface entry\n"
437 "usage: add_interface ip [netmask]"},
438 {"del_interface", jt_ptl_del_interface, 0, "del interface entry\n"
439 "usage: del_interface [ip]"},
440 {"add_route", jt_ptl_add_route, 0,
441 "add an entry to the portals routing table\n"
442 "usage: add_route <gateway> [<hops> [<priority>]]"},
443 {"del_route", jt_ptl_del_route, 0,
444 "delete route via gateway to targets from the portals routing table\n"
445 "usage: del_route <gateway> [<target>] [<target>]"},
446 {"set_route", jt_ptl_notify_router, 0,
447 "enable/disable routes via gateway in the portals routing table\n"
448 "usage: set_route <gateway> <up/down> [<time>]"},
453 int lctl_main(int argc, char **argv)
459 ptl_initialize(argc, argv);
460 if (obd_initialize(argc, argv) < 0)
462 if (dbg_initialize(argc, argv) < 0)
465 Parser_init("lctl > ", cmdlist);
468 rc = Parser_execarg(argc - 1, argv + 1, cmdlist);
470 rc = Parser_commands();
473 obd_finalize(argc, argv);
474 return rc < 0 ? -rc : rc;
477 #ifndef LIBLUSTRE_TEST
478 int main (int argc, char **argv)
480 return (lctl_main (argc, argv));