1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * Copyright (c) 2011 Whamcloud, Inc.
36 * This file is part of Lustre, http://www.lustre.org/
37 * Lustre is a trademark of Sun Microsystems, Inc.
40 #ifndef _LIBLUSTREAPI_H_
41 #define _LIBLUSTREAPI_H_
43 /** \defgroup llapi llapi
48 #include <lustre/lustre_user.h>
50 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid, void *args);
52 /* liblustreapi message severity level */
53 enum llapi_message_level {
64 /* the bottom three bits reserved for llapi_message_level */
65 #define LLAPI_MSG_MASK 0x00000007
66 #define LLAPI_MSG_NO_ERRNO 0x00000010
69 extern void llapi_msg_set_level(int level);
70 extern void llapi_error(int level, int rc, char *fmt, ...);
71 #define llapi_err_noerrno(level, fmt, a...) \
72 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
73 extern void llapi_printf(int level, char *fmt, ...);
74 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
75 int stripe_offset, int stripe_count,
77 extern int llapi_file_open(const char *name, int flags, int mode,
78 unsigned long long stripe_size, int stripe_offset,
79 int stripe_count, int stripe_pattern);
80 extern int llapi_file_create_pool(const char *name,
81 unsigned long long stripe_size,
82 int stripe_offset, int stripe_count,
83 int stripe_pattern, char *pool_name);
84 extern int llapi_file_open_pool(const char *name, int flags, int mode,
85 unsigned long long stripe_size,
86 int stripe_offset, int stripe_count,
87 int stripe_pattern, char *pool_name);
88 extern int llapi_poollist(const char *name);
89 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
90 char *buffer, int buffer_size);
91 extern int llapi_get_poolmembers(const char *poolname, char **members,
92 int list_size, char *buffer, int buffer_size);
93 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
94 #define HAVE_LLAPI_FILE_LOOKUP
95 extern int llapi_file_lookup(int dirfd, const char *name);
97 #define VERBOSE_COUNT 0x1
98 #define VERBOSE_SIZE 0x2
99 #define VERBOSE_OFFSET 0x4
100 #define VERBOSE_POOL 0x8
101 #define VERBOSE_DETAIL 0x10
102 #define VERBOSE_OBJID 0x20
103 #define VERBOSE_GENERATION 0x40
104 #define VERBOSE_ALL (VERBOSE_COUNT | VERBOSE_SIZE | VERBOSE_OFFSET | \
105 VERBOSE_POOL | VERBOSE_OBJID | VERBOSE_GENERATION)
108 unsigned int maxdepth;
116 unsigned long long size;
118 unsigned long long size_units;
122 unsigned long zeroend:1,
149 /* regular expression */
154 struct obd_uuid *obduuid;
160 struct obd_uuid *mdtuuid;
168 struct lov_user_mds_data *lmd;
170 /* In-precess parameters. */
174 char poolname[LOV_MAXPOOLNAME + 1];
177 extern int llapi_ostlist(char *path, struct find_param *param);
178 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
179 extern int llapi_getstripe(char *path, struct find_param *param);
180 extern int llapi_find(char *path, struct find_param *param);
182 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
183 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
184 struct obd_statfs *stat_buf,
185 struct obd_uuid *uuid_buf);
186 extern int llapi_ping(char *obd_type, char *obd_name);
187 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
188 extern int llapi_catinfo(char *dir, char *keyword, char *node_name);
189 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
190 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
191 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
192 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
193 extern int llapi_is_lustre_mnttype(const char *type);
194 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
195 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
196 extern int parse_size(char *optarg, unsigned long long *size,
197 unsigned long long *size_units, int bytes_spec);
198 extern int llapi_path2fid(const char *path, lustre_fid *fid);
199 extern int llapi_search_mounts(const char *pathname, int index,
200 char *mntdir, char *fsname);
201 extern int llapi_search_fsname(const char *pathname, char *fsname);
202 extern int llapi_getname(const char *path, char *buf, size_t size);
204 extern void llapi_ping_target(char *obd_type, char *obd_name,
205 char *obd_uuid, void *args);
208 #define HAVE_LLAPI_IS_LUSTRE_MNT
209 extern int llapi_is_lustre_mnt(struct mntent *mnt);
210 extern int llapi_quotachown(char *path, int flag);
211 extern int llapi_quotacheck(char *mnt, int check_type);
212 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
213 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
214 extern int llapi_target_iterate(int type_num, char **obd_type, void *args, llapi_cb_t cb);
215 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
216 extern int llapi_lsetfacl(int argc, char *argv[]);
217 extern int llapi_lgetfacl(int argc, char *argv[]);
218 extern int llapi_rsetfacl(int argc, char *argv[]);
219 extern int llapi_rgetfacl(int argc, char *argv[]);
220 extern int llapi_cp(int argc, char *argv[]);
221 extern int llapi_ls(int argc, char *argv[]);
222 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
223 int pathlen, long long *recno, int *linkno);
224 extern int llapi_path2fid(const char *path, lustre_fid *fid);
225 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
227 /* Changelog interface. priv is private state, managed internally
228 by these functions */
229 #define CHANGELOG_FLAG_FOLLOW 0x01 /* Not yet implemented */
230 #define CHANGELOG_FLAG_BLOCK 0x02 /* Blocking IO makes sense in case of
231 slow user parsing of the records, but it also prevents us from cleaning
232 up if the records are not consumed. */
234 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
236 extern int llapi_changelog_fini(void **priv);
237 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
238 extern int llapi_changelog_free(struct changelog_rec **rech);
239 /* Allow records up to endrec to be destroyed; requires registered id. */
240 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
243 /* HSM copytool interface. priv is private state, managed internally
244 by these functions */
245 extern int llapi_copytool_start(void **priv, char *fsname, int flags,
246 int archive_count, int *archives);
247 extern int llapi_copytool_fini(void **priv);
248 extern int llapi_copytool_recv(void *priv, struct hsm_action_list **hal,
250 extern int llapi_copytool_free(struct hsm_action_list **hal);