Whamcloud - gitweb
LU-5092 nodemap: handle config changes while mid-flight
[fs/lustre-release.git] / lustre / utils / lustre_cfg.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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2015, 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/lustre_cfg.c
37  *
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>
42  */
43
44 #include <errno.h>
45 #include <fcntl.h>
46 #include <limits.h>
47 #include <stdbool.h>
48 #include <stdlib.h>
49 #include <string.h>
50 #include <sys/ioctl.h>
51 #include <sys/stat.h>
52 #include <unistd.h>
53 #include <stdio.h>
54 #include <stdarg.h>
55 #include <ctype.h>
56
57 #include <libcfs/util/string.h>
58 #include <libcfs/util/param.h>
59 #include <libcfs/util/parser.h>
60 #include <lnet/nidstr.h>
61 #include <lustre_cfg.h>
62 #include <lustre_ioctl.h>
63 #include <lustre/lustre_idl.h>
64 #include <lustre_ver.h>
65
66 #include <sys/un.h>
67 #include <time.h>
68 #include <sys/time.h>
69 #include <errno.h>
70 #include <string.h>
71
72 #include "obdctl.h"
73 #include <lnet/lnetctl.h>
74 #include <stdio.h>
75
76 static char * lcfg_devname;
77
78 int lcfg_set_devname(char *name)
79 {
80         char *ptr;
81         int digit = 1;
82
83         if (name) {
84                 if (lcfg_devname)
85                         free(lcfg_devname);
86                 /* quietly strip the unnecessary '$' */
87                 if (*name == '$' || *name == '%')
88                         name++;
89
90                 ptr = name;
91                 while (*ptr != '\0') {
92                         if (!isdigit(*ptr)) {
93                             digit = 0;
94                             break;
95                         }
96                         ptr++;
97                 }
98
99                 if (digit) {
100                         /* We can't translate from dev # to name */
101                         lcfg_devname = NULL;
102                 } else {
103                         lcfg_devname = strdup(name);
104                 }
105         } else {
106                 lcfg_devname = NULL;
107         }
108         return 0;
109 }
110
111 char * lcfg_get_devname(void)
112 {
113         return lcfg_devname;
114 }
115
116 int jt_lcfg_device(int argc, char **argv)
117 {
118         return jt_obd_device(argc, argv);
119 }
120
121 int jt_lcfg_attach(int argc, char **argv)
122 {
123         struct lustre_cfg_bufs bufs;
124         struct lustre_cfg *lcfg;
125         int rc;
126
127         if (argc != 4)
128                 return CMD_HELP;
129
130         lustre_cfg_bufs_reset(&bufs, NULL);
131
132         lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
133         lustre_cfg_bufs_set_string(&bufs, 0, argv[2]);
134         lustre_cfg_bufs_set_string(&bufs, 2, argv[3]);
135
136         lcfg = lustre_cfg_new(LCFG_ATTACH, &bufs);
137         if (lcfg == NULL) {
138                 rc = -ENOMEM;
139         } else {
140                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
141                 lustre_cfg_free(lcfg);
142         }
143         if (rc < 0) {
144                 fprintf(stderr, "error: %s: LCFG_ATTACH %s\n",
145                         jt_cmdname(argv[0]), strerror(rc = errno));
146         } else {
147                 lcfg_set_devname(argv[2]);
148         }
149
150         return rc;
151 }
152
153 int jt_lcfg_setup(int argc, char **argv)
154 {
155         struct lustre_cfg_bufs bufs;
156         struct lustre_cfg *lcfg;
157         int i;
158         int rc;
159
160         if (lcfg_devname == NULL) {
161                 fprintf(stderr, "%s: please use 'device name' to set the "
162                         "device name for config commands.\n",
163                         jt_cmdname(argv[0]));
164                 return -EINVAL;
165         }
166
167         lustre_cfg_bufs_reset(&bufs, lcfg_devname);
168
169         if (argc > 6)
170                 return CMD_HELP;
171
172         for (i = 1; i < argc; i++) {
173                 lustre_cfg_bufs_set_string(&bufs, i, argv[i]);
174         }
175
176         lcfg = lustre_cfg_new(LCFG_SETUP, &bufs);
177         if (lcfg == NULL) {
178                 rc = -ENOMEM;
179         } else {
180                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
181                 lustre_cfg_free(lcfg);
182         }
183         if (rc < 0)
184                 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
185                         strerror(rc = errno));
186
187         return rc;
188 }
189
190 int jt_obd_detach(int argc, char **argv)
191 {
192         struct lustre_cfg_bufs bufs;
193         struct lustre_cfg *lcfg;
194         int rc;
195
196         if (lcfg_devname == NULL) {
197                 fprintf(stderr, "%s: please use 'device name' to set the "
198                         "device name for config commands.\n",
199                         jt_cmdname(argv[0]));
200                 return -EINVAL;
201         }
202
203         lustre_cfg_bufs_reset(&bufs, lcfg_devname);
204
205         if (argc != 1)
206                 return CMD_HELP;
207
208         lcfg = lustre_cfg_new(LCFG_DETACH, &bufs);
209         if (lcfg == NULL) {
210                 rc = -ENOMEM;
211         } else {
212                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
213                 lustre_cfg_free(lcfg);
214         }
215         if (rc < 0)
216                 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
217                         strerror(rc = errno));
218
219         return rc;
220 }
221
222 int jt_obd_cleanup(int argc, char **argv)
223 {
224         struct lustre_cfg_bufs bufs;
225         struct lustre_cfg *lcfg;
226         char force = 'F';
227         char failover = 'A';
228         char flags[3] = { 0 };
229         int flag_cnt = 0, n;
230         int rc;
231
232         if (lcfg_devname == NULL) {
233                 fprintf(stderr, "%s: please use 'device name' to set the "
234                         "device name for config commands.\n",
235                         jt_cmdname(argv[0]));
236                 return -EINVAL;
237         }
238
239         lustre_cfg_bufs_reset(&bufs, lcfg_devname);
240
241         if (argc < 1 || argc > 3)
242                 return CMD_HELP;
243
244         /* we are protected from overflowing our buffer by the argc
245          * check above
246          */
247         for (n = 1; n < argc; n++) {
248                 if (strcmp(argv[n], "force") == 0) {
249                         flags[flag_cnt++] = force;
250                 } else if (strcmp(argv[n], "failover") == 0) {
251                         flags[flag_cnt++] = failover;
252                 } else {
253                         fprintf(stderr, "unknown option: %s\n", argv[n]);
254                         return CMD_HELP;
255                 }
256         }
257
258         if (flag_cnt) {
259                 lustre_cfg_bufs_set_string(&bufs, 1, flags);
260         }
261
262         lcfg = lustre_cfg_new(LCFG_CLEANUP, &bufs);
263         if (lcfg == NULL) {
264                 rc = -ENOMEM;
265         } else {
266                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
267                 lustre_cfg_free(lcfg);
268         }
269         if (rc < 0)
270                 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
271                         strerror(rc = errno));
272
273         return rc;
274 }
275
276 static
277 int do_add_uuid(char * func, char *uuid, lnet_nid_t nid)
278 {
279         int rc;
280         struct lustre_cfg_bufs bufs;
281         struct lustre_cfg *lcfg;
282
283         lustre_cfg_bufs_reset(&bufs, lcfg_devname);
284         if (uuid != NULL)
285                 lustre_cfg_bufs_set_string(&bufs, 1, uuid);
286
287         lcfg = lustre_cfg_new(LCFG_ADD_UUID, &bufs);
288         if (lcfg == NULL) {
289                 rc = -ENOMEM;
290         } else {
291                 lcfg->lcfg_nid = nid;
292
293                 rc = lcfg_ioctl(func, OBD_DEV_ID, lcfg);
294                 lustre_cfg_free(lcfg);
295         }
296         if (rc) {
297                 fprintf(stderr, "IOC_PORTAL_ADD_UUID failed: %s\n",
298                         strerror(errno));
299                 return -1;
300         }
301
302         if (uuid != NULL)
303                 printf("Added uuid %s: %s\n", uuid, libcfs_nid2str(nid));
304
305         return 0;
306 }
307
308 int jt_lcfg_add_uuid(int argc, char **argv)
309 {
310         lnet_nid_t nid;
311
312         if (argc != 3) {
313                 return CMD_HELP;
314         }
315
316         nid = libcfs_str2nid(argv[2]);
317         if (nid == LNET_NID_ANY) {
318                 fprintf (stderr, "Can't parse NID %s\n", argv[2]);
319                 return (-1);
320         }
321
322         return do_add_uuid(argv[0], argv[1], nid);
323 }
324
325 int jt_lcfg_del_uuid(int argc, char **argv)
326 {
327         int rc;
328         struct lustre_cfg_bufs bufs;
329         struct lustre_cfg *lcfg;
330
331         if (argc != 2) {
332                 fprintf(stderr, "usage: %s <uuid>\n", argv[0]);
333                 return 0;
334         }
335
336         lustre_cfg_bufs_reset(&bufs, lcfg_devname);
337         if (strcmp (argv[1], "_all_"))
338                 lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
339
340         lcfg = lustre_cfg_new(LCFG_DEL_UUID, &bufs);
341         if (lcfg == NULL) {
342                 rc = -ENOMEM;
343         } else {
344                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
345                 lustre_cfg_free(lcfg);
346         }
347         if (rc) {
348                 fprintf(stderr, "IOC_PORTAL_DEL_UUID failed: %s\n",
349                         strerror(errno));
350                 return -1;
351         }
352         return 0;
353 }
354
355 int jt_lcfg_del_mount_option(int argc, char **argv)
356 {
357         int rc;
358         struct lustre_cfg_bufs bufs;
359         struct lustre_cfg *lcfg;
360
361         if (argc != 2)
362                 return CMD_HELP;
363
364         lustre_cfg_bufs_reset(&bufs, lcfg_devname);
365
366         /* profile name */
367         lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
368
369         lcfg = lustre_cfg_new(LCFG_DEL_MOUNTOPT, &bufs);
370         if (lcfg == NULL) {
371                 rc = -ENOMEM;
372         } else {
373                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
374                 lustre_cfg_free(lcfg);
375         }
376         if (rc < 0) {
377                 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
378                         strerror(rc = errno));
379         }
380         return rc;
381 }
382
383 int jt_lcfg_set_timeout(int argc, char **argv)
384 {
385         int rc;
386         struct lustre_cfg_bufs bufs;
387         struct lustre_cfg *lcfg;
388
389         fprintf(stderr, "%s has been deprecated. Use conf_param instead.\n"
390                 "e.g. conf_param lustre-MDT0000 obd_timeout=50\n",
391                 jt_cmdname(argv[0]));
392         return CMD_HELP;
393
394
395         if (argc != 2)
396                 return CMD_HELP;
397
398         lustre_cfg_bufs_reset(&bufs, lcfg_devname);
399         lcfg = lustre_cfg_new(LCFG_SET_TIMEOUT, &bufs);
400         if (lcfg == NULL) {
401                 rc = -ENOMEM;
402         } else {
403                 lcfg->lcfg_num = atoi(argv[1]);
404
405                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
406                 lustre_cfg_free(lcfg);
407         }
408         if (rc < 0) {
409                 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
410                         strerror(rc = errno));
411         }
412         return rc;
413 }
414
415 int jt_lcfg_add_conn(int argc, char **argv)
416 {
417         struct lustre_cfg_bufs bufs;
418         struct lustre_cfg *lcfg;
419         int priority;
420         int rc;
421
422         if (argc == 2)
423                 priority = 0;
424         else if (argc == 3)
425                 priority = 1;
426         else
427                 return CMD_HELP;
428
429         if (lcfg_devname == NULL) {
430                 fprintf(stderr, "%s: please use 'device name' to set the "
431                         "device name for config commands.\n",
432                         jt_cmdname(argv[0]));
433                 return -EINVAL;
434         }
435
436         lustre_cfg_bufs_reset(&bufs, lcfg_devname);
437
438         lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
439
440         lcfg = lustre_cfg_new(LCFG_ADD_CONN, &bufs);
441         if (lcfg == NULL) {
442                 rc = -ENOMEM;
443         } else {
444                 lcfg->lcfg_num = priority;
445
446                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
447                 lustre_cfg_free(lcfg);
448         }
449         if (rc < 0) {
450                 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
451                         strerror(rc = errno));
452         }
453
454         return rc;
455 }
456
457 int jt_lcfg_del_conn(int argc, char **argv)
458 {
459         struct lustre_cfg_bufs bufs;
460         struct lustre_cfg *lcfg;
461         int rc;
462
463         if (argc != 2)
464                 return CMD_HELP;
465
466         if (lcfg_devname == NULL) {
467                 fprintf(stderr, "%s: please use 'device name' to set the "
468                         "device name for config commands.\n",
469                         jt_cmdname(argv[0]));
470                 return -EINVAL;
471         }
472
473         lustre_cfg_bufs_reset(&bufs, lcfg_devname);
474
475         /* connection uuid */
476         lustre_cfg_bufs_set_string(&bufs, 1, argv[1]);
477
478         lcfg = lustre_cfg_new(LCFG_DEL_MOUNTOPT, &bufs);
479         if (lcfg == NULL) {
480                 rc = -ENOMEM;
481         } else {
482                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
483                 lustre_cfg_free(lcfg);
484         }
485         if (rc < 0) {
486                 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
487                         strerror(rc = errno));
488         }
489
490         return rc;
491 }
492
493 /* Param set locally, directly on target */
494 int jt_lcfg_param(int argc, char **argv)
495 {
496         int i, rc;
497         struct lustre_cfg_bufs bufs;
498         struct lustre_cfg *lcfg;
499
500         if (argc >= LUSTRE_CFG_MAX_BUFCOUNT)
501                 return CMD_HELP;
502
503         lustre_cfg_bufs_reset(&bufs, NULL);
504
505         for (i = 1; i < argc; i++) {
506                 lustre_cfg_bufs_set_string(&bufs, i, argv[i]);
507         }
508
509         lcfg = lustre_cfg_new(LCFG_PARAM, &bufs);
510         if (lcfg == NULL) {
511                 rc = -ENOMEM;
512         } else {
513                 rc = lcfg_ioctl(argv[0], OBD_DEV_ID, lcfg);
514                 lustre_cfg_free(lcfg);
515         }
516         if (rc < 0) {
517                 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
518                         strerror(rc = errno));
519         }
520         return rc;
521 }
522
523 struct param_opts {
524         unsigned int po_only_path:1;
525         unsigned int po_show_path:1;
526         unsigned int po_show_type:1;
527         unsigned int po_recursive:1;
528         unsigned int po_params2:1;
529         unsigned int po_delete:1;
530         unsigned int po_only_dir:1;
531 };
532
533 /* Param set to single log file, used by all clients and servers.
534  * This should be loaded after the individual config logs.
535  * Called from set param with -P option.
536  */
537 static int jt_lcfg_mgsparam2(int argc, char **argv, struct param_opts *popt)
538 {
539         int     rc, i;
540         int     first_param;
541         struct  lustre_cfg_bufs bufs;
542         struct  lustre_cfg *lcfg;
543         char    *buf = NULL;
544         int     len;
545
546         first_param = optind;
547         if (first_param < 0 || first_param >= argc)
548                 return CMD_HELP;
549
550         for (i = first_param, rc = 0; i < argc; i++) {
551                 lustre_cfg_bufs_reset(&bufs, NULL);
552                 /* This same command would be executed on all nodes, many
553                  * of which should fail (silently) because they don't have
554                  * that proc file existing locally. There would be no
555                  * preprocessing on the MGS to try to figure out which
556                  * parameter files to add this to, there would be nodes
557                  * processing on the cluster nodes to try to figure out
558                  * if they are the intended targets. They will blindly
559                  * try to set the parameter, and ENOTFOUND means it wasn't
560                  * for them.
561                  * Target name "general" means call on all targets. It is
562                  * left here in case some filtering will be added in
563                  * future.
564                  */
565                 lustre_cfg_bufs_set_string(&bufs, 0, "general");
566
567                 len = strlen(argv[i]);
568
569                 /* put an '=' on the end in case it doesn't have one */
570                 if (popt->po_delete && argv[i][len - 1] != '=') {
571                         buf = malloc(len + 1);
572                         if (buf == NULL) {
573                                 rc = -ENOMEM;
574                                 break;
575                         }
576                         sprintf(buf, "%s=", argv[i]);
577                 } else {
578                         buf = argv[i];
579                 }
580                 lustre_cfg_bufs_set_string(&bufs, 1, buf);
581
582                 lcfg = lustre_cfg_new(LCFG_SET_PARAM, &bufs);
583                 if (lcfg == NULL) {
584                         fprintf(stderr, "error: allocating lcfg for %s: %s\n",
585                                 jt_cmdname(argv[0]), strerror(-ENOMEM));
586                         if (rc == 0)
587                                 rc = -ENOMEM;
588                 } else {
589                         int rc2 = lcfg_mgs_ioctl(argv[0], OBD_DEV_ID, lcfg);
590                         if (rc2 != 0) {
591                                 fprintf(stderr, "error: executing %s: %s\n",
592                                         jt_cmdname(argv[0]), strerror(errno));
593                                 if (rc == 0)
594                                         rc = rc2;
595                         }
596                         lustre_cfg_free(lcfg);
597                 }
598                 if (buf != argv[i])
599                         free(buf);
600         }
601
602         return rc;
603 }
604
605 /* Param set in config log on MGS */
606 /* conf_param key=value */
607 /* Note we can actually send mgc conf_params from clients, but currently
608  * that's only done for default file striping (see ll_send_mgc_param),
609  * and not here. */
610 /* After removal of a parameter (-d) Lustre will use the default
611  * AT NEXT REBOOT, not immediately. */
612 int jt_lcfg_mgsparam(int argc, char **argv)
613 {
614         int rc;
615         int del = 0;
616         struct lustre_cfg_bufs bufs;
617         struct lustre_cfg *lcfg;
618         char *buf = NULL;
619
620 #if LUSTRE_VERSION_CODE >= OBD_OCD_VERSION(2, 8, 53, 0)
621         fprintf(stderr, "warning: 'lctl conf_param' is deprecated, "
622                 "use 'lctl set_param -P' instead\n");
623 #endif
624
625         /* mgs_setparam processes only lctl buf #1 */
626         if ((argc > 3) || (argc <= 1))
627                 return CMD_HELP;
628
629         while ((rc = getopt(argc, argv, "d")) != -1) {
630                 switch (rc) {
631                         case 'd':
632                                 del = 1;
633                                 break;
634                         default:
635                                 return CMD_HELP;
636                 }
637         }
638
639         lustre_cfg_bufs_reset(&bufs, NULL);
640         if (del) {
641                 char *ptr;
642
643                 /* for delete, make it "<param>=\0" */
644                 buf = malloc(strlen(argv[optind]) + 2);
645                 if (buf == NULL) {
646                         rc = -ENOMEM;
647                         goto out;
648                 }
649                 /* put an '=' on the end in case it doesn't have one */
650                 sprintf(buf, "%s=", argv[optind]);
651                 /* then truncate after the first '=' */
652                 ptr = strchr(buf, '=');
653                 *(++ptr) = '\0';
654                 lustre_cfg_bufs_set_string(&bufs, 1, buf);
655         } else {
656                 lustre_cfg_bufs_set_string(&bufs, 1, argv[optind]);
657         }
658
659         /* We could put other opcodes here. */
660         lcfg = lustre_cfg_new(LCFG_PARAM, &bufs);
661         if (lcfg == NULL) {
662                 rc = -ENOMEM;
663         } else {
664                 rc = lcfg_mgs_ioctl(argv[0], OBD_DEV_ID, lcfg);
665                 if (rc < 0)
666                         rc = -errno;
667                 lustre_cfg_free(lcfg);
668         }
669         if (buf)
670                 free(buf);
671 out:
672         if (rc < 0) {
673                 fprintf(stderr, "error: %s: %s\n", jt_cmdname(argv[0]),
674                         strerror(-rc));
675         }
676
677         return rc;
678 }
679
680 /**
681  * Display a parameter path in the same format as sysctl.
682  * E.g. obdfilter.lustre-OST0000.stats
683  *
684  * \param[in] filename  file name of the parameter
685  * \param[in] st        parameter file stats
686  * \param[in] popt      set/get param options
687  *
688  * \retval allocated pointer containing modified filename
689  */
690 static char *
691 display_name(const char *filename, struct stat *st, struct param_opts *popt)
692 {
693         size_t suffix_len = 0;
694         char *suffix = NULL;
695         char *param_name;
696         char *tmp;
697
698         if (popt->po_show_type) {
699                 if (S_ISDIR(st->st_mode))
700                         suffix = "/";
701                 else if (S_ISLNK(st->st_mode))
702                         suffix = "@";
703                 else if (st->st_mode & S_IWUSR)
704                         suffix = "=";
705         }
706
707         /* Take the original filename string and chop off the glob addition */
708         tmp = strstr(filename, "/lustre/");
709         if (tmp == NULL) {
710                 tmp = strstr(filename, "/lnet/");
711                 if (tmp != NULL)
712                         tmp += strlen("/lnet/");
713         } else {
714                 tmp += strlen("/lustre/");
715         }
716
717         /* Allocate return string */
718         param_name = strdup(tmp);
719         if (param_name == NULL)
720                 return NULL;
721
722         /* replace '/' with '.' to match conf_param and sysctl */
723         for (tmp = strchr(param_name, '/'); tmp != NULL; tmp = strchr(tmp, '/'))
724                 *tmp = '.';
725
726         /* Append the indicator to entries if needed. */
727         if (popt->po_show_type && suffix != NULL) {
728                 suffix_len = strlen(suffix);
729
730                 tmp = realloc(param_name, suffix_len + strlen(param_name) + 1);
731                 if (tmp != NULL) {
732                         param_name = tmp;
733                         strncat(param_name, suffix, suffix_len);
734                 }
735         }
736
737         return param_name;
738 }
739
740 /* Find a character in a length limited string */
741 /* BEWARE - kernel definition of strnchr has args in different order! */
742 static char *strnchr(const char *p, char c, size_t n)
743 {
744        if (!p)
745                return (0);
746
747        while (n-- > 0) {
748                if (*p == c)
749                        return ((char *)p);
750                p++;
751        }
752        return (0);
753 }
754
755 /**
756  * Turns a lctl parameter string into a procfs/sysfs subdirectory path pattern.
757  *
758  * \param[in] popt              Used to control parameter usage. For this
759  *                              function it is used to see if the path has
760  *                              a added suffix.
761  * \param[in,out] path          lctl parameter string that is turned into
762  *                              the subdirectory path pattern that is used
763  *                              to search the procfs/sysfs tree.
764  *
765  * \retval -errno on error.
766  */
767 static int
768 clean_path(struct param_opts *popt, char *path)
769 {
770         char *nidstr = NULL;
771         char *tmp;
772
773         if (popt == NULL || path == NULL || strlen(path) == 0)
774                 return -EINVAL;
775
776         /* If path contains a suffix we need to remove it */
777         if (popt->po_show_type) {
778                 size_t path_end = strlen(path) - 1;
779
780                 tmp = path + path_end;
781                 switch (*tmp) {
782                 case '@':
783                 case '=':
784                 case '/':
785                         *tmp = '\0';
786                 default:
787                         break;
788                 }
789         }
790
791         /* get rid of '\', glob doesn't like it */
792         tmp = strrchr(path, '\\');
793         if (tmp != NULL) {
794                 char *tail = path + strlen(path);
795
796                 while (tmp != path) {
797                         if (*tmp == '\\') {
798                                 memmove(tmp, tmp + 1, tail - tmp);
799                                 --tail;
800                         }
801                         --tmp;
802                 }
803         }
804
805         /* Does this path contain a NID string ? */
806         tmp = strchr(path, '@');
807         if (tmp != NULL) {
808                 char *find_nid = strdup(path);
809                 lnet_nid_t nid;
810
811                 if (find_nid == NULL)
812                         return -ENOMEM;
813
814                 /* First we need to chop off rest after nid string.
815                  * Since find_nid is a clone of path it better have
816                  * '@' */
817                 tmp = strchr(find_nid, '@');
818                 tmp = strchr(tmp, '.');
819                 if (tmp != NULL)
820                         *tmp = '\0';
821
822                 /* Now chop off the front. */
823                 for (tmp = strchr(find_nid, '.'); tmp != NULL;
824                      tmp = strchr(tmp, '.')) {
825                         /* Remove MGC to make it NID format */
826                         if (!strncmp(++tmp, "MGC", 3))
827                                 tmp += 3;
828
829                         nid = libcfs_str2nid(tmp);
830                         if (nid != LNET_NID_ANY) {
831                                 nidstr = libcfs_nid2str(nid);
832                                 if (nidstr == NULL)
833                                         return -EINVAL;
834                                 break;
835                         }
836                 }
837                 free(find_nid);
838         }
839
840         /* replace param '.' with '/' */
841         for (tmp = strchr(path, '.'); tmp != NULL; tmp = strchr(tmp, '.')) {
842                 *tmp++ = '/';
843
844                 /* Remove MGC to make it NID format */
845                 if (!strncmp(tmp, "MGC", 3))
846                         tmp += 3;
847
848                 /* There exist cases where some of the subdirectories of the
849                  * the parameter tree has embedded in its name a NID string.
850                  * This means that it is possible that these subdirectories
851                  * could have actual '.' in its name. If this is the case we
852                  * don't want to blindly replace the '.' with '/'. */
853                 if (nidstr != NULL) {
854                         char *match = strstr(tmp, nidstr);
855
856                         if (tmp == match)
857                                 tmp += strlen(nidstr);
858                 }
859         }
860
861         return 0;
862 }
863
864 /**
865  * The application lctl can perform three operations for lustre
866  * tunables. This enum defines those three operations which are
867  *
868  * 1) LIST_PARAM        - list available tunables
869  * 2) GET_PARAM         - report the current setting of a tunable
870  * 3) SET_PARAM         - set the tunable to a new value
871  */
872 enum parameter_operation {
873         LIST_PARAM,
874         GET_PARAM,
875         SET_PARAM,
876 };
877
878 char *parameter_opname[] = {
879         [LIST_PARAM] = "list_param",
880         [GET_PARAM] = "get_param",
881         [SET_PARAM] = "set_param",
882 };
883
884 /**
885  * Read the value of parameter
886  *
887  * \param[in]   path            full path to the parameter
888  * \param[in]   param_name      lctl parameter format of the
889  *                              parameter path
890  * \param[in]   popt            set/get param options
891  *
892  * \retval 0 on success.
893  * \retval -errno on error.
894  */
895 static int
896 read_param(const char *path, const char *param_name, struct param_opts *popt)
897 {
898         bool display_path = popt->po_show_path;
899         long page_size = sysconf(_SC_PAGESIZE);
900         int rc = 0;
901         char *buf;
902         int fd;
903
904         /* Read the contents of file to stdout */
905         fd = open(path, O_RDONLY);
906         if (fd < 0) {
907                 rc = -errno;
908                 fprintf(stderr,
909                         "error: get_param: opening '%s': %s\n",
910                         path, strerror(errno));
911                 return rc;
912         }
913
914         buf = calloc(1, page_size);
915         if (buf == NULL) {
916                 fprintf(stderr,
917                         "error: get_param: allocating '%s' buffer: %s\n",
918                         path, strerror(errno));
919                 close(fd);
920                 return -ENOMEM;
921         }
922
923         while (1) {
924                 ssize_t count = read(fd, buf, page_size);
925
926                 if (count == 0)
927                         break;
928                 if (count < 0) {
929                         rc = -errno;
930                         if (errno != EIO) {
931                                 fprintf(stderr, "error: get_param: "
932                                         "reading '%s': %s\n",
933                                         param_name, strerror(errno));
934                         }
935                         break;
936                 }
937
938                 /* Print the output in the format path=value if the value does
939                  * not contain a new line character and the output can fit in
940                  * a single line, else print value on new line */
941                 if (display_path) {
942                         bool longbuf;
943
944                         longbuf = strnchr(buf, count - 1, '\n') != NULL ||
945                                           count + strlen(param_name) >= 80;
946                         printf("%s=%s", param_name, longbuf ? "\n" : buf);
947
948                         /* Make sure it doesn't print again while looping */
949                         display_path = false;
950
951                         if (!longbuf)
952                                 continue;
953                 }
954
955                 if (fwrite(buf, 1, count, stdout) != count) {
956                         rc = -errno;
957                         fprintf(stderr,
958                                 "error: get_param: write to stdout: %s\n",
959                                 strerror(errno));
960                         break;
961                 }
962         }
963         close(fd);
964         free(buf);
965
966         return rc;
967 }
968
969 /**
970  * Set a parameter to a specified value
971  *
972  * \param[in] path              full path to the parameter
973  * \param[in] param_name        lctl parameter format of the parameter path
974  * \param[in] popt              set/get param options
975  * \param[in] value             value to set the parameter to
976  *
977  * \retval number of bytes written on success.
978  * \retval -errno on error.
979  */
980 static int
981 write_param(const char *path, const char *param_name, struct param_opts *popt,
982             const char *value)
983 {
984         int fd, rc = 0;
985         ssize_t count;
986
987         if (value == NULL)
988                 return -EINVAL;
989
990         /* Write the new value to the file */
991         fd = open(path, O_WRONLY);
992         if (fd < 0) {
993                 rc = -errno;
994                 fprintf(stderr, "error: set_param: opening '%s': %s\n",
995                         path, strerror(errno));
996                 return rc;
997         }
998
999         count = write(fd, value, strlen(value));
1000         if (count < 0) {
1001                 rc = -errno;
1002                 if (errno != EIO) {
1003                         fprintf(stderr, "error: set_param: setting %s=%s: %s\n",
1004                                 path, value, strerror(errno));
1005                 }
1006         } else if (count < strlen(value)) { /* Truncate case */
1007                 rc = -EINVAL;
1008                 fprintf(stderr, "error: set_param: setting %s=%s: "
1009                         "wrote only %zd\n", path, value, count);
1010         } else if (popt->po_show_path) {
1011                 printf("%s=%s\n", param_name, value);
1012         }
1013         close(fd);
1014
1015         return rc;
1016 }
1017
1018 /**
1019  * Perform a read, write or just a listing of a parameter
1020  *
1021  * \param[in] popt              list,set,get parameter options
1022  * \param[in] pattern           search filter for the path of the parameter
1023  * \param[in] value             value to set the parameter if write operation
1024  * \param[in] mode              what operation to perform with the parameter
1025  *
1026  * \retval number of bytes written on success.
1027  * \retval -errno on error and prints error message.
1028  */
1029 static int
1030 param_display(struct param_opts *popt, char *pattern, char *value,
1031               enum parameter_operation mode)
1032 {
1033         int dir_count = 0;
1034         char **dir_cache;
1035         glob_t paths;
1036         char *opname = parameter_opname[mode];
1037         int rc, i;
1038
1039         rc = cfs_get_param_paths(&paths, "%s", pattern);
1040         if (rc != 0) {
1041                 rc = -errno;
1042                 if (!popt->po_recursive) {
1043                         fprintf(stderr, "error: %s: param_path '%s': %s\n",
1044                                 opname, pattern, strerror(errno));
1045                 }
1046                 return rc;
1047         }
1048
1049         dir_cache = calloc(paths.gl_pathc, sizeof(char *));
1050         if (dir_cache == NULL) {
1051                 rc = -ENOMEM;
1052                 fprintf(stderr,
1053                         "error: %s: allocating '%s' dir_cache[%zd]: %s\n",
1054                         opname, pattern, paths.gl_pathc, strerror(-rc));
1055                 goto out_param;
1056         }
1057
1058         for (i = 0; i < paths.gl_pathc; i++) {
1059                 char *param_name = NULL, *tmp;
1060                 char pathname[PATH_MAX];
1061                 struct stat st;
1062                 int rc2;
1063
1064                 if (stat(paths.gl_pathv[i], &st) == -1) {
1065                         fprintf(stderr, "error: %s: stat '%s': %s\n",
1066                                 opname, paths.gl_pathv[i], strerror(errno));
1067                         if (rc == 0)
1068                                 rc = -errno;
1069                         continue;
1070                 }
1071
1072                 if (popt->po_only_dir && !S_ISDIR(st.st_mode))
1073                         continue;
1074
1075                 param_name = display_name(paths.gl_pathv[i], &st, popt);
1076                 if (param_name == NULL) {
1077                         fprintf(stderr,
1078                                 "error: %s: generating name for '%s': %s\n",
1079                                 opname, paths.gl_pathv[i], strerror(ENOMEM));
1080                         if (rc == 0)
1081                                 rc = -ENOMEM;
1082                         continue;
1083                 }
1084
1085                 /**
1086                  * For the upstream client the parameter files locations
1087                  * are split between under both /sys/kernel/debug/lustre
1088                  * and /sys/fs/lustre. The parameter files containing
1089                  * small amounts of data, less than a page in size, are
1090                  * located under /sys/fs/lustre and in the case of large
1091                  * parameter data files, think stats for example, are
1092                  * located in the debugfs tree. Since the files are split
1093                  * across two trees the directories are often duplicated
1094                  * which means these directories are listed twice which
1095                  * leads to duplicate output to the user. To avoid scanning
1096                  * a directory twice we have to cache any directory and
1097                  * check if a search has been requested twice.
1098                  */
1099                 if (S_ISDIR(st.st_mode)) {
1100                         int j;
1101
1102                         for (j = 0; j < dir_count; j++) {
1103                                 if (!strcmp(dir_cache[j], param_name))
1104                                         break;
1105                         }
1106                         if (j != dir_count) {
1107                                 free(param_name);
1108                                 param_name = NULL;
1109                                 continue;
1110                         }
1111                         dir_cache[dir_count++] = strdup(param_name);
1112                 }
1113
1114                 switch (mode) {
1115                 case GET_PARAM:
1116                         /* Read the contents of file to stdout */
1117                         if (S_ISREG(st.st_mode))
1118                                 read_param(paths.gl_pathv[i], param_name, popt);
1119                         break;
1120                 case SET_PARAM:
1121                         if (S_ISREG(st.st_mode)) {
1122                                 rc2 = write_param(paths.gl_pathv[i],
1123                                                   param_name, popt, value);
1124                                 if (rc2 < 0 && rc == 0)
1125                                         rc = rc2;
1126                         }
1127                         break;
1128                 case LIST_PARAM:
1129                         if (popt->po_show_path)
1130                                 printf("%s\n", param_name);
1131                         break;
1132                 }
1133
1134                 /* Only directories are searched recursively if
1135                  * requested by the user */
1136                 if (!S_ISDIR(st.st_mode) || !popt->po_recursive) {
1137                         free(param_name);
1138                         param_name = NULL;
1139                         continue;
1140                 }
1141
1142                 /* Turn param_name into file path format */
1143                 rc2 = clean_path(popt, param_name);
1144                 if (rc2 < 0) {
1145                         fprintf(stderr, "error: %s: cleaning '%s': %s\n",
1146                                 opname, param_name, strerror(-rc2));
1147                         free(param_name);
1148                         param_name = NULL;
1149                         if (rc == 0)
1150                                 rc = rc2;
1151                         continue;
1152                 }
1153
1154                 /* Use param_name to grab subdirectory tree from full path */
1155                 tmp = strstr(paths.gl_pathv[i], param_name);
1156
1157                 /* cleanup paramname now that we are done with it */
1158                 free(param_name);
1159                 param_name = NULL;
1160
1161                 /* Shouldn't happen but just in case */
1162                 if (tmp == NULL) {
1163                         if (rc == 0)
1164                                 rc = -EINVAL;
1165                         continue;
1166                 }
1167
1168                 rc2 = snprintf(pathname, sizeof(pathname), "%s/*", tmp);
1169                 if (rc2 < 0) {
1170                         /* snprintf() should never an error, and if it does
1171                          * there isn't much point trying to use fprintf() */
1172                         continue;
1173                 }
1174                 if (rc2 >= sizeof(pathname)) {
1175                         fprintf(stderr, "error: %s: overflow processing '%s'\n",
1176                                 opname, pathname);
1177                         if (rc == 0)
1178                                 rc = -EINVAL;
1179                         continue;
1180                 }
1181
1182                 rc2 = param_display(popt, pathname, value, mode);
1183                 if (rc2 != 0 && rc2 != -ENOENT) {
1184                         /* errors will be printed by param_display() */
1185                         if (rc == 0)
1186                                 rc = rc2;
1187                         continue;
1188                 }
1189         }
1190
1191         for (i = 0; i < dir_count; i++)
1192                 free(dir_cache[i]);
1193         free(dir_cache);
1194 out_param:
1195         cfs_free_param_data(&paths);
1196         return rc;
1197 }
1198
1199 static int listparam_cmdline(int argc, char **argv, struct param_opts *popt)
1200 {
1201         int ch;
1202
1203         popt->po_show_path = 1;
1204         popt->po_only_path = 1;
1205
1206         while ((ch = getopt(argc, argv, "FRD")) != -1) {
1207                 switch (ch) {
1208                 case 'F':
1209                         popt->po_show_type = 1;
1210                         break;
1211                 case 'R':
1212                         popt->po_recursive = 1;
1213                         break;
1214                 case 'D':
1215                         popt->po_only_dir = 1;
1216                         break;
1217                 default:
1218                         return -1;
1219                 }
1220         }
1221
1222         return optind;
1223 }
1224
1225 int jt_lcfg_listparam(int argc, char **argv)
1226 {
1227         int rc = 0, index, i;
1228         struct param_opts popt;
1229         char *path;
1230
1231         memset(&popt, 0, sizeof(popt));
1232         index = listparam_cmdline(argc, argv, &popt);
1233         if (index < 0 || index >= argc)
1234                 return CMD_HELP;
1235
1236         for (i = index; i < argc; i++) {
1237                 int rc2;
1238
1239                 path = argv[i];
1240
1241                 rc2 = clean_path(&popt, path);
1242                 if (rc2 < 0) {
1243                         fprintf(stderr, "error: %s: cleaning '%s': %s\n",
1244                                 jt_cmdname(argv[0]), path, strerror(-rc2));
1245                         if (rc == 0)
1246                                 rc = rc2;
1247                         continue;
1248                 }
1249
1250                 rc2 = param_display(&popt, path, NULL, LIST_PARAM);
1251                 if (rc2 < 0) {
1252                         fprintf(stderr, "error: %s: listing '%s': %s\n",
1253                                 jt_cmdname(argv[0]), path, strerror(-rc2));
1254                         if (rc == 0)
1255                                 rc = rc2;
1256                         continue;
1257                 }
1258         }
1259
1260         return rc;
1261 }
1262
1263 static int getparam_cmdline(int argc, char **argv, struct param_opts *popt)
1264 {
1265         int ch;
1266
1267         popt->po_show_path = 1;
1268
1269         while ((ch = getopt(argc, argv, "FnNR")) != -1) {
1270                 switch (ch) {
1271                 case 'F':
1272                         popt->po_show_type = 1;
1273                         break;
1274                 case 'n':
1275                         popt->po_show_path = 0;
1276                         break;
1277                 case 'N':
1278                         popt->po_only_path = 1;
1279                         break;
1280                 case 'R':
1281                         popt->po_recursive = 1;
1282                         break;
1283                 default:
1284                         return -1;
1285                 }
1286         }
1287
1288         return optind;
1289 }
1290
1291 int jt_lcfg_getparam(int argc, char **argv)
1292 {
1293         int rc = 0, index, i;
1294         struct param_opts popt;
1295         char *path;
1296
1297         memset(&popt, 0, sizeof(popt));
1298         index = getparam_cmdline(argc, argv, &popt);
1299         if (index < 0 || index >= argc)
1300                 return CMD_HELP;
1301
1302         for (i = index; i < argc; i++) {
1303                 int rc2;
1304
1305                 path = argv[i];
1306
1307                 rc2 = clean_path(&popt, path);
1308                 if (rc2 < 0) {
1309                         fprintf(stderr, "error: %s: cleaning '%s': %s\n",
1310                                 jt_cmdname(argv[0]), path, strerror(-rc2));
1311                         if (rc == 0)
1312                                 rc = rc2;
1313                         continue;
1314                 }
1315
1316                 rc2 = param_display(&popt, path, NULL,
1317                                    popt.po_only_path ? LIST_PARAM : GET_PARAM);
1318                 if (rc2 < 0) {
1319                         if (rc == 0)
1320                                 rc = rc2;
1321                         continue;
1322                 }
1323         }
1324
1325         return rc;
1326 }
1327
1328 /**
1329  * Output information about nodemaps.
1330  * \param       argc            number of args
1331  * \param       argv[]          variable string arguments
1332  *
1333  * [list|nodemap_name|all]      \a list will list all nodemaps (default).
1334  *                              Specifying a \a nodemap_name will
1335  *                              display info about that specific nodemap.
1336  *                              \a all will display info for all nodemaps.
1337  * \retval                      0 on success
1338  */
1339 int jt_nodemap_info(int argc, char **argv)
1340 {
1341         const char              usage_str[] = "usage: nodemap_info "
1342                                               "[list|nodemap_name|all]\n";
1343         struct param_opts       popt;
1344         int                     rc = 0;
1345
1346         memset(&popt, 0, sizeof(popt));
1347         popt.po_show_path = 1;
1348
1349         if (argc > 2) {
1350                 fprintf(stderr, usage_str);
1351                 return -1;
1352         }
1353
1354         if (argc == 1 || strcmp("list", argv[1]) == 0) {
1355                 popt.po_only_path = 1;
1356                 popt.po_only_dir = 1;
1357                 rc = param_display(&popt, "nodemap/*", NULL, LIST_PARAM);
1358         } else if (strcmp("all", argv[1]) == 0) {
1359                 rc = param_display(&popt, "nodemap/*/*", NULL, LIST_PARAM);
1360         } else {
1361                 char    pattern[PATH_MAX];
1362
1363                 snprintf(pattern, sizeof(pattern), "nodemap/%s/*", argv[1]);
1364                 rc = param_display(&popt, pattern, NULL, LIST_PARAM);
1365                 if (rc == -ESRCH)
1366                         fprintf(stderr, "error: nodemap_info: cannot find "
1367                                         "nodemap %s\n", argv[1]);
1368         }
1369         return rc;
1370 }
1371
1372 static int setparam_cmdline(int argc, char **argv, struct param_opts *popt)
1373 {
1374         int ch;
1375
1376         popt->po_show_path = 1;
1377         popt->po_only_path = 0;
1378         popt->po_show_type = 0;
1379         popt->po_recursive = 0;
1380         popt->po_params2 = 0;
1381         popt->po_delete = 0;
1382
1383         while ((ch = getopt(argc, argv, "nPd")) != -1) {
1384                 switch (ch) {
1385                 case 'n':
1386                         popt->po_show_path = 0;
1387                         break;
1388                 case 'P':
1389                         popt->po_params2 = 1;
1390                         break;
1391                 case 'd':
1392                         popt->po_delete = 1;
1393                         break;
1394                 default:
1395                         return -1;
1396                 }
1397         }
1398         return optind;
1399 }
1400
1401 int jt_lcfg_setparam(int argc, char **argv)
1402 {
1403         int rc = 0, index, i;
1404         struct param_opts popt;
1405         char *path = NULL, *value = NULL;
1406
1407         memset(&popt, 0, sizeof(popt));
1408         index = setparam_cmdline(argc, argv, &popt);
1409         if (index < 0 || index >= argc)
1410                 return CMD_HELP;
1411
1412         if (popt.po_params2)
1413                 /* We can't delete parameters that were
1414                  * set with old conf_param interface */
1415                 return jt_lcfg_mgsparam2(argc, argv, &popt);
1416
1417         for (i = index; i < argc; i++) {
1418                 int rc2;
1419                 path = NULL;
1420
1421                 value = strchr(argv[i], '=');
1422                 if (value != NULL) {
1423                         /* format: set_param a=b */
1424                         *value = '\0';
1425                         value++;
1426                         path = argv[i];
1427                         if (*value == '\0') {
1428                                 fprintf(stderr,
1429                                         "error: %s: setting %s: no value\n",
1430                                         jt_cmdname(argv[0]), path);
1431                                 if (rc == 0)
1432                                         rc = -EINVAL;
1433                                 continue;
1434                         }
1435                 } else {
1436                         /* format: set_param a b */
1437                         path = argv[i];
1438                         i++;
1439                         if (i >= argc) {
1440                                 fprintf(stderr,
1441                                         "error: %s: setting %s: no value\n",
1442                                         jt_cmdname(argv[0]), path);
1443                                 if (rc == 0)
1444                                         rc = -EINVAL;
1445                                 break;
1446                         } else {
1447                                 value = argv[i];
1448                         }
1449                 }
1450
1451                 rc2 = clean_path(&popt, path);
1452                 if (rc2 < 0) {
1453                         fprintf(stderr, "error: %s: cleaning %s: %s\n",
1454                                 jt_cmdname(argv[0]), path, strerror(-rc2));
1455                         if (rc == 0)
1456                                 rc = rc2;
1457                         continue;
1458                 }
1459
1460                 rc2 = param_display(&popt, path, value, SET_PARAM);
1461                 if (rc == 0)
1462                         rc = rc2;
1463         }
1464
1465         return rc;
1466 }