4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
40 /** \defgroup llapi llapi
46 #include <lustre/lustre_user.h>
48 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
51 /* lustreapi message severity level */
52 enum llapi_message_level {
63 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
64 const char *fmt, va_list ap);
67 /* the bottom three bits reserved for llapi_message_level */
68 #define LLAPI_MSG_MASK 0x00000007
69 #define LLAPI_MSG_NO_ERRNO 0x00000010
71 extern void llapi_msg_set_level(int level);
72 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
73 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
75 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
76 __attribute__((__format__(__printf__, 3, 4)));
77 #define llapi_err_noerrno(level, fmt, a...) \
78 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
79 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
80 __attribute__((__format__(__printf__, 2, 3)));
82 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
83 int stripe_offset, int stripe_count,
85 extern int llapi_file_open(const char *name, int flags, int mode,
86 unsigned long long stripe_size, int stripe_offset,
87 int stripe_count, int stripe_pattern);
88 extern int llapi_file_create_pool(const char *name,
89 unsigned long long stripe_size,
90 int stripe_offset, int stripe_count,
91 int stripe_pattern, char *pool_name);
92 extern int llapi_file_open_pool(const char *name, int flags, int mode,
93 unsigned long long stripe_size,
94 int stripe_offset, int stripe_count,
95 int stripe_pattern, char *pool_name);
96 extern int llapi_poollist(const char *name);
97 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
98 char *buffer, int buffer_size);
99 extern int llapi_get_poolmembers(const char *poolname, char **members,
100 int list_size, char *buffer, int buffer_size);
101 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
102 #define HAVE_LLAPI_FILE_LOOKUP
103 extern int llapi_file_lookup(int dirfd, const char *name);
105 #define VERBOSE_COUNT 0x1
106 #define VERBOSE_SIZE 0x2
107 #define VERBOSE_OFFSET 0x4
108 #define VERBOSE_POOL 0x8
109 #define VERBOSE_DETAIL 0x10
110 #define VERBOSE_OBJID 0x20
111 #define VERBOSE_GENERATION 0x40
112 #define VERBOSE_MDTINDEX 0x80
113 #define VERBOSE_LAYOUT 0x100
114 #define VERBOSE_ALL (VERBOSE_COUNT | VERBOSE_SIZE | \
115 VERBOSE_OFFSET | VERBOSE_POOL | \
116 VERBOSE_OBJID | VERBOSE_GENERATION |\
120 unsigned int maxdepth;
124 /* cannot be bitfields due to using pointers to */
126 /* access them during argument parsing. */
130 /* these need to be signed values */
134 unsigned long long size;
135 unsigned long long size_units;
139 unsigned long zeroend:1,
147 check_gid:1, /* group ID */
148 check_uid:1, /* user ID */
149 check_pool:1, /* LOV pool name */
150 check_size:1, /* file size */
156 get_lmv:1, /* get MDT list from LMV */
157 raw:1, /* do not fill in defaults */
158 check_stripesize:1, /* LOV stripe size */
159 exclude_stripesize:1,
160 check_stripecount:1, /* LOV stripe count */
161 exclude_stripecount:1,
168 /* regular expression */
173 struct obd_uuid *obduuid;
179 struct obd_uuid *mdtuuid;
187 struct lov_user_mds_data *lmd;
189 char poolname[LOV_MAXPOOLNAME + 1];
192 struct lmv_user_md *fp_lmv_md;
194 unsigned long long stripesize;
195 unsigned long long stripesize_units;
196 unsigned long long stripecount;
199 /* In-process parameters. */
200 unsigned long got_uuids:1,
202 have_fileinfo:1; /* file attrs and LOV xattr */
211 extern int llapi_ostlist(char *path, struct find_param *param);
212 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
213 extern int llapi_getstripe(char *path, struct find_param *param);
214 extern int llapi_find(char *path, struct find_param *param);
216 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
217 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
218 int stripe_count, int stripe_pattern,
220 int llapi_direntry_remove(char *dname);
221 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
222 struct obd_statfs *stat_buf,
223 struct obd_uuid *uuid_buf);
224 extern int llapi_ping(char *obd_type, char *obd_name);
225 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
226 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
227 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
228 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
229 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
230 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
231 extern int llapi_is_lustre_mnttype(const char *type);
232 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
233 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
234 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
235 unsigned long long *size_units, int bytes_spec);
236 extern int llapi_search_mounts(const char *pathname, int index,
237 char *mntdir, char *fsname);
238 extern int llapi_search_fsname(const char *pathname, char *fsname);
239 extern int llapi_getname(const char *path, char *buf, size_t size);
241 extern void llapi_ping_target(char *obd_type, char *obd_name,
242 char *obd_uuid, void *args);
244 extern int llapi_search_rootpath(char *pathname, const char *fsname);
247 #define HAVE_LLAPI_IS_LUSTRE_MNT
248 extern int llapi_is_lustre_mnt(struct mntent *mnt);
249 extern int llapi_quotachown(char *path, int flag);
250 extern int llapi_quotacheck(char *mnt, int check_type);
251 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
252 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
253 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
255 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
256 extern int llapi_lsetfacl(int argc, char *argv[]);
257 extern int llapi_lgetfacl(int argc, char *argv[]);
258 extern int llapi_rsetfacl(int argc, char *argv[]);
259 extern int llapi_rgetfacl(int argc, char *argv[]);
260 extern int llapi_cp(int argc, char *argv[]);
261 extern int llapi_ls(int argc, char *argv[]);
262 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
263 int pathlen, long long *recno, int *linkno);
264 extern int llapi_path2fid(const char *path, lustre_fid *fid);
265 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
267 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
268 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
269 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
270 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
271 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
273 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
276 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
277 static inline int llapi_create_volatile(char *directory, int mode)
279 return llapi_create_volatile_idx(directory, -1, mode);
283 extern int llapi_fswap_layouts(const int fd1, const int fd2,
284 __u64 dv1, __u64 dv2, __u64 flags);
285 extern int llapi_swap_layouts(const char *path1, const char *path2,
286 __u64 dv1, __u64 dv2, __u64 flags);
288 /* Changelog interface. priv is private state, managed internally
289 by these functions */
290 #define CHANGELOG_FLAG_FOLLOW 0x01 /* Not yet implemented */
291 #define CHANGELOG_FLAG_BLOCK 0x02 /* Blocking IO makes sense in case of
292 slow user parsing of the records, but it also prevents us from cleaning
293 up if the records are not consumed. */
295 /* Records received are in extentded format now, though most of them are still
296 * written in disk in changelog_rec format (to save space and time), it's
297 * converted to extented format in the lustre api to ease changelog analysis. */
298 #define HAVE_CHANGELOG_EXTEND_REC 1
300 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
302 extern int llapi_changelog_fini(void **priv);
303 extern int llapi_changelog_recv(void *priv, struct changelog_ext_rec **rech);
304 extern int llapi_changelog_free(struct changelog_ext_rec **rech);
305 /* Allow records up to endrec to be destroyed; requires registered id. */
306 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
309 /* HSM copytool interface.
310 * priv is private state, managed internally by these functions
312 struct hsm_copytool_private;
313 struct hsm_copyaction_private;
315 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
316 const char *mnt, int flags,
317 int archive_count, int *archives);
318 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
319 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
320 struct hsm_action_list **hal, int *msgsize);
321 extern void llapi_hsm_action_list_free(struct hsm_action_list **hal);
322 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
323 const struct hsm_copytool_private *ct,
324 const struct hsm_action_item *hai,
325 int restore_mdt_index, int restore_open_flags,
327 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
328 const struct hsm_extent *he,
329 int hp_flags, int errval);
330 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
331 const struct hsm_extent *he, int hp_flags);
332 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
334 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
335 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
336 unsigned long long stripe_size, int stripe_offset,
337 int stripe_count, int stripe_pattern,
338 char *pool_name, lustre_fid *newfid);
340 /* HSM user interface */
341 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
343 extern int llapi_hsm_request(const char *path,
344 const struct hsm_user_request *request);
345 extern int llapi_hsm_current_action(const char *path,
346 struct hsm_current_action *hca);