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/");
574 /* replace '/' with '.' to match conf_param and sysctl */
576 while ((tmp = strchr(tmp, '/')) != NULL)
579 /* append the indicator to entries */
581 if (S_ISDIR(st.st_mode))
582 strcat(filename, "/");
583 else if (S_ISLNK(st.st_mode))
584 strcat(filename, "@");
585 else if (st.st_mode & S_IWUSR)
586 strcat(filename, "=");
592 /* Find a character in a length limited string */
593 /* BEWARE - kernel definition of strnchr has args in different order! */
594 static char *strnchr(const char *p, char c, size_t n)
607 static char *globerrstr(int glob_rc)
611 return "Out of memory";
615 return "Found no match";
617 return "Unknown error";
620 static void clean_path(char *path)
624 /* If the input is in form Eg. obdfilter.*.stats */
625 if (strchr(path, '.')) {
627 while (*tmp != '\0') {
629 (tmp != path) && (*(tmp - 1) != '\\'))
634 /* get rid of '\', glob doesn't like it */
635 if ((tmp = strrchr(path, '\\')) != NULL) {
636 char *tail = path + strlen(path);
637 while (tmp != path) {
639 memmove(tmp, tmp + 1, tail - tmp);
654 static int listparam_cmdline(int argc, char **argv, struct param_opts *popt)
663 while ((ch = getopt(argc, argv, "FR")) != -1) {
679 static int listparam_display(struct param_opts *popt, char *pattern)
684 char filename[PATH_MAX + 1]; /* extra 1 byte for file type */
686 rc = glob(pattern, GLOB_BRACE | (popt->recursive ? GLOB_MARK : 0),
689 fprintf(stderr, "error: list_param: %s: %s\n",
690 pattern, globerrstr(rc));
694 for (i = 0; i < glob_info.gl_pathc; i++) {
695 char *valuename = NULL;
698 /* Trailing '/' will indicate recursion into directory */
699 last = strlen(glob_info.gl_pathv[i]) - 1;
701 /* Remove trailing '/' or it will be converted to '.' */
702 if (last > 0 && glob_info.gl_pathv[i][last] == '/')
703 glob_info.gl_pathv[i][last] = '\0';
706 strcpy(filename, glob_info.gl_pathv[i]);
707 valuename = display_name(filename, popt->show_type);
709 printf("%s\n", valuename);
711 strcpy(filename, glob_info.gl_pathv[i]);
712 strcat(filename, "/*");
713 listparam_display(popt, filename);
717 globfree(&glob_info);
721 int jt_lcfg_listparam(int argc, char **argv)
725 struct param_opts popt;
726 char pattern[PATH_MAX];
729 rc = listparam_cmdline(argc, argv, &popt);
730 if (rc == argc && popt.recursive) {
731 rc--; /* we know at least "-R" is a parameter */
733 } else if (rc < 0 || rc >= argc) {
737 for (i = rc; i < argc; i++) {
742 /* If the entire path is specified as input */
743 fp = open(path, O_RDONLY);
745 snprintf(pattern, PATH_MAX, "/proc/{fs,sys}/{lnet,lustre}/%s",
748 strcpy(pattern, path);
752 rc = listparam_display(&popt, pattern);
760 static int getparam_cmdline(int argc, char **argv, struct param_opts *popt)
768 while ((ch = getopt(argc, argv, "nNF")) != -1) {
786 static int getparam_display(struct param_opts *popt, char *pattern)
793 char filename[PATH_MAX + 1]; /* extra 1 byte for file type */
795 rc = glob(pattern, GLOB_BRACE, NULL, &glob_info);
797 fprintf(stderr, "error: get_param: %s: %s\n",
798 pattern, globerrstr(rc));
802 buf = malloc(CFS_PAGE_SIZE);
803 for (i = 0; i < glob_info.gl_pathc; i++) {
804 char *valuename = NULL;
806 memset(buf, 0, CFS_PAGE_SIZE);
807 /* As listparam_display is used to show param name (with type),
808 * here "if (only_path)" is ignored.*/
809 if (popt->show_path) {
810 strcpy(filename, glob_info.gl_pathv[i]);
811 valuename = display_name(filename, 0);
814 /* Write the contents of file to stdout */
815 fd = open(glob_info.gl_pathv[i], O_RDONLY);
818 "error: get_param: opening('%s') failed: %s\n",
819 glob_info.gl_pathv[i], strerror(errno));
824 rc = read(fd, buf, CFS_PAGE_SIZE);
828 fprintf(stderr, "error: get_param: "
829 "read('%s') failed: %s\n",
830 glob_info.gl_pathv[i], strerror(errno));
833 /* Print the output in the format path=value if the
834 * value contains no new line character or cab be
835 * occupied in a line, else print value on new line */
836 if (valuename && popt->show_path) {
837 int longbuf = strnchr(buf, rc - 1, '\n') != NULL
839 printf("%s=%s", valuename, longbuf ? "\n" : buf);
845 rc = write(fileno(stdout), buf, rc);
847 fprintf(stderr, "error: get_param: "
848 "write to stdout failed: %s\n",
856 globfree(&glob_info);
861 int jt_lcfg_getparam(int argc, char **argv)
865 struct param_opts popt;
866 char pattern[PATH_MAX];
869 rc = getparam_cmdline(argc, argv, &popt);
870 if (rc < 0 || rc >= argc)
873 for (i = rc; i < argc; i++) {
878 /* If the entire path is specified as input */
879 fp = open(path, O_RDONLY);
881 snprintf(pattern, PATH_MAX, "/proc/{fs,sys}/{lnet,lustre}/%s",
884 strcpy(pattern, path);
889 rc = listparam_display(&popt, pattern);
891 rc = getparam_display(&popt, pattern);
899 static int setparam_cmdline(int argc, char **argv, struct param_opts *popt)
907 while ((ch = getopt(argc, argv, "n")) != -1) {
919 static int setparam_display(struct param_opts *popt, char *pattern, char *value)
925 char filename[PATH_MAX + 1]; /* extra 1 byte for file type */
927 rc = glob(pattern, GLOB_BRACE, NULL, &glob_info);
929 fprintf(stderr, "error: set_param: %s: %s\n",
930 pattern, globerrstr(rc));
933 for (i = 0; i < glob_info.gl_pathc; i++) {
934 char *valuename = NULL;
936 if (popt->show_path) {
937 strcpy(filename, glob_info.gl_pathv[i]);
938 valuename = display_name(filename, 0);
940 printf("%s=%s\n", valuename, value);
942 /* Write the new value to the file */
943 fd = open(glob_info.gl_pathv[i], O_WRONLY);
945 rc = write(fd, value, strlen(value));
947 fprintf(stderr, "error: set_param: "
948 "writing to file %s: %s\n",
949 glob_info.gl_pathv[i], strerror(errno));
954 fprintf(stderr, "error: set_param: %s opening %s\n",
955 strerror(rc = errno), glob_info.gl_pathv[i]);
959 globfree(&glob_info);
963 int jt_lcfg_setparam(int argc, char **argv)
967 struct param_opts popt;
968 char pattern[PATH_MAX];
969 char *path = NULL, *value = NULL;
971 rc = setparam_cmdline(argc, argv, &popt);
972 if (rc < 0 || rc >= argc)
975 for (i = rc; i < argc; i++) {
976 if ((value = strchr(argv[i], '=')) != NULL) {
977 /* format: set_param a=b */
982 /* format: set_param a b */
993 /* If the entire path is specified as input */
994 fp = open(path, O_RDONLY);
996 snprintf(pattern, PATH_MAX, "/proc/{fs,sys}/{lnet,lustre}/%s",
999 strcpy(pattern, path);
1003 rc = setparam_display(&popt, pattern, value);