Whamcloud - gitweb
5636ad08481c047972a8589b8d533e6dd4911c65
[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, 2016, 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 #ifndef LL_MAXQUOTAS
46 #define LL_MAXQUOTAS 3
47 #endif
48
49 #ifndef ARRAY_SIZE
50 #define ARRAY_SIZE(a) ((sizeof(a)) / (sizeof((a)[0])))
51 #endif
52
53 extern bool liblustreapi_initialized;
54
55
56 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
57                            void *args);
58
59 /* lustreapi message severity level */
60 enum llapi_message_level {
61         LLAPI_MSG_OFF    = 0,
62         LLAPI_MSG_FATAL  = 1,
63         LLAPI_MSG_ERROR  = 2,
64         LLAPI_MSG_WARN   = 3,
65         LLAPI_MSG_NORMAL = 4,
66         LLAPI_MSG_INFO   = 5,
67         LLAPI_MSG_DEBUG  = 6,
68         LLAPI_MSG_MAX
69 };
70
71 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
72                                      const char *fmt, va_list ap);
73
74
75 /* the bottom three bits reserved for llapi_message_level */
76 #define LLAPI_MSG_MASK          0x00000007
77 #define LLAPI_MSG_NO_ERRNO      0x00000010
78
79 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
80 {
81         static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
82                                                     "WARNING", "NORMAL",
83                                                     "INFO", "DEBUG"};
84
85         if (level >= LLAPI_MSG_MAX)
86                 return NULL;
87
88         return levels[level];
89 }
90
91 void llapi_msg_set_level(int level);
92 int llapi_msg_get_level(void);
93 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
94 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
95
96 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
97         __attribute__((__format__(__printf__, 3, 4)));
98 #define llapi_err_noerrno(level, fmt, a...)                     \
99         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
100 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
101         __attribute__((__format__(__printf__, 2, 3)));
102
103 struct llapi_stripe_param {
104         unsigned long long      lsp_stripe_size;
105         char                    *lsp_pool;
106         int                     lsp_stripe_offset;
107         int                     lsp_stripe_pattern;
108         /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
109         int                     lsp_stripe_count;
110         bool                    lsp_is_specific;
111         __u32                   lsp_osts[0];
112 };
113
114 int llapi_file_open_param(const char *name, int flags, mode_t mode,
115                           const struct llapi_stripe_param *param);
116 int llapi_file_create(const char *name, unsigned long long stripe_size,
117                       int stripe_offset, int stripe_count, int stripe_pattern);
118 int llapi_file_open(const char *name, int flags, int mode,
119                     unsigned long long stripe_size, int stripe_offset,
120                     int stripe_count, int stripe_pattern);
121 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
122                            int stripe_offset, int stripe_count,
123                            int stripe_pattern, char *pool_name);
124 int llapi_file_open_pool(const char *name, int flags, int mode,
125                          unsigned long long stripe_size, int stripe_offset,
126                          int stripe_count, int stripe_pattern, char *pool_name);
127 int llapi_poollist(const char *name);
128 int llapi_get_poollist(const char *name, char **poollist, int list_size,
129                        char *buffer, int buffer_size);
130 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
131                           char *buffer, int buffer_size);
132 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
133 int llapi_file_lookup(int dirfd, const char *name);
134
135 #define VERBOSE_COUNT              0x1
136 #define VERBOSE_SIZE               0x2
137 #define VERBOSE_OFFSET             0x4
138 #define VERBOSE_POOL               0x8
139 #define VERBOSE_DETAIL            0x10
140 #define VERBOSE_OBJID             0x20
141 #define VERBOSE_GENERATION        0x40
142 #define VERBOSE_MDTINDEX          0x80
143 #define VERBOSE_LAYOUT           0x100
144 #define VERBOSE_COMP_COUNT       0x200
145 #define VERBOSE_COMP_FLAGS       0x400
146 #define VERBOSE_COMP_START       0x800
147 #define VERBOSE_COMP_END        0x1000
148 #define VERBOSE_COMP_ID         0x2000
149 #define VERBOSE_DFID            0x4000
150 #define VERBOSE_HASH_TYPE       0x8000
151 #define VERBOSE_MIRROR_COUNT    0x10000
152 #define VERBOSE_DEFAULT         (VERBOSE_COUNT | VERBOSE_SIZE | \
153                                  VERBOSE_OFFSET | VERBOSE_POOL | \
154                                  VERBOSE_OBJID | VERBOSE_GENERATION | \
155                                  VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \
156                                  VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \
157                                  VERBOSE_COMP_START | VERBOSE_COMP_END | \
158                                  VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT)
159
160 struct find_param {
161         unsigned int             fp_max_depth;
162         dev_t                    fp_dev;
163         mode_t                   fp_type; /* S_IFIFO,... */
164         uid_t                    fp_uid;
165         gid_t                    fp_gid;
166         time_t                   fp_atime;
167         time_t                   fp_mtime;
168         time_t                   fp_ctime;
169         /* {a,m,c}sign cannot be bitfields due to using pointers to
170          * access them during argument parsing. */
171         int                      fp_asign;
172         int                      fp_msign;
173         int                      fp_csign;
174         /* these need to be signed values */
175         int                      fp_size_sign:2,
176                                  fp_stripe_size_sign:2,
177                                  fp_stripe_count_sign:2,
178                                  fp_comp_start_sign:2,
179                                  fp_comp_end_sign:2,
180                                  fp_comp_count_sign:2,
181                                  fp_mdt_count_sign:2;
182         unsigned long long       fp_size;
183         unsigned long long       fp_size_units;
184
185         unsigned long long       fp_zero_end:1,
186                                  fp_recursive:1,
187                                  fp_exclude_pattern:1,
188                                  fp_exclude_type:1,
189                                  fp_exclude_obd:1,
190                                  fp_exclude_mdt:1,
191                                  fp_exclude_gid:1,
192                                  fp_exclude_uid:1,
193                                  fp_check_gid:1,
194                                  fp_check_uid:1,
195                                  fp_check_pool:1,       /* LOV pool name */
196                                  fp_check_size:1,       /* file size */
197                                  fp_exclude_pool:1,
198                                  fp_exclude_size:1,
199                                  fp_exclude_atime:1,
200                                  fp_exclude_mtime:1,
201                                  fp_exclude_ctime:1,
202                                  fp_get_lmv:1,  /* get MDT list from LMV */
203                                  fp_raw:1,      /* do not fill in defaults */
204                                  fp_check_stripe_size:1, /* LOV stripe size */
205                                  fp_exclude_stripe_size:1,
206                                  fp_check_stripe_count:1, /* LOV stripe count */
207                                  fp_exclude_stripe_count:1,
208                                  fp_check_layout:1,
209                                  fp_exclude_layout:1,
210                                  fp_get_default_lmv:1, /* Get default LMV */
211                                  fp_migrate:1,
212                                  fp_check_projid:1,
213                                  fp_exclude_projid:1,
214                                  fp_check_comp_count:1,
215                                  fp_exclude_comp_count:1,
216                                  fp_check_comp_flags:1,
217                                  fp_exclude_comp_flags:1,
218                                  fp_check_comp_start:1,
219                                  fp_exclude_comp_start:1,
220                                  fp_check_comp_end:1,
221                                  fp_exclude_comp_end:1,
222                                  fp_check_comp_id:1,
223                                  fp_exclude_comp_id:1,
224                                  fp_check_mdt_count:1,
225                                  fp_exclude_mdt_count:1,
226                                  fp_check_hash_type:1,
227                                  fp_exclude_hash_type:1,
228                                  fp_yaml:1;     /* output layout in YAML */
229
230         int                      fp_verbose;
231         int                      fp_quiet;
232
233         /* regular expression */
234         char                    *fp_pattern;
235
236         struct  obd_uuid        *fp_obd_uuid;
237         int                      fp_num_obds;
238         int                      fp_num_alloc_obds;
239         int                      fp_obd_index;
240         int                     *fp_obd_indexes;
241
242         struct  obd_uuid        *fp_mdt_uuid;
243         int                      fp_num_mdts;
244         int                      fp_num_alloc_mdts;
245         int                      fp_mdt_index;
246         int                     *fp_mdt_indexes;
247         int                      fp_file_mdt_index;
248
249         size_t                   fp_lum_size;
250         struct  lov_user_mds_data *fp_lmd;
251
252         char                     fp_poolname[LOV_MAXPOOLNAME + 1];
253
254         __u32                    fp_lmv_stripe_count;
255         struct lmv_user_md      *fp_lmv_md;
256
257         unsigned long long       fp_stripe_size;
258         unsigned long long       fp_stripe_size_units;
259         unsigned long long       fp_stripe_count;
260         __u32                    fp_layout;
261
262         __u32                    fp_comp_count;
263         __u32                    fp_comp_flags;
264         __u32                    fp_comp_id;
265         unsigned long long       fp_comp_start;
266         unsigned long long       fp_comp_start_units;
267         unsigned long long       fp_comp_end;
268         unsigned long long       fp_comp_end_units;
269         unsigned long long       fp_mdt_count;
270         unsigned                 fp_projid;
271
272         /* In-process parameters. */
273         unsigned long            fp_got_uuids:1,
274                                  fp_obds_printed:1;
275         unsigned int             fp_depth;
276         unsigned int             fp_hash_type;
277 };
278
279 int llapi_ostlist(char *path, struct find_param *param);
280 int llapi_uuid_match(char *real_uuid, char *search_uuid);
281 int llapi_getstripe(char *path, struct find_param *param);
282 int llapi_find(char *path, struct find_param *param);
283
284 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
285 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
286                                      int stripe_count, int stripe_pattern,
287                                      const char *pool_name);
288 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
289                           int stripe_count, int stripe_pattern,
290                           const char *poolname);
291 int llapi_direntry_remove(char *dname);
292
293 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
294                       struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
295 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
296                      struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
297 int llapi_ping(char *obd_type, char *obd_name);
298 int llapi_target_check(int num_types, char **obd_types, char *dir);
299 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
300 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
301 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
302 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
303 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
304 int llapi_is_lustre_mnttype(const char *type);
305 int llapi_search_ost(char *fsname, char *poolname, char *ostname);
306 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
307 int llapi_parse_size(const char *optarg, unsigned long long *size,
308                      unsigned long long *size_units, int bytes_spec);
309 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
310                         char *fsname);
311 int llapi_search_fsname(const char *pathname, char *fsname);
312 int llapi_getname(const char *path, char *buf, size_t size);
313 int llapi_search_fileset(const char *pathname, char *fileset);
314
315 int llapi_search_rootpath(char *pathname, const char *fsname);
316 int llapi_nodemap_exists(const char *name);
317 int llapi_migrate_mdt(char *path, struct find_param *param);
318 int llapi_mv(char *path, struct find_param *param);
319
320 struct mntent;
321 #define HAVE_LLAPI_IS_LUSTRE_MNT
322 int llapi_is_lustre_mnt(struct mntent *mnt);
323 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
324 int llapi_target_iterate(int type_num, char **obd_type, void *args,
325                          llapi_cb_t cb);
326 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
327 int llapi_cp(int argc, char *argv[]);
328 int llapi_ls(int argc, char *argv[]);
329 int llapi_fid2path(const char *device, const char *fidstr, char *path,
330                    int pathlen, long long *recno, int *linkno);
331 int llapi_path2fid(const char *path, lustre_fid *fid);
332 int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid, int *mdt_index);
333 int llapi_fd2fid(int fd, lustre_fid *fid);
334 /* get FID of parent dir + the related name of entry in this parent dir */
335 int llapi_path2parent(const char *path, unsigned int linkno,
336                       lustre_fid *parent_fid, char *name, size_t name_size);
337 int llapi_fd2parent(int fd, unsigned int linkno, lustre_fid *parent_fid,
338                     char *name, size_t name_size);
339 int llapi_chomp_string(char *buf);
340 int llapi_open_by_fid(const char *dir, const lustre_fid *fid, int open_flags);
341
342 int llapi_get_version_string(char *version, unsigned int version_size);
343 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
344 int llapi_get_version(char *buffer, int buffer_size, char **version)
345         __attribute__((deprecated));
346 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
347 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
348 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
349 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
350 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
351                            __u32 archive_id);
352 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
353                         __u32 archive_id);
354 int llapi_hsm_register_event_fifo(const char *path);
355 int llapi_hsm_unregister_event_fifo(const char *path);
356 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
357                          const char *fmt, va_list args);
358
359 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
360 int llapi_create_volatile_idx(char *directory, int idx, int mode);
361
362 static inline int llapi_create_volatile(char *directory, int mode)
363 {
364         return llapi_create_volatile_idx(directory, -1, mode);
365 }
366
367
368 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
369                                   int gid, __u64 flags);
370 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
371 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
372                        __u64 dv2, __u64 flags);
373
374 /* Changelog interface.  priv is private state, managed internally by these
375  * functions */
376
377 /* Records received are in extended format now, though most of them are still
378  * written in disk in changelog_rec format (to save space and time), it's
379  * converted to extended format in the lustre api to ease changelog analysis. */
380 #define HAVE_CHANGELOG_EXTEND_REC 1
381
382 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
383                           const char *mdtname, long long startrec);
384 int llapi_changelog_fini(void **priv);
385 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
386 int llapi_changelog_free(struct changelog_rec **rech);
387 int llapi_changelog_get_fd(void *priv);
388 /* Allow records up to endrec to be destroyed; requires registered id. */
389 int llapi_changelog_clear(const char *mdtname, const char *idstr,
390                           long long endrec);
391
392 /* HSM copytool interface.
393  * priv is private state, managed internally by these functions
394  */
395 struct hsm_copytool_private;
396 struct hsm_copyaction_private;
397
398 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
399                                 const char *mnt, int archive_count,
400                                 int *archives, int rfd_flags);
401 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
402 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
403 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
404                             struct hsm_action_list **hal, int *msgsize);
405 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
406                            const struct hsm_copytool_private *ct,
407                            const struct hsm_action_item *hai,
408                            int restore_mdt_index, int restore_open_flags,
409                            bool is_error);
410 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
411                          const struct hsm_extent *he, int hp_flags, int errval);
412 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
413                               const struct hsm_extent *he, __u64 total,
414                               int hp_flags);
415 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
416                               lustre_fid *fid);
417 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
418 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
419                      unsigned long long stripe_size, int stripe_offset,
420                      int stripe_count, int stripe_pattern, char *pool_name,
421                      lustre_fid *newfid);
422
423 /* HSM user interface */
424 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
425                                                       int data_len);
426 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
427 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
428
429 /* JSON handling */
430 int llapi_json_init_list(struct llapi_json_item_list **item_list);
431 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
432 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
433                         __u32 type, void *val);
434 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
435
436 /* File lease */
437 int llapi_lease_get(int fd, int mode);
438 int llapi_lease_check(int fd);
439 int llapi_lease_put(int fd);
440 extern int llapi_lease_get_ext(int fd, struct ll_ioc_lease *data);
441
442 /* Group lock */
443 int llapi_group_lock(int fd, int gid);
444 int llapi_group_unlock(int fd, int gid);
445
446 /* Ladvise */
447 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
448                   struct llapi_lu_ladvise *ladvise);
449 /** @} llapi */
450
451 /* llapi_layout user interface */
452
453 /** Opaque data type abstracting the layout of a Lustre file. */
454 struct llapi_layout;
455
456 /*
457  * Flags to control how layouts are retrieved.
458  */
459
460 /* Replace non-specified values with expected inherited values. */
461 #define LAYOUT_GET_EXPECTED 0x1
462
463 /**
464  * Return a pointer to a newly-allocated opaque data structure containing
465  * the layout for the file at \a path.  The pointer should be freed with
466  * llapi_layout_free() when it is no longer needed. Failure is indicated
467  * by a NULL return value and an appropriate error code stored in errno.
468  */
469 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
470
471 /**
472  * Return a pointer to a newly-allocated opaque data type containing the
473  * layout for the file referenced by open file descriptor \a fd.  The
474  * pointer should be freed with llapi_layout_free() when it is no longer
475  * needed. Failure is indicated by a NULL return value and an
476  * appropriate error code stored in errno.
477  */
478 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
479
480 /**
481  * Return a pointer to a newly-allocated opaque data type containing the
482  * layout for the file associated with Lustre file identifier string
483  * \a fidstr.  The string \a path must name a path within the
484  * filesystem that contains the file being looked up, such as the
485  * filesystem root.  The returned pointer should be freed with
486  * llapi_layout_free() when it is no longer needed.  Failure is
487  * indicated with a NULL return value and an appropriate error code
488  * stored in errno.
489  */
490 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
491                                              const lustre_fid *fid,
492                                              uint32_t flags);
493
494 /**
495  * Allocate a new layout. Use this when creating a new file with
496  * llapi_layout_file_create().
497  */
498 struct llapi_layout *llapi_layout_alloc(void);
499
500 /**
501  * Free memory allocated for \a layout.
502  */
503 void llapi_layout_free(struct llapi_layout *layout);
504
505 /** Not a valid stripe size, offset, or RAID pattern. */
506 #define LLAPI_LAYOUT_INVALID    0x1000000000000001ULL
507
508 /**
509  * When specified or returned as the value for stripe count,
510  * stripe size, offset, or RAID pattern, the filesystem-wide
511  * default behavior will apply.
512  */
513 #define LLAPI_LAYOUT_DEFAULT    (LLAPI_LAYOUT_INVALID + 1)
514
515 /**
516  * When specified or returned as the value for stripe count, all
517  * available OSTs will be used.
518  */
519 #define LLAPI_LAYOUT_WIDE       (LLAPI_LAYOUT_INVALID + 2)
520
521 /**
522  * When specified as the value for layout pattern, file objects will be
523  * stored using RAID0.  That is, data will be split evenly and without
524  * redundancy across all OSTs in the layout.
525  */
526 #define LLAPI_LAYOUT_RAID0      0ULL
527 #define LLAPI_LAYOUT_MDT        2ULL
528
529 /**
530 * The layout includes a specific set of OSTs on which to allocate.
531 */
532 #define LLAPI_LAYOUT_SPECIFIC   0x2000000000000000ULL
533
534 /**
535  * A valid ost index should be less than maximum valid OST index (UINT_MAX).
536  */
537 #define LLAPI_LAYOUT_IDX_MAX    0x00000000FFFFFFFFULL
538
539 /**
540  * Flags to modify how layouts are retrieved.
541  */
542 /******************** Stripe Count ********************/
543
544 /**
545  * Store the stripe count of \a layout in \a count.
546  *
547  * \retval  0 Success
548  * \retval -1 Error with status code in errno.
549  */
550 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
551                                   uint64_t *count);
552
553 /**
554  * Set the stripe count of \a layout to \a count.
555  *
556  * \retval  0 Success.
557  * \retval -1 Invalid argument, errno set to EINVAL.
558  */
559 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
560
561 /******************** Stripe Size ********************/
562
563 /**
564  * Store the stripe size of \a layout in \a size.
565  *
566  * \retval  0 Success.
567  * \retval -1 Invalid argument, errno set to EINVAL.
568  */
569 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
570                                  uint64_t *size);
571
572 /**
573  * Set the stripe size of \a layout to \a stripe_size.
574  *
575  * \retval  0 Success.
576  * \retval -1 Invalid argument, errno set to EINVAL.
577  */
578 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
579
580 /******************** Stripe Pattern ********************/
581
582 /**
583  * Store the stripe pattern of \a layout in \a pattern.
584  *
585  * \retval 0  Success.
586  * \retval -1 Error with status code in errno.
587  */
588 int llapi_layout_pattern_get(const struct llapi_layout *layout,
589                              uint64_t *pattern);
590
591 /**
592  * Set the stripe pattern of \a layout to \a pattern.
593  *
594  * \retval  0 Success.
595  * \retval -1 Invalid argument, errno set to EINVAL.
596  */
597 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
598
599 /******************** OST Index ********************/
600
601 /**
602  * Store the index of the OST where stripe number \a stripe_number is stored
603  * in \a index.
604  *
605  * An error return value will result from a NULL layout, if \a
606  * stripe_number is out of range, or if \a layout was not initialized
607  * with llapi_layout_lookup_by{path,fd,fid}().
608  *
609  * \retval  0 Success
610  * \retval -1 Invalid argument, errno set to EINVAL.
611  */
612 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
613                                uint64_t stripe_number, uint64_t *index);
614
615 /**
616  * Set the OST index associated with stripe number \a stripe_number to
617  * \a ost_index.
618  * NB: This is currently supported only for \a stripe_number = 0 and
619  * other usage will return ENOTSUPP in errno.  A NULL \a layout or
620  * out-of-range \a stripe_number will return EINVAL in errno.
621  *
622  * \retval  0 Success.
623  * \retval -1 Error with errno set to non-zero value.
624  */
625 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
626                                uint64_t index);
627
628 /******************** Pool Name ********************/
629
630 /**
631  * Store up to \a pool_name_len characters of the name of the pool of
632  * OSTs associated with \a layout into the buffer pointed to by
633  * \a pool_name.
634  *
635  * The correct calling form is:
636  *
637  *   llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
638  *
639  * A pool defines a set of OSTs from which file objects may be
640  * allocated for a file using \a layout.
641  *
642  * On success, the number of bytes stored is returned, excluding the
643  * terminating '\0' character (zero indicates that \a layout does not
644  * have an associated OST pool).  On error, -1 is returned and errno is
645  * set appropriately. Possible sources of error include a NULL pointer
646  * argument or insufficient space in \a dest to store the pool name,
647  * in which cases errno will be set to EINVAL.
648  *
649  * \retval 0+           The number of bytes stored in \a dest.
650  * \retval -1           Invalid argument, errno set to EINVAL.
651  */
652 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
653                               char *pool_name, size_t pool_name_len);
654
655 /**
656  * Set the name of the pool of OSTs from which file objects will be
657  * allocated to \a pool_name.
658  *
659  * If the pool name uses "fsname.pool" notation to qualify the pool name
660  * with a filesystem name, the "fsname." portion will be silently
661  * discarded before storing the value. No validation that \a pool_name
662  * is an existing non-empty pool in filesystem \a fsname will be
663  * performed.  Such validation can be performed by the application if
664  * desired using the llapi_search_ost() function.  The maximum length of
665  * the stored value is defined by the constant LOV_MAXPOOLNAME.
666  *
667  * \retval  0   Success.
668  * \retval -1   Invalid argument, errno set to EINVAL.
669  */
670 int llapi_layout_pool_name_set(struct llapi_layout *layout,
671                               const char *pool_name);
672
673 /******************** File Creation ********************/
674
675 /**
676  * Open an existing file at \a path, or create it with the specified
677  * \a layout and \a mode.
678  *
679  * One access mode and zero or more file creation flags and file status
680  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
681  * open file descriptor for the file.  If \a layout is non-NULL and
682  * \a path is not on a Lustre filesystem this function will fail and set
683  * errno to ENOTTY.
684  *
685  * An already existing file may be opened with this function, but
686  * \a layout and \a mode will not be applied to it.  Callers requiring a
687  * guarantee that the opened file is created with the specified
688  * \a layout and \a mode should use llapi_layout_file_create().
689  *
690  * A NULL \a layout may be specified, in which case the standard Lustre
691  * behavior for assigning layouts to newly-created files will apply.
692  *
693  * \retval 0+ An open file descriptor.
694  * \retval -1 Error with status code in errno.
695  */
696 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
697                            const struct llapi_layout *layout);
698
699 /**
700  * Create a new file at \a path with the specified \a layout and \a mode.
701  *
702  * One access mode and zero or more file creation flags and file status
703  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
704  * open file descriptor for the file.  If \a layout is non-NULL and
705  * \a path is not on a Lustre filesystem this function will fail and set
706  * errno to ENOTTY.
707  *
708  * The function call
709  *
710  *   llapi_layout_file_create(path, open_flags, mode, layout)
711  *
712  * shall be equivalent to:
713  *
714  *   llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
715  *
716  * It is an error if \a path specifies an existing file.
717  *
718  * A NULL \a layout may be specified, in which the standard Lustre
719  * behavior for assigning layouts to newly-created files will apply.
720  *
721  * \retval 0+ An open file descriptor.
722  * \retval -1 Error with status code in errno.
723  */
724 int llapi_layout_file_create(const char *path, int open_flags, int mode,
725                              const struct llapi_layout *layout);
726
727 /**
728  * Set flags to the header of component layout.
729  */
730 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
731 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
732
733 /**
734  * Fetch the start and end offset of the current layout component.
735  */
736 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
737                                  uint64_t *start, uint64_t *end);
738 /**
739  * Set the extent of current layout component.
740  */
741 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
742                                  uint64_t start, uint64_t end);
743
744 /* PFL component flags table */
745 static const struct comp_flag_name {
746         enum lov_comp_md_entry_flags cfn_flag;
747         const char *cfn_name;
748 } comp_flags_table[] = {
749         { LCME_FL_INIT,         "init" },
750         /* For now, only "init" is supported
751         { LCME_FL_PRIMARY,      "primary" },
752         { LCME_FL_STALE,        "stale" },
753         { LCME_FL_OFFLINE,      "offline" },
754         { LCME_FL_PREFERRED,    "preferred" }
755         */
756 };
757
758 /**
759  * Gets the attribute flags of the current component.
760  */
761 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
762                                 uint32_t *flags);
763 /**
764  * Sets the specified flags of the current component leaving other flags as-is.
765  */
766 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
767 /**
768  * Clears the flags specified in the flags leaving other flags as-is.
769  */
770 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
771 /**
772  * Fetches the file-unique component ID of the current layout component.
773  */
774 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
775 /**
776  * Fetches the mirror ID of the current layout component.
777  */
778 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
779 /**
780  * Adds one component to the existing composite or plain layout.
781  */
782 int llapi_layout_comp_add(struct llapi_layout *layout);
783 /**
784  * Deletes the current layout component from the composite layout.
785  */
786 int llapi_layout_comp_del(struct llapi_layout *layout);
787
788 enum llapi_layout_comp_use {
789         LLAPI_LAYOUT_COMP_USE_FIRST = 1,
790         LLAPI_LAYOUT_COMP_USE_LAST = 2,
791         LLAPI_LAYOUT_COMP_USE_NEXT = 3,
792         LLAPI_LAYOUT_COMP_USE_PREV = 4,
793 };
794
795 /**
796  * Set the currently active component to the specified component ID.
797  */
798 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
799 /**
800  * Select the currently active component at the specified position.
801  */
802 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
803 /**
804  * Add layout components to an existing file.
805  */
806 int llapi_layout_file_comp_add(const char *path,
807                                const struct llapi_layout *layout);
808 /**
809  * Delete component(s) by the specified component id or flags.
810  */
811 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
812 /**
813  * Change flags or other parameters of the component(s) by component ID of an
814  * existing file. The component to be modified is specified by the
815  * comp->lcme_id value, which must be an unique component ID. The new
816  * attributes are passed in by @comp and @valid is used to specify which
817  * attributes in the component are going to be changed.
818  */
819 int llapi_layout_file_comp_set(const char *path,
820                                const struct llapi_layout *comp,
821                                uint32_t valid);
822 /**
823  * Check if the file layout is composite.
824  */
825 bool llapi_layout_is_composite(struct llapi_layout *layout);
826
827 /**
828  * FLR: mirror operation APIs
829  */
830 int llapi_mirror_set(int fd, unsigned int id);
831 int llapi_mirror_clear(int fd);
832 ssize_t llapi_mirror_read(int fd, unsigned int id,
833                            void *buf, size_t count, off_t pos);
834 ssize_t llapi_mirror_copy_many(int fd, unsigned int src,
835                                 unsigned int *dst, size_t count);
836 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
837                        off_t pos, size_t count);
838
839 /** @} llapi */
840
841 #endif