Whamcloud - gitweb
LU-1214 ptlrpc: start minimum service threads
[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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2014, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 #ifndef _LUSTREAPI_H_
38 #define _LUSTREAPI_H_
39
40 /** \defgroup llapi llapi
41  *
42  * @{
43  */
44
45 #include <stdarg.h>
46 #include <stdint.h>
47 #include <lustre/lustre_user.h>
48
49 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
50                            void *args);
51
52 /* lustreapi message severity level */
53 enum llapi_message_level {
54         LLAPI_MSG_OFF    = 0,
55         LLAPI_MSG_FATAL  = 1,
56         LLAPI_MSG_ERROR  = 2,
57         LLAPI_MSG_WARN   = 3,
58         LLAPI_MSG_NORMAL = 4,
59         LLAPI_MSG_INFO   = 5,
60         LLAPI_MSG_DEBUG  = 6,
61         LLAPI_MSG_MAX
62 };
63
64 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
65                                      const char *fmt, va_list ap);
66
67
68 /* the bottom three bits reserved for llapi_message_level */
69 #define LLAPI_MSG_MASK          0x00000007
70 #define LLAPI_MSG_NO_ERRNO      0x00000010
71
72 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
73 {
74         static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
75                                                     "WARNING", "NORMAL",
76                                                     "INFO", "DEBUG"};
77
78         if (level >= LLAPI_MSG_MAX)
79                 return NULL;
80
81         return levels[level];
82 }
83 extern void llapi_msg_set_level(int level);
84 int llapi_msg_get_level(void);
85 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
86 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
87
88 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
89         __attribute__((__format__(__printf__, 3, 4)));
90 #define llapi_err_noerrno(level, fmt, a...)                     \
91         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
92 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
93         __attribute__((__format__(__printf__, 2, 3)));
94
95 struct llapi_stripe_param {
96         unsigned long long      lsp_stripe_size;
97         char                    *lsp_pool;
98         int                     lsp_stripe_offset;
99         int                     lsp_stripe_pattern;
100         /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
101         int                     lsp_stripe_count;
102         bool                    lsp_is_specific;
103         __u32                   lsp_osts[0];
104 };
105
106 extern int llapi_file_open_param(const char *name, int flags, mode_t mode,
107                                  const struct llapi_stripe_param *param);
108 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
109                              int stripe_offset, int stripe_count,
110                              int stripe_pattern);
111 extern int llapi_file_open(const char *name, int flags, int mode,
112                            unsigned long long stripe_size, int stripe_offset,
113                            int stripe_count, int stripe_pattern);
114 extern int llapi_file_create_pool(const char *name,
115                                   unsigned long long stripe_size,
116                                   int stripe_offset, int stripe_count,
117                                   int stripe_pattern, char *pool_name);
118 extern int llapi_file_open_pool(const char *name, int flags, int mode,
119                                 unsigned long long stripe_size,
120                                 int stripe_offset, int stripe_count,
121                                 int stripe_pattern, char *pool_name);
122 extern int llapi_poollist(const char *name);
123 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
124                               char *buffer, int buffer_size);
125 extern int llapi_get_poolmembers(const char *poolname, char **members,
126                                  int list_size, char *buffer, int buffer_size);
127 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
128 #define HAVE_LLAPI_FILE_LOOKUP
129 extern int llapi_file_lookup(int dirfd, const char *name);
130
131 #define VERBOSE_COUNT           0x1
132 #define VERBOSE_SIZE            0x2
133 #define VERBOSE_OFFSET          0x4
134 #define VERBOSE_POOL            0x8
135 #define VERBOSE_DETAIL          0x10
136 #define VERBOSE_OBJID           0x20
137 #define VERBOSE_GENERATION      0x40
138 #define VERBOSE_MDTINDEX        0x80
139 #define VERBOSE_LAYOUT          0x100
140 #define VERBOSE_ALL             (VERBOSE_COUNT | VERBOSE_SIZE | \
141                                  VERBOSE_OFFSET | VERBOSE_POOL | \
142                                  VERBOSE_OBJID | VERBOSE_GENERATION |\
143                                  VERBOSE_LAYOUT)
144
145 struct find_param {
146         unsigned int             fp_max_depth;
147         dev_t                    fp_dev;
148         mode_t                   fp_type; /* S_IFIFO,... */
149         uid_t                    fp_uid;
150         gid_t                    fp_gid;
151         time_t                   fp_atime;
152         time_t                   fp_mtime;
153         time_t                   fp_ctime;
154         /* {a,m,c}sign cannot be bitfields due to using pointers to
155          * access them during argument parsing. */
156         int                      fp_asign;
157         int                      fp_msign;
158         int                      fp_csign;
159         /* these need to be signed values */
160         int                      fp_size_sign:2,
161                                  fp_stripe_size_sign:2,
162                                  fp_stripe_count_sign:2;
163         unsigned long long       fp_size;
164         unsigned long long       fp_size_units;
165
166         unsigned long            fp_zero_end:1,
167                                  fp_recursive:1,
168                                  fp_exclude_pattern:1,
169                                  fp_exclude_type:1,
170                                  fp_exclude_obd:1,
171                                  fp_exclude_mdt:1,
172                                  fp_exclude_gid:1,
173                                  fp_exclude_uid:1,
174                                  fp_check_gid:1,
175                                  fp_check_uid:1,
176                                  fp_check_pool:1,       /* LOV pool name */
177                                  fp_check_size:1,       /* file size */
178                                  fp_exclude_pool:1,
179                                  fp_exclude_size:1,
180                                  fp_exclude_atime:1,
181                                  fp_exclude_mtime:1,
182                                  fp_exclude_ctime:1,
183                                  fp_get_lmv:1,  /* get MDT list from LMV */
184                                  fp_raw:1,      /* do not fill in defaults */
185                                  fp_check_stripe_size:1, /* LOV stripe size */
186                                  fp_exclude_stripe_size:1,
187                                  fp_check_stripe_count:1, /* LOV stripe count */
188                                  fp_exclude_stripe_count:1,
189                                  fp_check_layout:1,
190                                  fp_exclude_layout:1,
191                                  fp_get_default_lmv:1, /* Get default LMV */
192                                  fp_migrate:1;
193
194         int                      fp_verbose;
195         int                      fp_quiet;
196
197         /* regular expression */
198         char                    *fp_pattern;
199
200         struct  obd_uuid        *fp_obd_uuid;
201         int                      fp_num_obds;
202         int                      fp_num_alloc_obds;
203         int                      fp_obd_index;
204         int                     *fp_obd_indexes;
205
206         struct  obd_uuid        *fp_mdt_uuid;
207         int                      fp_num_mdts;
208         int                      fp_num_alloc_mdts;
209         int                      fp_mdt_index;
210         int                     *fp_mdt_indexes;
211         int                      fp_file_mdt_index;
212
213         size_t                   fp_lum_size;
214         struct  lov_user_mds_data *fp_lmd;
215
216         char                     fp_poolname[LOV_MAXPOOLNAME + 1];
217
218         __u32                    fp_lmv_stripe_count;
219         struct lmv_user_md      *fp_lmv_md;
220
221         unsigned long long       fp_stripe_size;
222         unsigned long long       fp_stripe_size_units;
223         unsigned long long       fp_stripe_count;
224         __u32                    fp_layout;
225
226         /* In-process parameters. */
227         unsigned long            fp_got_uuids:1,
228                                  fp_obds_printed:1;
229         unsigned int             fp_depth;
230 };
231
232 extern int llapi_ostlist(char *path, struct find_param *param);
233 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
234 extern int llapi_getstripe(char *path, struct find_param *param);
235 extern int llapi_find(char *path, struct find_param *param);
236
237 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
238 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
239                                            int stripe_count, int stripe_pattern,
240                                             const char *pool_name);
241 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
242                                  int stripe_count, int stripe_pattern,
243                                  const char *poolname);
244 int llapi_direntry_remove(char *dname);
245 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
246                      struct obd_statfs *stat_buf,
247                      struct obd_uuid *uuid_buf);
248 extern int llapi_ping(char *obd_type, char *obd_name);
249 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
250 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
251 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
252 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
253 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
254 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
255 extern int llapi_is_lustre_mnttype(const char *type);
256 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
257 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
258 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
259                             unsigned long long *size_units, int bytes_spec);
260 extern int llapi_search_mounts(const char *pathname, int index,
261                                char *mntdir, char *fsname);
262 extern int llapi_search_fsname(const char *pathname, char *fsname);
263 extern int llapi_getname(const char *path, char *buf, size_t size);
264
265 extern int llapi_search_rootpath(char *pathname, const char *fsname);
266 extern int llapi_nodemap_exists(const char *name);
267 extern int llapi_mv(char *path, struct find_param *param);
268
269 struct mntent;
270 #define HAVE_LLAPI_IS_LUSTRE_MNT
271 extern int llapi_is_lustre_mnt(struct mntent *mnt);
272 extern int llapi_quotachown(char *path, int flag);
273 extern int llapi_quotacheck(char *mnt, int check_type);
274 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
275 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
276 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
277                                 llapi_cb_t cb);
278 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
279 extern int llapi_lsetfacl(int argc, char *argv[]);
280 extern int llapi_lgetfacl(int argc, char *argv[]);
281 extern int llapi_rsetfacl(int argc, char *argv[]);
282 extern int llapi_rgetfacl(int argc, char *argv[]);
283 extern int llapi_cp(int argc, char *argv[]);
284 extern int llapi_ls(int argc, char *argv[]);
285 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
286                           int pathlen, long long *recno, int *linkno);
287 extern int llapi_path2fid(const char *path, lustre_fid *fid);
288 extern int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid,
289                                       int *mdt_index);
290 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
291 /* get FID of parent dir + the related name of entry in this parent dir */
292 extern int llapi_path2parent(const char *path, unsigned int linkno,
293                              lustre_fid *parent_fid, char *name,
294                              size_t name_size);
295 extern int llapi_fd2parent(int fd, unsigned int linkno,
296                            lustre_fid *parent_fid, char *name,
297                            size_t name_size);
298 extern int llapi_chomp_string(char *buf);
299 extern int llapi_open_by_fid(const char *dir, const lustre_fid *fid,
300                              int open_flags);
301
302 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
303 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
304 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
305 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
306 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
307                                   __u32 archive_id);
308 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
309                                __u32 archive_id);
310 extern int llapi_hsm_register_event_fifo(const char *path);
311 extern int llapi_hsm_unregister_event_fifo(const char *path);
312 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
313                                 const char *fmt, va_list args);
314
315 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
316 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
317 static inline int llapi_create_volatile(char *directory, int mode)
318 {
319         return llapi_create_volatile_idx(directory, -1, mode);
320 }
321
322
323 extern int llapi_fswap_layouts(const int fd1, const int fd2,
324                                __u64 dv1, __u64 dv2, __u64 flags);
325 extern int llapi_swap_layouts(const char *path1, const char *path2,
326                               __u64 dv1, __u64 dv2, __u64 flags);
327
328 /* Changelog interface.  priv is private state, managed internally by these
329  * functions */
330
331 /* Records received are in extentded format now, though most of them are still
332  * written in disk in changelog_rec format (to save space and time), it's
333  * converted to extented format in the lustre api to ease changelog analysis. */
334 #define HAVE_CHANGELOG_EXTEND_REC 1
335
336 extern int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
337                                  const char *mdtname, long long startrec);
338 extern int llapi_changelog_fini(void **priv);
339 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
340 extern int llapi_changelog_free(struct changelog_rec **rech);
341 /* Allow records up to endrec to be destroyed; requires registered id. */
342 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
343                                  long long endrec);
344
345 /* HSM copytool interface.
346  * priv is private state, managed internally by these functions
347  */
348 struct hsm_copytool_private;
349 struct hsm_copyaction_private;
350
351 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
352                                        const char *mnt, int archive_count,
353                                        int *archives, int rfd_flags);
354 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
355 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
356 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
357                                    struct hsm_action_list **hal, int *msgsize);
358 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
359                                   const struct hsm_copytool_private *ct,
360                                   const struct hsm_action_item *hai,
361                                   int restore_mdt_index, int restore_open_flags,
362                                   bool is_error);
363 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
364                                 const struct hsm_extent *he,
365                                 int hp_flags, int errval);
366 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
367                                      const struct hsm_extent *he, __u64 total,
368                                      int hp_flags);
369 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
370                                      lustre_fid *fid);
371 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
372 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
373                             unsigned long long stripe_size, int stripe_offset,
374                             int stripe_count, int stripe_pattern,
375                             char *pool_name, lustre_fid *newfid);
376
377 /* HSM user interface */
378 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
379                                                              int data_len);
380 extern int llapi_hsm_request(const char *path,
381                              const struct hsm_user_request *request);
382 extern int llapi_hsm_current_action(const char *path,
383                                     struct hsm_current_action *hca);
384
385 /* JSON handling */
386 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
387 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
388 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
389                                char *key, __u32 type, void *val);
390 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
391                                  FILE *fp);
392
393 /* File lease */
394 extern int llapi_lease_get(int fd, int mode);
395 extern int llapi_lease_check(int fd);
396 extern int llapi_lease_put(int fd);
397
398 /* Group lock */
399 int llapi_group_lock(int fd, int gid);
400 int llapi_group_unlock(int fd, int gid);
401
402 /** @} llapi */
403
404 /* llapi_layout user interface */
405
406 /** Opaque data type abstracting the layout of a Lustre file. */
407 struct llapi_layout;
408
409 /*
410  * Flags to control how layouts are retrieved.
411  */
412
413 /* Replace non-specified values with expected inherited values. */
414 #define LAYOUT_GET_EXPECTED 0x1
415
416 /**
417  * Return a pointer to a newly-allocated opaque data structure containing
418  * the layout for the file at \a path.  The pointer should be freed with
419  * llapi_layout_free() when it is no longer needed. Failure is indicated
420  * by a NULL return value and an appropriate error code stored in errno.
421  */
422 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
423
424 /**
425  * Return a pointer to a newly-allocated opaque data type containing the
426  * layout for the file referenced by open file descriptor \a fd.  The
427  * pointer should be freed with llapi_layout_free() when it is no longer
428  * needed. Failure is indicated by a NULL return value and an
429  * appropriate error code stored in errno.
430  */
431 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
432
433 /**
434  * Return a pointer to a newly-allocated opaque data type containing the
435  * layout for the file associated with Lustre file identifier string
436  * \a fidstr.  The string \a path must name a path within the
437  * filesystem that contains the file being looked up, such as the
438  * filesystem root.  The returned pointer should be freed with
439  * llapi_layout_free() when it is no longer needed.  Failure is
440  * indicated with a NULL return value and an appropriate error code
441  * stored in errno.
442  */
443 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
444                                              const lustre_fid *fid,
445                                              uint32_t flags);
446
447 /**
448  * Allocate a new layout. Use this when creating a new file with
449  * llapi_layout_file_create().
450  */
451 struct llapi_layout *llapi_layout_alloc(void);
452
453 /**
454  * Free memory allocated for \a layout.
455  */
456 void llapi_layout_free(struct llapi_layout *layout);
457
458 /** Not a valid stripe size, offset, or RAID pattern. */
459 #define LLAPI_LAYOUT_INVALID    0x1000000000000001ULL
460
461 /**
462  * When specified or returned as the value for stripe count,
463  * stripe size, offset, or RAID pattern, the filesystem-wide
464  * default behavior will apply.
465  */
466 #define LLAPI_LAYOUT_DEFAULT    (LLAPI_LAYOUT_INVALID + 1)
467
468 /**
469  * When specified or returned as the value for stripe count, all
470  * available OSTs will be used.
471  */
472 #define LLAPI_LAYOUT_WIDE       (LLAPI_LAYOUT_INVALID + 2)
473
474 /**
475  * When specified as the value for layout pattern, file objects will be
476  * stored using RAID0.  That is, data will be split evenly and without
477  * redundancy across all OSTs in the layout.
478  */
479 #define LLAPI_LAYOUT_RAID0      0
480
481 /**
482  * Flags to modify how layouts are retrieved.
483  */
484 /******************** Stripe Count ********************/
485
486 /**
487  * Store the stripe count of \a layout in \a count.
488  *
489  * \retval  0 Success
490  * \retval -1 Error with status code in errno.
491  */
492 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
493                                   uint64_t *count);
494
495 /**
496  * Set the stripe count of \a layout to \a count.
497  *
498  * \retval  0 Success.
499  * \retval -1 Invalid argument, errno set to EINVAL.
500  */
501 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
502
503 /******************** Stripe Size ********************/
504
505 /**
506  * Store the stripe size of \a layout in \a size.
507  *
508  * \retval  0 Success.
509  * \retval -1 Invalid argument, errno set to EINVAL.
510  */
511 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
512                                  uint64_t *size);
513
514 /**
515  * Set the stripe size of \a layout to \a stripe_size.
516  *
517  * \retval  0 Success.
518  * \retval -1 Invalid argument, errno set to EINVAL.
519  */
520 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
521
522 /******************** Stripe Pattern ********************/
523
524 /**
525  * Store the stripe pattern of \a layout in \a pattern.
526  *
527  * \retval 0  Success.
528  * \retval -1 Error with status code in errno.
529  */
530 int llapi_layout_pattern_get(const struct llapi_layout *layout,
531                              uint64_t *pattern);
532
533 /**
534  * Set the stripe pattern of \a layout to \a pattern.
535  *
536  * \retval  0 Success.
537  * \retval -1 Invalid argument, errno set to EINVAL.
538  */
539 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
540
541 /******************** OST Index ********************/
542
543 /**
544  * Store the index of the OST where stripe number \a stripe_number is stored
545  * in \a index.
546  *
547  * An error return value will result from a NULL layout, if \a
548  * stripe_number is out of range, or if \a layout was not initialized
549  * with llapi_layout_lookup_by{path,fd,fid}().
550  *
551  * \retval  0 Success
552  * \retval -1 Invalid argument, errno set to EINVAL.
553  */
554 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
555                                uint64_t stripe_number, uint64_t *index);
556
557 /**
558  * Set the OST index associated with stripe number \a stripe_number to
559  * \a ost_index.
560  * NB: This is currently supported only for \a stripe_number = 0 and
561  * other usage will return ENOTSUPP in errno.  A NULL \a layout or
562  * out-of-range \a stripe_number will return EINVAL in errno.
563  *
564  * \retval  0 Success.
565  * \retval -1 Error with errno set to non-zero value.
566  */
567 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
568                                uint64_t index);
569
570 /******************** Pool Name ********************/
571
572 /**
573  * Store up to \a pool_name_len characters of the name of the pool of
574  * OSTs associated with \a layout into the buffer pointed to by
575  * \a pool_name.
576  *
577  * The correct calling form is:
578  *
579  *   llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
580  *
581  * A pool defines a set of OSTs from which file objects may be
582  * allocated for a file using \a layout.
583  *
584  * On success, the number of bytes stored is returned, excluding the
585  * terminating '\0' character (zero indicates that \a layout does not
586  * have an associated OST pool).  On error, -1 is returned and errno is
587  * set appropriately. Possible sources of error include a NULL pointer
588  * argument or insufficient space in \a dest to store the pool name,
589  * in which cases errno will be set to EINVAL.
590  *
591  * \retval 0+           The number of bytes stored in \a dest.
592  * \retval -1           Invalid argument, errno set to EINVAL.
593  */
594 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
595                               char *pool_name, size_t pool_name_len);
596
597 /**
598  * Set the name of the pool of OSTs from which file objects will be
599  * allocated to \a pool_name.
600  *
601  * If the pool name uses "fsname.pool" notation to qualify the pool name
602  * with a filesystem name, the "fsname." portion will be silently
603  * discarded before storing the value. No validation that \a pool_name
604  * is an existing non-empty pool in filesystem \a fsname will be
605  * performed.  Such validation can be performed by the application if
606  * desired using the llapi_search_ost() function.  The maximum length of
607  * the stored value is defined by the constant LOV_MAXPOOLNAME.
608  *
609  * \retval  0   Success.
610  * \retval -1   Invalid argument, errno set to EINVAL.
611  */
612 int llapi_layout_pool_name_set(struct llapi_layout *layout,
613                               const char *pool_name);
614
615 /******************** File Creation ********************/
616
617 /**
618  * Open an existing file at \a path, or create it with the specified
619  * \a layout and \a mode.
620  *
621  * One access mode and zero or more file creation flags and file status
622  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
623  * open file descriptor for the file.  If \a layout is non-NULL and
624  * \a path is not on a Lustre filesystem this function will fail and set
625  * errno to ENOTTY.
626  *
627  * An already existing file may be opened with this function, but
628  * \a layout and \a mode will not be applied to it.  Callers requiring a
629  * guarantee that the opened file is created with the specified
630  * \a layout and \a mode should use llapi_layout_file_create().
631  *
632  * A NULL \a layout may be specified, in which case the standard Lustre
633  * behavior for assigning layouts to newly-created files will apply.
634  *
635  * \retval 0+ An open file descriptor.
636  * \retval -1 Error with status code in errno.
637  */
638 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
639                            const struct llapi_layout *layout);
640
641 /**
642  * Create a new file at \a path with the specified \a layout and \a mode.
643  *
644  * One access mode and zero or more file creation flags and file status
645  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
646  * open file descriptor for the file.  If \a layout is non-NULL and
647  * \a path is not on a Lustre filesystem this function will fail and set
648  * errno to ENOTTY.
649  *
650  * The function call
651  *
652  *   llapi_layout_file_create(path, open_flags, mode, layout)
653  *
654  * shall be equivalent to:
655  *
656  *   llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
657  *
658  * It is an error if \a path specifies an existing file.
659  *
660  * A NULL \a layout may be specified, in which the standard Lustre
661  * behavior for assigning layouts to newly-created files will apply.
662  *
663  * \retval 0+ An open file descriptor.
664  * \retval -1 Error with status code in errno.
665  */
666 int llapi_layout_file_create(const char *path, int open_flags, int mode,
667                              const struct llapi_layout *layout);
668
669 /** @} llapi */
670
671 #endif