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.
36 * lustre/utils/lustre_cfg.c
38 * Author: Peter J. Braam <braam@clusterfs.com>
39 * Author: Phil Schwan <phil@clusterfs.com>
40 * Author: Andreas Dilger <adilger@clusterfs.com>
41 * Author: Robert Read <rread@clusterfs.com>
45 #include <sys/ioctl.h>
53 #include <liblustre.h>
55 #include <lustre_lib.h>
56 #include <lustre_cfg.h>
57 #include <lustre/lustre_idl.h>
58 #include <lustre_dlm.h>
59 #include <obd.h> /* for struct lov_stripe_md */
61 #include <lustre/lustre_build_version.h>
72 #include <lnet/lnetctl.h>
73 #include <libcfs/libcfsutil.h>
76 static char * lcfg_devname;
78 int lcfg_set_devname(char *name)
83 /* quietly strip the unnecessary '$' */
84 if (*name == '$' || *name == '%')
87 /* We can't translate from dev # to name */
90 lcfg_devname = strdup(name);
98 char * lcfg_get_devname(void)
103 int jt_lcfg_device(int argc, char **argv)
105 return jt_obd_device(argc, argv);
108 int jt_lcfg_attach(int argc, char **argv)
110 struct lustre_cfg_bufs bufs;
111 struct lustre_cfg *lcfg;
117 lustre_cfg_bufs_reset(&bufs, NULL);
119 lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
120 lustre_cfg_bufs_set_string(&bufs, 0, argv[2]);
121 lustre_cfg_bufs_set_string(&bufs, 2, argv[3]);
123 lcfg = lustre_cfg_new(LCFG_ATTACH, &bufs);
124 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
125 lustre_cfg_free(lcfg);
127 fprintf(stderr, "error: %s: LCFG_ATTACH %s\n",
128 jt_cmdname(argv[0]), strerror(rc = errno));
129 } else if (argc == 3) {
132 lcfg_set_devname(argv[2]);
133 if (strlen(argv[2]) > 128) {
134 printf("Name too long to set environment\n");
137 snprintf(name, 512, "LUSTRE_DEV_%s", argv[2]);
138 rc = setenv(name, argv[1], 1);
140 printf("error setting env variable %s\n", name);
143 lcfg_set_devname(argv[2]);
149 int jt_lcfg_setup(int argc, char **argv)
151 struct lustre_cfg_bufs bufs;
152 struct lustre_cfg *lcfg;
156 if (lcfg_devname == NULL) {
157 fprintf(stderr, "%s: please use 'device name' to set the "
158 "device name for config commands.\n",
159 jt_cmdname(argv[0]));
163 lustre_cfg_bufs_reset(&bufs, lcfg_devname);
168 for (i = 1; i < argc; i++) {
169 lustre_cfg_bufs_set_string(&bufs, i, argv[i]);
172 lcfg = lustre_cfg_new(LCFG_SETUP, &bufs);
173 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
174 lustre_cfg_free(lcfg);
176 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
177 strerror(rc = errno));
182 int jt_obd_detach(int argc, char **argv)
184 struct lustre_cfg_bufs bufs;
185 struct lustre_cfg *lcfg;
188 if (lcfg_devname == NULL) {
189 fprintf(stderr, "%s: please use 'device name' to set the "
190 "device name for config commands.\n",
191 jt_cmdname(argv[0]));
195 lustre_cfg_bufs_reset(&bufs, lcfg_devname);
200 lcfg = lustre_cfg_new(LCFG_DETACH, &bufs);
201 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
202 lustre_cfg_free(lcfg);
204 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
205 strerror(rc = errno));
210 int jt_obd_cleanup(int argc, char **argv)
212 struct lustre_cfg_bufs bufs;
213 struct lustre_cfg *lcfg;
216 char flags[3] = { 0 };
220 if (lcfg_devname == NULL) {
221 fprintf(stderr, "%s: please use 'device name' to set the "
222 "device name for config commands.\n",
223 jt_cmdname(argv[0]));
227 lustre_cfg_bufs_reset(&bufs, lcfg_devname);
229 if (argc < 1 || argc > 3)
232 /* we are protected from overflowing our buffer by the argc
235 for (n = 1; n < argc; n++) {
236 if (strcmp(argv[n], "force") == 0) {
237 flags[flag_cnt++] = force;
238 } else if (strcmp(argv[n], "failover") == 0) {
239 flags[flag_cnt++] = failover;
241 fprintf(stderr, "unknown option: %s", argv[n]);
247 lustre_cfg_bufs_set_string(&bufs, 1, flags);
250 lcfg = lustre_cfg_new(LCFG_CLEANUP, &bufs);
251 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
252 lustre_cfg_free(lcfg);
254 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
255 strerror(rc = errno));
261 int do_add_uuid(char * func, char *uuid, lnet_nid_t nid)
264 struct lustre_cfg_bufs bufs;
265 struct lustre_cfg *lcfg;
267 lustre_cfg_bufs_reset(&bufs, lcfg_devname);
269 lustre_cfg_bufs_set_string(&bufs, 1, uuid);
271 lcfg = lustre_cfg_new(LCFG_ADD_UUID, &bufs);
272 lcfg->lcfg_nid = nid;
273 /* Poison NAL -- pre 1.4.6 will LASSERT on 0 NAL, this way it
274 doesn't work without crashing (bz 10130) */
275 lcfg->lcfg_nal = 0x5a;
278 fprintf(stderr, "adding\tnid: %d\tuuid: %s\n",
279 lcfg->lcfg_nid, uuid);
281 rc = lcfg_ioctl(func, OBD_DEV_ID, lcfg);
282 lustre_cfg_free(lcfg);
284 fprintf(stderr, "IOC_PORTAL_ADD_UUID failed: %s\n",
289 printf ("Added uuid %s: %s\n", uuid, libcfs_nid2str(nid));
293 int jt_lcfg_add_uuid(int argc, char **argv)
301 nid = libcfs_str2nid(argv[2]);
302 if (nid == LNET_NID_ANY) {
303 fprintf (stderr, "Can't parse NID %s\n", argv[2]);
307 return do_add_uuid(argv[0], argv[1], nid);
310 int obd_add_uuid(char *uuid, lnet_nid_t nid)
312 return do_add_uuid("obd_add_uuid", uuid, nid);
315 int jt_lcfg_del_uuid(int argc, char **argv)
318 struct lustre_cfg_bufs bufs;
319 struct lustre_cfg *lcfg;
322 fprintf(stderr, "usage: %s <uuid>\n", argv[0]);
326 lustre_cfg_bufs_reset(&bufs, lcfg_devname);
327 if (strcmp (argv[1], "_all_"))
328 lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
330 lcfg = lustre_cfg_new(LCFG_DEL_UUID, &bufs);
331 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
332 lustre_cfg_free(lcfg);
334 fprintf(stderr, "IOC_PORTAL_DEL_UUID failed: %s\n",
341 int jt_lcfg_del_mount_option(int argc, char **argv)
344 struct lustre_cfg_bufs bufs;
345 struct lustre_cfg *lcfg;
350 lustre_cfg_bufs_reset(&bufs, lcfg_devname);
353 lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
355 lcfg = lustre_cfg_new(LCFG_DEL_MOUNTOPT, &bufs);
356 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
357 lustre_cfg_free(lcfg);
359 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
360 strerror(rc = errno));
365 int jt_lcfg_set_timeout(int argc, char **argv)
368 struct lustre_cfg_bufs bufs;
369 struct lustre_cfg *lcfg;
371 fprintf(stderr, "%s has been deprecated. Use conf_param instead.\n"
372 "e.g. conf_param lustre-MDT0000 obd_timeout=50\n",
373 jt_cmdname(argv[0]));
380 lustre_cfg_bufs_reset(&bufs, lcfg_devname);
381 lcfg = lustre_cfg_new(LCFG_SET_TIMEOUT, &bufs);
382 lcfg->lcfg_num = atoi(argv[1]);
384 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
385 //rc = lcfg_mgs_ioctl(argv[0], OBD_DEV_ID, lcfg);
387 lustre_cfg_free(lcfg);
389 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
390 strerror(rc = errno));
395 int jt_lcfg_add_conn(int argc, char **argv)
397 struct lustre_cfg_bufs bufs;
398 struct lustre_cfg *lcfg;
409 if (lcfg_devname == NULL) {
410 fprintf(stderr, "%s: please use 'device name' to set the "
411 "device name for config commands.\n",
412 jt_cmdname(argv[0]));
416 lustre_cfg_bufs_reset(&bufs, lcfg_devname);
418 lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
420 lcfg = lustre_cfg_new(LCFG_ADD_CONN, &bufs);
421 lcfg->lcfg_num = priority;
423 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
424 lustre_cfg_free (lcfg);
426 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
427 strerror(rc = errno));
433 int jt_lcfg_del_conn(int argc, char **argv)
435 struct lustre_cfg_bufs bufs;
436 struct lustre_cfg *lcfg;
442 if (lcfg_devname == NULL) {
443 fprintf(stderr, "%s: please use 'device name' to set the "
444 "device name for config commands.\n",
445 jt_cmdname(argv[0]));
449 lustre_cfg_bufs_reset(&bufs, lcfg_devname);
451 /* connection uuid */
452 lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
454 lcfg = lustre_cfg_new(LCFG_DEL_MOUNTOPT, &bufs);
456 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
457 lustre_cfg_free(lcfg);
459 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
460 strerror(rc = errno));
466 /* Param set locally, directly on target */
467 int jt_lcfg_param(int argc, char **argv)
470 struct lustre_cfg_bufs bufs;
471 struct lustre_cfg *lcfg;
473 if (argc >= LUSTRE_CFG_MAX_BUFCOUNT)
476 lustre_cfg_bufs_reset(&bufs, NULL);
478 for (i = 1; i < argc; i++) {
479 lustre_cfg_bufs_set_string(&bufs, i, argv[i]);
482 lcfg = lustre_cfg_new(LCFG_PARAM, &bufs);
484 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
485 lustre_cfg_free(lcfg);
487 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
488 strerror(rc = errno));
493 /* Param set in config log on MGS */
494 /* conf_param key=value */
495 /* Note we can actually send mgc conf_params from clients, but currently
496 * that's only done for default file striping (see ll_send_mgc_param),
498 /* After removal of a parameter (-d) Lustre will use the default
499 * AT NEXT REBOOT, not immediately. */
500 int jt_lcfg_mgsparam(int argc, char **argv)
504 struct lustre_cfg_bufs bufs;
505 struct lustre_cfg *lcfg;
508 /* mgs_setparam processes only lctl buf #1 */
509 if ((argc > 3) || (argc <= 1))
512 while ((rc = getopt(argc, argv, "d")) != -1) {
522 lustre_cfg_bufs_reset(&bufs, NULL);
526 /* for delete, make it "<param>=\0" */
527 buf = malloc(strlen(argv[optind]) + 2);
528 /* put an '=' on the end in case it doesn't have one */
529 sprintf(buf, "%s=", argv[optind]);
530 /* then truncate after the first '=' */
531 ptr = strchr(buf, '=');
533 lustre_cfg_bufs_set_string(&bufs, 1, buf);
535 lustre_cfg_bufs_set_string(&bufs, 1, argv[optind]);
538 /* We could put other opcodes here. */
539 lcfg = lustre_cfg_new(LCFG_PARAM, &bufs);
541 rc = lcfg_mgs_ioctl(argv[0], OBD_DEV_ID, lcfg);
542 lustre_cfg_free(lcfg);
546 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
547 strerror(rc = errno));
553 /* Display the path in the same format as sysctl
554 * For eg. obdfilter.lustre-OST0000.stats */
555 static char *display_name(char *filename, int show_type)
561 if (lstat(filename, &st) < 0)
565 filename += strlen("/proc/");
566 if (strncmp(filename, "fs/", strlen("fs/")) == 0)
567 filename += strlen("fs/");
569 filename += strlen("sys/");
571 if (strncmp(filename, "lustre/", strlen("lustre/")) == 0)
572 filename += strlen("lustre/");
573 else if (strncmp(filename, "lnet/", strlen("lnet/")) == 0)
574 filename += strlen("lnet/");
576 /* replace '/' with '.' to match conf_param and sysctl */
578 while ((tmp = strchr(tmp, '/')) != NULL)
581 /* append the indicator to entries */
583 if (S_ISDIR(st.st_mode))
584 strcat(filename, "/");
585 else if (S_ISLNK(st.st_mode))
586 strcat(filename, "@");
587 else if (st.st_mode & S_IWUSR)
588 strcat(filename, "=");
594 /* Find a character in a length limited string */
595 /* BEWARE - kernel definition of strnchr has args in different order! */
596 static char *strnchr(const char *p, char c, size_t n)
609 static char *globerrstr(int glob_rc)
613 return "Out of memory";
617 return "Found no match";
619 return "Unknown error";
622 static void clean_path(char *path)
626 /* If the input is in form Eg. obdfilter.*.stats */
627 if (strchr(path, '.')) {
629 while (*tmp != '\0') {
631 (tmp != path) && (*(tmp - 1) != '\\'))
636 /* get rid of '\', glob doesn't like it */
637 if ((tmp = strrchr(path, '\\')) != NULL) {
638 char *tail = path + strlen(path);
639 while (tmp != path) {
641 memmove(tmp, tmp + 1, tail - tmp);
656 static int listparam_cmdline(int argc, char **argv, struct param_opts *popt)
665 while ((ch = getopt(argc, argv, "FR")) != -1) {
681 static int listparam_display(struct param_opts *popt, char *pattern)
686 char filename[PATH_MAX + 1]; /* extra 1 byte for file type */
688 rc = glob(pattern, GLOB_BRACE | (popt->recursive ? GLOB_MARK : 0),
691 fprintf(stderr, "error: list_param: %s: %s\n",
692 pattern, globerrstr(rc));
696 for (i = 0; i < glob_info.gl_pathc; i++) {
697 char *valuename = NULL;
700 /* Trailing '/' will indicate recursion into directory */
701 last = strlen(glob_info.gl_pathv[i]) - 1;
703 /* Remove trailing '/' or it will be converted to '.' */
704 if (last > 0 && glob_info.gl_pathv[i][last] == '/')
705 glob_info.gl_pathv[i][last] = '\0';
708 strcpy(filename, glob_info.gl_pathv[i]);
709 valuename = display_name(filename, popt->show_type);
711 printf("%s\n", valuename);
713 strcpy(filename, glob_info.gl_pathv[i]);
714 strcat(filename, "/*");
715 listparam_display(popt, filename);
719 globfree(&glob_info);
723 int jt_lcfg_listparam(int argc, char **argv)
727 struct param_opts popt;
728 char pattern[PATH_MAX];
731 rc = listparam_cmdline(argc, argv, &popt);
732 if (rc == argc && popt.recursive) {
733 rc--; /* we know at least "-R" is a parameter */
735 } else if (rc < 0 || rc >= argc) {
739 for (i = rc; i < argc; i++) {
744 /* If the entire path is specified as input */
745 fp = open(path, O_RDONLY);
747 snprintf(pattern, PATH_MAX, "/proc/{fs,sys}/{lnet,lustre}/%s",
750 strcpy(pattern, path);
754 rc = listparam_display(&popt, pattern);
762 static int getparam_cmdline(int argc, char **argv, struct param_opts *popt)
770 while ((ch = getopt(argc, argv, "nNF")) != -1) {
788 static int getparam_display(struct param_opts *popt, char *pattern)
795 char filename[PATH_MAX + 1]; /* extra 1 byte for file type */
797 rc = glob(pattern, GLOB_BRACE, NULL, &glob_info);
799 fprintf(stderr, "error: get_param: %s: %s\n",
800 pattern, globerrstr(rc));
804 buf = malloc(CFS_PAGE_SIZE);
805 for (i = 0; i < glob_info.gl_pathc; i++) {
806 char *valuename = NULL;
808 memset(buf, 0, CFS_PAGE_SIZE);
809 /* As listparam_display is used to show param name (with type),
810 * here "if (only_path)" is ignored.*/
811 if (popt->show_path) {
812 strcpy(filename, glob_info.gl_pathv[i]);
813 valuename = display_name(filename, 0);
816 /* Write the contents of file to stdout */
817 fd = open(glob_info.gl_pathv[i], O_RDONLY);
820 "error: get_param: opening('%s') failed: %s\n",
821 glob_info.gl_pathv[i], strerror(errno));
826 rc = read(fd, buf, CFS_PAGE_SIZE);
830 fprintf(stderr, "error: get_param: "
831 "read('%s') failed: %s\n",
832 glob_info.gl_pathv[i], strerror(errno));
835 /* Print the output in the format path=value if the
836 * value contains no new line character or cab be
837 * occupied in a line, else print value on new line */
838 if (valuename && popt->show_path) {
839 int longbuf = strnchr(buf, rc - 1, '\n') != NULL
841 printf("%s=%s", valuename, longbuf ? "\n" : buf);
847 rc = write(fileno(stdout), buf, rc);
849 fprintf(stderr, "error: get_param: "
850 "write to stdout failed: %s\n",
858 globfree(&glob_info);
863 int jt_lcfg_getparam(int argc, char **argv)
867 struct param_opts popt;
868 char pattern[PATH_MAX];
871 rc = getparam_cmdline(argc, argv, &popt);
872 if (rc < 0 || rc >= argc)
875 for (i = rc; i < argc; i++) {
880 /* If the entire path is specified as input */
881 fp = open(path, O_RDONLY);
883 snprintf(pattern, PATH_MAX, "/proc/{fs,sys}/{lnet,lustre}/%s",
886 strcpy(pattern, path);
891 rc = listparam_display(&popt, pattern);
893 rc = getparam_display(&popt, pattern);
901 static int setparam_cmdline(int argc, char **argv, struct param_opts *popt)
909 while ((ch = getopt(argc, argv, "n")) != -1) {
921 static int setparam_display(struct param_opts *popt, char *pattern, char *value)
927 char filename[PATH_MAX + 1]; /* extra 1 byte for file type */
929 rc = glob(pattern, GLOB_BRACE, NULL, &glob_info);
931 fprintf(stderr, "error: set_param: %s: %s\n",
932 pattern, globerrstr(rc));
935 for (i = 0; i < glob_info.gl_pathc; i++) {
936 char *valuename = NULL;
938 if (popt->show_path) {
939 strcpy(filename, glob_info.gl_pathv[i]);
940 valuename = display_name(filename, 0);
942 printf("%s=%s\n", valuename, value);
944 /* Write the new value to the file */
945 fd = open(glob_info.gl_pathv[i], O_WRONLY);
947 rc = write(fd, value, strlen(value));
949 fprintf(stderr, "error: set_param: "
950 "writing to file %s: %s\n",
951 glob_info.gl_pathv[i], strerror(errno));
956 fprintf(stderr, "error: set_param: %s opening %s\n",
957 strerror(rc = errno), glob_info.gl_pathv[i]);
961 globfree(&glob_info);
965 int jt_lcfg_setparam(int argc, char **argv)
969 struct param_opts popt;
970 char pattern[PATH_MAX];
971 char *path = NULL, *value = NULL;
973 rc = setparam_cmdline(argc, argv, &popt);
974 if (rc < 0 || rc >= argc)
977 for (i = rc; i < argc; i++) {
978 if ((value = strchr(argv[i], '=')) != NULL) {
979 /* format: set_param a=b */
984 /* format: set_param a b */
995 /* If the entire path is specified as input */
996 fp = open(path, O_RDONLY);
998 snprintf(pattern, PATH_MAX, "/proc/{fs,sys}/{lnet,lustre}/%s",
1001 strcpy(pattern, path);
1005 rc = setparam_display(&popt, pattern, value);