/* * GPL HEADER START * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 only, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License version 2 for more details (a copy is included * in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU General Public License * version 2 along with this program; If not, see * http://www.gnu.org/licenses/gpl-2.0.html * * GPL HEADER END */ /* * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved. * Use is subject to license terms. * * Copyright (c) 2012, 2017, Intel Corporation. */ /* * This file is part of Lustre, http://www.lustre.org/ * * lustre/utils/lctl.c * * Author: Peter J. Braam * Author: Phil Schwan * Author: Robert Read */ #include #include #include #include #include #include #include #include "obdctl.h" #include #include #include "lctl_thread.h" static int jt_pcc(int argc, char **argv); /** * command_t pccdev_cmdlist - lctl pcc commands. */ command_t pccdev_cmdlist[] = { { .pc_name = "add", .pc_func = jt_pcc_add, .pc_help = "Add a PCC backend to a client.\n" "usage: lctl pcc add [--param|-p ]\n" "\tmntpath: Lustre mount point.\n" "\tpccpath: Path of the PCC backend.\n" "\tparam: Setting parameters for PCC backend.\n" }, { .pc_name = "del", .pc_func = jt_pcc_del, .pc_help = "Delete the specified PCC backend on a client.\n" "usage: clt pcc del \n" }, { .pc_name = "clear", .pc_func = jt_pcc_clear, .pc_help = "Remove all PCC backend on a client.\n" "usage: lctl pcc clear \n" }, { .pc_name = "list", .pc_func = jt_pcc_list, .pc_help = "List all PCC backends on a client.\n" "usage: lctl pcc list \n" }, { .pc_help = NULL } }; command_t cmdlist[] = { /* Metacommands */ {"===== metacommands =======", NULL, 0, "metacommands"}, {"--device", jt_opt_device, 0, "run after connecting to device \n" "--device "}, /* User interface commands */ {"======== control =========", NULL, 0, "control commands"}, {"lustre_build_version", jt_get_version, 0, "print version of Lustre modules\n" "usage: lustre_build_version"}, /* Network configuration commands */ {"===== network config =====", NULL, 0, "network config"}, {"--net", jt_opt_net, 0, "run after selecting network \n" "usage: --net "}, {"network", jt_ptl_network, 0, "configure LNET\n" "usage: network up|down"}, {"net", jt_ptl_network, 0, "configure LNET\n" "usage: net up|down"}, {"list_nids", jt_ptl_list_nids, 0, "list local NIDs\n" "usage: list_nids [all]"}, {"which_nid", jt_ptl_which_nid, 0, "choose a NID\n" "usage: which_nid NID [NID...]"}, {"replace_nids", jt_replace_nids, 0, "replace primary NIDs for device (clients/servers must be unmounted)\n" "usage: replace_nids [,NID2,NID3:NID4,NID5:NID6]"}, {"interface_list", jt_ptl_print_interfaces, 0, "print network interface entries\n" "usage: interface_list"}, {"peer_list", jt_ptl_print_peers, 0, "print peer LNet NIDs\n" "usage: peer_list"}, {"conn_list", jt_ptl_print_connections, 0, "print all the remote LNet connections\n" "usage: conn_list"}, {"route_list", jt_ptl_print_routes, 0, "print the LNet routing table, same as 'show_route'\n" "usage: route_list"}, {"show_route", jt_ptl_print_routes, 0, "print the LNet routing table, same as 'route_list'\n" "usage: show_route"}, {"ping", jt_ptl_ping, 0, "Check LNET connectivity\n" "usage: ping nid [timeout [pid]]"}, {"net_drop_add", jt_ptl_drop_add, 0, "Add LNet drop rule\n" "usage: net_drop_add <-s | --source NID>\n" " <-d | --dest NID>\n" " <<-r | --rate DROP_RATE> |\n" " <-i | --interval SECONDS>>\n" " [<-p | --portal> PORTAL...]\n" " [<-m | --message> ...]\n" " [< -e | --health_error]\n"}, {"net_drop_del", jt_ptl_drop_del, 0, "remove LNet drop rule\n" "usage: net_drop_del <[-a | --all] |\n" " <-s | --source NID>\n" " <-d | --dest NID>>\n"}, {"net_drop_reset", jt_ptl_drop_reset, 0, "reset drop rule stats\n" "usage: net_drop_reset"}, {"net_drop_list", jt_ptl_drop_list, 0, "list LNet drop rules\n" "usage: net_drop_list"}, {"net_delay_add", jt_ptl_delay_add, 0, "Add LNet delay rule\n" "usage: net_delay_add <-s | --source NID>\n" " <-d | --dest NID>\n" " <<-r | --rate DROP_RATE> |\n" " <-i | --interval SECONDS>>\n" " <-l | --latency SECONDS>\n" " [<-p | --portal> PORTAL...]\n" " [<-m | --message> ...]\n"}, {"net_delay_del", jt_ptl_delay_del, 0, "remove LNet delay rule\n" "usage: net_delay_del <[-a | --all] |\n" " <-s | --source NID>\n" " <-d | --dest NID>>\n"}, {"net_delay_reset", jt_ptl_delay_reset, 0, "reset delay rule stats\n" "usage: net_delay_reset"}, {"net_delay_list", jt_ptl_delay_list, 0, "list LNet delay rules\n" "usage: net_delay_list"}, /* Device selection commands */ {"==== obd device selection ====", NULL, 0, "device selection"}, {"device", jt_obd_device, 0, "set current device to \n" "usage: device <%name|$name|devno>"}, {"cfg_device", jt_obd_device, 0, "set current device to , same as 'device'\n" "usage: cfg_device "}, {"device_list", jt_device_list, 0, "show all devices\n" "usage: device_list [--target|-t] [--yaml|-y]"}, {"dl", jt_device_list, 0, "show all devices, same as 'device_list'\n" "usage: dl [--target|-t] [--yaml|-y]"}, /* Device operations */ {"==== obd device operations ====", NULL, 0, "device operations"}, {"activate", jt_obd_activate, 0, "activate an import\n"}, {"deactivate", jt_obd_deactivate, 0, "deactivate an import. " "This command should be used on failed OSC devices in an MDT LOV.\n"}, {"abort_recovery", jt_obd_abort_recovery, 0, "abort recovery on a restarting MDT or OST device\n"}, {"abort_recovery_mdt", jt_obd_abort_recovery_mdt, 0, "abort recovery between MDTs\n"}, {"recover", jt_obd_recover, 0, "try to restore a lost connection immediately\n" "usage: recover [MDC/OSC device]"}, {"set_timeout", jt_lcfg_set_timeout, 0, "usage: conf_param obd_timeout=\n"}, #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(3, 0, 53, 0) {"conf_param", jt_lcfg_confparam, 0, "set a permanent config parameter.\n" "This command must be run on the MGS node\n" "usage: conf_param [-d] \n" " -d Delete the permanent setting from the configuration."}, #endif {"local_param", jt_lcfg_param, 0, "set a temporary, local param\n" "usage: local_param \n"}, {"get_param", jt_lcfg_getparam, 0, "get the Lustre or LNET parameter\n" "usage: get_param [-F|n|-N|-R] \n" "Get the value of Lustre or LNET parameter from the specified path.\n" "The path can contain shell-style filename patterns.\n" " -F When -N specified, add '/', '@' or '=' for directories,\n" " symlinks and writeable files, respectively.\n" " -H Prefix each output line with the parameter name.\n" " -n Print only the value and not parameter name.\n" " -N Print only matched parameter names and not the values.\n" " (Especially useful when using patterns.)\n" " -R Get parameters recursively from the specified entry.\n"}, {"set_param", jt_lcfg_setparam, 0, "set the Lustre or LNET parameter\n" "usage: set_param [-n] [-P] [-d] [-F] " #ifdef HAVE_LIBPTHREAD "[-t[THREAD_COUNT]] " #endif "PARAM1=VALUE1 [PARAM2=VALUE2 ...]\n" "Set the value of the Lustre or LNET parameter at the specified path.\n" " -n Disable printing of the key name when printing values.\n" " -P Set the parameter permanently, filesystem-wide.\n" " -d Remove the permanent setting (only with -P option).\n" " -F Read permanent configuration from a YAML file.\n" #ifdef HAVE_LIBPTHREAD " -t Set parameters in parallel, max THREAD_COUNT threads\n" " (default " STRINGIFY(LCFG_THREADS_DEF) ").\n" #endif }, {"apply_yaml", jt_lcfg_applyyaml, 0, "set/config the Lustre or LNET " "parameters using configuration from a YAML file.\n" "usage: apply_yaml file\n"}, {"list_param", jt_lcfg_listparam, 0, "list the Lustre or LNET parameter name\n" "usage: list_param [-F|-R|-D] \n" "List the name of Lustre or LNET parameter from the specified path.\n" " -F Add '/', '@' or '=' for dirs, symlinks and writeable files,\n" "respectively.\n" " -D Only list directories.\n" " -R Recursively list all parameters under the specified path.\n"}, {"del_ost", jt_del_ost, 0, "permanently delete OST records\n" "usage: del_ost [--dryrun] --target <$fsname-OSTxxxx>\n" "Cancel the config records for a specific OST to forget about it.\n"}, /* Debug commands */ {"==== debugging control ====", NULL, 0, "debug"}, {"debug_daemon", jt_dbg_debug_daemon, 0, "debug daemon control and dump to a file\n" "usage: debug_daemon {start file [#MB]|stop}"}, {"debug_kernel", jt_dbg_debug_kernel, 0, "get debug buffer and dump to a file, same as 'dk'\n" "usage: debug_kernel [file] [raw]"}, {"dk", jt_dbg_debug_kernel, 0, "get debug buffer and dump to a file, same as 'debug_kernel'\n" "usage: dk [file] [raw]"}, {"debug_file", jt_dbg_debug_file, 0, "convert a binary debug file dumped by the kernel to ASCII text\n" "usage: debug_file [output]"}, {"df", jt_dbg_debug_file, 0, "read debug log from input convert to ASCII, same as 'debug_file'\n" "usage: df [output]"}, {"clear", jt_dbg_clear_debug_buf, 0, "clear kernel debug buffer\n" "usage: clear"}, {"mark", jt_dbg_mark_debug_buf, 0, "insert marker text in kernel debug buffer\n" "usage: mark "}, {"filter", jt_dbg_filter, 0, "filter message type\n" "usage: filter "}, {"show", jt_dbg_show, 0, "Show specific type of messages\n" "usage: show "}, {"debug_list", jt_dbg_list, 0, "list subsystem and debug types\n" "usage: debug_list "}, {"modules", jt_dbg_modules, 0, "provide gdb-friendly module information\n" "usage: modules "}, /* Pool commands */ {"=== Pools ==", NULL, 0, "pool management"}, {"pool_new", jt_pool_cmd, 0, "add a new pool\n" "usage: pool_new [-n|--nowait] ."}, {"pool_add", jt_pool_cmd, 0, "add the named OSTs to the pool\n" "usage: pool_add [-n|--nowait] . "}, {"pool_remove", jt_pool_cmd, 0, "remove the named OST from the pool\n" "usage: pool_remove [-n|--nowait] . "}, {"pool_destroy", jt_pool_cmd, 0, "destroy a pool\n" "usage: pool_destroy [-n|--nowait] ."}, {"pool_list", jt_pool_cmd, 0, "list pools and pools members\n" "usage: pool_list [.] | "}, #ifdef HAVE_SERVER_SUPPORT /* Barrier commands */ {"=== Barrier ==", NULL, 0, "barrier management"}, {"barrier_freeze", jt_barrier_freeze, 0, "freeze write barrier on MDTs\n" "usage: barrier_freeze [timeout (in seconds)]"}, {"barrier_thaw", jt_barrier_thaw, 0, "thaw write barrier on MDTs\n" "usage: barrier_thaw "}, {"barrier_stat", jt_barrier_stat, 0, "query write barrier status on MDTs\n" "usage: barrier_stat [--state|-s] [--timeout|-t] "}, {"barrier_rescan", jt_barrier_rescan, 0, "rescan the system to filter out inactive MDT(s) for barrier\n" "usage: barrier_rescan [timeout (in seconds)]"}, /* Snapshot commands */ {"=== Snapshot ==", NULL, 0, "Snapshot management"}, {"snapshot_create", jt_snapshot_create, 0, "create the snapshot\n" "usage: snapshot_create [-b | --barrier [on | off]]\n" " [-c | --comment comment]\n" " <-F | --fsname fsname>\n" " [-h | --help] <-n | --name ssname>\n" " [-r | --rsh remote_shell]\n" " [-t | --timeout timeout]"}, {"snapshot_destroy", jt_snapshot_destroy, 0, "destroy the snapshot\n" "usage: snapshot_destroy [-f | --force]\n" " <-F | --fsname fsname> [-h | --help]\n" " <-n | --name ssname>\n" " [-r | --rsh remote_shell]"}, {"snapshot_modify", jt_snapshot_modify, 0, "modify the snapshot\n" "usage: snapshot_modify [-c | --comment comment]\n" " <-F | --fsname fsname> [-h | --help]\n" " <-n | --name ssname> [-N | --new new_ssname]\n" " [-r | --rsh remote_shell]"}, {"snapshot_list", jt_snapshot_list, 0, "query the snapshot(s)\n" "usage: snapshot_list [-d | --detail]\n" " <-F | --fsname fsname> [-h | --help]\n" " [-n | --name ssname] [-r | --rsh remote_shell]"}, {"snapshot_mount", jt_snapshot_mount, 0, "mount the snapshot\n" "usage: snapshot_mount <-F | --fsname fsname> [-h | --help]\n" " <-n | --name ssname>\n" " [-r | --rsh remote_shell]"}, {"snapshot_umount", jt_snapshot_umount, 0, "umount the snapshot\n" "usage: snapshot_umount <-F | --fsname fsname> [-h | --help]\n" " <-n | --name ssname>\n" " [-r | --rsh remote_shell]"}, #endif /* HAVE_SERVER_SUPPORT */ /* Nodemap commands */ {"=== Nodemap ===", NULL, 0, "nodemap management"}, {"nodemap_activate", jt_nodemap_activate, 0, "activate nodemap idmapping functions\n" "usage: nodemap_activate {0|1}"}, {"nodemap_add", jt_nodemap_add, 0, "add a new nodemap\n" "usage: nodemap_add "}, {"nodemap_del", jt_nodemap_del, 0, "remove a nodemap\n" "usage: nodemap_del "}, {"nodemap_add_range", jt_nodemap_add_range, 0, "add a range to a nodemap\n" "usage: nodemap_add_range "}, {"nodemap_del_range", jt_nodemap_del_range, 0, "add a range to a nodemap\n" "usage: nodemap_del_range "}, {"nodemap_modify", jt_nodemap_modify, 0, "modify a nodemap parameters\n" "usage: nodemap_modify nodemap_name param value"}, {"nodemap_add_idmap", jt_nodemap_add_idmap, 0, "add a UID or GID mapping to a nodemap"}, {"nodemap_del_idmap", jt_nodemap_del_idmap, 0, "delete a UID or GID mapping from a nodemap"}, {"nodemap_set_fileset", jt_nodemap_set_fileset, 0, "set a fileset on a nodemap\n" "usage: nodemap_set_fileset "}, {"nodemap_set_sepol", jt_nodemap_set_sepol, 0, "set SELinux policy info on a nodemap\n" "usage: nodemap_set_sepol "}, {"nodemap_test_nid", jt_nodemap_test_nid, 0, "usage: nodemap_test_nid "}, {"nodemap_test_id", jt_nodemap_test_id, 0, "Usage: nodemap_test_id --nid --idtype [uid|gid] --id "}, {"nodemap_info", jt_nodemap_info, 0, "Usage: nodemap_info [list|nodemap_name|all]"}, /* Changelog commands */ {"=== Changelogs ==", NULL, 0, "changelog user management"}, {"changelog_register", jt_changelog_register, 0, "register a new persistent changelog user, returns id\n" "usage: --device changelog_register [--help|-h]\n" " [--mask|-m <[+|-]mask1[<,|+|->mask2...]>]\n" " [--nameonly|-n]\n" " [--user|-u ]"}, {"changelog_deregister", jt_changelog_deregister, 0, "deregister an existing changelog user\n" "usage: --device changelog_deregister [|cl...]\n" " [--help|-h]\n" " [--user|-u ]\n"}, /* Persistent Client Cache (PCC) commands */ {"=== Persistent Client Cache ===", NULL, 0, "PCC user management"}, {"pcc", jt_pcc, pccdev_cmdlist, "lctl commands used to interact with PCC features:\n" "lctl pcc add - add a PCC backend to a client\n" "lctl pcc del - delete a PCC backend on a client\n" "lctl pcc clear - remove all PCC backends on a client\n" "lctl pcc list - list all PCC backends on a client\n"}, /* Device configuration commands */ {"== device setup (these are not normally used post 1.4) ==", NULL, 0, "device config"}, {"attach", jt_lcfg_attach, 0, "set the type, name, and uuid of the current device\n" "usage: attach type name uuid"}, {"detach", jt_obd_detach, 0, "remove driver (and name and uuid) from current device\n" "usage: detach"}, {"setup", jt_lcfg_setup, 0, "type specific device configuration information\n" "usage: setup "}, {"cleanup", jt_obd_cleanup, 0, "cleanup previously setup device\n" "usage: cleanup [force | failover]"}, #ifdef HAVE_SERVER_SUPPORT /* LFSCK commands */ {"==== LFSCK ====", NULL, 0, "LFSCK"}, {"lfsck_start", jt_lfsck_start, 0, "start LFSCK\n" "usage: lfsck_start [--device|-M [MDT,OST]_device]\n" " [--all|-A] [--create-ostobj|-c [on | off]]\n" " [--create-mdtobj|-C [on | off]]\n" " [--delay-create-ostobj|-d [on | off]]\n" " [--error|-e {continue | abort}] [--help|-h]\n" " [--dryrun|-n [on | off]] [--orphan|-o]\n" " [--reset|-r] [--speed|-s speed_limit]\n" " [--type|-t lfsck_type[,lfsck_type...]]\n" " [--window-size|-w size]"}, {"lfsck_stop", jt_lfsck_stop, 0, "stop lfsck(s)\n" "usage: lfsck_stop [--device|-M [MDT,OST]_device]\n" " [--all|-A] [--help|-h]"}, {"lfsck_query", jt_lfsck_query, 0, "check lfsck(s) status\n" "usage: lfsck_query [--device|-M MDT_device] [--help|-h]\n" " [--type|-t lfsck_type[,lfsck_type...]]\n" " [--wait|-w]"}, /* Llog operations */ {"==== LLOG ====", NULL, 0, "LLOG"}, {"llog_catlist", jt_llog_catlist, 0, "list all catalog files on current device. If current device is not\n" "set, MGS device is used by default.\n" "usage: llog_catlist"}, {"llog_info", jt_llog_info, 0, "print log header information.\n" "usage: llog_info {LOGNAME|FID}\n"}, {"llog_print", jt_llog_print, 0, "print all effective log records by default, or within given range.\n" "With --raw option skipped records are printed as well.\n" "usage: llog_print {LOGNAME|FID} [--start INDEX] [--end INDEX]\n" " [--raw]\n"}, {"llog_cancel", jt_llog_cancel, 0, "cancel one record in specified log.\n" "usage:llog_cancel {LOGNAME|FID} --log_idx INDEX\n"}, {"llog_check", jt_llog_check, 0, "verify that log content is valid.\n" "usage: llog_check {LOGNAME|FID} [--start INDEX] [--end INDEX]\n" " check all records from index 1 by default."}, {"llog_remove", jt_llog_remove, 0, "remove one log from catalog or plain log, erase it from disk.\n" "usage: llog_remove {LOGNAME|FID} [--log_id ID]"}, {"lcfg_clear", jt_lcfg_clear, 0, "drop unused config llog records for a device or filesystem.\n" "clients and servers must be unmounted during this operation.\n" "usage: clear_conf {FSNAME|DEVNAME}"}, {"clear_conf", jt_lcfg_clear, 0, "alias for 'lcfg_clear'\n"}, {"lcfg_fork", jt_lcfg_fork, 0, "copy configuration logs for named filesystem with given name\n" "usage: fork_lcfg FSNAME NEWNAME"}, {"fork_lcfg", jt_lcfg_fork, 0, "alias for 'lcfg_fork'\n"}, {"lcfg_erase", jt_lcfg_erase, 0, "permanently erase configuration logs for the named filesystem\n" "usage: erase_lcfg FSNAME"}, {"erase_lcfg", jt_lcfg_erase, 0, "alias for 'lcfg_erase'\n"}, #endif /* HAVE_SERVER_SUPPORT */ {"==== obsolete (DANGEROUS) ====", NULL, 0, "obsolete (DANGEROUS)"}, /* network operations */ {"add_interface", jt_ptl_add_interface, 0, "add interface entry\n" "usage: add_interface ip [netmask]"}, {"del_interface", jt_ptl_del_interface, 0, "del interface entry\n" "usage: del_interface [ip]"}, {"add_route", jt_ptl_add_route, 0, "add an entry to the LNet routing table\n" "usage: add_route [ []]"}, {"del_route", jt_ptl_del_route, 0, "delete route via gateway to targets from the LNet routing table\n" "usage: del_route [] []"}, {"set_route", jt_ptl_notify_router, 0, "enable/disable routes via gateway in the LNet routing table\n" "usage: set_route [