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