Whamcloud - gitweb
LU-12705 build: fix building fail against Power9 little endian
[fs/lustre-release.git] / lustre / utils / liblustreapi.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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/utils/liblustreapi.c
33  *
34  * Author: Peter J. Braam <braam@clusterfs.com>
35  * Author: Phil Schwan <phil@clusterfs.com>
36  * Author: Robert Read <rread@clusterfs.com>
37  */
38
39 /* for O_DIRECTORY */
40 #ifndef _GNU_SOURCE
41 #define _GNU_SOURCE
42 #endif
43
44 #include <ctype.h>
45 #include <mntent.h>
46 #include <stdlib.h>
47 #include <stdio.h>
48 #include <string.h>
49 #include <stddef.h>
50 #include <sys/ioctl.h>
51 #include <unistd.h>
52 #include <fcntl.h>
53 #include <errno.h>
54 #include <dirent.h>
55 #include <stdarg.h>
56 #include <sys/stat.h>
57 #include <sys/statfs.h>
58 #include <sys/syscall.h>
59 #include <sys/time.h>
60 #include <sys/types.h>
61 #include <sys/xattr.h>
62 #include <time.h>
63 #include <fnmatch.h>
64 #include <libgen.h> /* for dirname() */
65 #ifdef HAVE_LINUX_UNISTD_H
66 #include <linux/unistd.h>
67 #else
68 #include <unistd.h>
69 #endif
70 #include <poll.h>
71 #include <time.h>
72 #include <inttypes.h>
73
74 #include <libcfs/util/ioctl.h>
75 #include <libcfs/util/param.h>
76 #include <libcfs/util/string.h>
77 #include <linux/lnet/lnetctl.h>
78 #include <lustre/lustreapi.h>
79 #include <linux/lustre/lustre_ostid.h>
80 #include <linux/lustre/lustre_ioctl.h>
81 #include "lustreapi_internal.h"
82
83 static int llapi_msg_level = LLAPI_MSG_MAX;
84 const char *liblustreapi_cmd;
85
86 char *mdt_hash_name[] = { "none",
87                           LMV_HASH_NAME_ALL_CHARS,
88                           LMV_HASH_NAME_FNV_1A_64,
89 };
90
91 struct lustre_foreign_type lu_foreign_types[] = {
92         {.lft_type = LU_FOREIGN_TYPE_NONE, .lft_name = "none"},
93         {.lft_type = LU_FOREIGN_TYPE_DAOS, .lft_name = "daos"},
94         /* must be the last element */
95         {.lft_type = LU_FOREIGN_TYPE_UNKNOWN, .lft_name = NULL}
96         /* array max dimension must be <= UINT32_MAX */
97 };
98
99 void llapi_msg_set_level(int level)
100 {
101         /* ensure level is in the good range */
102         if (level < LLAPI_MSG_OFF)
103                 llapi_msg_level = LLAPI_MSG_OFF;
104         else if (level > LLAPI_MSG_MAX)
105                 llapi_msg_level = LLAPI_MSG_MAX;
106         else
107                 llapi_msg_level = level;
108 }
109
110 int llapi_msg_get_level(void)
111 {
112         return llapi_msg_level;
113 }
114
115 void llapi_set_command_name(const char *cmd)
116 {
117         liblustreapi_cmd = cmd;
118 }
119
120 void llapi_clear_command_name(void)
121 {
122         liblustreapi_cmd = NULL;
123 }
124
125 static void error_callback_default(enum llapi_message_level level, int err,
126                                    const char *fmt, va_list ap)
127 {
128         if (liblustreapi_cmd != NULL)
129                 fprintf(stderr, "%s %s: ", program_invocation_short_name,
130                         liblustreapi_cmd);
131         else
132                 fprintf(stderr, "%s: ", program_invocation_short_name);
133         vfprintf(stderr, fmt, ap);
134         if (level & LLAPI_MSG_NO_ERRNO)
135                 fprintf(stderr, "\n");
136         else
137                 fprintf(stderr, ": %s (%d)\n", strerror(err), err);
138 }
139
140 static void info_callback_default(enum llapi_message_level level, int err,
141                                   const char *fmt, va_list ap)
142 {
143         if (err != 0) {
144                 if (liblustreapi_cmd != NULL) {
145                         fprintf(stdout, "%s %s: ",
146                                 program_invocation_short_name,
147                                 liblustreapi_cmd);
148                 } else {
149                         fprintf(stdout, "%s: ", program_invocation_short_name);
150                 }
151         }
152         vfprintf(stdout, fmt, ap);
153 }
154
155 static llapi_log_callback_t llapi_error_callback = error_callback_default;
156 static llapi_log_callback_t llapi_info_callback = info_callback_default;
157
158
159 /* llapi_error will preserve errno */
160 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
161 {
162         va_list  args;
163         int      tmp_errno = errno;
164
165         if ((level & LLAPI_MSG_MASK) > llapi_msg_level)
166                 return;
167
168         va_start(args, fmt);
169         llapi_error_callback(level, abs(err), fmt, args);
170         va_end(args);
171         errno = tmp_errno;
172 }
173
174 /* llapi_printf will preserve errno */
175 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
176 {
177         va_list  args;
178         int      tmp_errno = errno;
179
180         if ((level & LLAPI_MSG_MASK) > llapi_msg_level)
181                 return;
182
183         va_start(args, fmt);
184         llapi_info_callback(level, 0, fmt, args);
185         va_end(args);
186         errno = tmp_errno;
187 }
188
189 /**
190  * Set a custom error logging function. Passing in NULL will reset the logging
191  * callback to its default value.
192  *
193  * This function returns the value of the old callback.
194  */
195 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb)
196 {
197         llapi_log_callback_t    old = llapi_error_callback;
198
199         if (cb != NULL)
200                 llapi_error_callback = cb;
201         else
202                 llapi_error_callback = error_callback_default;
203
204         return old;
205 }
206
207 /**
208  * Set a custom info logging function. Passing in NULL will reset the logging
209  * callback to its default value.
210  *
211  * This function returns the value of the old callback.
212  */
213 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb)
214 {
215         llapi_log_callback_t    old = llapi_info_callback;
216
217         if (cb != NULL)
218                 llapi_info_callback = cb;
219         else
220                 llapi_info_callback = info_callback_default;
221
222         return old;
223 }
224
225 /**
226  * size_units is to be initialized (or zeroed) by caller.
227  */
228 int llapi_parse_size(const char *optarg, unsigned long long *size,
229                      unsigned long long *size_units, int bytes_spec)
230 {
231         char *end;
232         char *argbuf = (char *)optarg;
233         unsigned long long frac = 0, frac_d = 1;
234
235         if (strncmp(optarg, "-", 1) == 0)
236                 return -1;
237
238         if (*size_units == 0)
239                 *size_units = 1;
240
241         *size = strtoull(argbuf, &end, 0);
242         if (end != NULL && *end == '.') {
243                 int i;
244
245                 argbuf = end + 1;
246                 frac = strtoull(argbuf, &end, 10);
247                 /* count decimal places */
248                 for (i = 0; i < (end - argbuf); i++)
249                         frac_d *= 10;
250         }
251
252         if (*end != '\0') {
253                 if ((*end == 'b') && *(end + 1) == '\0' &&
254                     (*size & (~0ULL << (64 - 9))) == 0 &&
255                     !bytes_spec) {
256                         *size_units = 1 << 9;
257                 } else if ((*end == 'b') &&
258                            *(end + 1) == '\0' &&
259                            bytes_spec) {
260                         *size_units = 1;
261                 } else if ((*end == 'k' || *end == 'K') &&
262                            *(end + 1) == '\0' &&
263                            (*size & (~0ULL << (64 - 10))) == 0) {
264                         *size_units = 1 << 10;
265                 } else if ((*end == 'm' || *end == 'M') &&
266                            *(end + 1) == '\0' &&
267                            (*size & (~0ULL << (64 - 20))) == 0) {
268                         *size_units = 1 << 20;
269                 } else if ((*end == 'g' || *end == 'G') &&
270                            *(end + 1) == '\0' &&
271                            (*size & (~0ULL << (64 - 30))) == 0) {
272                         *size_units = 1 << 30;
273                 } else if ((*end == 't' || *end == 'T') &&
274                            *(end + 1) == '\0' &&
275                            (*size & (~0ULL << (64 - 40))) == 0) {
276                         *size_units = 1ULL << 40;
277                 } else if ((*end == 'p' || *end == 'P') &&
278                            *(end + 1) == '\0' &&
279                            (*size & (~0ULL << (64 - 50))) == 0) {
280                         *size_units = 1ULL << 50;
281                 } else if ((*end == 'e' || *end == 'E') &&
282                            *(end + 1) == '\0' &&
283                            (*size & (~0ULL << (64 - 60))) == 0) {
284                         *size_units = 1ULL << 60;
285                 } else {
286                         return -1;
287                 }
288         }
289         *size = *size * *size_units + frac * *size_units / frac_d;
290
291         return 0;
292 }
293
294 int llapi_ioctl_pack(struct obd_ioctl_data *data, char **pbuf, int max_len)
295 {
296         struct obd_ioctl_data *overlay;
297         char *ptr;
298
299         data->ioc_len = obd_ioctl_packlen(data);
300         data->ioc_version = OBD_IOCTL_VERSION;
301
302         if (*pbuf != NULL && data->ioc_len > max_len) {
303                 llapi_error(LLAPI_MSG_ERROR, -EINVAL,
304                             "pbuf = %p, ioc_len = %u, max_len = %d\n",
305                             *pbuf, data->ioc_len, max_len);
306                 return -EINVAL;
307         }
308
309         if (*pbuf == NULL)
310                 *pbuf = malloc(data->ioc_len);
311
312         if (*pbuf == NULL)
313                 return -ENOMEM;
314
315         overlay = (struct obd_ioctl_data *)*pbuf;
316         memcpy(*pbuf, data, sizeof(*data));
317
318         ptr = overlay->ioc_bulk;
319         if (data->ioc_inlbuf1) {
320                 memcpy(ptr, data->ioc_inlbuf1, data->ioc_inllen1);
321                 ptr += __ALIGN_KERNEL(data->ioc_inllen1, 8);
322         }
323
324         if (data->ioc_inlbuf2) {
325                 memcpy(ptr, data->ioc_inlbuf2, data->ioc_inllen2);
326                 ptr += __ALIGN_KERNEL(data->ioc_inllen2, 8);
327         }
328
329         if (data->ioc_inlbuf3) {
330                 memcpy(ptr, data->ioc_inlbuf3, data->ioc_inllen3);
331                 ptr += __ALIGN_KERNEL(data->ioc_inllen3, 8);
332         }
333
334         if (data->ioc_inlbuf4) {
335                 memcpy(ptr, data->ioc_inlbuf4, data->ioc_inllen4);
336                 ptr += __ALIGN_KERNEL(data->ioc_inllen4, 8);
337         }
338
339         return 0;
340 }
341
342 int llapi_ioctl_unpack(struct obd_ioctl_data *data, char *pbuf, int max_len)
343 {
344         struct obd_ioctl_data *overlay;
345         char *ptr;
346
347         if (pbuf == NULL)
348                 return 1;
349
350         overlay = (struct obd_ioctl_data *)pbuf;
351
352         /* Preserve the caller's buffer pointers */
353         overlay->ioc_inlbuf1 = data->ioc_inlbuf1;
354         overlay->ioc_inlbuf2 = data->ioc_inlbuf2;
355         overlay->ioc_inlbuf3 = data->ioc_inlbuf3;
356         overlay->ioc_inlbuf4 = data->ioc_inlbuf4;
357
358         memcpy(data, pbuf, sizeof(*data));
359
360         ptr = overlay->ioc_bulk;
361         if (data->ioc_inlbuf1) {
362                 memcpy(data->ioc_inlbuf1, ptr, data->ioc_inllen1);
363                 ptr += __ALIGN_KERNEL(data->ioc_inllen1, 8);
364         }
365
366         if (data->ioc_inlbuf2) {
367                 memcpy(data->ioc_inlbuf2, ptr, data->ioc_inllen2);
368                 ptr += __ALIGN_KERNEL(data->ioc_inllen2, 8);
369         }
370
371         if (data->ioc_inlbuf3) {
372                 memcpy(data->ioc_inlbuf3, ptr, data->ioc_inllen3);
373                 ptr += __ALIGN_KERNEL(data->ioc_inllen3, 8);
374         }
375
376         if (data->ioc_inlbuf4) {
377                 memcpy(data->ioc_inlbuf4, ptr, data->ioc_inllen4);
378                 ptr += __ALIGN_KERNEL(data->ioc_inllen4, 8);
379         }
380
381         return 0;
382 }
383
384 /* XXX: llapi_xxx() functions return negative values upon failure */
385
386 int llapi_stripe_limit_check(unsigned long long stripe_size, int stripe_offset,
387                                 int stripe_count, int stripe_pattern)
388 {
389         static int page_size;
390         int rc = 0;
391
392         if (page_size == 0) {
393                 /* 64 KB is the largest common page size (on ia64/PPC/ARM),
394                  * but check the local page size just in case. The page_size
395                  * will not change for the lifetime of this process at least.
396                  */
397                 page_size = LOV_MIN_STRIPE_SIZE;
398                 if (getpagesize() > page_size) {
399                         page_size = getpagesize();
400                         llapi_err_noerrno(LLAPI_MSG_WARN,
401                                           "warning: page size (%u) larger than expected (%u)",
402                                           page_size, LOV_MIN_STRIPE_SIZE);
403                 }
404         }
405         if (!llapi_stripe_size_is_aligned(stripe_size)) {
406                 rc = -EINVAL;
407                 llapi_error(LLAPI_MSG_ERROR, rc, "error: bad stripe_size %llu, "
408                                 "must be an even multiple of %d bytes",
409                                 (unsigned long long)stripe_size, page_size);
410                 goto out;
411         }
412         if (!llapi_stripe_index_is_valid(stripe_offset)) {
413                 rc = -EINVAL;
414                 llapi_error(LLAPI_MSG_ERROR, rc, "error: bad stripe offset %d",
415                                 stripe_offset);
416                 goto out;
417         }
418         if (!llapi_stripe_count_is_valid(stripe_count)) {
419                 rc = -EINVAL;
420                 llapi_error(LLAPI_MSG_ERROR, rc, "error: bad stripe count %d",
421                                 stripe_count);
422                 goto out;
423         }
424         if (llapi_stripe_size_is_too_big(stripe_size)) {
425                 rc = -EINVAL;
426                 llapi_error(LLAPI_MSG_ERROR, rc,
427                             "error: stripe size '%llu' over 4GB limit",
428                             (unsigned long long)stripe_size);
429                 goto out;
430         }
431
432 out:
433         errno = -rc;
434         return rc;
435 }
436
437 int llapi_dir_stripe_limit_check(int stripe_offset, int stripe_count,
438                                  int hash_type)
439 {
440         int rc;
441
442         if (!llapi_dir_stripe_index_is_valid(stripe_offset)) {
443                 rc = -EINVAL;
444                 llapi_error(LLAPI_MSG_ERROR, rc, "error: bad stripe offset %d",
445                                 stripe_offset);
446                 return rc;
447         }
448         if (!llapi_dir_stripe_count_is_valid(stripe_count)) {
449                 rc = -EINVAL;
450                 llapi_error(LLAPI_MSG_ERROR, rc, "error: bad stripe count %d",
451                                 stripe_count);
452                 return rc;
453         }
454
455         if (!llapi_dir_hash_type_is_valid(hash_type)) {
456                 rc = -EINVAL;
457                 llapi_error(LLAPI_MSG_ERROR, rc, "error: bad hash type %d",
458                                 hash_type);
459                 return rc;
460         }
461         return 0;
462 }
463
464 /*
465  * Trim a trailing newline from a string, if it exists.
466  */
467 int llapi_chomp_string(char *buf)
468 {
469         if (!buf || !*buf)
470                 return 0;
471
472         while (buf[1])
473                 buf++;
474
475         if (*buf != '\n')
476                 return 0;
477
478         *buf = '\0';
479         return '\n';
480 }
481
482 /*
483  * Wrapper to grab parameter settings for lov.*-clilov-*.* values
484  */
485 static int get_param_lov(const char *path, const char *param,
486                          char *buf, size_t buf_size)
487 {
488         struct obd_uuid uuid;
489         int rc;
490
491         rc = llapi_file_get_lov_uuid(path, &uuid);
492         if (rc != 0)
493                 return rc;
494
495         return get_lustre_param_value("lov", uuid.uuid, FILTER_BY_EXACT, param,
496                                       buf, buf_size);
497 }
498
499 /*
500  * Wrapper to grab parameter settings for lmv.*-clilov-*.* values
501  */
502 static int get_param_lmv(const char *path, const char *param,
503                          char *buf, size_t buf_size)
504 {
505         struct obd_uuid uuid;
506         int rc;
507
508         rc = llapi_file_get_lmv_uuid(path, &uuid);
509         if (rc != 0)
510                 return rc;
511
512         return get_lustre_param_value("lmv", uuid.uuid, FILTER_BY_EXACT, param,
513                                buf, buf_size);
514 }
515
516 static int get_mds_md_size(const char *path)
517 {
518         char buf[PATH_MAX], inst[PATH_MAX];
519         int md_size = lov_user_md_size(LOV_MAX_STRIPE_COUNT, LOV_USER_MAGIC_V3);
520         int rc;
521
522         rc = llapi_getname(path, inst, sizeof(inst));
523         if (rc != 0)
524                 return rc;
525
526         /* Get the max ea size from llite parameters. */
527         rc = get_lustre_param_value("llite", inst, FILTER_BY_EXACT,
528                                     "max_easize", buf, sizeof(buf));
529         if (rc != 0)
530                 return rc;
531
532         rc = atoi(buf);
533
534         return rc > 0 ? rc : md_size;
535 }
536
537 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize)
538 {
539         return get_param_lmv(path, "uuid", buf, bufsize);
540 }
541
542 /**
543  * Open a Lustre file.
544  *
545  * \param name     the name of the file to be opened
546  * \param flags    access mode, see flags in open(2)
547  * \param mode     permission of the file if it is created, see mode in open(2)
548  * \param param    stripe pattern of the newly created file
549  *
550  * \retval         file descriptor of opened file
551  * \retval         negative errno on failure
552  */
553 int llapi_file_open_param(const char *name, int flags, mode_t mode,
554                           const struct llapi_stripe_param *param)
555 {
556         char fsname[MAX_OBD_NAME + 1] = { 0 };
557         char *pool_name = param->lsp_pool;
558         struct lov_user_md *lum = NULL;
559         size_t lum_size = sizeof(*lum);
560         int fd, rc;
561
562         /* Make sure we are on a Lustre file system */
563         rc = llapi_search_fsname(name, fsname);
564         if (rc) {
565                 llapi_error(LLAPI_MSG_ERROR, rc,
566                             "'%s' is not on a Lustre filesystem",
567                             name);
568                 return rc;
569         }
570
571         /* Check if the stripe pattern is sane. */
572         rc = llapi_stripe_limit_check(param->lsp_stripe_size,
573                                       param->lsp_stripe_offset,
574                                       param->lsp_stripe_count,
575                                       param->lsp_stripe_pattern);
576         if (rc != 0)
577                 return rc;
578
579         /* Make sure we have a good pool */
580         if (pool_name != NULL) {
581                 /* in case user gives the full pool name <fsname>.<poolname>,
582                  * strip the fsname */
583                 char *ptr = strchr(pool_name, '.');
584                 if (ptr != NULL) {
585                         *ptr = '\0';
586                         if (strcmp(pool_name, fsname) != 0) {
587                                 *ptr = '.';
588                                 llapi_err_noerrno(LLAPI_MSG_ERROR,
589                                         "Pool '%s' is not on filesystem '%s'",
590                                         pool_name, fsname);
591                                 return -EINVAL;
592                         }
593                         pool_name = ptr + 1;
594                 }
595
596                 /* Make sure the pool exists and is non-empty */
597                 rc = llapi_search_ost(fsname, pool_name, NULL);
598                 if (rc < 1) {
599                         char *err = rc == 0 ? "has no OSTs" : "does not exist";
600
601                         llapi_err_noerrno(LLAPI_MSG_ERROR, "pool '%s.%s' %s",
602                                           fsname, pool_name, err);
603                         return -EINVAL;
604                 }
605
606                 lum_size = sizeof(struct lov_user_md_v3);
607         }
608
609         /* sanity check of target list */
610         if (param->lsp_is_specific) {
611                 char ostname[MAX_OBD_NAME + 64];
612                 bool found = false;
613                 int i;
614
615                 for (i = 0; i < param->lsp_stripe_count; i++) {
616                         snprintf(ostname, sizeof(ostname), "%s-OST%04x_UUID",
617                                  fsname, param->lsp_osts[i]);
618                         rc = llapi_search_ost(fsname, pool_name, ostname);
619                         if (rc <= 0) {
620                                 if (rc == 0)
621                                         rc = -ENODEV;
622
623                                 llapi_error(LLAPI_MSG_ERROR, rc,
624                                             "%s: cannot find OST %s in %s",
625                                             __func__, ostname,
626                                             pool_name != NULL ?
627                                             "pool" : "system");
628                                 return rc;
629                         }
630
631                         /* Make sure stripe offset is in OST list. */
632                         if (param->lsp_osts[i] == param->lsp_stripe_offset)
633                                 found = true;
634                 }
635                 if (!found) {
636                         llapi_error(LLAPI_MSG_ERROR, -EINVAL,
637                                     "%s: stripe offset '%d' is not in the "
638                                     "target list",
639                                     __func__, param->lsp_stripe_offset);
640                         return -EINVAL;
641                 }
642
643                 lum_size = lov_user_md_size(param->lsp_stripe_count,
644                                             LOV_USER_MAGIC_SPECIFIC);
645         }
646
647         lum = calloc(1, lum_size);
648         if (lum == NULL)
649                 return -ENOMEM;
650
651 retry_open:
652         fd = open(name, flags | O_LOV_DELAY_CREATE, mode);
653         if (fd < 0) {
654                 if (errno == EISDIR && !(flags & O_DIRECTORY)) {
655                         flags = O_DIRECTORY | O_RDONLY;
656                         goto retry_open;
657                 }
658         }
659
660         if (fd < 0) {
661                 rc = -errno;
662                 llapi_error(LLAPI_MSG_ERROR, rc, "unable to open '%s'", name);
663                 free(lum);
664                 return rc;
665         }
666
667         /*  Initialize IOCTL striping pattern structure */
668         lum->lmm_magic = LOV_USER_MAGIC_V1;
669         lum->lmm_pattern = param->lsp_stripe_pattern;
670         lum->lmm_stripe_size = param->lsp_stripe_size;
671         lum->lmm_stripe_count = param->lsp_stripe_count;
672         lum->lmm_stripe_offset = param->lsp_stripe_offset;
673         if (pool_name != NULL) {
674                 struct lov_user_md_v3 *lumv3 = (void *)lum;
675
676                 lumv3->lmm_magic = LOV_USER_MAGIC_V3;
677                 strncpy(lumv3->lmm_pool_name, pool_name, LOV_MAXPOOLNAME);
678         }
679         if (param->lsp_is_specific) {
680                 struct lov_user_md_v3 *lumv3 = (void *)lum;
681                 int i;
682
683                 lumv3->lmm_magic = LOV_USER_MAGIC_SPECIFIC;
684                 if (pool_name == NULL) {
685                         /* LOV_USER_MAGIC_SPECIFIC uses v3 format plus specified
686                          * OST list, therefore if pool is not specified we have
687                          * to pack a null pool name for placeholder. */
688                         memset(lumv3->lmm_pool_name, 0, LOV_MAXPOOLNAME);
689                 }
690
691                 for (i = 0; i < param->lsp_stripe_count; i++)
692                         lumv3->lmm_objects[i].l_ost_idx = param->lsp_osts[i];
693         }
694
695         if (ioctl(fd, LL_IOC_LOV_SETSTRIPE, lum) != 0) {
696                 char *errmsg = "stripe already set";
697
698                 rc = -errno;
699                 if (errno != EEXIST && errno != EALREADY)
700                         errmsg = strerror(errno);
701
702                 llapi_err_noerrno(LLAPI_MSG_ERROR,
703                                   "setstripe error for '%s': %s", name, errmsg);
704
705                 close(fd);
706                 fd = rc;
707         }
708
709         free(lum);
710
711         return fd;
712 }
713
714 int llapi_file_open_pool(const char *name, int flags, int mode,
715                          unsigned long long stripe_size, int stripe_offset,
716                          int stripe_count, int stripe_pattern, char *pool_name)
717 {
718         const struct llapi_stripe_param param = {
719                 .lsp_stripe_size = stripe_size,
720                 .lsp_stripe_count = stripe_count,
721                 .lsp_stripe_pattern = stripe_pattern,
722                 .lsp_stripe_offset = stripe_offset,
723                 .lsp_pool = pool_name
724         };
725         return llapi_file_open_param(name, flags, mode, &param);
726 }
727
728 int llapi_file_open(const char *name, int flags, int mode,
729                     unsigned long long stripe_size, int stripe_offset,
730                     int stripe_count, int stripe_pattern)
731 {
732         return llapi_file_open_pool(name, flags, mode, stripe_size,
733                                     stripe_offset, stripe_count,
734                                     stripe_pattern, NULL);
735 }
736
737 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
738                               __u32 flags, char *foreign_lov)
739 {
740         size_t len;
741         struct lov_foreign_md *lfm;
742         int fd, rc;
743
744         if (foreign_lov == NULL) {
745                 rc = -EINVAL;
746                 llapi_error(LLAPI_MSG_ERROR, rc,
747                             "foreign LOV EA content must be provided");
748                 goto out_err;
749         }
750
751         len = strlen(foreign_lov);
752         if (len > XATTR_SIZE_MAX - offsetof(struct lov_foreign_md, lfm_value) ||
753             len <= 0) {
754                 rc = -EINVAL;
755                 llapi_error(LLAPI_MSG_ERROR, rc,
756                             "foreign LOV EA size %zu (must be 0 < len < %zu)",
757                             len, XATTR_SIZE_MAX -
758                             offsetof(struct lov_foreign_md, lfm_value));
759                 goto out_err;
760         }
761
762         lfm = malloc(len + offsetof(struct lov_foreign_md, lfm_value));
763         if (lfm == NULL) {
764                 rc = -ENOMEM;
765                 llapi_error(LLAPI_MSG_ERROR, rc,
766                             "failed to allocate lov_foreign_md");
767                 goto out_err;
768         }
769
770         fd = open(name, O_WRONLY|O_CREAT|O_LOV_DELAY_CREATE, mode);
771         if (fd == -1) {
772                 fd = -errno;
773                 llapi_error(LLAPI_MSG_ERROR, fd, "open '%s' failed", name);
774                 goto out_free;
775         }
776
777         lfm->lfm_magic = LOV_USER_MAGIC_FOREIGN;
778         lfm->lfm_length = len;
779         lfm->lfm_type = type;
780         lfm->lfm_flags = flags;
781         memcpy(lfm->lfm_value, foreign_lov, len);
782
783         if (ioctl(fd, LL_IOC_LOV_SETSTRIPE, lfm) != 0) {
784                 char *errmsg = "stripe already set";
785
786                 rc = -errno;
787                 if (errno == ENOTTY)
788                         errmsg = "not on a Lustre filesystem";
789                 else if (errno == EEXIST || errno == EALREADY)
790                         errmsg = "stripe already set";
791                 else
792                         errmsg = strerror(errno);
793
794                 llapi_err_noerrno(LLAPI_MSG_ERROR,
795                                   "setstripe error for '%s': %s", name, errmsg);
796
797                 close(fd);
798                 fd = rc;
799         }
800
801 out_free:
802         free(lfm);
803
804         return fd;
805
806 out_err:
807         errno = -rc;
808         return rc;
809 }
810
811 int llapi_file_create(const char *name, unsigned long long stripe_size,
812                       int stripe_offset, int stripe_count, int stripe_pattern)
813 {
814         int fd;
815
816         fd = llapi_file_open_pool(name, O_CREAT | O_WRONLY, 0644, stripe_size,
817                                   stripe_offset, stripe_count, stripe_pattern,
818                                   NULL);
819         if (fd < 0)
820                 return fd;
821
822         close(fd);
823         return 0;
824 }
825
826 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
827                            int stripe_offset, int stripe_count,
828                            int stripe_pattern, char *pool_name)
829 {
830         int fd;
831
832         fd = llapi_file_open_pool(name, O_CREAT | O_WRONLY, 0644, stripe_size,
833                                   stripe_offset, stripe_count, stripe_pattern,
834                                   pool_name);
835         if (fd < 0)
836                 return fd;
837
838         close(fd);
839         return 0;
840 }
841
842 static int verify_dir_param(const char *name,
843                             const struct llapi_stripe_param *param)
844 {
845         char fsname[MAX_OBD_NAME + 1] = { 0 };
846         char *pool_name = param->lsp_pool;
847         int rc;
848
849         /* Make sure we are on a Lustre file system */
850         rc = llapi_search_fsname(name, fsname);
851         if (rc) {
852                 llapi_error(LLAPI_MSG_ERROR, rc,
853                             "'%s' is not on a Lustre filesystem",
854                             name);
855                 return rc;
856         }
857
858         /* Check if the stripe pattern is sane. */
859         rc = llapi_dir_stripe_limit_check(param->lsp_stripe_offset,
860                                           param->lsp_stripe_count,
861                                           param->lsp_stripe_pattern);
862         if (rc != 0)
863                 return rc;
864
865         /* Make sure we have a good pool */
866         if (pool_name != NULL) {
867                 /* in case user gives the full pool name <fsname>.<poolname>,
868                  * strip the fsname */
869                 char *ptr = strchr(pool_name, '.');
870
871                 if (ptr != NULL) {
872                         *ptr = '\0';
873                         if (strcmp(pool_name, fsname) != 0) {
874                                 *ptr = '.';
875                                 llapi_err_noerrno(LLAPI_MSG_ERROR,
876                                         "Pool '%s' is not on filesystem '%s'",
877                                         pool_name, fsname);
878                                 return -EINVAL;
879                         }
880                         pool_name = ptr + 1;
881                 }
882
883                 /* Make sure the pool exists and is non-empty */
884                 rc = llapi_search_tgt(fsname, pool_name, NULL, true);
885                 if (rc < 1) {
886                         char *err = rc == 0 ? "has no OSTs" : "does not exist";
887
888                         llapi_err_noerrno(LLAPI_MSG_ERROR, "pool '%s.%s' %s",
889                                           fsname, pool_name, err);
890                         return -EINVAL;
891                 }
892         }
893
894         /* sanity check of target list */
895         if (param->lsp_is_specific) {
896                 char mdtname[MAX_OBD_NAME + 64];
897                 bool found = false;
898                 int i;
899
900                 for (i = 0; i < param->lsp_stripe_count; i++) {
901                         snprintf(mdtname, sizeof(mdtname), "%s-MDT%04x_UUID",
902                                  fsname, param->lsp_tgts[i]);
903                         rc = llapi_search_tgt(fsname, pool_name, mdtname, true);
904                         if (rc <= 0) {
905                                 if (rc == 0)
906                                         rc = -ENODEV;
907
908                                 llapi_error(LLAPI_MSG_ERROR, rc,
909                                             "%s: cannot find MDT %s in %s",
910                                             __func__, mdtname,
911                                             pool_name != NULL ?
912                                             "pool" : "system");
913                                 return rc;
914                         }
915
916                         /* Make sure stripe offset is in MDT list. */
917                         if (param->lsp_tgts[i] == param->lsp_stripe_offset)
918                                 found = true;
919                 }
920                 if (!found) {
921                         llapi_error(LLAPI_MSG_ERROR, -EINVAL,
922                                     "%s: stripe offset '%d' is not in the "
923                                     "target list",
924                                     __func__, param->lsp_stripe_offset);
925                         return -EINVAL;
926                 }
927         }
928
929         return 0;
930 }
931
932 static inline void param2lmu(struct lmv_user_md *lmu,
933                              const struct llapi_stripe_param *param)
934 {
935         lmu->lum_magic = param->lsp_is_specific ? LMV_USER_MAGIC_SPECIFIC :
936                                                   LMV_USER_MAGIC;
937         lmu->lum_stripe_count = param->lsp_stripe_count;
938         lmu->lum_stripe_offset = param->lsp_stripe_offset;
939         lmu->lum_hash_type = param->lsp_stripe_pattern;
940         if (param->lsp_pool != NULL)
941                 strncpy(lmu->lum_pool_name, param->lsp_pool, LOV_MAXPOOLNAME);
942         if (param->lsp_is_specific) {
943                 int i;
944
945                 for (i = 0; i < param->lsp_stripe_count; i++)
946                         lmu->lum_objects[i].lum_mds = param->lsp_tgts[i];
947         }
948 }
949
950 int llapi_dir_set_default_lmv(const char *name,
951                               const struct llapi_stripe_param *param)
952 {
953         struct lmv_user_md lmu = { 0 };
954         int fd;
955         int rc = 0;
956
957         rc = verify_dir_param(name, param);
958         if (rc)
959                 return rc;
960
961         /* TODO: default lmv doesn't support specific targets yet */
962         if (param->lsp_is_specific)
963                 return -EINVAL;
964
965         param2lmu(&lmu, param);
966
967         fd = open(name, O_DIRECTORY | O_RDONLY);
968         if (fd < 0) {
969                 rc = -errno;
970                 llapi_error(LLAPI_MSG_ERROR, rc, "unable to open '%s'", name);
971                 return rc;
972         }
973
974         rc = ioctl(fd, LL_IOC_LMV_SET_DEFAULT_STRIPE, &lmu);
975         if (rc < 0) {
976                 char *errmsg = "stripe already set";
977                 rc = -errno;
978                 if (errno != EEXIST && errno != EALREADY)
979                         errmsg = strerror(errno);
980
981                 llapi_err_noerrno(LLAPI_MSG_ERROR,
982                                   "default dirstripe error on '%s': %s",
983                                   name, errmsg);
984         }
985         close(fd);
986         return rc;
987 }
988
989 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
990                                      int stripe_count, int stripe_pattern,
991                                      const char *pool_name)
992 {
993         const struct llapi_stripe_param param = {
994                 .lsp_stripe_count = stripe_count,
995                 .lsp_stripe_offset = stripe_offset,
996                 .lsp_stripe_pattern = stripe_pattern,
997                 .lsp_pool = (char *)pool_name
998         };
999
1000         return llapi_dir_set_default_lmv(name, &param);
1001 }
1002
1003 /**
1004  * Create a Lustre directory.
1005  *
1006  * \param name     the name of the directory to be created
1007  * \param mode     permission of the file if it is created, see mode in open(2)
1008  * \param param    stripe pattern of the newly created directory
1009  *
1010  * \retval         0 on success
1011  * \retval         negative errno on failure
1012  */
1013 int llapi_dir_create(const char *name, mode_t mode,
1014                      const struct llapi_stripe_param *param)
1015 {
1016         struct lmv_user_md *lmu = NULL;
1017         size_t lmu_size;
1018         struct obd_ioctl_data data = { 0 };
1019         char rawbuf[8192];
1020         char *buf = rawbuf;
1021         char *dirpath = NULL;
1022         char *namepath = NULL;
1023         char *dir;
1024         char *filename;
1025         int fd, rc;
1026
1027         rc = verify_dir_param(name, param);
1028         if (rc)
1029                 return rc;
1030
1031         lmu_size = lmv_user_md_size(param->lsp_stripe_count,
1032                                     param->lsp_is_specific ?
1033                                          LMV_USER_MAGIC_SPECIFIC :
1034                                          LMV_USER_MAGIC);
1035
1036         lmu = calloc(1, lmu_size);
1037         if (lmu == NULL)
1038                 return -ENOMEM;
1039
1040         dirpath = strdup(name);
1041         if (!dirpath) {
1042                 free(lmu);
1043                 return -ENOMEM;
1044         }
1045
1046         namepath = strdup(name);
1047         if (!namepath) {
1048                 free(dirpath);
1049                 free(lmu);
1050                 return -ENOMEM;
1051         }
1052
1053         param2lmu(lmu, param);
1054
1055         filename = basename(namepath);
1056         dir = dirname(dirpath);
1057
1058         data.ioc_inlbuf1 = (char *)filename;
1059         data.ioc_inllen1 = strlen(filename) + 1;
1060         data.ioc_inlbuf2 = (char *)lmu;
1061         data.ioc_inllen2 = lmu_size;
1062         data.ioc_type = mode;
1063         rc = llapi_ioctl_pack(&data, &buf, sizeof(rawbuf));
1064         if (rc) {
1065                 llapi_error(LLAPI_MSG_ERROR, rc,
1066                             "error: LL_IOC_LMV_SETSTRIPE pack failed '%s'.",
1067                             name);
1068                 goto out;
1069         }
1070
1071         fd = open(dir, O_DIRECTORY | O_RDONLY);
1072         if (fd < 0) {
1073                 rc = -errno;
1074                 llapi_error(LLAPI_MSG_ERROR, rc, "unable to open '%s'", name);
1075                 goto out;
1076         }
1077
1078         if (ioctl(fd, LL_IOC_LMV_SETSTRIPE, buf)) {
1079                 char *errmsg = "stripe already set";
1080
1081                 rc = -errno;
1082                 if (errno != EEXIST && errno != EALREADY)
1083                         errmsg = strerror(errno);
1084
1085                 llapi_err_noerrno(LLAPI_MSG_ERROR,
1086                                   "dirstripe error on '%s': %s", name, errmsg);
1087         }
1088         close(fd);
1089 out:
1090         free(namepath);
1091         free(dirpath);
1092         free(lmu);
1093         return rc;
1094 }
1095
1096 /**
1097  * Create a foreign directory.
1098  *
1099  * \param name     the name of the directory to be created
1100  * \param mode     permission of the file if it is created, see mode in open(2)
1101  * \param type     foreign type to be set in LMV EA
1102  * \param flags    foreign flags to be set in LMV EA
1103  * \param value    foreign pattern to be set in LMV EA
1104  *
1105  * \retval         0 on success
1106  * \retval         negative errno on failure
1107  */
1108 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
1109                              __u32 flags, const char *value)
1110 {
1111         struct lmv_foreign_md *lfm = NULL;
1112         size_t lfm_size, len;
1113         struct obd_ioctl_data data = { 0 };
1114         char rawbuf[8192];
1115         char *buf = rawbuf;
1116         char *dirpath = NULL;
1117         char *namepath = NULL;
1118         char *dir;
1119         char *filename;
1120         int fd, rc;
1121
1122         len = strlen(value);
1123         if (len > XATTR_SIZE_MAX - offsetof(struct lmv_foreign_md, lfm_value) ||
1124             len <= 0) {
1125                 rc = -EINVAL;
1126                 llapi_error(LLAPI_MSG_ERROR, rc, "invalid LOV EA length %zu "
1127                         "(must be 0 < len < %zu)\n", len,
1128                         XATTR_SIZE_MAX -
1129                         offsetof(struct lmv_foreign_md, lfm_value));
1130                 return rc;
1131         }
1132         lfm_size = len + offsetof(struct lmv_foreign_md, lfm_value);
1133         lfm = calloc(1, lfm_size);
1134         if (lfm == NULL)
1135                 return -ENOMEM;
1136
1137         dirpath = strdup(name);
1138         if (!dirpath) {
1139                 free(lfm);
1140                 return -ENOMEM;
1141         }
1142
1143         namepath = strdup(name);
1144         if (!namepath) {
1145                 free(dirpath);
1146                 free(lfm);
1147                 return -ENOMEM;
1148         }
1149
1150         lfm->lfm_magic = LMV_MAGIC_FOREIGN;
1151         lfm->lfm_length = len;
1152         lfm->lfm_type = type;
1153         lfm->lfm_flags = flags;
1154         memcpy(lfm->lfm_value, value, len);
1155
1156         filename = basename(namepath);
1157         dir = dirname(dirpath);
1158
1159         data.ioc_inlbuf1 = (char *)filename;
1160         data.ioc_inllen1 = strlen(filename) + 1;
1161         data.ioc_inlbuf2 = (char *)lfm;
1162         data.ioc_inllen2 = lfm_size;
1163         data.ioc_type = mode;
1164         rc = llapi_ioctl_pack(&data, &buf, sizeof(rawbuf));
1165         if (rc) {
1166                 llapi_error(LLAPI_MSG_ERROR, rc,
1167                             "error: LL_IOC_LMV_SETSTRIPE pack failed '%s'.",
1168                             name);
1169                 goto out;
1170         }
1171
1172         fd = open(dir, O_DIRECTORY | O_RDONLY);
1173         if (fd < 0) {
1174                 rc = -errno;
1175                 llapi_error(LLAPI_MSG_ERROR, rc, "unable to open '%s'", name);
1176                 goto out;
1177         }
1178
1179         if (ioctl(fd, LL_IOC_LMV_SETSTRIPE, buf)) {
1180                 char *errmsg = "stripe already set";
1181
1182                 rc = -errno;
1183                 if (errno != EEXIST && errno != EALREADY)
1184                         errmsg = strerror(errno);
1185
1186                 llapi_err_noerrno(LLAPI_MSG_ERROR,
1187                                   "dirstripe error on '%s': %s", name, errmsg);
1188         }
1189         close(fd);
1190 out:
1191         free(namepath);
1192         free(dirpath);
1193         free(lfm);
1194         return rc;
1195 }
1196
1197 int llapi_dir_create_pool(const char *name, int mode, int stripe_offset,
1198                           int stripe_count, int stripe_pattern,
1199                           const char *pool_name)
1200 {
1201         const struct llapi_stripe_param param = {
1202                 .lsp_stripe_count = stripe_count,
1203                 .lsp_stripe_offset = stripe_offset,
1204                 .lsp_stripe_pattern = stripe_pattern,
1205                 .lsp_pool = (char *)pool_name
1206         };
1207
1208         return llapi_dir_create(name, mode, &param);
1209 }
1210
1211 int llapi_direntry_remove(char *dname)
1212 {
1213         char *dirpath = NULL;
1214         char *namepath = NULL;
1215         char *dir;
1216         char *filename;
1217         int fd = -1;
1218         int rc = 0;
1219
1220         dirpath = strdup(dname);
1221         namepath = strdup(dname);
1222         if (!dirpath || !namepath)
1223                 return -ENOMEM;
1224
1225         filename = basename(namepath);
1226
1227         dir = dirname(dirpath);
1228
1229         fd = open(dir, O_DIRECTORY | O_RDONLY);
1230         if (fd < 0) {
1231                 rc = -errno;
1232                 llapi_error(LLAPI_MSG_ERROR, rc, "unable to open '%s'",
1233                             filename);
1234                 goto out;
1235         }
1236
1237         if (ioctl(fd, LL_IOC_REMOVE_ENTRY, filename)) {
1238                 char *errmsg = strerror(errno);
1239                 llapi_err_noerrno(LLAPI_MSG_ERROR,
1240                                   "error on ioctl %#jx for '%s' (%d): %s",
1241                                   (uintmax_t)LL_IOC_LMV_SETSTRIPE, filename,
1242                                   fd, errmsg);
1243         }
1244 out:
1245         free(dirpath);
1246         free(namepath);
1247         if (fd != -1)
1248                 close(fd);
1249         return rc;
1250 }
1251
1252 /*
1253  * Find the fsname, the full path, and/or an open fd.
1254  * Either the fsname or path must not be NULL
1255  */
1256 int get_root_path(int want, char *fsname, int *outfd, char *path, int index)
1257 {
1258         struct mntent mnt;
1259         char buf[PATH_MAX], mntdir[PATH_MAX];
1260         char *ptr, *ptr_end;
1261         FILE *fp;
1262         int idx = 0, len = 0, mntlen, fd;
1263         int rc = -ENODEV;
1264
1265         /* get the mount point */
1266         fp = setmntent(PROC_MOUNTS, "r");
1267         if (fp == NULL) {
1268                 rc = -EIO;
1269                 llapi_error(LLAPI_MSG_ERROR, rc,
1270                             "cannot retrieve filesystem mount point");
1271                 return rc;
1272         }
1273         while (1) {
1274                 if (getmntent_r(fp, &mnt, buf, sizeof(buf)) == NULL)
1275                         break;
1276
1277                 if (!llapi_is_lustre_mnt(&mnt))
1278                         continue;
1279
1280                 if ((want & WANT_INDEX) && (idx++ != index))
1281                         continue;
1282
1283                 mntlen = strlen(mnt.mnt_dir);
1284                 ptr = strchr(mnt.mnt_fsname, '/');
1285                 while (ptr && *ptr == '/')
1286                         ptr++;
1287                 /* thanks to the call to llapi_is_lustre_mnt() above,
1288                  * we are sure that mnt.mnt_fsname contains ":/",
1289                  * so ptr should never be NULL */
1290                 if (ptr == NULL)
1291                         continue;
1292                 ptr_end = ptr;
1293                 while (*ptr_end != '/' && *ptr_end != '\0')
1294                         ptr_end++;
1295
1296                 /* Check the fsname for a match, if given */
1297                 if (!(want & WANT_FSNAME) && fsname != NULL &&
1298                     (strlen(fsname) > 0) &&
1299                     (strncmp(ptr, fsname, ptr_end - ptr) != 0))
1300                         continue;
1301
1302                 /* If the path isn't set return the first one we find */
1303                 if (path == NULL || strlen(path) == 0) {
1304                         strncpy(mntdir, mnt.mnt_dir, sizeof(mntdir) - 1);
1305                         mntdir[sizeof(mntdir) - 1] = '\0';
1306                         if ((want & WANT_FSNAME) && fsname != NULL) {
1307                                 strncpy(fsname, ptr, ptr_end - ptr);
1308                                 fsname[ptr_end - ptr] = '\0';
1309                         }
1310                         rc = 0;
1311                         break;
1312                 /* Otherwise find the longest matching path */
1313                 } else if ((strlen(path) >= mntlen) && (mntlen >= len) &&
1314                            (strncmp(mnt.mnt_dir, path, mntlen) == 0)) {
1315                         strncpy(mntdir, mnt.mnt_dir, sizeof(mntdir) - 1);
1316                         mntdir[sizeof(mntdir) - 1] = '\0';
1317                         len = mntlen;
1318                         if ((want & WANT_FSNAME) && fsname != NULL) {
1319                                 strncpy(fsname, ptr, ptr_end - ptr);
1320                                 fsname[ptr_end - ptr] = '\0';
1321                         }
1322                         rc = 0;
1323                 }
1324         }
1325         endmntent(fp);
1326
1327         /* Found it */
1328         if (rc == 0) {
1329                 if ((want & WANT_PATH) && path != NULL) {
1330                         strncpy(path, mntdir, PATH_MAX);
1331                         path[strlen(mntdir)] = '\0';
1332                 }
1333                 if (want & WANT_FD) {
1334                         fd = open(mntdir, O_RDONLY | O_DIRECTORY | O_NONBLOCK);
1335                         if (fd < 0) {
1336                                 rc = -errno;
1337                                 llapi_error(LLAPI_MSG_ERROR, rc,
1338                                             "cannot open '%s': %s", mntdir,
1339                                             strerror(-rc));
1340
1341                         } else {
1342                                 *outfd = fd;
1343                         }
1344                 }
1345         } else if (want & WANT_ERROR)
1346                 llapi_err_noerrno(LLAPI_MSG_ERROR,
1347                                   "'%s' not on a mounted Lustre filesystem",
1348                                   (want & WANT_PATH) ? fsname : path);
1349         return rc;
1350 }
1351
1352 /*
1353  * search lustre mounts
1354  *
1355  * Calling this function will return to the user the mount point, mntdir, and
1356  * the file system name, fsname, if the user passed a buffer to this routine.
1357  *
1358  * The user inputs are pathname and index. If the pathname is supplied then
1359  * the value of the index will be ignored. The pathname will return data if
1360  * the pathname is located on a lustre mount. Index is used to pick which
1361  * mount point you want in the case of multiple mounted lustre file systems.
1362  * See function lfs_osts in lfs.c for an example of the index use.
1363  */
1364 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
1365                         char *fsname)
1366 {
1367         int want = WANT_PATH, idx = -1;
1368
1369         if (!pathname || pathname[0] == '\0') {
1370                 want |= WANT_INDEX;
1371                 idx = index;
1372         } else
1373                 strcpy(mntdir, pathname);
1374
1375         if (fsname)
1376                 want |= WANT_FSNAME;
1377         return get_root_path(want, fsname, NULL, mntdir, idx);
1378 }
1379
1380 /* Given a path, find the corresponding Lustre fsname */
1381 int llapi_search_fsname(const char *pathname, char *fsname)
1382 {
1383         char *path;
1384         int rc;
1385
1386         path = realpath(pathname, NULL);
1387         if (path == NULL) {
1388                 char tmp[PATH_MAX - 1];
1389                 char buf[PATH_MAX];
1390                 char *ptr;
1391
1392                 tmp[0] = '\0';
1393                 buf[0] = '\0';
1394                 if (pathname[0] != '/') {
1395                         /* Need an absolute path, but realpath() only works for
1396                          * pathnames that actually exist.  We go through the
1397                          * extra hurdle of dirname(getcwd() + pathname) in
1398                          * case the relative pathname contains ".." in it. */
1399                         char realpath[PATH_MAX - 1];
1400
1401                         if (getcwd(realpath, sizeof(realpath) - 2) == NULL) {
1402                                 rc = -errno;
1403                                 llapi_error(LLAPI_MSG_ERROR, rc,
1404                                             "cannot get current working directory");
1405                                 return rc;
1406                         }
1407
1408                         rc = snprintf(tmp, sizeof(tmp), "%s/", realpath);
1409                         if (rc >= sizeof(tmp)) {
1410                                 rc = -E2BIG;
1411                                 llapi_error(LLAPI_MSG_ERROR, rc,
1412                                             "invalid parent path '%s'",
1413                                             tmp);
1414                                 return rc;
1415                         }
1416                 }
1417
1418                 rc = snprintf(buf, sizeof(buf), "%s%s", tmp, pathname);
1419                 if (rc >= sizeof(buf)) {
1420                         rc = -E2BIG;
1421                         llapi_error(LLAPI_MSG_ERROR, rc,
1422                                     "invalid path '%s'", pathname);
1423                         return rc;
1424                 }
1425                 path = realpath(buf, NULL);
1426                 if (path == NULL) {
1427                         ptr = strrchr(buf, '/');
1428                         if (ptr == NULL) {
1429                                 llapi_error(LLAPI_MSG_ERROR |
1430                                             LLAPI_MSG_NO_ERRNO, 0,
1431                                             "cannot resolve path '%s'",
1432                                             buf);
1433                                 return -ENOENT;
1434                         }
1435                         *ptr = '\0';
1436                         path = realpath(buf, NULL);
1437                         if (path == NULL) {
1438                                 rc = -errno;
1439                                 llapi_error(LLAPI_MSG_ERROR, rc,
1440                                             "cannot resolve path '%s'",
1441                                              pathname);
1442                                 return rc;
1443                         }
1444                 }
1445         }
1446         rc = get_root_path(WANT_FSNAME | WANT_ERROR, fsname, NULL, path, -1);
1447         free(path);
1448         return rc;
1449 }
1450
1451 int llapi_search_rootpath(char *pathname, const char *fsname)
1452 {
1453         return get_root_path(WANT_PATH, (char *)fsname, NULL, pathname, -1);
1454 }
1455
1456 int llapi_getname(const char *path, char *buf, size_t size)
1457 {
1458         struct obd_uuid uuid_buf;
1459         char *uuid = uuid_buf.uuid;
1460         char *cfg_instance;
1461         int rc, len, fsname_len;
1462
1463         memset(&uuid_buf, 0, sizeof(uuid_buf));
1464         rc = llapi_file_get_lov_uuid(path, &uuid_buf);
1465         if (rc)
1466                 return rc;
1467
1468         /*
1469          * We want to turn testfs-clilov-ffff88002738bc00 into
1470          * testfs-ffff88002738bc00 in a portable way that doesn't depend
1471          * on what is after "-clilov-" as it may change in the future.
1472          * Unfortunately, the "fsname" part may contain a dash, so we
1473          * can't just skip to the first dash, and the "instance" may be a
1474          * UUID in the future, so we can't necessarily go to the last dash.
1475          */
1476         cfg_instance = strstr(uuid, "-clilov-");
1477         if (!cfg_instance)
1478                 return -EINVAL;
1479
1480         fsname_len = cfg_instance - uuid;
1481         cfg_instance += strlen("-clilov-");
1482         len = snprintf(buf, size, "%.*s-%s", fsname_len, uuid, cfg_instance);
1483
1484         if (len >= size)
1485                 rc = -ENAMETOOLONG;
1486
1487         return rc;
1488 }
1489
1490 /**
1491  * Get the list of pool members.
1492  * \param poolname    string of format \<fsname\>.\<poolname\>
1493  * \param members     caller-allocated array of char*
1494  * \param list_size   size of the members array
1495  * \param buffer      caller-allocated buffer for storing OST names
1496  * \param buffer_size size of the buffer
1497  *
1498  * \return number of members retrieved for this pool
1499  * \retval -error failure
1500  */
1501 int llapi_get_poolmembers(const char *poolname, char **members,
1502                           int list_size, char *buffer, int buffer_size)
1503 {
1504         char fsname[PATH_MAX];
1505         char *pool, *tmp;
1506         glob_t pathname;
1507         char buf[PATH_MAX];
1508         FILE *fd;
1509         int rc = 0;
1510         int nb_entries = 0;
1511         int used = 0;
1512
1513         /* name is FSNAME.POOLNAME */
1514         if (strlen(poolname) >= sizeof(fsname))
1515                 return -EOVERFLOW;
1516
1517         snprintf(fsname, sizeof(fsname), "%s", poolname);
1518         pool = strchr(fsname, '.');
1519         if (pool == NULL)
1520                 return -EINVAL;
1521
1522         *pool = '\0';
1523         pool++;
1524
1525         rc = poolpath(&pathname, fsname, NULL);
1526         if (rc != 0) {
1527                 llapi_error(LLAPI_MSG_ERROR, rc,
1528                             "Lustre filesystem '%s' not found",
1529                             fsname);
1530                 return rc;
1531         }
1532
1533         llapi_printf(LLAPI_MSG_NORMAL, "Pool: %s.%s\n", fsname, pool);
1534         rc = snprintf(buf, sizeof(buf), "%s/%s", pathname.gl_pathv[0], pool);
1535         cfs_free_param_data(&pathname);
1536         if (rc >= sizeof(buf))
1537                 return -EOVERFLOW;
1538         fd = fopen(buf, "r");
1539         if (fd == NULL) {
1540                 rc = -errno;
1541                 llapi_error(LLAPI_MSG_ERROR, rc, "cannot open %s", buf);
1542                 return rc;
1543         }
1544
1545         rc = 0;
1546         while (fgets(buf, sizeof(buf), fd) != NULL) {
1547                 if (nb_entries >= list_size) {
1548                         rc = -EOVERFLOW;
1549                         break;
1550                 }
1551                 buf[sizeof(buf) - 1] = '\0';
1552                 /* remove '\n' */
1553                 tmp = strchr(buf, '\n');
1554                 if (tmp != NULL)
1555                         *tmp='\0';
1556                 if (used + strlen(buf) + 1 > buffer_size) {
1557                         rc = -EOVERFLOW;
1558                         break;
1559                 }
1560
1561                 strcpy(buffer + used, buf);
1562                 members[nb_entries] = buffer + used;
1563                 used += strlen(buf) + 1;
1564                 nb_entries++;
1565                 rc = nb_entries;
1566         }
1567
1568         fclose(fd);
1569         return rc;
1570 }
1571
1572 /**
1573  * Get the list of pools in a filesystem.
1574  * \param name        filesystem name or path
1575  * \param poollist    caller-allocated array of char*
1576  * \param list_size   size of the poollist array
1577  * \param buffer      caller-allocated buffer for storing pool names
1578  * \param buffer_size size of the buffer
1579  *
1580  * \return number of pools retrieved for this filesystem
1581  * \retval -error failure
1582  */
1583 int llapi_get_poollist(const char *name, char **poollist, int list_size,
1584                        char *buffer, int buffer_size)
1585 {
1586         glob_t pathname;
1587         char *fsname;
1588         char *ptr;
1589         DIR *dir;
1590         struct dirent *pool;
1591         int rc = 0;
1592         unsigned int nb_entries = 0;
1593         unsigned int used = 0;
1594         unsigned int i;
1595
1596         /* initialize output array */
1597         for (i = 0; i < list_size; i++)
1598                 poollist[i] = NULL;
1599
1600         /* is name a pathname ? */
1601         ptr = strchr(name, '/');
1602         if (ptr != NULL) {
1603                 char fsname_buf[MAXNAMLEN];
1604
1605                 /* We will need fsname for printing later */
1606                 rc = llapi_getname(name, fsname_buf, sizeof(fsname_buf));
1607                 if (rc)
1608                         return rc;
1609
1610                 ptr = strrchr(fsname_buf, '-');
1611                 if (ptr)
1612                         *ptr = '\0';
1613
1614                 fsname = strdup(fsname_buf);
1615                 if (!fsname)
1616                         return -ENOMEM;
1617         } else {
1618                 /* name is FSNAME */
1619                 fsname = strdup(name);
1620                 if (!fsname)
1621                         return -ENOMEM;
1622         }
1623
1624         rc = poolpath(&pathname, fsname, NULL);
1625         if (rc != 0) {
1626                 llapi_error(LLAPI_MSG_ERROR, rc,
1627                             "Lustre filesystem '%s' not found", name);
1628                 goto free_path;
1629         }
1630
1631         dir = opendir(pathname.gl_pathv[0]);
1632         if (dir == NULL) {
1633                 rc = -errno;
1634                 llapi_error(LLAPI_MSG_ERROR, rc,
1635                             "Could not open pool list for '%s'",
1636                             name);
1637                 goto free_path;
1638         }
1639
1640         do {
1641                 errno = 0;
1642                 pool = readdir(dir);
1643                 if (pool == NULL) {
1644                         rc = -errno;
1645                         goto free_dir;
1646                 }
1647
1648                 /* ignore . and .. */
1649                 if (!strcmp(pool->d_name, ".") || !strcmp(pool->d_name, ".."))
1650                         continue;
1651
1652                 /* check output bounds */
1653                 if (nb_entries >= list_size) {
1654                         rc = -EOVERFLOW;
1655                         goto free_dir_no_msg;
1656                 }
1657
1658                 /* +2 for '.' and final '\0' */
1659                 if (used + strlen(pool->d_name) + strlen(fsname) + 2
1660                     > buffer_size) {
1661                         rc = -EOVERFLOW;
1662                         goto free_dir_no_msg;
1663                 }
1664
1665                 sprintf(buffer + used, "%s.%s", fsname, pool->d_name);
1666                 poollist[nb_entries] = buffer + used;
1667                 used += strlen(pool->d_name) + strlen(fsname) + 2;
1668                 nb_entries++;
1669         } while (1);
1670
1671 free_dir:
1672         if (rc)
1673                 llapi_error(LLAPI_MSG_ERROR, rc,
1674                             "Error reading pool list for '%s'", name);
1675         else
1676                 llapi_printf(LLAPI_MSG_NORMAL, "Pools from %s:\n", fsname);
1677
1678 free_dir_no_msg:
1679         closedir(dir);
1680 free_path:
1681         cfs_free_param_data(&pathname);
1682         if (fsname)
1683                 free(fsname);
1684         return rc != 0 ? rc : nb_entries;
1685 }
1686
1687 /* wrapper for lfs.c and obd.c */
1688 int llapi_poollist(const char *name)
1689 {
1690         /* list of pool names (assume that pool count is smaller
1691            than OST count) */
1692         char **list, *buffer = NULL, *fsname = (char *)name;
1693         char *poolname = NULL, *tmp = NULL, data[16];
1694         enum param_filter type = FILTER_BY_PATH;
1695         int obdcount, bufsize, rc, nb, i;
1696
1697         if (name == NULL)
1698                 return -EINVAL;
1699
1700         if (name[0] != '/') {
1701                 fsname = strdup(name);
1702                 if (fsname == NULL)
1703                         return -ENOMEM;
1704
1705                 poolname = strchr(fsname, '.');
1706                 if (poolname)
1707                         *poolname = '\0';
1708                 type = FILTER_BY_FS_NAME;
1709         }
1710
1711         rc = get_lustre_param_value("lov", fsname, type, "numobd",
1712                                     data, sizeof(data));
1713         if (rc < 0)
1714                 goto err;
1715         obdcount = atoi(data);
1716
1717         /* Allocate space for each fsname-OST0000_UUID, 1 per OST,
1718          * and also an array to store the pointers for all that
1719          * allocated space. */
1720 retry_get_pools:
1721         bufsize = sizeof(struct obd_uuid) * obdcount;
1722         buffer = realloc(tmp, bufsize + sizeof(*list) * obdcount);
1723         if (buffer == NULL) {
1724                 rc = -ENOMEM;
1725                 goto err;
1726         }
1727         list = (char **) (buffer + bufsize);
1728
1729         if (!poolname) {
1730                 /* name is a path or fsname */
1731                 nb = llapi_get_poollist(name, list, obdcount,
1732                                         buffer, bufsize);
1733         } else {
1734                 /* name is a pool name (<fsname>.<poolname>) */
1735                 nb = llapi_get_poolmembers(name, list, obdcount,
1736                                            buffer, bufsize);
1737         }
1738
1739         if (nb == -EOVERFLOW) {
1740                 obdcount *= 2;
1741                 tmp = buffer;
1742                 goto retry_get_pools;
1743         }
1744
1745         for (i = 0; i < nb; i++)
1746                 llapi_printf(LLAPI_MSG_NORMAL, "%s\n", list[i]);
1747         rc = (nb < 0 ? nb : 0);
1748 err:
1749         if (buffer)
1750                 free(buffer);
1751         if (fsname != NULL && type == FILTER_BY_FS_NAME)
1752                 free(fsname);
1753         return rc;
1754 }
1755
1756 typedef int (semantic_func_t)(char *path, DIR *parent, DIR **d,
1757                               void *data, struct dirent64 *de);
1758
1759 #define OBD_NOT_FOUND           (-1)
1760
1761 static void find_param_fini(struct find_param *param)
1762 {
1763         if (param->fp_migrate)
1764                 return;
1765
1766         if (param->fp_obd_indexes) {
1767                 free(param->fp_obd_indexes);
1768                 param->fp_obd_indexes = NULL;
1769         }
1770
1771         if (param->fp_lmd) {
1772                 free(param->fp_lmd);
1773                 param->fp_lmd = NULL;
1774         }
1775
1776         if (param->fp_lmv_md) {
1777                 free(param->fp_lmv_md);
1778                 param->fp_lmv_md = NULL;
1779         }
1780 }
1781
1782 static int common_param_init(struct find_param *param, char *path)
1783 {
1784         int lum_size = get_mds_md_size(path);
1785
1786         if (lum_size < 0)
1787                 return lum_size;
1788
1789         /* migrate has fp_lmv_md initialized outside */
1790         if (param->fp_migrate)
1791                 return 0;
1792
1793         if (lum_size < PATH_MAX + 1)
1794                 lum_size = PATH_MAX + 1;
1795
1796         param->fp_lum_size = lum_size;
1797         param->fp_lmd = calloc(1, sizeof(lstat_t) + lum_size);
1798         if (param->fp_lmd == NULL) {
1799                 llapi_error(LLAPI_MSG_ERROR, -ENOMEM,
1800                             "error: allocation of %zu bytes for ioctl",
1801                             sizeof(lstat_t) + param->fp_lum_size);
1802                 return -ENOMEM;
1803         }
1804
1805         param->fp_lmv_stripe_count = 256;
1806         param->fp_lmv_md = calloc(1,
1807                                   lmv_user_md_size(param->fp_lmv_stripe_count,
1808                                                    LMV_USER_MAGIC_SPECIFIC));
1809         if (param->fp_lmv_md == NULL) {
1810                 llapi_error(LLAPI_MSG_ERROR, -ENOMEM,
1811                             "error: allocation of %d bytes for ioctl",
1812                             lmv_user_md_size(param->fp_lmv_stripe_count,
1813                                              LMV_USER_MAGIC_SPECIFIC));
1814                 find_param_fini(param);
1815                 return -ENOMEM;
1816         }
1817
1818         param->fp_got_uuids = 0;
1819         param->fp_obd_indexes = NULL;
1820         param->fp_obd_index = OBD_NOT_FOUND;
1821         param->fp_mdt_index = OBD_NOT_FOUND;
1822         return 0;
1823 }
1824
1825 static int cb_common_fini(char *path, DIR *parent, DIR **dirp, void *data,
1826                           struct dirent64 *de)
1827 {
1828         struct find_param *param = data;
1829         param->fp_depth--;
1830
1831         return 0;
1832 }
1833
1834 /* set errno upon failure */
1835 static DIR *opendir_parent(const char *path)
1836 {
1837         char *path_copy;
1838         char *parent_path;
1839         DIR *parent;
1840
1841         path_copy = strdup(path);
1842         if (path_copy == NULL)
1843                 return NULL;
1844
1845         parent_path = dirname(path_copy);
1846         parent = opendir(parent_path);
1847         free(path_copy);
1848
1849         return parent;
1850 }
1851
1852 static int cb_get_dirstripe(char *path, DIR *d, struct find_param *param)
1853 {
1854         int ret;
1855
1856 again:
1857         param->fp_lmv_md->lum_stripe_count = param->fp_lmv_stripe_count;
1858         if (param->fp_get_default_lmv)
1859                 param->fp_lmv_md->lum_magic = LMV_USER_MAGIC;
1860         else
1861                 param->fp_lmv_md->lum_magic = LMV_MAGIC_V1;
1862
1863         ret = ioctl(dirfd(d), LL_IOC_LMV_GETSTRIPE, param->fp_lmv_md);
1864         if (errno == E2BIG && ret != 0) {
1865                 int stripe_count;
1866                 int lmv_size;
1867
1868                 /* if foreign LMV case, fake stripes number */
1869                 if (param->fp_lmv_md->lum_magic == LMV_MAGIC_FOREIGN) {
1870                         struct lmv_foreign_md *lfm;
1871
1872                         lfm = (struct lmv_foreign_md *)param->fp_lmv_md;
1873                         if (lfm->lfm_length < XATTR_SIZE_MAX -
1874                             offsetof(typeof(*lfm), lfm_value)) {
1875                                 uint32_t size = lfm->lfm_length +
1876                                              offsetof(typeof(*lfm), lfm_value);
1877
1878                                 stripe_count = lmv_foreign_to_md_stripes(size);
1879                         } else {
1880                                 llapi_error(LLAPI_MSG_ERROR, -EINVAL,
1881                                             "error: invalid %d foreign size "
1882                                             "returned from ioctl",
1883                                             lfm->lfm_length);
1884                                 return -EINVAL;
1885                         }
1886                 } else {
1887                         stripe_count = param->fp_lmv_md->lum_stripe_count;
1888                 }
1889                 if (stripe_count <= param->fp_lmv_stripe_count)
1890                         return ret;
1891
1892                 free(param->fp_lmv_md);
1893                 param->fp_lmv_stripe_count = stripe_count;
1894                 lmv_size = lmv_user_md_size(stripe_count,
1895                                             LMV_USER_MAGIC_SPECIFIC);
1896                 param->fp_lmv_md = malloc(lmv_size);
1897                 if (param->fp_lmv_md == NULL) {
1898                         llapi_error(LLAPI_MSG_ERROR, -ENOMEM,
1899                                     "error: allocation of %d bytes for ioctl",
1900                                     lmv_user_md_size(param->fp_lmv_stripe_count,
1901                                                      LMV_USER_MAGIC_SPECIFIC));
1902                         return -ENOMEM;
1903                 }
1904                 goto again;
1905         }
1906         return ret;
1907 }
1908
1909 int get_lmd_info_fd(char *path, int parent_fd, int dir_fd,
1910                     void *lmdbuf, int lmdlen, enum get_lmd_info_type type)
1911 {
1912         struct lov_user_mds_data *lmd = lmdbuf;
1913         lstat_t *st = &lmd->lmd_st;
1914         int ret = 0;
1915
1916         if (parent_fd < 0 && dir_fd < 0)
1917                 return -EINVAL;
1918         if (type != GET_LMD_INFO && type != GET_LMD_STRIPE)
1919                 return -EINVAL;
1920
1921         if (dir_fd >= 0) {
1922                 /* LL_IOC_MDC_GETINFO operates on the current directory inode
1923                  * and returns struct lov_user_mds_data, while
1924                  * LL_IOC_LOV_GETSTRIPE returns only struct lov_user_md.
1925                  */
1926                 ret = ioctl(dir_fd, type == GET_LMD_INFO ? LL_IOC_MDC_GETINFO :
1927                                                            LL_IOC_LOV_GETSTRIPE,
1928                             lmdbuf);
1929         } else if (parent_fd >= 0) {
1930                 char *fname = strrchr(path, '/');
1931
1932                 /* IOC_MDC_GETFILEINFO takes as input the filename (relative to
1933                  * the parent directory) and returns struct lov_user_mds_data,
1934                  * while IOC_MDC_GETFILESTRIPE returns only struct lov_user_md.
1935                  *
1936                  * This avoids opening, locking, and closing each file on the
1937                  * client if that is not needed. Multiple of these ioctl() can
1938                  * be done on the parent dir with a single open for all
1939                  * files in that directory, and it also doesn't pollute the
1940                  * client dcache with millions of dentries when traversing
1941                  * a large filesystem.
1942                  */
1943                 fname = (fname == NULL ? path : fname + 1);
1944
1945                 ret = snprintf(lmdbuf, lmdlen, "%s", fname);
1946                 if (ret < 0)
1947                         errno = -ret;
1948                 else if (ret >= lmdlen || ret++ == 0)
1949                         errno = EINVAL;
1950                 else
1951                         ret = ioctl(parent_fd, type == GET_LMD_INFO ?
1952                                                 IOC_MDC_GETFILEINFO :
1953                                                 IOC_MDC_GETFILESTRIPE, lmdbuf);
1954         }
1955
1956         if (ret && type == GET_LMD_INFO) {
1957                 if (errno == ENOTTY) {
1958                         /* ioctl is not supported, it is not a lustre fs.
1959                          * Do the regular lstat(2) instead.
1960                          */
1961                         ret = lstat_f(path, st);
1962                         if (ret) {
1963                                 ret = -errno;
1964                                 llapi_error(LLAPI_MSG_ERROR, ret,
1965                                             "error: %s: lstat failed for %s",
1966                                             __func__, path);
1967                         }
1968                 } else if (errno == ENOENT) {
1969                         ret = -errno;
1970                         llapi_error(LLAPI_MSG_WARN, ret,
1971                                     "warning: %s does not exist", path);
1972                 } else if (errno != EISDIR && errno != ENODATA) {
1973                         ret = -errno;
1974                         llapi_error(LLAPI_MSG_ERROR, ret,
1975                                     "%s ioctl failed for %s.",
1976                                     dir_fd >= 0 ? "LL_IOC_MDC_GETINFO" :
1977                                     "IOC_MDC_GETFILEINFO", path);
1978                 }
1979         }
1980
1981         return ret;
1982 }
1983
1984 static int get_lmd_info(char *path, DIR *parent, DIR *dir, void *lmdbuf,
1985                         int lmdlen, enum get_lmd_info_type type)
1986 {
1987         int parent_fd = -1;
1988         int dir_fd = -1;
1989
1990         if (parent)
1991                 parent_fd = dirfd(parent);
1992         if (dir)
1993                 dir_fd = dirfd(dir);
1994
1995         return get_lmd_info_fd(path, parent_fd, dir_fd, lmdbuf, lmdlen, type);
1996 }
1997
1998 static int llapi_semantic_traverse(char *path, int size, DIR *parent,
1999                                    semantic_func_t sem_init,
2000                                    semantic_func_t sem_fini, void *data,
2001                                    struct dirent64 *de)
2002 {
2003         struct find_param *param = (struct find_param *)data;
2004         struct dirent64 *dent;
2005         int len, ret;
2006         DIR *d, *p = NULL;
2007
2008         ret = 0;
2009         len = strlen(path);
2010
2011         d = opendir(path);
2012         if (!d && errno != ENOTDIR) {
2013                 ret = -errno;
2014                 llapi_error(LLAPI_MSG_ERROR, ret, "%s: Failed to open '%s'",
2015                             __func__, path);
2016                 return ret;
2017         } else if (!d && !parent) {
2018                 /* ENOTDIR. Open the parent dir. */
2019                 p = opendir_parent(path);
2020                 if (!p) {
2021                         ret = -errno;
2022                         goto out;
2023                 }
2024         }
2025
2026         if (sem_init && (ret = sem_init(path, parent ?: p, &d, data, de)))
2027                 goto err;
2028
2029         if (d == NULL)
2030                 goto out;
2031
2032         while ((dent = readdir64(d)) != NULL) {
2033                 int rc;
2034
2035                 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, ".."))
2036                         continue;
2037
2038                 path[len] = 0;
2039                 if ((len + dent->d_reclen + 2) > size) {
2040                         llapi_err_noerrno(LLAPI_MSG_ERROR,
2041                                           "error: %s: string buffer too small",
2042                                           __func__);
2043                         break;
2044                 }
2045                 strcat(path, "/");
2046                 strcat(path, dent->d_name);
2047
2048                 if (dent->d_type == DT_UNKNOWN) {
2049                         lstat_t *st = &param->fp_lmd->lmd_st;
2050
2051                         rc = get_lmd_info(path, d, NULL, param->fp_lmd,
2052                                           param->fp_lum_size, GET_LMD_INFO);
2053                         if (rc == 0)
2054                                 dent->d_type = IFTODT(st->st_mode);
2055                         else if (ret == 0)
2056                                 ret = rc;
2057
2058                         if (rc == -ENOENT)
2059                                 continue;
2060                 }
2061                 switch (dent->d_type) {
2062                 case DT_UNKNOWN:
2063                         llapi_err_noerrno(LLAPI_MSG_ERROR,
2064                                           "error: %s: '%s' is UNKNOWN type %d",
2065                                           __func__, dent->d_name, dent->d_type);
2066                         break;
2067                 case DT_DIR:
2068                         rc = llapi_semantic_traverse(path, size, d, sem_init,
2069                                                       sem_fini, data, dent);
2070                         if (rc != 0 && ret == 0)
2071                                 ret = rc;
2072                         break;
2073                 default:
2074                         rc = 0;
2075                         if (sem_init) {
2076                                 rc = sem_init(path, d, NULL, data, dent);
2077                                 if (rc < 0 && ret == 0) {
2078                                         ret = rc;
2079                                         break;
2080                                 }
2081                         }
2082                         if (sem_fini && rc == 0)
2083                                 sem_fini(path, d, NULL, data, dent);
2084                 }
2085         }
2086
2087 out:
2088         path[len] = 0;
2089
2090         if (sem_fini)
2091                 sem_fini(path, parent, &d, data, de);
2092 err:
2093         if (d)
2094                 closedir(d);
2095         if (p)
2096                 closedir(p);
2097         return ret;
2098 }
2099
2100 static int param_callback(char *path, semantic_func_t sem_init,
2101                           semantic_func_t sem_fini, struct find_param *param)
2102 {
2103         int ret, len = strlen(path);
2104         char *buf;
2105
2106         if (len > PATH_MAX) {
2107                 ret = -EINVAL;
2108                 llapi_error(LLAPI_MSG_ERROR, ret,
2109                             "Path name '%s' is too long", path);
2110                 return ret;
2111         }
2112
2113         buf = (char *)malloc(PATH_MAX + 1);
2114         if (!buf)
2115                 return -ENOMEM;
2116
2117         snprintf(buf, PATH_MAX + 1, "%s", path);
2118         ret = common_param_init(param, buf);
2119         if (ret)
2120                 goto out;
2121
2122         param->fp_depth = 0;
2123
2124         ret = llapi_semantic_traverse(buf, PATH_MAX + 1, NULL, sem_init,
2125                                       sem_fini, param, NULL);
2126 out:
2127         find_param_fini(param);
2128         free(buf);
2129         return ret < 0 ? ret : 0;
2130 }
2131
2132 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_name)
2133 {
2134         int rc = ioctl(fd, OBD_IOC_GETNAME, lov_name);
2135
2136         if (rc) {
2137                 rc = -errno;
2138                 llapi_error(LLAPI_MSG_ERROR, rc, "cannot get lov name");
2139         }
2140         return rc;
2141 }
2142
2143 int llapi_file_fget_lmv_uuid(int fd, struct obd_uuid *lov_name)
2144 {
2145         int rc = ioctl(fd, OBD_IOC_GETMDNAME, lov_name);
2146         if (rc) {
2147                 rc = -errno;
2148                 llapi_error(LLAPI_MSG_ERROR, rc, "error: can't get lmv name.");
2149         }
2150         return rc;
2151 }
2152
2153 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid)
2154 {
2155         int fd, rc;
2156
2157         fd = open(path, O_RDONLY | O_NONBLOCK);
2158         if (fd < 0) {
2159                 rc = -errno;
2160                 llapi_error(LLAPI_MSG_ERROR, rc, "cannot open '%s'", path);
2161                 return rc;
2162         }
2163
2164         rc = llapi_file_fget_lov_uuid(fd, lov_uuid);
2165
2166         close(fd);
2167         return rc;
2168 }
2169
2170 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lov_uuid)
2171 {
2172         int fd, rc;
2173
2174         fd = open(path, O_RDONLY | O_NONBLOCK);
2175         if (fd < 0) {
2176                 rc = -errno;
2177                 llapi_error(LLAPI_MSG_ERROR, rc, "error opening %s", path);
2178                 return rc;
2179         }
2180
2181         rc = llapi_file_fget_lmv_uuid(fd, lov_uuid);
2182
2183         close(fd);
2184         return rc;
2185 }
2186
2187 enum tgt_type {
2188         LOV_TYPE = 1,
2189         LMV_TYPE
2190 };
2191
2192 /*
2193  * If uuidp is NULL, return the number of available obd uuids.
2194  * If uuidp is non-NULL, then it will return the uuids of the obds. If
2195  * there are more OSTs than allocated to uuidp, then an error is returned with
2196  * the ost_count set to number of available obd uuids.
2197  */
2198 static int llapi_get_target_uuids(int fd, struct obd_uuid *uuidp,
2199                                   int *ost_count, enum tgt_type type)
2200 {
2201         char buf[PATH_MAX], format[32];
2202         int rc = 0, index = 0;
2203         struct obd_uuid name;
2204         glob_t param;
2205         FILE *fp;
2206
2207         /* Get the lov name */
2208         if (type == LOV_TYPE)
2209                 rc = llapi_file_fget_lov_uuid(fd, &name);
2210         else
2211                 rc = llapi_file_fget_lmv_uuid(fd, &name);
2212         if (rc != 0)
2213                 return rc;
2214
2215         /* Now get the ost uuids */
2216         rc = get_lustre_param_path(type == LOV_TYPE ? "lov" : "lmv", name.uuid,
2217                                    FILTER_BY_EXACT, "target_obd", &param);
2218         if (rc != 0)
2219                 return -ENOENT;
2220
2221         fp = fopen(param.gl_pathv[0], "r");
2222         if (fp == NULL) {
2223                 rc = -errno;
2224                 llapi_error(LLAPI_MSG_ERROR, rc, "error: opening '%s'",
2225                             param.gl_pathv[0]);
2226                 goto free_param;
2227         }
2228
2229         snprintf(format, sizeof(format),
2230                  "%%d: %%%zus", sizeof(uuidp[0].uuid) - 1);
2231         while (fgets(buf, sizeof(buf), fp) != NULL) {
2232                 if (uuidp && (index < *ost_count)) {
2233                         if (sscanf(buf, format, &index, uuidp[index].uuid) < 2)
2234                                 break;
2235                 }
2236                 index++;
2237         }
2238
2239         fclose(fp);
2240
2241         if (uuidp && (index > *ost_count))
2242                 rc = -EOVERFLOW;
2243
2244         *ost_count = index;
2245 free_param:
2246         cfs_free_param_data(&param);
2247         return rc;
2248 }
2249
2250 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count)
2251 {
2252         return llapi_get_target_uuids(fd, uuidp, ost_count, LOV_TYPE);
2253 }
2254
2255 int llapi_get_obd_count(char *mnt, int *count, int is_mdt)
2256 {
2257         int root;
2258         int rc;
2259
2260         root = open(mnt, O_RDONLY | O_DIRECTORY);
2261         if (root < 0) {
2262                 rc = -errno;
2263                 llapi_error(LLAPI_MSG_ERROR, rc, "open %s failed", mnt);
2264                 return rc;
2265         }
2266
2267         *count = is_mdt;
2268         rc = ioctl(root, LL_IOC_GETOBDCOUNT, count);
2269         if (rc < 0)
2270                 rc = -errno;
2271
2272         close(root);
2273         return rc;
2274 }
2275
2276 /* Check if user specified value matches a real uuid.  Ignore _UUID,
2277  * -osc-4ba41334, other trailing gunk in comparison.
2278  * @param real_uuid ends in "_UUID"
2279  * @param search_uuid may or may not end in "_UUID"
2280  */
2281 int llapi_uuid_match(char *real_uuid, char *search_uuid)
2282 {
2283         int cmplen = strlen(real_uuid);
2284         int searchlen = strlen(search_uuid);
2285
2286         if (cmplen > 5 && strcmp(real_uuid + cmplen - 5, "_UUID") == 0)
2287                 cmplen -= 5;
2288         if (searchlen > 5 && strcmp(search_uuid + searchlen - 5, "_UUID") == 0)
2289                 searchlen -= 5;
2290
2291         /* The UUIDs may legitimately be different lengths, if
2292          * the system was upgraded from an older version. */
2293         if (cmplen != searchlen)
2294                 return 0;
2295
2296         return (strncmp(search_uuid, real_uuid, cmplen) == 0);
2297 }
2298
2299 /* Here, param->fp_obd_uuid points to a single obduuid, the index of which is
2300  * returned in param->fp_obd_index */
2301 static int setup_obd_uuid(int fd, char *dname, struct find_param *param)
2302 {
2303         struct obd_uuid obd_uuid;
2304         char buf[PATH_MAX];
2305         glob_t param_data;
2306         char format[32];
2307         int rc = 0;
2308         FILE *fp;
2309
2310         if (param->fp_got_uuids)
2311                 return rc;
2312
2313         /* Get the lov/lmv name */
2314         if (param->fp_get_lmv)
2315                 rc = llapi_file_fget_lmv_uuid(fd, &obd_uuid);
2316         else
2317                 rc = llapi_file_fget_lov_uuid(fd, &obd_uuid);
2318         if (rc) {
2319                 if (rc != -ENOTTY) {
2320                         llapi_error(LLAPI_MSG_ERROR, rc,
2321                                     "error: can't get %s name: %s",
2322                                     param->fp_get_lmv ? "lmv" : "lov",
2323                                     dname);
2324                 } else {
2325                         rc = 0;
2326                 }
2327                 return rc;
2328         }
2329
2330         param->fp_got_uuids = 1;
2331
2332         /* Now get the ost uuids */
2333         rc = get_lustre_param_path(param->fp_get_lmv ? "lmv" : "lov",
2334                                    obd_uuid.uuid, FILTER_BY_EXACT,
2335                                    "target_obd", &param_data);
2336         if (rc != 0)
2337                 return -ENOENT;
2338
2339         fp = fopen(param_data.gl_pathv[0], "r");
2340         if (fp == NULL) {
2341                 rc = -errno;
2342                 llapi_error(LLAPI_MSG_ERROR, rc, "error: opening '%s'",
2343                             param_data.gl_pathv[0]);
2344                 goto free_param;
2345         }
2346
2347         if (!param->fp_obd_uuid && !param->fp_quiet && !param->fp_obds_printed)
2348                 llapi_printf(LLAPI_MSG_NORMAL, "%s:\n",
2349                              param->fp_get_lmv ? "MDTS" : "OBDS");
2350
2351         snprintf(format, sizeof(format),
2352                  "%%d: %%%zus", sizeof(obd_uuid.uuid) - 1);
2353         while (fgets(buf, sizeof(buf), fp) != NULL) {
2354                 int index;
2355
2356                 if (sscanf(buf, format, &index, obd_uuid.uuid) < 2)
2357                         break;
2358
2359                 if (param->fp_obd_uuid) {
2360                         if (llapi_uuid_match(obd_uuid.uuid,
2361                                              param->fp_obd_uuid->uuid)) {
2362                                 param->fp_obd_index = index;
2363                                 break;
2364                         }
2365                 } else if (!param->fp_quiet && !param->fp_obds_printed) {
2366                         /* Print everything */
2367                         llapi_printf(LLAPI_MSG_NORMAL, "%s", buf);
2368                 }
2369         }
2370         param->fp_obds_printed = 1;
2371
2372         fclose(fp);
2373
2374         if (param->fp_obd_uuid && (param->fp_obd_index == OBD_NOT_FOUND)) {
2375                 llapi_err_noerrno(LLAPI_MSG_ERROR,
2376                                   "error: %s: unknown obduuid: %s",
2377                                   __func__, param->fp_obd_uuid->uuid);
2378                 rc = -EINVAL;
2379         }
2380 free_param:
2381         cfs_free_param_data(&param_data);
2382         return rc;
2383 }
2384
2385 /* In this case, param->fp_obd_uuid will be an array of obduuids and
2386  * obd index for all these obduuids will be returned in
2387  * param->fp_obd_indexes */
2388 static int setup_indexes(DIR *dir, char *path, struct obd_uuid *obduuids,
2389                          int num_obds, int **obdindexes, int *obdindex,
2390                          enum tgt_type type)
2391 {
2392         int ret, obdcount, obd_valid = 0, obdnum;
2393         long i;
2394         struct obd_uuid *uuids = NULL;
2395         char buf[16];
2396         int *indexes;
2397
2398         if (type == LOV_TYPE)
2399                 ret = get_param_lov(path, "numobd", buf, sizeof(buf));
2400         else
2401                 ret = get_param_lmv(path, "numobd", buf, sizeof(buf));
2402         if (ret != 0)
2403                 return ret;
2404
2405         obdcount = atoi(buf);
2406         uuids = malloc(obdcount * sizeof(struct obd_uuid));
2407         if (uuids == NULL)
2408                 return -ENOMEM;
2409
2410 retry_get_uuids:
2411         ret = llapi_get_target_uuids(dirfd(dir), uuids, &obdcount, type);
2412         if (ret) {
2413                 if (ret == -EOVERFLOW) {
2414                         struct obd_uuid *uuids_temp;
2415
2416                         uuids_temp = realloc(uuids, obdcount *
2417                                              sizeof(struct obd_uuid));
2418                         if (uuids_temp != NULL) {
2419                                 uuids = uuids_temp;
2420                                 goto retry_get_uuids;
2421                         }
2422                         ret = -ENOMEM;
2423                 }
2424
2425                 llapi_error(LLAPI_MSG_ERROR, ret, "cannot get ost uuid");
2426                 goto out_free;
2427         }
2428
2429         indexes = malloc(num_obds * sizeof(*obdindex));
2430         if (indexes == NULL) {
2431                 ret = -ENOMEM;
2432                 goto out_free;
2433         }
2434
2435         for (obdnum = 0; obdnum < num_obds; obdnum++) {
2436                 char *end = NULL;
2437
2438                 /* The user may have specified a simple index */
2439                 i = strtol(obduuids[obdnum].uuid, &end, 0);
2440                 if (end && *end == '\0' && i < obdcount) {
2441                         indexes[obdnum] = i;
2442                         obd_valid++;
2443                 } else {
2444                         for (i = 0; i < obdcount; i++) {
2445                                 if (llapi_uuid_match(uuids[i].uuid,
2446                                                      obduuids[obdnum].uuid)) {
2447                                         indexes[obdnum] = i;
2448                                         obd_valid++;
2449                                         break;
2450                                 }
2451                         }
2452                 }
2453                 if (i >= obdcount) {
2454                         indexes[obdnum] = OBD_NOT_FOUND;
2455                         llapi_err_noerrno(LLAPI_MSG_ERROR,
2456                                           "invalid obduuid '%s'",
2457                                           obduuids[obdnum].uuid);
2458                         ret = -EINVAL;
2459                 }
2460         }
2461
2462         if (obd_valid == 0)
2463                 *obdindex = OBD_NOT_FOUND;
2464         else
2465                 *obdindex = obd_valid;
2466
2467         *obdindexes = indexes;
2468 out_free:
2469         if (uuids)
2470                 free(uuids);
2471
2472         return ret;
2473 }
2474
2475 static int setup_target_indexes(DIR *dir, char *path, struct find_param *param)
2476 {
2477         int ret = 0;
2478
2479         if (param->fp_mdt_uuid) {
2480                 ret = setup_indexes(dir, path, param->fp_mdt_uuid,
2481                                     param->fp_num_mdts,
2482                                     &param->fp_mdt_indexes,
2483                                     &param->fp_mdt_index, LMV_TYPE);
2484                 if (ret)
2485                         return ret;
2486         }
2487
2488         if (param->fp_obd_uuid) {
2489                 ret = setup_indexes(dir, path, param->fp_obd_uuid,
2490                                     param->fp_num_obds,
2491                                     &param->fp_obd_indexes,
2492                                     &param->fp_obd_index, LOV_TYPE);
2493                 if (ret)
2494                         return ret;
2495         }
2496
2497         param->fp_got_uuids = 1;
2498
2499         return ret;
2500 }
2501
2502 int llapi_ostlist(char *path, struct find_param *param)
2503 {
2504         int fd;
2505         int ret;
2506
2507         fd = open(path, O_RDONLY | O_DIRECTORY);
2508         if (fd < 0)
2509                 return -errno;
2510
2511         ret = setup_obd_uuid(fd, path, param);
2512         close(fd);
2513
2514         return ret;
2515 }
2516
2517 /*
2518  * Tries to determine the default stripe attributes for a given filesystem. The
2519  * filesystem to check should be specified by fsname, or will be determined
2520  * using pathname.
2521  */
2522 static int sattr_get_defaults(const char *const fsname,
2523                               unsigned int *scount,
2524                               unsigned int *ssize,
2525                               unsigned int *soffset)
2526 {
2527         char val[PATH_MAX];
2528         int rc;
2529
2530         if (scount) {
2531                 rc = get_lustre_param_value("lov", fsname, FILTER_BY_FS_NAME,
2532                                             "stripecount", val, sizeof(val));
2533                 if (rc != 0)
2534                         return rc;
2535                 *scount = atoi(val);
2536         }
2537
2538         if (ssize) {
2539                 rc = get_lustre_param_value("lov", fsname, FILTER_BY_FS_NAME,
2540                                             "stripesize", val, sizeof(val));
2541                 if (rc != 0)
2542                         return rc;
2543                 *ssize = atoi(val);
2544         }
2545
2546         if (soffset) {
2547                 rc = get_lustre_param_value("lov", fsname, FILTER_BY_FS_NAME,
2548                                             "stripeoffset", val, sizeof(val));
2549                 if (rc != 0)
2550                         return rc;
2551                 *soffset = atoi(val);
2552         }
2553
2554         return 0;
2555 }
2556
2557 /*
2558  * Tries to gather the default stripe attributes for a given filesystem. If
2559  * the attributes can be determined, they are cached for easy retreival the
2560  * next time they are needed. Only a single filesystem's attributes are
2561  * cached at a time.
2562  */
2563 int sattr_cache_get_defaults(const char *const fsname,
2564                              const char *const pathname, unsigned int *scount,
2565                              unsigned int *ssize, unsigned int *soffset)
2566 {
2567         static struct {
2568                 char fsname[PATH_MAX + 1];
2569                 unsigned int stripecount;
2570                 unsigned int stripesize;
2571                 unsigned int stripeoffset;
2572         } cache = {
2573                 .fsname = {'\0'}
2574         };
2575
2576         int rc;
2577         char fsname_buf[PATH_MAX + 1];
2578         unsigned int tmp[3];
2579
2580         if (fsname == NULL) {
2581                 rc = llapi_search_fsname(pathname, fsname_buf);
2582                 if (rc)
2583                         return rc;
2584         } else {
2585                 snprintf(fsname_buf, sizeof(fsname_buf), "%s", fsname);
2586         }
2587
2588         if (strncmp(fsname_buf, cache.fsname, sizeof(fsname_buf) - 1) != 0) {
2589                 /*
2590                  * Ensure all 3 sattrs (count, size, and offset) are
2591                  * successfully retrieved and stored in tmp before writing to
2592                  * cache.
2593                  */
2594                 rc = sattr_get_defaults(fsname_buf, &tmp[0], &tmp[1], &tmp[2]);
2595                 if (rc != 0)
2596                         return rc;
2597
2598                 cache.stripecount = tmp[0];
2599                 cache.stripesize = tmp[1];
2600                 cache.stripeoffset = tmp[2];
2601                 snprintf(cache.fsname, sizeof(cache.fsname), "%s", fsname_buf);
2602         }
2603
2604         if (scount)
2605                 *scount = cache.stripecount;
2606         if (ssize)
2607                 *ssize = cache.stripesize;
2608         if (soffset)
2609                 *soffset = cache.stripeoffset;
2610
2611         return 0;
2612 }
2613
2614 static char *layout2name(__u32 layout_pattern)
2615 {
2616         if (layout_pattern & LOV_PATTERN_F_RELEASED)
2617                 return "released";
2618         else if (layout_pattern == LOV_PATTERN_MDT)
2619                 return "mdt";
2620         else if (layout_pattern == LOV_PATTERN_RAID0)
2621                 return "raid0";
2622         else if (layout_pattern ==
2623                         (LOV_PATTERN_RAID0 | LOV_PATTERN_OVERSTRIPING))
2624                 return "raid0,overstriped";
2625         else
2626                 return "unknown";
2627 }
2628
2629 enum lov_dump_flags {
2630         LDF_IS_DIR      = 0x0001,
2631         LDF_IS_RAW      = 0x0002,
2632         LDF_INDENT      = 0x0004,
2633         LDF_SKIP_OBJS   = 0x0008,
2634         LDF_YAML        = 0x0010,
2635         LDF_EXTENSION   = 0x0020,
2636 };
2637
2638 static void lov_dump_user_lmm_header(struct lov_user_md *lum, char *path,
2639                                      struct lov_user_ost_data_v1 *objects,
2640                                      enum llapi_layout_verbose verbose,
2641                                      int depth, char *pool_name,
2642                                      enum lov_dump_flags flags)
2643 {
2644         bool is_dir = flags & LDF_IS_DIR;
2645         bool is_raw = flags & LDF_IS_RAW;
2646         bool indent = flags & LDF_INDENT;
2647         bool yaml = flags & LDF_YAML;
2648         bool skip_objs = flags & LDF_SKIP_OBJS;
2649         bool extension = flags & LDF_EXTENSION;
2650         char *prefix = is_dir ? "" : "lmm_";
2651         char *separator = "";
2652         char *space = indent ? "      " : "";
2653         int rc;
2654
2655         if (is_dir && lmm_oi_seq(&lum->lmm_oi) == FID_SEQ_LOV_DEFAULT) {
2656                 lmm_oi_set_seq(&lum->lmm_oi, 0);
2657                 if (!indent && (verbose & VERBOSE_DETAIL))
2658                         llapi_printf(LLAPI_MSG_NORMAL, "%s(Default) ", space);
2659         }
2660
2661         if (!yaml && !indent && depth && path &&
2662             ((verbose != VERBOSE_OBJID) || !is_dir))
2663                 llapi_printf(LLAPI_MSG_NORMAL, "%s\n", path);
2664
2665         if ((verbose & VERBOSE_DETAIL) && !is_dir) {
2666                 llapi_printf(LLAPI_MSG_NORMAL, "%s%smagic:         0x%08X\n",
2667                              space, prefix, lum->lmm_magic);
2668                 llapi_printf(LLAPI_MSG_NORMAL, "%s%sseq:           %#jx\n",
2669                              space, prefix,
2670                              (uintmax_t)lmm_oi_seq(&lum->lmm_oi));
2671                 llapi_printf(LLAPI_MSG_NORMAL, "%s%sobject_id:     %#jx\n",
2672                              space, prefix,
2673                              (uintmax_t)lmm_oi_id(&lum->lmm_oi));
2674         }
2675         if ((verbose & (VERBOSE_DETAIL | VERBOSE_DFID)) && !is_dir) {
2676                 __u64 seq;
2677                 __u32 oid;
2678                 __u32 ver;
2679
2680                 if (verbose & ~VERBOSE_DFID)
2681                         llapi_printf(LLAPI_MSG_NORMAL, "%slmm_fid:           ",
2682                                      space);
2683                 /* This needs a bit of hand-holding since old 1.x lmm_oi
2684                  * have { oi.oi_id = mds_inum, oi.oi_seq = 0 } and 2.x lmm_oi
2685                  * have { oi.oi_id = mds_oid, oi.oi_seq = mds_seq } instead of
2686                  * a real FID.  Ideally the 2.x code would have stored this
2687                  * like a FID with { oi_id = mds_seq, oi_seq = mds_oid } so the
2688                  * ostid union lu_fid { f_seq = mds_seq, f_oid = mds_oid }
2689                  * worked properly (especially since IGIF FIDs use mds_inum as
2690                  * the FID SEQ), but unfortunately that didn't happen.
2691                  *
2692                  * Print it to look like an IGIF FID, even though the fields
2693                  * are reversed on disk, so that it makes sense to userspace.
2694                  *
2695                  * Don't use ostid_id() and ostid_seq(), since they assume the
2696                  * oi_fid fields are in the right order.  This is why there are
2697                  * separate lmm_oi_seq() and lmm_oi_id() routines for this.
2698                  *
2699                  * For newer layout types hopefully this will be a real FID. */
2700                 seq = lmm_oi_seq(&lum->lmm_oi) == 0 ?
2701                         lmm_oi_id(&lum->lmm_oi) : lmm_oi_seq(&lum->lmm_oi);
2702                 oid = lmm_oi_seq(&lum->lmm_oi) == 0 ?
2703                         0 : (__u32)lmm_oi_id(&lum->lmm_oi);
2704                 ver = (__u32)(lmm_oi_id(&lum->lmm_oi) >> 32);
2705                 if (yaml)
2706                         llapi_printf(LLAPI_MSG_NORMAL, DFID_NOBRACE"\n",
2707                                      (unsigned long long)seq, oid, ver);
2708                 else
2709                         llapi_printf(LLAPI_MSG_NORMAL, DFID"\n",
2710                                      (unsigned long long)seq, oid, ver);
2711         }
2712
2713         if (verbose & VERBOSE_STRIPE_COUNT) {
2714                 if (verbose & ~VERBOSE_STRIPE_COUNT)
2715                         llapi_printf(LLAPI_MSG_NORMAL, "%s%sstripe_count:  ",
2716                                      space, prefix);
2717                 if (is_dir) {
2718                         if (!is_raw && lum->lmm_stripe_count == 0 &&
2719                             lov_pattern(lum->lmm_pattern) != LOV_PATTERN_MDT) {
2720                                 unsigned int scount;
2721                                 rc = sattr_cache_get_defaults(NULL, path,
2722                                                               &scount, NULL,
2723                                                               NULL);
2724                                 if (rc == 0)
2725                                         llapi_printf(LLAPI_MSG_NORMAL, "%d",
2726                                                      scount);
2727                                 else
2728                                         llapi_error(LLAPI_MSG_ERROR, rc,
2729                                                     "Cannot determine default"
2730                                                     " stripe count.");
2731                         } else {
2732                                 llapi_printf(LLAPI_MSG_NORMAL, "%d",
2733                                              extension ? 0 :
2734                                              (__s16)lum->lmm_stripe_count);
2735                         }
2736                 } else {
2737                         llapi_printf(LLAPI_MSG_NORMAL, "%hd",
2738                                      extension ? 0 :
2739                                      (__s16)lum->lmm_stripe_count);
2740                 }
2741                 if (!yaml && is_dir)
2742                         separator = " ";
2743                 else
2744                         separator = "\n";
2745         }
2746
2747         if (((verbose & VERBOSE_STRIPE_SIZE) && !extension) ||
2748             ((verbose & VERBOSE_EXT_SIZE) && extension)) {
2749                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
2750                 if (verbose & ~VERBOSE_EXT_SIZE && extension)
2751                         llapi_printf(LLAPI_MSG_NORMAL, "%s%sextension_size: ",
2752                                      space, prefix);
2753                 if (verbose & ~VERBOSE_STRIPE_SIZE && !extension)
2754                         llapi_printf(LLAPI_MSG_NORMAL, "%s%sstripe_size:   ",
2755                                      space, prefix);
2756                 if (is_dir && !is_raw && lum->lmm_stripe_size == 0) {
2757                         unsigned int ssize;
2758                         rc = sattr_cache_get_defaults(NULL, path, NULL, &ssize,
2759                                                       NULL);
2760                         if (rc == 0)
2761                                 llapi_printf(LLAPI_MSG_NORMAL, "%u", ssize);
2762                         else
2763                                 llapi_error(LLAPI_MSG_ERROR, rc,
2764                                             "Cannot determine default"
2765                                             " stripe size.");
2766                 } else {
2767                         /* Extension size is in KiB */
2768                         llapi_printf(LLAPI_MSG_NORMAL, "%llu",
2769                                      extension ?
2770                                      (unsigned long long)(lum->lmm_stripe_size * SEL_UNIT_SIZE) :
2771                                      (unsigned long long)lum->lmm_stripe_size);
2772                 }
2773                 if (!yaml && is_dir)
2774                         separator = " ";
2775                 else
2776                         separator = "\n";
2777         }
2778
2779         if ((verbose & VERBOSE_PATTERN)) {
2780                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
2781                 if (verbose & ~VERBOSE_PATTERN)
2782                         llapi_printf(LLAPI_MSG_NORMAL, "%s%spattern:       ",
2783                                      space, prefix);
2784                 if (lov_pattern_supported(lum->lmm_pattern))
2785                         llapi_printf(LLAPI_MSG_NORMAL, "%s",
2786                                      layout2name(lum->lmm_pattern));
2787                 else
2788                         llapi_printf(LLAPI_MSG_NORMAL, "%x", lum->lmm_pattern);
2789                 separator = (!yaml && is_dir) ? " " : "\n";
2790         }
2791
2792         if ((verbose & VERBOSE_GENERATION) && !is_dir) {
2793                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
2794                 if (verbose & ~VERBOSE_GENERATION)
2795                         llapi_printf(LLAPI_MSG_NORMAL, "%s%slayout_gen:    ",
2796                                      space, prefix);
2797                 llapi_printf(LLAPI_MSG_NORMAL, "%u",
2798                              skip_objs ? 0 : (int)lum->lmm_layout_gen);
2799                 separator = "\n";
2800         }
2801
2802         if (verbose & VERBOSE_STRIPE_OFFSET) {
2803                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
2804                 if (verbose & ~VERBOSE_STRIPE_OFFSET)
2805                         llapi_printf(LLAPI_MSG_NORMAL, "%s%sstripe_offset: ",
2806                                      space, prefix);
2807                 if (is_dir || skip_objs)
2808                         llapi_printf(LLAPI_MSG_NORMAL, "%d",
2809                                      lum->lmm_stripe_offset ==
2810                                      (typeof(lum->lmm_stripe_offset))(-1) ? -1 :
2811                                      lum->lmm_stripe_offset);
2812                 else if (lov_pattern(lum->lmm_pattern) == LOV_PATTERN_MDT)
2813                         llapi_printf(LLAPI_MSG_NORMAL, "0");
2814                 else
2815                         llapi_printf(LLAPI_MSG_NORMAL, "%u",
2816                                      objects[0].l_ost_idx);
2817                 if (!yaml && is_dir)
2818                         separator = " ";
2819                 else
2820                         separator = "\n";
2821         }
2822
2823         if ((verbose & VERBOSE_POOL) && pool_name && (pool_name[0] != '\0')) {
2824                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
2825                 if (verbose & ~VERBOSE_POOL)
2826                         llapi_printf(LLAPI_MSG_NORMAL, "%s%spool:          ",
2827                                      space, prefix);
2828                 llapi_printf(LLAPI_MSG_NORMAL, "%s", pool_name);
2829                 if (!yaml && is_dir)
2830                         separator = " ";
2831                 else
2832                         separator = "\n";
2833         }
2834
2835         if (strlen(separator) != 0)
2836                 llapi_printf(LLAPI_MSG_NORMAL, "\n");
2837 }
2838
2839 void lov_dump_user_lmm_v1v3(struct lov_user_md *lum, char *pool_name,
2840                             struct lov_user_ost_data_v1 *objects,
2841                             char *path, int obdindex, int depth,
2842                             enum llapi_layout_verbose verbose,
2843                             enum lov_dump_flags flags)
2844 {
2845         bool is_dir = flags & LDF_IS_DIR;
2846         bool indent = flags & LDF_INDENT;
2847         bool skip_objs = flags & LDF_SKIP_OBJS;
2848         bool yaml = flags & LDF_YAML;
2849         bool obdstripe = obdindex == OBD_NOT_FOUND;
2850         int i;
2851
2852         if (!obdstripe && !skip_objs) {
2853                 for (i = 0; !is_dir && i < lum->lmm_stripe_count; i++) {
2854                         if (obdindex == objects[i].l_ost_idx) {
2855                                 obdstripe = true;
2856                                 break;
2857                         }
2858                 }
2859         }
2860
2861         if (!obdstripe)
2862                 return;
2863
2864         lov_dump_user_lmm_header(lum, path, objects, verbose, depth, pool_name,
2865                                  flags);
2866
2867         if (!is_dir && !skip_objs && (verbose & VERBOSE_OBJID) &&
2868             !(lum->lmm_pattern & LOV_PATTERN_F_RELEASED ||
2869               lov_pattern(lum->lmm_pattern) == LOV_PATTERN_MDT)) {
2870                 char *space = "      - ";
2871
2872                 if (indent)
2873                         llapi_printf(LLAPI_MSG_NORMAL,
2874                                      "%6slmm_objects:\n", " ");
2875                 else if (yaml)
2876                         llapi_printf(LLAPI_MSG_NORMAL, "lmm_objects:\n");
2877                 else
2878                         llapi_printf(LLAPI_MSG_NORMAL,
2879                                 "\tobdidx\t\t objid\t\t objid\t\t group\n");
2880
2881                 for (i = 0; i < lum->lmm_stripe_count; i++) {
2882                         int idx = objects[i].l_ost_idx;
2883                         long long oid = ostid_id(&objects[i].l_ost_oi);
2884                         long long gr = ostid_seq(&objects[i].l_ost_oi);
2885
2886                         if (obdindex != OBD_NOT_FOUND && obdindex != idx)
2887                                 continue;
2888
2889                         if (yaml) {
2890                                 struct lu_fid fid = { 0 };
2891
2892                                 ostid_to_fid(&fid, &objects[i].l_ost_oi, idx);
2893                                 llapi_printf(LLAPI_MSG_NORMAL,
2894                                     "%sl_ost_idx: %d\n", space, idx);
2895                                 llapi_printf(LLAPI_MSG_NORMAL,
2896                                     "%8sl_fid:     "DFID_NOBRACE"\n",
2897                                     " ", PFID(&fid));
2898                         } else if (indent) {
2899                                 struct lu_fid fid = { 0 };
2900
2901                                 ostid_to_fid(&fid, &objects[i].l_ost_oi, idx);
2902                                 llapi_printf(LLAPI_MSG_NORMAL,
2903                                     "%s%d: { l_ost_idx: %d, l_fid: "DFID" }\n",
2904                                     space, i, idx, PFID(&fid));
2905                         } else {
2906                                 char fmt[48];
2907                                 sprintf(fmt, "%s%s%s\n",
2908                                         "\t%6u\t%14llu\t%#13llx\t",
2909                                         (fid_seq_is_rsvd(gr) ||
2910                                          fid_seq_is_mdt0(gr)) ?
2911                                          "%14llu" : "%#14llx", "%s");
2912                                 llapi_printf(LLAPI_MSG_NORMAL, fmt, idx, oid,
2913                                              oid, gr,
2914                                              obdindex == idx ? " *" : "");
2915                         }
2916                 }
2917         }
2918         llapi_printf(LLAPI_MSG_NORMAL, "\n");
2919 }
2920
2921 void lmv_dump_user_lmm(struct lmv_user_md *lum, char *pool_name,
2922                        char *path, int obdindex, int depth,
2923                        enum llapi_layout_verbose verbose,
2924                        enum lov_dump_flags flags)
2925 {
2926         struct lmv_user_mds_data *objects = lum->lum_objects;
2927         char *prefix = lum->lum_magic == LMV_USER_MAGIC ? "(Default)" : "";
2928         char *separator = "";
2929         bool yaml = flags & LDF_YAML;
2930         bool obdstripe = false;
2931         int i;
2932
2933         if (obdindex != OBD_NOT_FOUND) {
2934                 if (lum->lum_stripe_count == 0) {
2935                         if (obdindex == lum->lum_stripe_offset)
2936                                 obdstripe = true;
2937                 } else {
2938                         for (i = 0; i < lum->lum_stripe_count; i++) {
2939                                 if (obdindex == objects[i].lum_mds) {
2940                                         llapi_printf(LLAPI_MSG_NORMAL,
2941                                                      "%s%s\n", prefix,
2942                                                      path);
2943                                         obdstripe = true;
2944                                         break;
2945                                 }
2946                         }
2947                 }
2948         } else {
2949                 obdstripe = true;
2950         }
2951
2952         if (!obdstripe)
2953                 return;
2954
2955         /* show all information default */
2956         if (!verbose) {
2957                 if (lum->lum_magic == LMV_USER_MAGIC)
2958                         verbose = VERBOSE_POOL | VERBOSE_STRIPE_COUNT |
2959                                   VERBOSE_STRIPE_OFFSET | VERBOSE_HASH_TYPE;
2960                 else
2961                         verbose = VERBOSE_OBJID;
2962         }
2963
2964         if (depth && path && ((verbose != VERBOSE_OBJID)))
2965                 llapi_printf(LLAPI_MSG_NORMAL, "%s%s\n", prefix, path);
2966
2967         if (verbose & VERBOSE_STRIPE_COUNT) {
2968                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
2969                 if (verbose & ~VERBOSE_STRIPE_COUNT)
2970                         llapi_printf(LLAPI_MSG_NORMAL, "lmv_stripe_count: ");
2971                 llapi_printf(LLAPI_MSG_NORMAL, "%u",
2972                              (int)lum->lum_stripe_count);
2973                 if ((verbose & VERBOSE_STRIPE_OFFSET) && !yaml)
2974                         separator = " ";
2975                 else
2976                         separator = "\n";
2977         }
2978
2979         if (verbose & VERBOSE_STRIPE_OFFSET) {
2980                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
2981                 if (verbose & ~VERBOSE_STRIPE_OFFSET)
2982                         llapi_printf(LLAPI_MSG_NORMAL, "lmv_stripe_offset: ");
2983                 llapi_printf(LLAPI_MSG_NORMAL, "%d",
2984                              (int)lum->lum_stripe_offset);
2985                 if (verbose & VERBOSE_HASH_TYPE && !yaml)
2986                         separator = " ";
2987                 else
2988                         separator = "\n";
2989         }
2990
2991         if (verbose & VERBOSE_HASH_TYPE) {
2992                 unsigned int type = lum->lum_hash_type & LMV_HASH_TYPE_MASK;
2993                 unsigned int flags = lum->lum_hash_type & ~LMV_HASH_TYPE_MASK;
2994
2995                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
2996                 if (verbose & ~VERBOSE_HASH_TYPE)
2997                         llapi_printf(LLAPI_MSG_NORMAL, "lmv_hash_type: ");
2998                 if (type < LMV_HASH_TYPE_MAX)
2999                         llapi_printf(LLAPI_MSG_NORMAL, "%s",
3000                                      mdt_hash_name[type]);
3001                 else
3002                         llapi_printf(LLAPI_MSG_NORMAL, "%#x", type);
3003
3004                 if (flags & LMV_HASH_FLAG_SPACE)
3005                         llapi_printf(LLAPI_MSG_NORMAL, ",space");
3006                 if (flags & LMV_HASH_FLAG_MIGRATION)
3007                         llapi_printf(LLAPI_MSG_NORMAL, ",migrating");
3008                 if (flags & LMV_HASH_FLAG_BAD_TYPE)
3009                         llapi_printf(LLAPI_MSG_NORMAL, ",bad_type");
3010                 if (flags & LMV_HASH_FLAG_LOST_LMV)
3011                         llapi_printf(LLAPI_MSG_NORMAL, ",lost_lmv");
3012                 separator = "\n";
3013
3014         }
3015
3016         if (verbose & VERBOSE_OBJID && lum->lum_magic != LMV_USER_MAGIC) {
3017                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
3018                 if (lum->lum_stripe_count > 0)
3019                         llapi_printf(LLAPI_MSG_NORMAL,
3020                                      "mdtidx\t\t FID[seq:oid:ver]\n");
3021                 for (i = 0; i < lum->lum_stripe_count; i++) {
3022                         int idx = objects[i].lum_mds;
3023                         struct lu_fid *fid = &objects[i].lum_fid;
3024                         if ((obdindex == OBD_NOT_FOUND) || (obdindex == idx))
3025                                 llapi_printf(LLAPI_MSG_NORMAL,
3026                                              "%6u\t\t "DFID"\t\t%s\n",
3027                                             idx, PFID(fid),
3028                                             obdindex == idx ? " *" : "");
3029                 }
3030
3031         }
3032
3033         if ((verbose & VERBOSE_POOL) && pool_name != NULL &&
3034              pool_name[0] != '\0') {
3035                 llapi_printf(LLAPI_MSG_NORMAL, "%s", separator);
3036                 if (verbose & ~VERBOSE_POOL)
3037                         llapi_printf(LLAPI_MSG_NORMAL, "%slmv_pool:           ",
3038                                      prefix);
3039                 llapi_printf(LLAPI_MSG_NORMAL, "%s%c ", pool_name, ' ');
3040                 separator = "\n";
3041         }
3042
3043         if (!(verbose & VERBOSE_OBJID) || lum->lum_magic == LMV_USER_MAGIC)
3044                 llapi_printf(LLAPI_MSG_NORMAL, "\n");
3045 }
3046
3047 static void lov_dump_comp_v1_header(struct find_param *param, char *path,
3048                                     enum lov_dump_flags flags)
3049 {
3050         struct lov_comp_md_v1 *comp_v1 = (void *)&param->fp_lmd->lmd_lmm;
3051         int depth = param->fp_max_depth;
3052         enum llapi_layout_verbose verbose = param->fp_verbose;
3053         bool yaml = flags & LDF_YAML;
3054
3055         if (depth && path && ((verbose != VERBOSE_OBJID) ||
3056                               !(flags & LDF_IS_DIR)) && !yaml)
3057                 llapi_printf(LLAPI_MSG_NORMAL, "%s\n", path);
3058
3059         if (verbose & VERBOSE_DETAIL) {
3060                 llapi_printf(LLAPI_MSG_NORMAL, "composite_header:\n");
3061                 llapi_printf(LLAPI_MSG_NORMAL, "%2slcm_magic:         0x%08X\n",
3062                              " ", comp_v1->lcm_magic);
3063                 llapi_printf(LLAPI_MSG_NORMAL, "%2slcm_size:          %u\n",
3064                              " ", comp_v1->lcm_size);
3065                 if (flags & LDF_IS_DIR)
3066                         llapi_printf(LLAPI_MSG_NORMAL,
3067                                      "%2slcm_flags:         %s\n", " ",
3068                                      comp_v1->lcm_mirror_count > 0 ?
3069                                                         "mirrored" : "");
3070                 else
3071                         llapi_printf(LLAPI_MSG_NORMAL,
3072                                      "%2slcm_flags:         %s\n", " ",
3073                                 llapi_layout_flags_string(comp_v1->lcm_flags));
3074         }
3075
3076         if (verbose & VERBOSE_GENERATION) {
3077                 if (verbose & ~VERBOSE_GENERATION)
3078                         llapi_printf(LLAPI_MSG_NORMAL, "%2slcm_layout_gen:    ",
3079                                      " ");
3080                 llapi_printf(LLAPI_MSG_NORMAL, "%u\n", comp_v1->lcm_layout_gen);
3081         }
3082
3083         if (verbose & VERBOSE_MIRROR_COUNT) {
3084                 if (verbose & ~VERBOSE_MIRROR_COUNT)
3085                         llapi_printf(LLAPI_MSG_NORMAL, "%2slcm_mirror_count:  ",
3086                                      " ");
3087                 llapi_printf(LLAPI_MSG_NORMAL, "%u\n",
3088                              comp_v1->lcm_magic == LOV_USER_MAGIC_COMP_V1 ?
3089                              comp_v1->lcm_mirror_count + 1 : 1);
3090         }
3091
3092         if (verbose & VERBOSE_COMP_COUNT) {
3093                 if (verbose & ~VERBOSE_COMP_COUNT)
3094                         llapi_printf(LLAPI_MSG_NORMAL, "%2slcm_entry_count:   ",
3095                                      " ");
3096                 llapi_printf(LLAPI_MSG_NORMAL, "%u\n",
3097                              comp_v1->lcm_magic == LOV_USER_MAGIC_COMP_V1 ?
3098                              comp_v1->lcm_entry_count : 0);
3099         }
3100
3101         if (verbose & VERBOSE_DETAIL && !yaml)
3102                 llapi_printf(LLAPI_MSG_NORMAL, "components:\n");
3103 }
3104
3105 static void lcme_flags2str(__u32 comp_flags)
3106 {
3107         bool found = false;
3108         int i = 0;
3109
3110         if (!comp_flags) {
3111                 lla