Whamcloud - gitweb
78a2e444e55890b1135b1328d8fb5085b55d9d44
[fs/lustre-release.git] / lustre / include / lustre / lustreapi.h
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) 2004, 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  */
31
32 #ifndef _LUSTREAPI_H_
33 #define _LUSTREAPI_H_
34
35 /** \defgroup llapi llapi
36  *
37  * @{
38  */
39
40 #include <glob.h>
41 #include <stdarg.h>
42 #include <stdint.h>
43 #include <time.h>
44 #include <unistd.h>
45 #include <sys/types.h>
46 #include <linux/lustre/lustre_user.h>
47
48 #if defined(__cplusplus)
49 extern "C" {
50 #endif
51
52 #ifndef LL_MAXQUOTAS
53 #define LL_MAXQUOTAS 3
54 #endif
55
56 #ifndef SEL_UNIT_SIZE
57 #define SEL_UNIT_SIZE 1024llu
58 #endif
59
60 #ifndef LOV_PATTERN_DEFAULT
61 #define LOV_PATTERN_DEFAULT     0xffffffff
62 #endif
63
64 typedef struct statx lstatx_t;
65
66 #define lustre_fid struct lu_fid
67
68 /* Currently external applications can access this but in the
69  * future this will no longer be exposed for the user. Instead
70  * if you want to know if the library is initialized just call
71  * llapi_liblustreapi_initialized() which is now available. */
72 extern bool liblustreapi_initialized;
73
74 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
75                            void *args);
76
77 /* lustreapi message severity level */
78 enum llapi_message_level {
79         LLAPI_MSG_OFF    = 0,
80         LLAPI_MSG_FATAL  = 1,
81         LLAPI_MSG_ERROR  = 2,
82         LLAPI_MSG_WARN   = 3,
83         LLAPI_MSG_NORMAL = 4,
84         LLAPI_MSG_INFO   = 5,
85         LLAPI_MSG_DEBUG  = 6,
86         LLAPI_MSG_MAX
87 };
88
89 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
90                                      const char *fmt, va_list ap);
91
92 static inline bool llapi_liblustreapi_initialized(void)
93 {
94         return liblustreapi_initialized;
95 }
96
97 /* the bottom three bits reserved for llapi_message_level */
98 #define LLAPI_MSG_MASK          0x00000007
99 #define LLAPI_MSG_NO_ERRNO      0x00000010
100
101 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
102 {
103         static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
104                                                     "WARNING", "NORMAL",
105                                                     "INFO", "DEBUG"};
106
107         if (level >= LLAPI_MSG_MAX)
108                 return NULL;
109
110         return levels[level];
111 }
112
113 void llapi_msg_set_level(int level);
114 int llapi_msg_get_level(void);
115 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
116 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
117
118 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
119         __attribute__((__format__(__printf__, 3, 4)));
120 #define llapi_err_noerrno(level, fmt, a...)                     \
121         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
122 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
123         __attribute__((__format__(__printf__, 2, 3)));
124
125 struct llapi_stripe_param {
126         unsigned long long      lsp_stripe_size;
127         char                    *lsp_pool;
128         int                     lsp_stripe_offset;
129         int                     lsp_stripe_pattern;
130         /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
131         int                     lsp_stripe_count;
132         bool                    lsp_is_specific;
133         bool                    lsp_is_create;
134         __u32                   lsp_osts[0];
135 };
136
137 #define lsp_tgts        lsp_osts
138
139 __u32 llapi_pattern_to_lov(uint64_t pattern);
140
141 int llapi_file_open_param(const char *name, int flags, mode_t mode,
142                           const struct llapi_stripe_param *param);
143 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
144                               __u32 flags, char *foreign_lov);
145 int llapi_file_create(const char *name, unsigned long long stripe_size,
146                       int stripe_offset, int stripe_count, int stripe_pattern);
147 int llapi_file_open(const char *name, int flags, int mode,
148                     unsigned long long stripe_size, int stripe_offset,
149                     int stripe_count, int stripe_pattern);
150 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
151                            int stripe_offset, int stripe_count,
152                            int stripe_pattern, char *pool_name);
153 int llapi_file_open_pool(const char *name, int flags, int mode,
154                          unsigned long long stripe_size, int stripe_offset,
155                          int stripe_count, int stripe_pattern, char *pool_name);
156 int llapi_poollist(const char *name);
157 int llapi_get_poollist(const char *name, char **poollist, int list_size,
158                        char *buffer, int buffer_size);
159 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
160                           char *buffer, int buffer_size);
161 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
162 int llapi_file_lookup(int dirfd, const char *name);
163 void llapi_set_command_name(const char *cmd);
164 void llapi_clear_command_name(void);
165
166 enum llapi_layout_verbose  {
167         VERBOSE_STRIPE_COUNT    =     0x1,
168         VERBOSE_STRIPE_SIZE     =     0x2,
169         VERBOSE_STRIPE_OFFSET   =     0x4,
170         VERBOSE_POOL            =     0x8,
171         VERBOSE_DETAIL          =    0x10,
172         VERBOSE_OBJID           =    0x20,
173         VERBOSE_GENERATION      =    0x40,
174         VERBOSE_MDTINDEX        =    0x80,
175         VERBOSE_PATTERN         =   0x100,
176         VERBOSE_COMP_COUNT      =   0x200,
177         VERBOSE_COMP_FLAGS      =   0x400,
178         VERBOSE_COMP_START      =   0x800,
179         VERBOSE_COMP_END        =  0x1000,
180         VERBOSE_COMP_ID         =  0x2000,
181         VERBOSE_DFID            =  0x4000,
182         VERBOSE_HASH_TYPE       =  0x8000,
183         VERBOSE_MIRROR_COUNT    = 0x10000,
184         VERBOSE_MIRROR_ID       = 0x20000,
185         VERBOSE_EXT_SIZE        = 0x40000,
186         VERBOSE_DEFAULT         = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
187                                   VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
188                                   VERBOSE_OBJID | VERBOSE_GENERATION |
189                                   VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
190                                   VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
191                                   VERBOSE_COMP_START | VERBOSE_COMP_END |
192                                   VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
193                                   VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE
194 };
195 /* Compatibility with original names */
196 #define VERBOSE_SIZE    VERBOSE_STRIPE_SIZE
197 #define VERBOSE_COUNT   VERBOSE_STRIPE_COUNT
198 #define VERBOSE_OFFSET  VERBOSE_STRIPE_OFFSET
199 #define VERBOSE_LAYOUT  VERBOSE_PATTERN
200
201 enum {
202         NEWERXY_ATIME = 0,      /* neweraY */
203         NEWERXY_MTIME = 1,      /* newermY */
204         NEWERXY_CTIME = 2,      /* newercY */
205         NEWERXY_BTIME = 3,      /* newerbY | newerBY */
206         NEWERXY_MAX,
207 };
208
209 struct find_param {
210         unsigned int             fp_max_depth;
211         dev_t                    fp_dev;
212         mode_t                   fp_type; /* S_IFIFO,... */
213         uid_t                    fp_uid;
214         gid_t                    fp_gid;
215         time_t                   fp_atime;
216         time_t                   fp_mtime;
217         time_t                   fp_ctime;
218         /* {a,m,c,b}sign cannot be bitfields due to using pointers to
219          * access them during argument parsing. */
220         int                      fp_asign;
221         int                      fp_msign;
222         int                      fp_csign;
223         /* these need to be signed values */
224         int                      fp_size_sign:2,
225                                  fp_stripe_size_sign:2,
226                                  fp_stripe_count_sign:2,
227                                  fp_comp_start_sign:2,
228                                  fp_comp_end_sign:2,
229                                  fp_comp_count_sign:2,
230                                  fp_mirror_count_sign:2,
231                                  fp_mirror_index_sign:2,
232                                  fp_mirror_id_sign:2,
233                                  fp_mdt_count_sign:2,
234                                  fp_blocks_sign:2,
235                                  fp_ext_size_sign:2,
236                                  fp_unused1_sign:2, /* Fields available to use*/
237                                  fp_unused2_sign:2, /* Once used we must add  */
238                                  fp_unused3_sign:2, /* a separate flag field  */
239                                  fp_unused4_sign:2; /* at end of the struct.  */
240         unsigned long long       fp_size;
241         unsigned long long       fp_size_units;
242
243         unsigned long long       fp_zero_end:1,
244                                  fp_recursive:1,
245                                  fp_exclude_pattern:1,
246                                  fp_exclude_type:1,
247                                  fp_exclude_obd:1,
248                                  fp_exclude_mdt:1,
249                                  fp_exclude_gid:1,
250                                  fp_exclude_uid:1,
251                                  fp_check_gid:1,
252                                  fp_check_uid:1,
253                                  fp_check_pool:1,       /* LOV pool name */
254                                  fp_check_size:1,       /* file size */
255                                  fp_exclude_pool:1,
256                                  fp_exclude_size:1,
257                                  fp_exclude_atime:1,
258                                  fp_exclude_mtime:1,
259                                  fp_exclude_ctime:1,
260                                  fp_get_lmv:1,  /* get MDT list from LMV */
261                                  fp_raw:1,      /* do not fill in defaults */
262                                  fp_check_stripe_size:1, /* LOV stripe size */
263                                  fp_exclude_stripe_size:1,
264                                  fp_check_stripe_count:1, /* LOV stripe count */
265                                  fp_exclude_stripe_count:1,
266                                  fp_check_layout:1,
267                                  fp_exclude_layout:1,
268                                  fp_get_default_lmv:1, /* Get default LMV */
269                                  fp_migrate:1,
270                                  fp_check_projid:1,
271                                  fp_exclude_projid:1,
272                                  fp_check_comp_count:1,
273                                  fp_exclude_comp_count:1,
274                                  fp_check_mirror_count:1,
275                                  fp_exclude_mirror_count:1,
276                                  fp_check_comp_flags:1,
277                                  fp_check_mirror_state:1,
278                                  fp_check_comp_start:1,
279                                  fp_exclude_comp_start:1,
280                                  fp_check_comp_end:1,
281                                  fp_exclude_comp_end:1,
282                                  fp_check_comp_id:1,
283                                  fp_exclude_comp_id:1,
284                                  fp_check_mirror_id:1,
285                                  fp_exclude_mirror_id:1,
286                                  fp_check_mirror_index:1,
287                                  fp_exclude_mirror_index:1,
288                                  fp_check_mdt_count:1,
289                                  fp_exclude_mdt_count:1,
290                                  fp_check_hash_flag:1,
291                                  fp_exclude_hash_type:1,
292                                  fp_yaml:1,     /* output layout in YAML */
293                                  fp_check_blocks:1,
294                                  fp_exclude_blocks:1,
295                                  fp_check_foreign:1,
296                                  fp_exclude_foreign:1,
297                                  fp_check_ext_size:1, /* extension size */
298                                  fp_exclude_ext_size:1,
299                                  fp_lazy:1,
300                                  fp_newerxy:1,
301                                  fp_exclude_btime:1,
302                                  fp_unused_bit3:1, /* All of these unused bit */
303                                  fp_unused_bit4:1, /* fields available to use.*/
304                                  fp_unused_bit5:1, /* Once all unused fields  */
305                                  fp_unused_bit6:1, /* are used we need to add */
306                                  fp_unused_bit7:1; /* a separate flag field at*/
307                                                    /* the end of the struct.  */
308
309         enum llapi_layout_verbose fp_verbose;
310         int                      fp_quiet;
311
312         /* regular expression */
313         char                    *fp_pattern;
314
315         struct  obd_uuid        *fp_obd_uuid;
316         int                      fp_num_obds;
317         int                      fp_num_alloc_obds;
318         int                      fp_obd_index;
319         int                     *fp_obd_indexes;
320
321         struct  obd_uuid        *fp_mdt_uuid;
322         int                      fp_num_mdts;
323         int                      fp_num_alloc_mdts;
324         int                      fp_mdt_index;
325         int                     *fp_mdt_indexes;
326         int                      fp_file_mdt_index;
327
328         size_t                   fp_lum_size;
329         struct  lov_user_mds_data *fp_lmd;
330
331         char                     fp_poolname[LOV_MAXPOOLNAME + 1];
332
333         __u32                    fp_lmv_stripe_count;
334         struct lmv_user_md      *fp_lmv_md;
335
336         unsigned long long       fp_stripe_size;
337         unsigned long long       fp_stripe_size_units;
338         unsigned long long       fp_stripe_count;
339         __u32                    fp_layout;
340
341         __u32                    fp_comp_count;
342         __u32                    fp_mirror_count;
343         __u32                    fp_comp_flags;
344         __u32                    fp_comp_neg_flags;
345         __u16                    fp_mirror_state;
346         __u16                    fp_mirror_neg_state;
347         __u32                    fp_comp_id;
348         __u16                    fp_mirror_id;
349         __u16                    fp_mirror_index;
350         unsigned long long       fp_comp_start;
351         unsigned long long       fp_comp_start_units;
352         unsigned long long       fp_comp_end;
353         unsigned long long       fp_comp_end_units;
354         unsigned long long       fp_mdt_count;
355         unsigned                 fp_projid;
356         unsigned long long       fp_blocks;
357         unsigned long long       fp_blocks_units;
358
359         unsigned long            fp_got_uuids:1,
360                                  fp_obds_printed:1;
361         unsigned int             fp_depth;
362         unsigned int             fp_hash_type;
363         unsigned int             fp_time_margin; /* time margin in seconds */
364         __u32                    fp_foreign_type;
365         unsigned long long       fp_ext_size;
366         unsigned long long       fp_ext_size_units;
367
368         /*
369          * fp_newery[NEWERXY_MAX][0]: --newerXY reference
370          * fp_newery[NEWERXY_MAX][1]: ! -- newerXY reference
371          */
372         time_t                   fp_newery[NEWERXY_MAX][2];
373
374         time_t                   fp_btime;
375         int                      fp_bsign;
376         unsigned int             fp_hash_inflags;
377         unsigned int             fp_hash_exflags;
378 };
379
380 int llapi_ostlist(char *path, struct find_param *param);
381 int llapi_uuid_match(char *real_uuid, char *search_uuid);
382 int llapi_getstripe(char *path, struct find_param *param);
383 int llapi_find(char *path, struct find_param *param);
384
385 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
386 int llapi_dir_set_default_lmv(const char *name,
387                               const struct llapi_stripe_param *param);
388 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
389                                      int stripe_count, int stripe_pattern,
390                                      const char *pool_name);
391 int llapi_dir_create(const char *name, mode_t mode,
392                      const struct llapi_stripe_param *param);
393 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
394                              __u32 flags, const char *value);
395 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
396                           int stripe_count, int stripe_pattern,
397                           const char *poolname);
398 int llapi_direntry_remove(char *dname);
399 int llapi_unlink_foreign(char *dname);
400
401 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
402                       struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
403 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
404                      struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
405 int llapi_ping(char *obd_type, char *obd_name);
406 int llapi_target_check(int num_types, char **obd_types, char *dir);
407 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
408 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
409 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
410 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
411 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
412 int llapi_is_lustre_mnttype(const char *type);
413 int llapi_search_tgt(const char *fsname, const char *poolname,
414                      const char *tgtname, bool is_mdt);
415 int llapi_search_mdt(const char *fsname, const char *poolname,
416                      const char *mdtname);
417 int llapi_search_ost(const char *fsname, const char *poolname,
418                      const char *ostname);
419 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
420 int llapi_parse_size(const char *optarg, unsigned long long *size,
421                      unsigned long long *size_units, int bytes_spec);
422 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
423                         char *fsname);
424 int llapi_search_fsname(const char *pathname, char *fsname);
425 int llapi_get_fsname_instance(const char *path, char *fsname, size_t fsname_len,
426                               char *instance, size_t instance_len);
427 int llapi_get_instance(const char *path, char *instance, size_t instance_len);
428 int llapi_get_fsname(const char *path, char *fsname, size_t fsname_len);
429 int llapi_getname(const char *path, char *name, size_t namelen);
430 int llapi_search_fileset(const char *pathname, char *fileset);
431
432 int llapi_search_rootpath(char *pathname, const char *fsname);
433 int llapi_nodemap_exists(const char *name);
434 int llapi_migrate_mdt(char *path, struct find_param *param);
435 int llapi_mv(char *path, struct find_param *param);
436
437 struct mntent;
438
439 #define HAVE_LLAPI_IS_LUSTRE_MNT
440 int llapi_is_lustre_mnt(struct mntent *mnt);
441 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
442 int llapi_target_iterate(int type_num, char **obd_type, void *args,
443                          llapi_cb_t cb);
444 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
445 int llapi_cp(int argc, char *argv[]);
446 int llapi_ls(int argc, char *argv[]);
447 int llapi_fid_parse(const char *fidstr, struct lu_fid *fid, char **endptr);
448 int llapi_fid2path_at(int mnt_fd, const struct lu_fid *fid, char *path,
449                       int pathlen, long long *recno, int *linkno);
450 int llapi_fid2path(const char *device, const char *fidstr, char *path,
451                    int pathlen, long long *recno, int *linkno);
452 int llapi_path2fid(const char *path, struct lu_fid *fid);
453 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
454                                int *mdt_index);
455 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
456                        struct lov_user_md *lum, size_t lumsize);
457 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
458                       struct lov_user_md *lum, size_t lumsize);
459 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
460                           lstatx_t *statx, struct lov_user_md *lum,
461                           size_t lumsize);
462 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
463                          struct lov_user_md *lum, size_t lumsize);
464
465 int llapi_fd2fid(int fd, struct lu_fid *fid);
466 /* get FID of parent dir + the related name of entry in this parent dir */
467 int llapi_path2parent(const char *path, unsigned int linkno,
468                       struct lu_fid *parent_fid, char *name, size_t name_size);
469 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
470                     char *name, size_t name_size);
471 int llapi_rmfid(const char *path, struct fid_array *fa);
472 int llapi_chomp_string(char *buf);
473 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
474                       int open_flags);
475 int llapi_get_version_string(char *version, unsigned int version_size);
476 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
477 int llapi_get_version(char *buffer, int buffer_size, char **version)
478         __attribute__((deprecated));
479 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
480 int llapi_file_flush(int fd);
481 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
482 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
483 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
484 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
485                            __u32 archive_id);
486 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
487                         __u32 archive_id);
488 int llapi_hsm_register_event_fifo(const char *path);
489 int llapi_hsm_unregister_event_fifo(const char *path);
490 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
491                          const char *fmt, va_list args);
492
493 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
494 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
495                               int open_flags);
496 int llapi_create_volatile_param(const char *directory, int mdt_idx,
497                                 int open_flags, mode_t mode,
498                                 const struct llapi_stripe_param *stripe_param);
499
500 static inline int llapi_create_volatile(char *directory, int open_flags)
501 {
502         return llapi_create_volatile_idx(directory, -1, open_flags);
503 }
504
505
506 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
507                                   int gid, __u64 flags);
508 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
509 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
510                        __u64 dv2, __u64 flags);
511
512 /* Changelog interface.  priv is private state, managed internally by these
513  * functions */
514
515 /* Records received are in extended format now, though most of them are still
516  * written in disk in changelog_rec format (to save space and time), it's
517  * converted to extended format in the lustre api to ease changelog analysis. */
518 #define HAVE_CHANGELOG_EXTEND_REC 1
519
520 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
521                           const char *mdtname, long long startrec);
522 int llapi_changelog_fini(void **priv);
523 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
524 int llapi_changelog_in_buf(void *priv);
525 int llapi_changelog_free(struct changelog_rec **rech);
526 int llapi_changelog_get_fd(void *priv);
527 /* Allow records up to endrec to be destroyed; requires registered id. */
528 int llapi_changelog_clear(const char *mdtname, const char *idstr,
529                           long long endrec);
530 extern int llapi_changelog_set_xflags(void *priv,
531                                     enum changelog_send_extra_flag extra_flags);
532
533 /* HSM copytool interface.
534  * priv is private state, managed internally by these functions
535  */
536 struct hsm_copytool_private;
537 struct hsm_copyaction_private;
538
539 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
540                                 const char *mnt, int archive_count,
541                                 int *archives, int rfd_flags);
542 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
543 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
544 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
545                             struct hsm_action_list **hal, int *msgsize);
546 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
547                            const struct hsm_copytool_private *ct,
548                            const struct hsm_action_item *hai,
549                            int restore_mdt_index, int restore_open_flags,
550                            bool is_error);
551 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
552                          const struct hsm_extent *he, int hp_flags, int errval);
553 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
554                               const struct hsm_extent *he, __u64 total,
555                               int hp_flags);
556 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
557                               struct lu_fid *fid);
558 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
559 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
560                      unsigned long long stripe_size, int stripe_offset,
561                      int stripe_count, int stripe_pattern, char *pool_name,
562                      struct lu_fid *newfid);
563
564 /* HSM user interface */
565 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
566                                                       int data_len);
567 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
568 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
569
570 /* JSON handling */
571 enum llapi_json_types {
572         LLAPI_JSON_INTEGER = 1,
573         LLAPI_JSON_BIGNUM,
574         LLAPI_JSON_REAL,
575         LLAPI_JSON_STRING
576 };
577
578 struct llapi_json_item {
579         char                    *lji_key;
580         __u32                   lji_type;
581         union {
582                 int             lji_integer;
583                 __u64           lji_u64;
584                 double          lji_real;
585                 char            *lji_string;
586         };
587         struct llapi_json_item  *lji_next;
588 };
589
590 struct llapi_json_item_list {
591         int                     ljil_item_count;
592         struct llapi_json_item  *ljil_items;
593 };
594
595 int llapi_json_init_list(struct llapi_json_item_list **item_list);
596 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
597 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
598                         __u32 type, void *val);
599 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
600
601 /* File lease */
602 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
603 int llapi_lease_release(int fd);
604 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
605 int llapi_lease_check(int fd);
606 int llapi_lease_get(int fd, int mode); /* obsoleted */
607 int llapi_lease_put(int fd); /* obsoleted */
608
609 /* Group lock */
610 int llapi_group_lock(int fd, int gid);
611 int llapi_group_unlock(int fd, int gid);
612
613 bool llapi_file_is_sparse(int fd);
614 off_t llapi_data_seek(int src_fd, off_t offset, size_t *length);
615 int llapi_hole_punch(int fd, off_t start, size_t length);
616
617 /* Ladvise */
618 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
619                   struct llapi_lu_ladvise *ladvise);
620
621 /* PCC */
622 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
623 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
624                          __u32 id, enum lu_pcc_type type);
625 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
626                              __u32 id, enum lu_pcc_type type);
627 int llapi_pcc_detach_fd(int fd, __u32 option);
628 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
629                          __u32 option);
630 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
631                              __u32 option);
632 int llapi_pcc_detach_file(const char *path, __u32 option);
633 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
634 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
635 int llapi_pccdev_set(const char *mntpath, const char *cmd);
636 int llapi_pccdev_get(const char *mntpath);
637 /** @} llapi */
638
639 /* llapi_layout user interface */
640
641 /**
642  * An array element storing component info to be resynced during mirror
643  * resynchronization.
644  */
645 struct llapi_resync_comp {
646         uint64_t lrc_start;
647         uint64_t lrc_end;
648         uint32_t lrc_mirror_id;
649         uint32_t lrc_id;        /* component id */
650         bool lrc_synced;
651 };
652
653 /** Opaque data type abstracting the layout of a Lustre file. */
654 struct llapi_layout;
655
656 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
657 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
658                            size_t count, off_t pos);
659 uint32_t llapi_mirror_find(struct llapi_layout *layout,
660                            uint64_t file_start, uint64_t file_end,
661                            uint64_t *endp);
662 int llapi_layout_get_last_init_comp(struct llapi_layout *layout);
663 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
664                                 struct llapi_layout *m_layout);
665 int llapi_mirror_find_stale(struct llapi_layout *layout,
666                 struct llapi_resync_comp *comp, size_t comp_size,
667                 __u16 *mirror_ids, int ids_nr);
668 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
669                              struct llapi_resync_comp *comp_array,
670                              int comp_size,  uint64_t start, uint64_t end);
671 /*
672  * Flags to control how layouts are retrieved.
673  */
674
675 enum llapi_layout_get_flags {
676         /** Replace non-specified values with expected inherited values. */
677         LLAPI_LAYOUT_GET_EXPECTED       = 0x0001,
678         /** Use a temporary buffer to swab and return xattrs. */
679         LLAPI_LAYOUT_GET_COPY           = 0x0002,
680         /** Verify xattr contains sane layout values. */
681         LLAPI_LAYOUT_GET_CHECK          = 0x0004,
682 };
683 /* compatibility macros for old interfaces */
684 #define LAYOUT_GET_EXPECTED     LLAPI_LAYOUT_GET_EXPECTED
685 #define LLAPI_LXF_COPY          LLAPI_LAYOUT_GET_COPY
686 #define LLAPI_LXF_CHECK         LLAPI_LAYOUT_GET_CHECK
687
688 /**
689  * Return a pointer to a newly-allocated opaque data structure containing
690  * the layout for the file at \a path.  The pointer should be freed with
691  * llapi_layout_free() when it is no longer needed. Failure is indicated
692  * by a NULL return value and an appropriate error code stored in errno.
693  */
694 struct llapi_layout *llapi_layout_get_by_path(const char *path,
695                                              enum llapi_layout_get_flags flags);
696
697 /**
698  * Return a pointer to a newly-allocated opaque data type containing the
699  * layout for the file referenced by open file descriptor \a fd.  The
700  * pointer should be freed with llapi_layout_free() when it is no longer
701  * needed. Failure is indicated by a NULL return value and an
702  * appropriate error code stored in errno.
703  */
704 struct llapi_layout *llapi_layout_get_by_fd(int fd,
705                                             enum llapi_layout_get_flags flags);
706
707 /**
708  * Return a pointer to a newly-allocated opaque data type containing the
709  * layout for the file associated with Lustre file identifier
710  * \a fid.  The string \a path must name a path within the
711  * filesystem that contains the file being looked up, such as the
712  * filesystem root.  The returned pointer should be freed with
713  * llapi_layout_free() when it is no longer needed.  Failure is
714  * indicated with a NULL return value and an appropriate error code
715  * stored in errno.
716  */
717 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
718                                              const struct lu_fid *fid,
719                                              enum llapi_layout_get_flags flags);
720
721 /**
722  * Return a pointer to a newly-allocated opaque data type containing the
723  * layout for the file associated with extended attribute \a lov_xattr.  The
724  * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
725  * should be raw xattr without being swapped, since this function will swap it
726  * properly. Thus, \a lov_xattr will be modified during the process. If the
727  * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
728  * the objects count in lum is consistent with the stripe count in lum. This
729  * check only apply to regular file, so \a LLAPI_LAYOUT_GET_CHECK flag should
730  * be cleared if the xattr belongs to a directory. If the flag \a
731  * LLAPI_LAYOUT_GET_COPY is set, this function will use a temporary buffer for
732  * byte swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the
733  * byte swapping will be done to the \a lov_xattr buffer directly.  The returned
734  * pointer should be freed with llapi_layout_free() when it is no longer
735  * needed.  Failure is  * indicated with a NULL return value and an appropriate
736  * error code stored in errno.
737  */
738 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
739                                              ssize_t lov_xattr_size,
740                                              enum llapi_layout_get_flags flags);
741
742 /**
743  * Allocate a new layout. Use this when creating a new file with
744  * llapi_layout_file_create().
745  */
746 struct llapi_layout *llapi_layout_alloc(void);
747
748 /**
749  * Free memory allocated for \a layout.
750  */
751 void llapi_layout_free(struct llapi_layout *layout);
752
753 /**
754  * llapi_layout_merge() - Merge a composite layout into another one.
755  * @dst_layout: Destination composite layout.
756  * @src_layout: Source composite layout.
757  *
758  * This function copies all of the components from @src_layout and
759  * appends them to @dst_layout.
760  *
761  * Return: 0 on success or -1 on failure.
762  */
763 int llapi_layout_merge(struct llapi_layout **dst_layout,
764                        const struct llapi_layout *src_layout);
765
766 /** Not a valid stripe size, offset, or RAID pattern. */
767 #define LLAPI_LAYOUT_INVALID    0x1000000000000001ULL
768
769 /**
770  * When specified or returned as the value for stripe count,
771  * stripe size, offset, or RAID pattern, the filesystem-wide
772  * default behavior will apply.
773  */
774 #define LLAPI_LAYOUT_DEFAULT    (LLAPI_LAYOUT_INVALID + 1)
775
776 /**
777  * When specified or returned as the value for stripe count, all
778  * available OSTs will be used.
779  */
780 #define LLAPI_LAYOUT_WIDE       (LLAPI_LAYOUT_INVALID + 2)
781
782 /**
783  * When specified as the value for layout pattern, file objects will be
784  * stored using RAID0.  That is, data will be split evenly and without
785  * redundancy across all OSTs in the layout.
786  */
787 #define LLAPI_LAYOUT_RAID0              0ULL
788 #define LLAPI_LAYOUT_MDT                2ULL
789 #define LLAPI_LAYOUT_OVERSTRIPING       4ULL
790
791 /**
792 * The layout includes a specific set of OSTs on which to allocate.
793 */
794 #define LLAPI_LAYOUT_SPECIFIC   0x2000000000000000ULL
795
796 /**
797  * A valid ost index should be less than maximum valid OST index (UINT_MAX).
798  */
799 #define LLAPI_LAYOUT_IDX_MAX    0x00000000FFFFFFFFULL
800
801 /**
802  * Flags to modify how layouts are retrieved.
803  */
804 /******************** Stripe Count ********************/
805
806 /**
807  * Store the stripe count of \a layout in \a count.
808  *
809  * \retval  0 Success
810  * \retval -1 Error with status code in errno.
811  */
812 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
813                                   uint64_t *count);
814
815 /**
816  * Set the stripe count of \a layout to \a count.
817  *
818  * \retval  0 Success.
819  * \retval -1 Invalid argument, errno set to EINVAL.
820  */
821 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
822
823 /******************** Stripe Size ********************/
824
825 /**
826  * Store the stripe size of \a layout in \a size.
827  *
828  * \retval  0 Success.
829  * \retval -1 Invalid argument, errno set to EINVAL.
830  */
831 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
832                                  uint64_t *size);
833
834 /**
835  * Set the stripe size of \a layout to \a stripe_size.
836  *
837  * \retval  0 Success.
838  * \retval -1 Invalid argument, errno set to EINVAL.
839  */
840 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
841
842
843 /******************** Extension Size ********************/
844
845 /**
846  * Store the extension size of \a layout in \a size.
847  *
848  * \retval  0 Success.
849  * \retval -1 Invalid argument, errno set to EINVAL.
850  */
851 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
852                                     uint64_t *size);
853
854 /**
855  * Set the extension size of \a layout to \a stripe_size.
856  *
857  * \retval  0 Success.
858  * \retval -1 Invalid argument, errno set to EINVAL.
859  */
860 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
861
862
863 /******************** Stripe Pattern ********************/
864
865 /**
866  * Store the stripe pattern of \a layout in \a pattern.
867  *
868  * \retval 0  Success.
869  * \retval -1 Error with status code in errno.
870  */
871 int llapi_layout_pattern_get(const struct llapi_layout *layout,
872                              uint64_t *pattern);
873
874 /**
875  * Set the stripe pattern of \a layout to \a pattern.
876  *
877  * \retval  0 Success.
878  * \retval -1 Invalid argument, errno set to EINVAL.
879  */
880 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
881
882 /******************** OST Index ********************/
883
884 /**
885  * Store the index of the OST where stripe number \a stripe_number is stored
886  * in \a index.
887  *
888  * An error return value will result from a NULL layout, if \a
889  * stripe_number is out of range, or if \a layout was not initialized
890  * with llapi_layout_lookup_by{path,fd,fid}().
891  *
892  * \retval  0 Success
893  * \retval -1 Invalid argument, errno set to EINVAL.
894  */
895 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
896                                uint64_t stripe_number, uint64_t *index);
897
898 /**
899  * Set the OST index associated with stripe number \a stripe_number to
900  * \a ost_index.
901  * NB: This is currently supported only for \a stripe_number = 0 and
902  * other usage will return ENOTSUPP in errno.  A NULL \a layout or
903  * out-of-range \a stripe_number will return EINVAL in errno.
904  *
905  * \retval  0 Success.
906  * \retval -1 Error with errno set to non-zero value.
907  */
908 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
909                                uint64_t index);
910
911 /******************** Pool Name ********************/
912
913 /**
914  * Store up to \a pool_name_len characters of the name of the pool of
915  * OSTs associated with \a layout into the buffer pointed to by
916  * \a pool_name.
917  *
918  * The correct calling form is:
919  *
920  *   llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
921  *
922  * A pool defines a set of OSTs from which file objects may be
923  * allocated for a file using \a layout.
924  *
925  * On success, the number of bytes stored is returned, excluding the
926  * terminating '\0' character (zero indicates that \a layout does not
927  * have an associated OST pool).  On error, -1 is returned and errno is
928  * set appropriately. Possible sources of error include a NULL pointer
929  * argument or insufficient space in \a dest to store the pool name,
930  * in which cases errno will be set to EINVAL.
931  *
932  * \retval 0+           The number of bytes stored in \a dest.
933  * \retval -1           Invalid argument, errno set to EINVAL.
934  */
935 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
936                               char *pool_name, size_t pool_name_len);
937
938 /**
939  * Set the name of the pool of OSTs from which file objects will be
940  * allocated to \a pool_name.
941  *
942  * If the pool name uses "fsname.pool" notation to qualify the pool name
943  * with a filesystem name, the "fsname." portion will be silently
944  * discarded before storing the value. No validation that \a pool_name
945  * is an existing non-empty pool in filesystem \a fsname will be
946  * performed.  Such validation can be performed by the application if
947  * desired using the llapi_search_ost() function.  The maximum length of
948  * the stored value is defined by the constant LOV_MAXPOOLNAME.
949  *
950  * \retval  0   Success.
951  * \retval -1   Invalid argument, errno set to EINVAL.
952  */
953 int llapi_layout_pool_name_set(struct llapi_layout *layout,
954                               const char *pool_name);
955
956 /******************** File Creation ********************/
957
958 /**
959  * Open an existing file at \a path, or create it with the specified
960  * \a layout and \a mode.
961  *
962  * One access mode and zero or more file creation flags and file status
963  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
964  * open file descriptor for the file.  If \a layout is non-NULL and
965  * \a path is not on a Lustre filesystem this function will fail and set
966  * errno to ENOTTY.
967  *
968  * An already existing file may be opened with this function, but
969  * \a layout and \a mode will not be applied to it.  Callers requiring a
970  * guarantee that the opened file is created with the specified
971  * \a layout and \a mode should use llapi_layout_file_create().
972  *
973  * A NULL \a layout may be specified, in which case the standard Lustre
974  * behavior for assigning layouts to newly-created files will apply.
975  *
976  * \retval 0+ An open file descriptor.
977  * \retval -1 Error with status code in errno.
978  */
979 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
980                            const struct llapi_layout *layout);
981
982 /**
983  * Create a new file at \a path with the specified \a layout and \a mode.
984  *
985  * One access mode and zero or more file creation flags and file status
986  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
987  * open file descriptor for the file.  If \a layout is non-NULL and
988  * \a path is not on a Lustre filesystem this function will fail and set
989  * errno to ENOTTY.
990  *
991  * The function call
992  *
993  *   llapi_layout_file_create(path, open_flags, mode, layout)
994  *
995  * shall be equivalent to:
996  *
997  *   llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
998  *
999  * It is an error if \a path specifies an existing file.
1000  *
1001  * A NULL \a layout may be specified, in which the standard Lustre
1002  * behavior for assigning layouts to newly-created files will apply.
1003  *
1004  * \retval 0+ An open file descriptor.
1005  * \retval -1 Error with status code in errno.
1006  */
1007 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1008                              const struct llapi_layout *layout);
1009
1010 /**
1011  * Set flags to the header of component layout.
1012  */
1013 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
1014 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
1015 const char *llapi_layout_flags_string(uint32_t flags);
1016 const __u16 llapi_layout_string_flags(char *string);
1017
1018 /**
1019  * llapi_layout_mirror_count_get() - Get mirror count from the header of
1020  *                                   a layout.
1021  * @layout: Layout to get mirror count from.
1022  * @count:  Returned mirror count value.
1023  *
1024  * This function gets mirror count from the header of a layout.
1025  *
1026  * Return: 0 on success or -1 on failure.
1027  */
1028 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
1029                                   uint16_t *count);
1030
1031 /**
1032  * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
1033  * @layout: Layout to set mirror count in.
1034  * @count:  Mirror count value to be set.
1035  *
1036  * This function sets mirror count to the header of a layout.
1037  *
1038  * Return: 0 on success or -1 on failure.
1039  */
1040 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
1041                                   uint16_t count);
1042
1043 /**
1044  * Fetch the start and end offset of the current layout component.
1045  */
1046 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1047                                  uint64_t *start, uint64_t *end);
1048 /**
1049  * Set the extent of current layout component.
1050  */
1051 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1052                                  uint64_t start, uint64_t end);
1053
1054 /* PFL component flags table */
1055 static const struct comp_flag_name {
1056         enum lov_comp_md_entry_flags cfn_flag;
1057         const char *cfn_name;
1058 } comp_flags_table[] = {
1059         { LCME_FL_INIT,         "init" },
1060         { LCME_FL_STALE,        "stale" },
1061         { LCME_FL_PREF_RW,      "prefer" },
1062         { LCME_FL_OFFLINE,      "offline" },
1063         { LCME_FL_NOSYNC,       "nosync" },
1064         { LCME_FL_EXTENSION,    "extension" },
1065 };
1066
1067 /**
1068  * Gets the attribute flags of the current component.
1069  */
1070 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1071                                 uint32_t *flags);
1072 /**
1073  * Sets the specified flags of the current component leaving other flags as-is.
1074  */
1075 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
1076 /**
1077  * Clears the flags specified in the flags leaving other flags as-is.
1078  */
1079 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
1080 /**
1081  * Fetches the file-unique component ID of the current layout component.
1082  */
1083 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
1084 /**
1085  * Fetches the mirror ID of the current layout component.
1086  */
1087 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
1088 /**
1089  * Adds one component to the existing composite or plain layout.
1090  */
1091 int llapi_layout_comp_add(struct llapi_layout *layout);
1092 /**
1093  * Adds a first component of a mirror to the existing composite layout.
1094  */
1095 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1096 /**
1097  * Deletes the current layout component from the composite layout.
1098  */
1099 int llapi_layout_comp_del(struct llapi_layout *layout);
1100
1101 enum llapi_layout_comp_use {
1102         LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1103         LLAPI_LAYOUT_COMP_USE_LAST = 2,
1104         LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1105         LLAPI_LAYOUT_COMP_USE_PREV = 4,
1106 };
1107
1108 /**
1109  * Set the currently active component to the specified component ID.
1110  */
1111 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1112 /**
1113  * Select the currently active component at the specified position.
1114  */
1115 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1116 /**
1117  * Add layout components to an existing file.
1118  */
1119 int llapi_layout_file_comp_add(const char *path,
1120                                const struct llapi_layout *layout);
1121 /**
1122  * Delete component(s) by the specified component id or flags.
1123  */
1124 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1125 /**
1126  * Change flags or other parameters of the component(s) by component ID of an
1127  * existing file. The component to be modified is specified by the
1128  * comp->lcme_id value, which must be an unique component ID. The new
1129  * attributes are passed in by @comp and @valid is used to specify which
1130  * attributes in the component are going to be changed.
1131  */
1132 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1133                                size_t count);
1134 /**
1135  * Check if the file layout is composite.
1136  */
1137 bool llapi_layout_is_composite(struct llapi_layout *layout);
1138
1139 enum {
1140         LLAPI_LAYOUT_ITER_CONT = 0,
1141         LLAPI_LAYOUT_ITER_STOP = 1,
1142 };
1143
1144 /**
1145  * Iteration callback function.
1146  *
1147  * \retval LLAPI_LAYOUT_ITER_CONT       Iteration proceeds
1148  * \retval LLAPI_LAYOUT_ITER_STOP       Stop iteration
1149  * \retval < 0                          error code
1150  */
1151 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1152
1153 /**
1154  * Iterate all components in the corresponding layout
1155  */
1156 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1157                               llapi_layout_iter_cb cb, void *cbdata);
1158
1159 /**
1160  * FLR: mirror operation APIs
1161  */
1162 int llapi_mirror_set(int fd, unsigned int id);
1163 int llapi_mirror_clear(int fd);
1164 ssize_t llapi_mirror_read(int fd, unsigned int id,
1165                            void *buf, size_t count, off_t pos);
1166 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1167 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1168                       off_t pos, size_t count);
1169 off_t llapi_mirror_data_seek(int fd, unsigned int id, off_t pos, size_t *size);
1170 int llapi_mirror_punch(int fd, unsigned int id, off_t start, size_t length);
1171
1172 int llapi_heat_get(int fd, struct lu_heat *heat);
1173 int llapi_heat_set(int fd, __u64 flags);
1174
1175 int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr);
1176 void llapi_layout_sanity_perror(int error);
1177 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1178
1179 int llapi_param_get_paths(const char *pattern, glob_t *paths);
1180 int llapi_param_get_value(const char *path, char **buf, size_t *buflen);
1181 void llapi_param_paths_free(glob_t *paths);
1182
1183 /** @} llapi */
1184
1185 #if defined(__cplusplus)
1186 }
1187 #endif
1188
1189 #endif