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>"},
71 {"interface_list", jt_ptl_print_interfaces, 0, "print interface entries\n"
72 "usage: interface_list"},
73 {"add_interface", jt_ptl_add_interface, 0, "add interface entry\n"
74 "usage: add_interface ip [netmask]"},
75 {"del_interface", jt_ptl_del_interface, 0, "del interface entry\n"
76 "usage: del_interface [ip]"},
77 {"peer_list", jt_ptl_print_peers, 0, "print peer entries\n"
79 {"add_peer", jt_ptl_add_peer, 0, "add an peer entry\n"
80 "usage: add_peer <nid> <host> <port>"},
81 {"del_peer", jt_ptl_del_peer, 0, "remove an peer entry\n"
82 "usage: del_peer [<nid>] [<host>] [ks]"},
83 {"conn_list", jt_ptl_print_connections, 0, "print all the connected remote nid\n"
85 {"connect", jt_ptl_connect, 0, "connect to a remote nid\n"
86 "usage: connect <host> <port> [iIOC]"},
87 {"disconnect", jt_ptl_disconnect, 0, "disconnect from a remote nid\n"
88 "usage: disconnect [<nid>]"},
89 {"active_tx", jt_ptl_print_active_txs, 0, "print active transmits (no args)\n"
91 {"mynid", jt_ptl_mynid, 0, "inform the socknal of the local nid. "
92 "The nid defaults to hostname for tcp networks and is automatically "
93 "setup for elan/myrinet networks.\n"
94 "usage: mynid [<nid>]"},
95 {"shownid", jt_ptl_shownid, 0, "print the local NID\n"
97 {"add_uuid", jt_lcfg_add_uuid, 0, "associate a UUID with a nid\n"
98 "usage: add_uuid <uuid> <nid> <net_type>"},
99 {"close_uuid", jt_obd_close_uuid, 0, "disconnect a UUID\n"
100 "usage: close_uuid <uuid> <net_type>"},
101 {"del_uuid", jt_lcfg_del_uuid, 0, "delete a UUID association\n"
102 "usage: del_uuid <uuid>"},
103 {"add_route", jt_ptl_add_route, 0,
104 "add an entry to the portals routing table\n"
105 "usage: add_route <gateway> <target> [<target>]"},
106 {"del_route", jt_ptl_del_route, 0,
107 "delete the route via the given gateway to the given targets from the portals routing table\n"
108 "usage: del_route <gateway> [<target>] [<target>]"},
109 {"set_route", jt_ptl_notify_router, 0,
110 "enable/disable routes via the given gateway in the portals routing table\n"
111 "usage: set_route <gateway> <up/down> [<time>]"},
112 {"route_list", jt_ptl_print_routes, 0, "print the portals routing table\n"
113 "usage: route_list"},
114 {"fail", jt_ptl_fail_nid, 0, "fail/restore communications.\n"
115 "Omitting the count means indefinitely, 0 means restore, "
116 "otherwise fail 'count' messages.\n"
117 "usage: fail nid|_all_ [count]"},
119 /* Device selection commands */
120 {"=== device selection ===", jt_noop, 0, "device selection"},
121 {"newdev", jt_lcfg_newdev, 0, "create a new device\n"
123 {"device", jt_obd_device, 0,
124 "set current device to <%name|$name|devno>\n"
125 "usage: device <%name|$name|devno>"},
126 {"cfg_device", jt_lcfg_device, 0,
127 "set current device being configured to <$name>\n"
128 "usage: cfg_device <name>"},
129 {"device_list", jt_obd_list, 0, "show all devices\n"
130 "usage: device_list"},
131 {"dl", jt_obd_list, 0, "show all devices\n"
133 {"lustre_build_version", jt_get_version, 0,
134 "print the build version of lustre\n"
135 "usage: lustre_build_version"},
137 /* Device configuration commands */
138 {"==== device config =====", jt_noop, 0, "device config"},
139 {"attach", jt_lcfg_attach, 0,
140 "set the type of the current device (with <name> and <uuid>)\n"
141 "usage: attach type [name [uuid]]"},
142 {"setup", jt_lcfg_setup, 0,
143 "type specific device configuration information\n"
144 "usage: setup <args...>"},
145 {"cleanup", jt_obd_cleanup, 0, "cleanup previously setup device\n"
146 "usage: cleanup [force | failover]"},
147 {"detach", jt_obd_detach, 0,
148 "remove driver (and name and uuid) from current device\n"
150 {"lov_setup", jt_lcfg_lov_setup, 0, "create a LOV device\n"
151 "usage: lov_setup lov-uuid stripe-count stripe-size offset pattern"},
152 {"lmv_setup", jt_lcfg_lmv_setup, 0,
153 "create an LMV device\n"
154 "usage: lmv_setup lmv-uuid UUID1 [UUID2 ...]"},
155 {"lov_modify_tgts", jt_lcfg_lov_modify_tgts, 0,
156 "add or delete an obd to/from a LOV device\n"
157 "usage: lov_modify_tgts add|del <lov-name> <uuid> <index> <gen>"},
158 {"lov_getconfig", jt_obd_lov_getconfig, 0,
159 "read lov configuration from an mds device\n"
160 "usage: lov_getconfig lov-uuid"},
161 {"record", jt_cfg_record, 0, "record commands that follow in log\n"
162 "usage: record cfg-uuid-name"},
163 {"endrecord", jt_cfg_endrecord, 0, "stop recording\n"
165 {"parse", jt_cfg_parse, 0, "parse the log of recorded commands for this config\n"
166 "usage: parse config-uuid-name"},
167 {"dump_log", jt_cfg_dump_log, 0, "print log of recorded commands for this config to kernel debug log\n"
168 "usage: dump_log config-uuid-name"},
169 {"clear_log", jt_cfg_clear_log, 0, "delete current config log of recorded commands\n"
170 "usage: clear_log config-name"},
172 /* Device operations */
173 {"=== device operations ==", jt_noop, 0, "device operations"},
174 {"probe", jt_obd_connect, 0,
175 "build a connection handle to a device. This command is used to "
176 "suspend configuration until lctl has ensured that the mds and osc "
177 "services are available. This is to avoid mount failures in a "
178 "rebooting cluster.\n"
179 "usage: probe [timeout]"},
180 {"close", jt_obd_disconnect, 0,
181 "close the connection handle\n"
183 {"getattr", jt_obd_getattr, 0,
184 "get attribute for OST object <objid>\n"
185 "usage: getattr <objid>"},
186 {"setattr", jt_obd_setattr, 0,
187 "set mode attribute for OST object <objid>\n"
188 "usage: setattr <objid> <mode>"},
189 {"create", jt_obd_create, 0,
190 "create <num> OST objects (with <mode>)\n"
191 "usage: create [num [mode [verbose [lsm data]]]]"},
192 {"destroy", jt_obd_destroy, 0,
193 "destroy OST object <objid> [num [verbose]]\n"
194 "usage: destroy <num> objects, starting at objid <objid>"},
195 {"test_getattr", jt_obd_test_getattr, 0,
196 "do <num> getattrs (on OST object <objid> (objid+1 on each thread))\n"
197 "usage: test_getattr <num> [verbose [[t]objid]]"},
198 {"test_setattr", jt_obd_test_setattr, 0,
199 "do <num> setattrs (on OST object <objid> (objid+1 on each thread))\n"
200 "usage: test_setattr <num> [verbose [[t]objid]]"},
201 {"test_brw", jt_obd_test_brw, 0,
202 "do <num> bulk read/writes (<npages> per I/O, on OST object <objid>)\n"
203 "usage: test_brw [t]<num> [write [verbose [npages [[t]objid]]]]"},
204 {"get_stripe", jt_obd_get_stripe, 0,
205 "show stripe info for an echo client object\n"
206 "usage: get_stripe objid\n"},
207 {"set_stripe", jt_obd_set_stripe, 0,
208 "set stripe info for an echo client object\n"
209 "usage: set_stripe objid[=width!count[@offset][:id:id...]\n"},
210 {"unset_stripe", jt_obd_unset_stripe, 0,
211 "unset stripe info for an echo client object\n"
212 "usage: unset_stripe objid\n"},
213 {"test_ldlm", jt_obd_test_ldlm, 0,
214 "perform lock manager test\n"
216 {"ldlm_regress_start", jt_obd_ldlm_regress_start, 0,
217 "start lock manager stress test\n"
218 "usage: ldlm_regress_start [numthreads [refheld [numres [numext]]]]"},
219 {"ldlm_regress_stop", jt_obd_ldlm_regress_stop, 0,
220 "stop lock manager stress test (no args)\n"},
221 {"dump_ldlm", jt_obd_dump_ldlm, 0,
222 "dump all lock manager state (no args)"},
223 {"activate", jt_obd_activate, 0, "activate an import\n"},
224 {"deactivate", jt_obd_deactivate, 0, "deactivate an import\n"},
225 {"recover", jt_obd_recover, 0, "usage: recover [<connection UUID>]"},
226 {"lookup", jt_obd_mdc_lookup, 0, "usage: lookup <directory> <file>"},
227 {"finish_gns", jt_obd_finish_gns, 0, "usage: finish_gns <directory>"},
228 {"notransno", jt_obd_no_transno, 0,
229 "disable sending of committed-transno updates\n"},
230 {"readonly", jt_obd_set_readonly, 0,
231 "disable writes to the underlying device\n"},
232 {"abort_recovery", jt_obd_abort_recovery, 0,
233 "abort recovery on MDS device\n"},
234 {"root_squash", jt_obd_root_squash, 0,
235 "squash root to 'uid:gid' except client 'nid'\n"
236 "usage: root_squash [uid:gid [nid]]\n"},
237 {"mount_option", jt_lcfg_mount_option, 0,
238 "usage: mount_option profile osc_name [mdc_name] \n"},
239 {"del_mount_option", jt_lcfg_del_mount_option, 0,
240 "usage: del_mount_option profile\n"},
241 {"set_timeout", jt_lcfg_set_timeout, 0,
242 "usage: set_timeout <secs>\n"},
243 {"set_lustre_upcall", jt_lcfg_set_lustre_upcall, 0,
244 "usage: set_lustre_upcall </full/path/to/upcall> \n"},
245 {"add_conn ", jt_lcfg_add_conn, 0,
246 "usage: add_conn <conn_uuid> [priority]\n"},
247 {"del_conn ", jt_lcfg_del_conn, 0,
248 "usage: del_conn <conn_uuid> \n"},
249 {"lsync", jt_obd_reint_sync, 0,
251 {"cache_on", jt_obd_cache_on, 0,
253 {"cache_off", jt_obd_cache_off, 0,
256 {"snap_add", jt_obd_snap_add, 0,
257 "usage: snap_add <dev_name> <snap_name>\n"},
258 /* Llog operations */
259 {"llog_catlist", jt_llog_catlist, 0,
260 "list all catalog logs on current device.\n"
261 "usage: llog_catlist"},
262 {"llog_info", jt_llog_info, 0,
263 "print log header information.\n"
264 "usage: llog_info <$logname|#oid#ogr#ogen>\n"
265 " oid, ogr and ogen are hexadecimal."},
266 {"llog_print", jt_llog_print, 0,
267 "print log content information.\n"
268 "usage: llog_print <$logname|#oid#ogr#ogen> [from] [to]\n"
269 " oid, ogr and ogen are hexadecimal.\n"
270 " print all records from index 1 by default."},
271 {"llog_check", jt_llog_check, 0,
272 "print log content information.\n"
273 "usage: llog_check <$logname|#oid#ogr#ogen> [from] [to]\n"
274 " oid, ogr and ogen are hexadecimal.\n"
275 " check all records from index 1 by default."},
276 {"llog_cancel", jt_llog_cancel, 0,
277 "cancel one record in log.\n"
278 "usage: llog_cancel <catalog id|catalog name> <log id> <index>"},
279 {"llog_remove", jt_llog_remove, 0,
280 "remove one log from catalog, erase it from disk.\n"
281 "usage: llog_remove <catalog id|catalog name> <log id>"},
284 {"======== debug =========", jt_noop, 0, "debug"},
285 {"debug_daemon", jt_dbg_debug_daemon, 0,
286 "debug daemon control and dump to a file\n"
287 "usage: debug_daemon [start file <#MB>|stop|pause|continue]"},
288 {"debug_kernel", jt_dbg_debug_kernel, 0,
289 "get debug buffer and dump to a file\n"
290 "usage: debug_kernel [file] [raw]"},
291 {"dk", jt_dbg_debug_kernel, 0,
292 "get debug buffer and dump to a file\n"
293 "usage: dk [file] [raw]"},
294 {"debug_file", jt_dbg_debug_file, 0,
295 "read debug buffer from input and dump to output\n"
296 "usage: debug_file <input> [output] [raw]"},
297 {"clear", jt_dbg_clear_debug_buf, 0, "clear kernel debug buffer\n"
299 {"mark", jt_dbg_mark_debug_buf, 0,"insert marker text in kernel debug buffer\n"
300 "usage: mark <text>"},
301 {"filter", jt_dbg_filter, 0, "filter message type\n"
302 "usage: filter <subsystem id/debug mask>"},
303 {"show", jt_dbg_show, 0, "Show specific type of messages\n"
304 "usage: show <subsystem id/debug mask>"},
305 {"debug_list", jt_dbg_list, 0, "list subsystem and debug types\n"
306 "usage: debug_list <subs/types>"},
307 {"modules", jt_dbg_modules, 0,
308 "provide gdb-friendly module information\n"
309 "usage: modules <path>"},
310 {"panic", jt_dbg_panic, 0, "force the kernel to panic\n"
312 {"lwt", jt_ptl_lwt, 0,
313 "light-weight tracing\n"
316 {"memhog", jt_ptl_memhog, 0,
317 "memory pressure testing\n"
318 "usage: memhog <page count> [<gfp flags>]"},
320 /* User interface commands */
321 {"======= control ========", jt_noop, 0, "control commands"},
322 {"help", Parser_help, 0, "help"},
323 {"exit", jt_quit, 0, "quit"},
324 {"quit", jt_quit, 0, "quit"},
328 int lctl_main(int argc, char **argv)
334 ptl_initialize(argc, argv);
335 if (obd_initialize(argc, argv) < 0)
337 if (dbg_initialize(argc, argv) < 0)
340 Parser_init("lctl > ", cmdlist);
343 rc = Parser_execarg(argc - 1, argv + 1, cmdlist);
345 rc = Parser_commands();
348 obd_finalize(argc, argv);
353 int main (int argc, char **argv)
355 return (lctl_main (argc, argv));