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 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
73 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
77 if (level >= LLAPI_MSG_MAX)
82 extern void llapi_msg_set_level(int level);
83 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
84 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
86 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
87 __attribute__((__format__(__printf__, 3, 4)));
88 #define llapi_err_noerrno(level, fmt, a...) \
89 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
90 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
91 __attribute__((__format__(__printf__, 2, 3)));
93 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
94 int stripe_offset, int stripe_count,
96 extern int llapi_file_open(const char *name, int flags, int mode,
97 unsigned long long stripe_size, int stripe_offset,
98 int stripe_count, int stripe_pattern);
99 extern int llapi_file_create_pool(const char *name,
100 unsigned long long stripe_size,
101 int stripe_offset, int stripe_count,
102 int stripe_pattern, char *pool_name);
103 extern int llapi_file_open_pool(const char *name, int flags, int mode,
104 unsigned long long stripe_size,
105 int stripe_offset, int stripe_count,
106 int stripe_pattern, char *pool_name);
107 extern int llapi_poollist(const char *name);
108 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
109 char *buffer, int buffer_size);
110 extern int llapi_get_poolmembers(const char *poolname, char **members,
111 int list_size, char *buffer, int buffer_size);
112 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
113 #define HAVE_LLAPI_FILE_LOOKUP
114 extern int llapi_file_lookup(int dirfd, const char *name);
116 #define VERBOSE_COUNT 0x1
117 #define VERBOSE_SIZE 0x2
118 #define VERBOSE_OFFSET 0x4
119 #define VERBOSE_POOL 0x8
120 #define VERBOSE_DETAIL 0x10
121 #define VERBOSE_OBJID 0x20
122 #define VERBOSE_GENERATION 0x40
123 #define VERBOSE_MDTINDEX 0x80
124 #define VERBOSE_LAYOUT 0x100
125 #define VERBOSE_ALL (VERBOSE_COUNT | VERBOSE_SIZE | \
126 VERBOSE_OFFSET | VERBOSE_POOL | \
127 VERBOSE_OBJID | VERBOSE_GENERATION |\
131 unsigned int fp_max_depth;
133 mode_t fp_type; /* S_IFIFO,... */
139 /* {a,m,c}sign cannot be bitfields due to using pointers to
140 * access them during argument parsing. */
144 /* these need to be signed values */
148 unsigned long long size;
149 unsigned long long size_units;
151 unsigned long zeroend:1,
161 check_pool:1, /* LOV pool name */
162 check_size:1, /* file size */
168 get_lmv:1, /* get MDT list from LMV */
169 raw:1, /* do not fill in defaults */
170 check_stripesize:1, /* LOV stripe size */
171 exclude_stripesize:1,
172 check_stripecount:1, /* LOV stripe count */
173 exclude_stripecount:1,
176 get_default_lmv:1, /* Get default LMV */
182 /* regular expression */
185 struct obd_uuid *obduuid;
191 struct obd_uuid *mdtuuid;
199 struct lov_user_mds_data *lmd;
201 char poolname[LOV_MAXPOOLNAME + 1];
204 struct lmv_user_md *fp_lmv_md;
206 unsigned long long stripesize;
207 unsigned long long stripesize_units;
208 unsigned long long stripecount;
211 /* In-process parameters. */
212 unsigned long got_uuids:1,
214 have_fileinfo:1; /* file attrs and LOV xattr */
215 unsigned int fp_depth;
218 extern int llapi_ostlist(char *path, struct find_param *param);
219 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
220 extern int llapi_getstripe(char *path, struct find_param *param);
221 extern int llapi_find(char *path, struct find_param *param);
223 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
224 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
225 int stripe_count, int stripe_pattern,
226 const char *pool_name);
227 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
228 int stripe_count, int stripe_pattern,
229 const char *poolname);
230 int llapi_direntry_remove(char *dname);
231 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
232 struct obd_statfs *stat_buf,
233 struct obd_uuid *uuid_buf);
234 extern int llapi_ping(char *obd_type, char *obd_name);
235 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
236 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
237 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
238 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
239 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
240 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
241 extern int llapi_is_lustre_mnttype(const char *type);
242 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
243 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
244 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
245 unsigned long long *size_units, int bytes_spec);
246 extern int llapi_search_mounts(const char *pathname, int index,
247 char *mntdir, char *fsname);
248 extern int llapi_search_fsname(const char *pathname, char *fsname);
249 extern int llapi_getname(const char *path, char *buf, size_t size);
251 extern int llapi_search_rootpath(char *pathname, const char *fsname);
252 extern int llapi_nodemap_exists(const char *name);
253 extern int llapi_mv(char *path, struct find_param *param);
256 #define HAVE_LLAPI_IS_LUSTRE_MNT
257 extern int llapi_is_lustre_mnt(struct mntent *mnt);
258 extern int llapi_quotachown(char *path, int flag);
259 extern int llapi_quotacheck(char *mnt, int check_type);
260 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
261 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
262 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
264 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
265 extern int llapi_lsetfacl(int argc, char *argv[]);
266 extern int llapi_lgetfacl(int argc, char *argv[]);
267 extern int llapi_rsetfacl(int argc, char *argv[]);
268 extern int llapi_rgetfacl(int argc, char *argv[]);
269 extern int llapi_cp(int argc, char *argv[]);
270 extern int llapi_ls(int argc, char *argv[]);
271 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
272 int pathlen, long long *recno, int *linkno);
273 extern int llapi_path2fid(const char *path, lustre_fid *fid);
274 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
275 extern int llapi_chomp_string(char *buf);
277 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
278 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
279 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
280 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
281 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
283 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
285 extern int llapi_hsm_register_event_fifo(const char *path);
286 extern int llapi_hsm_unregister_event_fifo(const char *path);
287 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
288 const char *fmt, va_list args);
290 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
291 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
292 static inline int llapi_create_volatile(char *directory, int mode)
294 return llapi_create_volatile_idx(directory, -1, mode);
298 extern int llapi_fswap_layouts(const int fd1, const int fd2,
299 __u64 dv1, __u64 dv2, __u64 flags);
300 extern int llapi_swap_layouts(const char *path1, const char *path2,
301 __u64 dv1, __u64 dv2, __u64 flags);
303 /* Changelog interface. priv is private state, managed internally
304 by these functions */
305 #define CHANGELOG_FLAG_FOLLOW 0x01 /* Not yet implemented */
306 #define CHANGELOG_FLAG_BLOCK 0x02 /* Blocking IO makes sense in case of
307 slow user parsing of the records, but it also prevents us from cleaning
308 up if the records are not consumed. */
310 /* Records received are in extentded format now, though most of them are still
311 * written in disk in changelog_rec format (to save space and time), it's
312 * converted to extented format in the lustre api to ease changelog analysis. */
313 #define HAVE_CHANGELOG_EXTEND_REC 1
315 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
317 extern int llapi_changelog_fini(void **priv);
318 extern int llapi_changelog_recv(void *priv, struct changelog_ext_rec **rech);
319 extern int llapi_changelog_free(struct changelog_ext_rec **rech);
320 /* Allow records up to endrec to be destroyed; requires registered id. */
321 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
324 /* HSM copytool interface.
325 * priv is private state, managed internally by these functions
327 struct hsm_copytool_private;
328 struct hsm_copyaction_private;
330 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
331 const char *mnt, int archive_count,
332 int *archives, int rfd_flags);
333 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
334 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
335 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
336 struct hsm_action_list **hal, int *msgsize);
337 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
338 const struct hsm_copytool_private *ct,
339 const struct hsm_action_item *hai,
340 int restore_mdt_index, int restore_open_flags,
342 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
343 const struct hsm_extent *he,
344 int hp_flags, int errval);
345 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
346 const struct hsm_extent *he, __u64 total,
348 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
350 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
351 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
352 unsigned long long stripe_size, int stripe_offset,
353 int stripe_count, int stripe_pattern,
354 char *pool_name, lustre_fid *newfid);
356 /* HSM user interface */
357 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
359 extern int llapi_hsm_request(const char *path,
360 const struct hsm_user_request *request);
361 extern int llapi_hsm_current_action(const char *path,
362 struct hsm_current_action *hca);
365 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
366 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
367 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
368 char *key, __u32 type, void *val);
369 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,