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