1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
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/gm/...> <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 {"interface_list", jt_ptl_print_interfaces,0,"print interface entries\n"
98 "usage: interface_list"},
99 {"peer_list", jt_ptl_print_peers, 0, "print peer entries\n"
101 {"conn_list", jt_ptl_print_connections, 0,
102 "print all the connected remote nid\n"
104 {"active_tx", jt_ptl_print_active_txs, 0, "print active transmits\n"
106 {"route_list", jt_ptl_print_routes, 0,
107 "print the portals routing table, same as show_route\n"
108 "usage: route_list"},
109 {"show_route", jt_ptl_print_routes, 0,
110 "print the portals routing table, same as route_list\n"
111 "usage: show_route"},
112 {"ping", jt_ptl_ping, 0, "Check LNET connectivity\n"
113 "usage: ping nid [timeout] [pid]"},
115 /* Device selection commands */
116 {"==== obd device selection ====", jt_noop, 0, "device selection"},
117 {"device", jt_obd_device, 0,
118 "set current device to <name|devno>\n"
119 "usage: device <%name|$name|devno>"},
120 {"device_list", jt_obd_list, 0, "show all devices\n"
121 "usage: device_list"},
122 {"dl", jt_obd_list, 0, "show all devices\n"
125 /* Device operations */
126 {"==== obd device operations ====", jt_noop, 0, "device operations"},
127 {"activate", jt_obd_activate, 0, "activate an import\n"},
128 {"deactivate", jt_obd_deactivate, 0, "deactivate an import. "
129 "This command should be used on failed OSC devices in an MDT LOV.\n"},
130 {"abort_recovery", jt_obd_abort_recovery, 0,
131 "abort recovery on a restarting MDT or OST device\n"},
132 {"set_timeout", jt_lcfg_set_timeout, 0,
133 "usage: conf_param obd_timeout=<secs>\n"},
134 {"conf_param", jt_lcfg_mgsparam, 0, "set a permanent config param. "
135 "This command must be run on the MGS node\n"
136 "usage: conf_param <target.keyword=val> ...\n"},
137 {"local_param", jt_lcfg_param, 0, "set a temporary, local param\n"
138 "usage: local_param <target.keyword=val> ...\n"},
139 {"get_param", jt_lcfg_getparam, 0, "get the Lustre or LNET parameter\n"
140 "usage: get_param [-n|-N|-F] <param_path1 param_path2 ...>\n"
141 "Get the value of Lustre or LNET parameter from the specified path.\n"
142 "The path can contain shell-style filename patterns.\n"
143 " -n Print only the value and not parameter name.\n"
144 " -N Print only matched parameter names and not the values.\n"
145 " (Especially useful when using patterns.)\n"
146 " -F When -N specified, add '/', '@' or '=' for directories,\n"
147 " symlinks and writeable files, respectively."},
148 {"set_param", jt_lcfg_setparam, 0, "set the Lustre or LNET parameter\n"
149 "usage: set_param [-n] <param_path1=value1 param_path2 value2 ...>\n"
150 "Set the value of the Lustre or LNET parameter at the specified path\n"
151 " -n Disable printing of the key name when printing values."},
152 {"list_param", jt_lcfg_listparam, 0,
153 "list the Lustre or LNET parameter name\n"
154 "usage: list_param [-F] <param_path1 param_path2 ...>\n"
155 "List the name of Lustre or LNET parameter from the specified path.\n"
156 " -F Add '/', '@' or '=' for dirs, symlinks and writeable files,\n"
158 " -R Recursively list all parameters under the specified path.\n"},
161 {"==== debugging control ====", jt_noop, 0, "debug"},
162 {"debug_daemon", jt_dbg_debug_daemon, 0,
163 "debug daemon control and dump to a file\n"
164 "usage: debug_daemon {start file [#MB]|stop}"},
165 {"debug_kernel", jt_dbg_debug_kernel, 0,
166 "get debug buffer and dump to a file, same as dk\n"
167 "usage: debug_kernel [file] [raw]"},
168 {"dk", jt_dbg_debug_kernel, 0,
169 "get debug buffer and dump to a file, same as debug_kernel\n"
170 "usage: dk [file] [raw]"},
171 {"debug_file", jt_dbg_debug_file, 0,
172 "convert a binary debug file dumped by the kernel to ASCII text\n"
173 "usage: debug_file <input> [output]"},
174 {"df", jt_dbg_debug_file, 0,
175 "read debug buffer from input and dump to output, same as debug_file\n"
176 "usage: df <input> [output]"},
177 {"clear", jt_dbg_clear_debug_buf, 0, "clear kernel debug buffer\n"
179 {"mark", jt_dbg_mark_debug_buf, 0,
180 "insert marker text in kernel debug buffer\n"
181 "usage: mark <text>"},
182 {"filter", jt_dbg_filter, 0, "filter message type\n"
183 "usage: filter <subsystem id/debug mask>"},
184 {"show", jt_dbg_show, 0, "Show specific type of messages\n"
185 "usage: show <subsystem id/debug mask>"},
186 {"debug_list", jt_dbg_list, 0, "list subsystem and debug types\n"
187 "usage: debug_list <subs/types>"},
188 {"modules", jt_dbg_modules, 0,
189 "provide gdb-friendly module information\n"
190 "usage: modules <path>"},
192 /* virtual block operations */
193 {"==== virtual block device ====", jt_noop, 0, "virtual block device"},
194 {"blockdev_attach", jt_blockdev_attach, 0,
195 "attach a lustre regular file to a virtual block device\n"
196 "usage: blockdev_attach <file_name> <device_name>"},
197 {"blockdev_detach", jt_blockdev_detach, 0,
198 "detach a lustre regular file from a virtual block device\n"
199 "usage: blockdev_detach <device_name>"},
200 {"blockdev_info", jt_blockdev_info, 0,
201 "get the device info of a attached file\n"
202 "usage: blockdev_info <device_name>"},
205 {"=== Pools ==", jt_noop, 0, "pool management"},
206 {"pool_new", jt_pool_cmd, 0,
208 "usage pool_new <fsname>.<poolname>"},
209 {"pool_add", jt_pool_cmd, 0,
210 "add the named OSTs to the pool\n"
211 "usage pool_add <fsname>.<poolname> <ostname indexed list>"},
212 {"pool_remove", jt_pool_cmd, 0,
213 "remove the named OST from the pool\n"
214 "usage pool_remove <fsname>.<poolname> <ostname indexed list>"},
215 {"pool_destroy", jt_pool_cmd, 0,
217 "usage pool_destroy <fsname>.<poolname>"},
218 {"pool_list", jt_pool_cmd, 0,
219 "list pools and pools members\n"
220 "usage pool_list <fsname>[.<poolname>] | <pathname>"},
222 /* Changelog commands */
223 {"=== Changelogs ==", jt_noop, 0, "changelog user management"},
224 {"changelog_register", jt_changelog_register, 0,
225 "register a new persistent changelog user, returns id\n"
226 "usage:\tdevice <mdtname>\n\tchangelog_register [-n]"},
227 {"changelog_deregister", jt_changelog_deregister, 0,
228 "deregister an existing changelog user\n"
229 "usage:\tdevice <mdtname>\n\tchangelog_deregister <id>"},
231 /* Device configuration commands */
232 {"== device setup (these are not normally used post 1.4) ==",
233 jt_noop, 0, "device config"},
234 {"attach", jt_lcfg_attach, 0,
235 "set the type, name, and uuid of the current device\n"
236 "usage: attach type name uuid"},
237 {"detach", jt_obd_detach, 0,
238 "remove driver (and name and uuid) from current device\n"
240 {"setup", jt_lcfg_setup, 0,
241 "type specific device configuration information\n"
242 "usage: setup <args...>"},
243 {"cleanup", jt_obd_cleanup, 0, "cleanup previously setup device\n"
244 "usage: cleanup [force | failover]"},
245 {"dump_cfg", jt_cfg_dump_log, 0,
246 "print log of recorded commands for this config to kernel debug log\n"
247 "usage: dump_cfg config-uuid-name"},
249 /* Test only commands */
250 {"==== testing (DANGEROUS) ====", jt_noop, 0, "testing (DANGEROUS)"},
251 {"--threads", jt_opt_threads, 0,
252 "run <threads> separate instances of <command> on device <devno>\n"
253 "--threads <threads> <verbose> <devno> <command [args ...]>"},
254 {"lookup", jt_obd_mdc_lookup, 0, "report file mode info\n"
255 "usage: lookup <directory> <file>"},
256 {"readonly", jt_obd_set_readonly, 0,
257 "disable writes to the underlying device\n"},
258 {"notransno", jt_obd_no_transno, 0,
259 "disable sending of committed-transno updates\n"},
260 {"add_uuid", jt_lcfg_add_uuid, 0, "associate a UUID with a nid\n"
261 "usage: add_uuid <uuid> <nid>"},
262 {"del_uuid", jt_lcfg_del_uuid, 0, "delete a UUID association\n"
263 "usage: del_uuid <uuid>"},
264 {"add_peer", jt_ptl_add_peer, 0, "add an peer entry\n"
265 "usage: add_peer <nid> <host> <port>"},
266 {"del_peer", jt_ptl_del_peer, 0, "remove an peer entry\n"
267 "usage: del_peer [<nid>] [<ipaddr|pid>]"},
268 {"add_conn ", jt_lcfg_add_conn, 0,
269 "usage: add_conn <conn_uuid> [priority]\n"},
270 {"del_conn ", jt_lcfg_del_conn, 0,
271 "usage: del_conn <conn_uuid> \n"},
272 {"disconnect", jt_ptl_disconnect, 0, "disconnect from a remote nid\n"
273 "usage: disconnect [<nid>]"},
274 {"mynid", jt_ptl_mynid, 0, "inform the socknal of the local nid. "
275 "The nid defaults to hostname for tcp networks and is automatically "
276 "setup for elan/myrinet networks.\n"
277 "usage: mynid [<nid>]"},
278 {"fail", jt_ptl_fail_nid, 0, "fail/restore communications.\n"
279 "Omitting the count means indefinitely, 0 means restore, "
280 "otherwise fail 'count' messages.\n"
281 "usage: fail nid|_all_ [count]"},
282 {"getattr", jt_obd_getattr, 0,
283 "get attribute for OST object <objid>\n"
284 "usage: getattr <objid>"},
285 {"setattr", jt_obd_setattr, 0,
286 "set mode attribute for OST object <objid>\n"
287 "usage: setattr <objid> <mode>"},
288 {"create", jt_obd_create, 0,
289 "create <num> OST objects (with <mode>)\n"
290 "usage: create [num [mode [verbose [lsm data]]]]"},
291 {"destroy", jt_obd_destroy, 0,
292 "destroy OST object <objid> [num [verbose]]\n"
293 "usage: destroy <num> objects, starting at objid <objid>"},
294 {"test_getattr", jt_obd_test_getattr, 0,
295 "do <num> getattrs (on OST object <objid> (objid+1 on each thread))\n"
296 "usage: test_getattr <num> [verbose [[t]objid]]"},
297 {"test_setattr", jt_obd_test_setattr, 0,
298 "do <num> setattrs (on OST object <objid> (objid+1 on each thread))\n"
299 "usage: test_setattr <num> [verbose [[t]objid]]"},
300 {"test_brw", jt_obd_test_brw, 0,
301 "do <num> bulk read/writes (<npages> per I/O, on OST object <objid>)\n"
302 "usage: test_brw [t]<num> [write [verbose [npages [[t]objid]]]]"},
303 {"lwt", jt_ptl_lwt, 0,
304 "light-weight tracing\n"
307 {"memhog", jt_ptl_memhog, 0,
308 "memory pressure testing\n"
309 "usage: memhog <page count> [<gfp flags>]"},
310 {"getobjversion", jt_get_obj_version, 0,
311 "get the version of an object on servers\n"
312 "usage: getobjversion <fid>"},
314 {"==== obsolete (DANGEROUS) ====", jt_noop, 0, "obsolete (DANGEROUS)"},
315 /* some test scripts still use these */
316 {"cfg_device", jt_obd_device, 0,
317 "set current device to <name>\n"
318 "usage: device <name>"},
319 {"recover", jt_obd_recover, 0,
320 "try to restore a lost connection immediately\n"
321 "usage: recover [MDC/OSC device]"},
322 /* saving for sanity 44a */
323 {"lov_getconfig", jt_obd_lov_getconfig, 0,
324 "read lov configuration from an mds device\n"
325 "usage: lov_getconfig <mountpoint>"},
326 /* Llog operations */
327 {"llog_catlist", jt_llog_catlist, 0,
328 "list all catalog logs on current device.\n"
329 "usage: llog_catlist"},
330 {"llog_info", jt_llog_info, 0,
331 "print log header information.\n"
332 "usage: llog_info <$logname|#oid#ogr#ogen>\n"
333 " oid, ogr and ogen are hexadecimal."},
334 {"llog_print", jt_llog_print, 0,
335 "print log content information.\n"
336 "usage: llog_print <$logname|#oid#ogr#ogen> [from] [to]\n"
337 " oid, ogr and ogen are hexadecimal.\n"
338 " print all records from index 1 by default."},
339 {"llog_check", jt_llog_check, 0,
340 "print log content information.\n"
341 "usage: llog_check <$logname|#oid#ogr#ogen> [from] [to]\n"
342 " oid, ogr and ogen are hexadecimal.\n"
343 " check all records from index 1 by default."},
344 {"llog_cancel", jt_llog_cancel, 0,
345 "cancel one record in log.\n"
346 "usage: llog_cancel <catalog id|catalog name> <log id> <index>"},
347 {"llog_remove", jt_llog_remove, 0,
348 "remove one log from catalog, erase it from disk.\n"
349 "usage: llog_remove <catalog id|catalog name> <log id>"},
350 /* network operations */
351 {"add_interface", jt_ptl_add_interface, 0, "add interface entry\n"
352 "usage: add_interface ip [netmask]"},
353 {"del_interface", jt_ptl_del_interface, 0, "del interface entry\n"
354 "usage: del_interface [ip]"},
355 {"add_route", jt_ptl_add_route, 0,
356 "add an entry to the portals routing table\n"
357 "usage: add_route <gateway> <target> [<target>]"},
358 {"del_route", jt_ptl_del_route, 0,
359 "delete route via gateway to targets from the portals routing table\n"
360 "usage: del_route <gateway> [<target>] [<target>]"},
361 {"set_route", jt_ptl_notify_router, 0,
362 "enable/disable routes via gateway in the portals routing table\n"
363 "usage: set_route <gateway> <up/down> [<time>]"},
368 int lctl_main(int argc, char **argv)
374 ptl_initialize(argc, argv);
375 if (obd_initialize(argc, argv) < 0)
377 if (dbg_initialize(argc, argv) < 0)
380 Parser_init("lctl > ", cmdlist);
383 rc = Parser_execarg(argc - 1, argv + 1, cmdlist);
385 rc = Parser_commands();
388 obd_finalize(argc, argv);
389 return rc < 0 ? -rc : rc;
392 #ifndef LIBLUSTRE_TEST
393 int main (int argc, char **argv)
395 return (lctl_main (argc, argv));