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