1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2002 Cluster File Systems, Inc.
5 * Author: Peter J. Braam <braam@clusterfs.com>
6 * Author: Phil Schwan <phil@clusterfs.com>
7 * Author: Robert Read <rread@clusterfs.com>
9 * This file is part of Lustre, http://www.lustre.org.
11 * Lustre is free software; you can redistribute it and/or
12 * modify it under the terms of version 2 of the GNU General Public
13 * License as published by the Free Software Foundation.
15 * Lustre is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with Lustre; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30 #include <portals/ptlctl.h>
34 static int jt_quit(int argc, char **argv) {
35 Parser_quit(argc, argv);
39 static int jt_noop(int argc, char **argv) {
43 static int jt_opt_ignore_errors(int argc, char **argv) {
44 Parser_ignore_errors(1);
48 command_t cmdlist[] = {
50 {"--device", jt_opt_device, 0,
51 "run <command> after connecting to device <devno>\n"
52 "--device <devno> <command [args ...]>"},
53 {"--threads", jt_opt_threads, 0,
54 "run <threads> separate instances of <command> on device <devno>\n"
55 "--threads <threads> <verbose> <devno> <command [args ...]>"},
56 {"--ignore_errors", jt_opt_ignore_errors, 0,
57 "ignore errors that occur during script processing\n"
59 {"ignore_errors", jt_opt_ignore_errors, 0,
60 "ignore errors that occur during script processing\n"
62 {"dump", jt_ioc_dump, 0, "usage: dump file, save ioctl buffer to file"},
64 /* Network configuration commands */
65 {"==== network config ====", jt_noop, 0, "network config"},
66 {"--net", jt_opt_net, 0, "run <command> after setting network to <net>\n"
67 "usage: --net <tcp/elan/myrinet> <command>"},
68 {"network", jt_ptl_network, 0, "commands that follow apply to net\n"
69 "usage: network <tcp/elan/myrinet>"},
70 {"interface_list", jt_ptl_print_interfaces,0,"print interface entries\n"
71 "usage: interface_list"},
72 {"add_interface", jt_ptl_add_interface, 0, "add interface entry\n"
73 "usage: add_interface ip [netmask]"},
74 {"del_interface", jt_ptl_del_interface, 0, "del interface entry\n"
75 "usage: del_interface [ip]"},
76 {"peer_list", jt_ptl_print_peers, 0, "print peer entries\n"
78 {"add_peer", jt_ptl_add_peer, 0, "add an peer entry\n"
79 "usage: add_peer <nid> <host> <port>"},
80 {"del_peer", jt_ptl_del_peer, 0, "remove an peer entry\n"
81 "usage: del_autoconn [<nid>] [<host>] [ks]"},
82 {"conn_list", jt_ptl_print_connections, 0, "print all the connected remote nid\n"
84 {"connect", jt_ptl_connect, 0, "connect to a remote nid\n"
85 "usage: connect <host> <port> [iIOC]"},
86 {"disconnect", jt_ptl_disconnect, 0, "disconnect from a remote nid\n"
87 "usage: disconnect [<nid>]"},
88 {"active_tx", jt_ptl_print_active_txs, 0, "print active transmits\n"
90 {"mynid", jt_ptl_mynid, 0, "inform the socknal of the local nid. "
91 "The nid defaults to hostname for tcp networks and is automatically "
92 "setup for elan/myrinet networks.\n"
93 "usage: mynid [<nid>]"},
94 {"shownid", jt_ptl_shownid, 0, "print the local NID\n"
96 {"add_uuid", jt_lcfg_add_uuid, 0, "associate a UUID with a nid\n"
97 "usage: add_uuid <uuid> <nid> <net_type>"},
98 {"close_uuid", jt_obd_close_uuid, 0, "disconnect a UUID\n"
99 "usage: close_uuid <uuid> <net_type>"},
100 {"del_uuid", jt_lcfg_del_uuid, 0, "delete a UUID association\n"
101 "usage: del_uuid <uuid>"},
102 {"add_route", jt_ptl_add_route, 0,
103 "add an entry to the portals routing table\n"
104 "usage: add_route <gateway> <target> [<target>]"},
105 {"del_route", jt_ptl_del_route, 0,
106 "delete route via gateway to targets from the portals routing table\n"
107 "usage: del_route <gateway> [<target>] [<target>]"},
108 {"set_route", jt_ptl_notify_router, 0,
109 "enable/disable routes via gateway in the portals routing table\n"
110 "usage: set_route <gateway> <up/down> [<time>]"},
111 {"route_list", jt_ptl_print_routes, 0,
112 "print the portals routing table, same as show_route\n"
113 "usage: route_list"},
114 {"show_route", jt_ptl_print_routes, 0,
115 "print the portals routing table, same as route_list\n"
116 "usage: show_route"},
117 {"fail", jt_ptl_fail_nid, 0, "fail/restore communications.\n"
118 "Omitting the count means indefinitely, 0 means restore, "
119 "otherwise fail 'count' messages.\n"
120 "usage: fail nid|_all_ [count]"},
121 {"loopback", jt_ptl_loopback, 0, "print loopback state\n"
122 "With arg enable/disable\n"
123 "usage: loopback [on|off]"},
125 /* Device selection commands */
126 {"=== device selection ===", jt_noop, 0, "device selection"},
127 {"newdev", jt_lcfg_newdev, 0, "create a new device\n"
129 {"device", jt_obd_device, 0,
130 "set current device to <%name|$name|devno>\n"
131 "usage: device <%name|$name|devno>"},
132 {"cfg_device", jt_lcfg_device, 0,
133 "set current device being configured to <$name>\n"
134 "usage: cfg_device <name>"},
135 {"device_list", jt_obd_list, 0, "show all devices\n"
136 "usage: device_list"},
137 {"dl", jt_obd_list, 0, "show all devices\n"
139 {"lustre_build_version", jt_get_version, 0,
140 "print the build version of lustre\n"
141 "usage: lustre_build_version"},
143 /* Device configuration commands */
144 {"==== device config =====", jt_noop, 0, "device config"},
145 {"attach", jt_lcfg_attach, 0,
146 "set the type of the current device (with <name> and <uuid>)\n"
147 "usage: attach type [name [uuid]]"},
148 {"setup", jt_lcfg_setup, 0,
149 "type specific device configuration information\n"
150 "usage: setup <args...>"},
151 {"cleanup", jt_obd_cleanup, 0, "cleanup previously setup device\n"
152 "usage: cleanup [force | failover]"},
153 {"detach", jt_obd_detach, 0,
154 "remove driver (and name and uuid) from current device\n"
156 {"lov_setup", jt_lcfg_lov_setup, 0, "create a LOV device\n"
157 "usage: lov_setup lov-uuid stripe-count stripe-size offset pattern"},
158 {"lov_modify_tgts", jt_lcfg_lov_modify_tgts, 0,
159 "add or delete an obd to/from a LOV device\n"
160 "usage: lov_modify_tgts add|del <lov-name> <uuid> <index> <gen>"},
161 {"lov_getconfig", jt_obd_lov_getconfig, 0,
162 "read lov configuration from an mds device\n"
163 "usage: lov_getconfig <mountpoint>"},
164 {"record", jt_cfg_record, 0, "record commands that follow in log\n"
165 "usage: record cfg-uuid-name"},
166 {"endrecord", jt_cfg_endrecord, 0, "stop recording\n"
168 {"parse", jt_cfg_parse, 0, "parse the log of recorded commands for this config\n"
169 "usage: parse config-uuid-name"},
170 {"dump_log", jt_cfg_dump_log, 0, "print log of recorded commands for this config to kernel debug log\n"
171 "usage: dump_log config-uuid-name"},
172 {"clear_log", jt_cfg_clear_log, 0, "delete current config log of recorded commands\n"
173 "usage: clear_log config-name"},
175 /* Device operations */
176 {"=== device operations ==", jt_noop, 0, "device operations"},
177 {"probe", jt_obd_connect, 0,
178 "build a connection handle to a device. This command is used to "
179 "suspend configuration until lctl has ensured that the mds and osc "
180 "services are available. This is to avoid mount failures in a "
181 "rebooting cluster.\n"
182 "usage: probe [timeout]"},
183 {"close", jt_obd_disconnect, 0,
184 "close the connection handle\n"
186 {"getattr", jt_obd_getattr, 0,
187 "get attribute for OST object <objid>\n"
188 "usage: getattr <objid>"},
189 {"setattr", jt_obd_setattr, 0,
190 "set mode attribute for OST object <objid>\n"
191 "usage: setattr <objid> <mode>"},
192 {"create", jt_obd_create, 0,
193 "create <num> OST objects (with <mode>)\n"
194 "usage: create [num [mode [verbose [lsm data]]]]"},
195 {"destroy", jt_obd_destroy, 0,
196 "destroy OST object <objid> [num [verbose]]\n"
197 "usage: destroy <num> objects, starting at objid <objid>"},
198 {"test_getattr", jt_obd_test_getattr, 0,
199 "do <num> getattrs (on OST object <objid> (objid+1 on each thread))\n"
200 "usage: test_getattr <num> [verbose [[t]objid]]"},
201 {"test_setattr", jt_obd_test_setattr, 0,
202 "do <num> setattrs (on OST object <objid> (objid+1 on each thread))\n"
203 "usage: test_setattr <num> [verbose [[t]objid]]"},
204 {"test_brw", jt_obd_test_brw, 0,
205 "do <num> bulk read/writes (<npages> per I/O, on OST object <objid>)\n"
206 "usage: test_brw [t]<num> [write [verbose [npages [[t]objid]]]]"},
207 {"get_stripe", jt_obd_get_stripe, 0,
208 "show stripe info for an echo client object\n"
209 "usage: get_stripe objid\n"},
210 {"set_stripe", jt_obd_set_stripe, 0,
211 "set stripe info for an echo client object\n"
212 "usage: set_stripe objid[=width!count[@offset][:id:id...]\n"},
213 {"unset_stripe", jt_obd_unset_stripe, 0,
214 "unset stripe info for an echo client object\n"
215 "usage: unset_stripe objid\n"},
216 {"dump_ldlm", jt_obd_dump_ldlm, 0,
217 "dump all lock manager state (no args)"},
218 {"activate", jt_obd_activate, 0, "activate an import\n"},
219 {"deactivate", jt_obd_deactivate, 0, "deactivate an import\n"},
220 {"recover", jt_obd_recover, 0, "usage: recover [<connection UUID>]"},
221 {"lookup", jt_obd_mdc_lookup, 0, "usage: lookup <directory> <file>"},
222 {"notransno", jt_obd_no_transno, 0,
223 "disable sending of committed-transno updates\n"},
224 {"readonly", jt_obd_set_readonly, 0,
225 "disable writes to the underlying device\n"},
226 {"abort_recovery", jt_obd_abort_recovery, 0,
227 "abort recovery on MDS device\n"},
228 {"mount_option", jt_lcfg_mount_option, 0,
229 "usage: mount_option profile osc_name [mdc_name] \n"},
230 {"del_mount_option", jt_lcfg_del_mount_option, 0,
231 "usage: del_mount_option profile\n"},
232 {"set_timeout", jt_lcfg_set_timeout, 0,
233 "usage: set_timeout <secs>\n"},
234 {"set_lustre_upcall", jt_lcfg_set_lustre_upcall, 0,
235 "usage: set_lustre_upcall </full/path/to/upcall> \n"},
236 {"add_conn ", jt_lcfg_add_conn, 0,
237 "usage: add_conn <conn_uuid> [priority]\n"},
238 {"del_conn ", jt_lcfg_del_conn, 0,
239 "usage: del_conn <conn_uuid> \n"},
241 /* Llog operations */
242 {"llog_catlist", jt_llog_catlist, 0,
243 "list all catalog logs on current device.\n"
244 "usage: llog_catlist"},
245 {"llog_info", jt_llog_info, 0,
246 "print log header information.\n"
247 "usage: llog_info <$logname|#oid#ogr#ogen>\n"
248 " oid, ogr and ogen are hexadecimal."},
249 {"llog_print", jt_llog_print, 0,
250 "print log content information.\n"
251 "usage: llog_print <$logname|#oid#ogr#ogen> [from] [to]\n"
252 " oid, ogr and ogen are hexadecimal.\n"
253 " print all records from index 1 by default."},
254 {"llog_check", jt_llog_check, 0,
255 "print log content information.\n"
256 "usage: llog_check <$logname|#oid#ogr#ogen> [from] [to]\n"
257 " oid, ogr and ogen are hexadecimal.\n"
258 " check all records from index 1 by default."},
259 {"llog_cancel", jt_llog_cancel, 0,
260 "cancel one record in log.\n"
261 "usage: llog_cancel <catalog id|catalog name> <log id> <index>"},
262 {"llog_remove", jt_llog_remove, 0,
263 "remove one log from catalog, erase it from disk.\n"
264 "usage: llog_remove <catalog id|catalog name> <log id>"},
267 {"======== debug =========", jt_noop, 0, "debug"},
268 {"debug_daemon", jt_dbg_debug_daemon, 0,
269 "debug daemon control and dump to a file\n"
270 "usage: debug_daemon {start file [#MB]|stop}"},
271 {"debug_kernel", jt_dbg_debug_kernel, 0,
272 "get debug buffer and dump to a file, same as dk\n"
273 "usage: debug_kernel [file] [raw]"},
274 {"dk", jt_dbg_debug_kernel, 0,
275 "get debug buffer and dump to a file, same as debug_kernel\n"
276 "usage: dk [file] [raw]"},
277 {"debug_file", jt_dbg_debug_file, 0,
278 "convert a binary debug file dumped by the kernel to ASCII text\n"
279 "usage: debug_file <input> [output]"},
280 {"df", jt_dbg_debug_file, 0,
281 "read debug buffer from input and dump to output, same as debug_file\n"
282 "usage: df <input> [output]"},
283 {"clear", jt_dbg_clear_debug_buf, 0, "clear kernel debug buffer\n"
285 {"mark", jt_dbg_mark_debug_buf, 0,"insert marker text in kernel debug buffer\n"
286 "usage: mark <text>"},
287 {"filter", jt_dbg_filter, 0, "filter message type\n"
288 "usage: filter <subsystem id/debug mask>"},
289 {"show", jt_dbg_show, 0, "Show specific type of messages\n"
290 "usage: show <subsystem id/debug mask>"},
291 {"debug_list", jt_dbg_list, 0, "list subsystem and debug types\n"
292 "usage: debug_list <subs/types>"},
293 {"modules", jt_dbg_modules, 0,
294 "provide gdb-friendly module information\n"
295 "usage: modules <path>"},
296 {"panic", jt_dbg_panic, 0, "force the kernel to panic\n"
298 {"lwt", jt_ptl_lwt, 0,
299 "light-weight tracing\n"
302 {"memhog", jt_ptl_memhog, 0,
303 "memory pressure testing\n"
304 "usage: memhog <page count> [<gfp flags>]"},
306 /* User interface commands */
307 {"======= control ========", jt_noop, 0, "control commands"},
308 {"help", Parser_help, 0, "help"},
309 {"exit", jt_quit, 0, "quit"},
310 {"quit", jt_quit, 0, "quit"},
314 int lctl_main(int argc, char **argv)
320 ptl_initialize(argc, argv);
321 if (obd_initialize(argc, argv) < 0)
323 if (dbg_initialize(argc, argv) < 0)
326 Parser_init("lctl > ", cmdlist);
329 rc = Parser_execarg(argc - 1, argv + 1, cmdlist);
331 rc = Parser_commands();
334 obd_finalize(argc, argv);
339 int main (int argc, char **argv)
341 return (lctl_main (argc, argv));