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 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef _LIBLUSTREAPI_H_
38 #define _LIBLUSTREAPI_H_
40 /** \defgroup llapi llapi
45 #include <lustre/lustre_user.h>
47 /* Initially allocate for these many OSTs, realloc if needed */
48 #define INIT_ALLOC_NUM_OSTS 1024
50 /* Maximum number of osts that can be specified to lfs find */
51 #define FIND_MAX_OSTS 1024
53 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid, void *args);
55 /* liblustreapi message severity level */
56 enum llapi_message_level {
67 /* the bottom three bits reserved for llapi_message_level */
68 #define LLAPI_MSG_MASK 0x00000007
69 #define LLAPI_MSG_NO_ERRNO 0x00000010
72 extern void llapi_msg_set_level(int level);
73 extern void llapi_err(int level, char *fmt, ...);
74 extern void llapi_printf(int level, char *fmt, ...);
75 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
76 int stripe_offset, int stripe_count,
78 extern int llapi_file_open(const char *name, int flags, int mode,
79 unsigned long long stripe_size, int stripe_offset,
80 int stripe_count, int stripe_pattern);
81 extern int llapi_file_create_pool(const char *name,
82 unsigned long long stripe_size,
83 int stripe_offset, int stripe_count,
84 int stripe_pattern, char *pool_name);
85 extern int llapi_file_open_pool(const char *name, int flags, int mode,
86 unsigned long long stripe_size,
87 int stripe_offset, int stripe_count,
88 int stripe_pattern, char *pool_name);
89 extern int llapi_poollist(const char *name);
90 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
91 char *buffer, int buffer_size);
92 extern int llapi_get_poolmembers(const char *poolname, char **members,
93 int list_size, char *buffer, int buffer_size);
94 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
95 #define HAVE_LLAPI_FILE_LOOKUP
96 extern int llapi_file_lookup(int dirfd, const char *name);
98 #define VERBOSE_COUNT 0x1
99 #define VERBOSE_SIZE 0x2
100 #define VERBOSE_OFFSET 0x4
101 #define VERBOSE_POOL 0x8
102 #define VERBOSE_DETAIL 0x10
103 #define VERBOSE_OBJID 0x20
104 #define VERBOSE_ALL (VERBOSE_COUNT | VERBOSE_SIZE | VERBOSE_OFFSET | \
105 VERBOSE_POOL | VERBOSE_OBJID)
108 unsigned int maxdepth;
116 unsigned long long size;
118 unsigned long long size_units;
122 unsigned long zeroend:1,
141 /* regular expression */
146 struct obd_uuid *obduuid;
153 struct lov_user_mds_data *lmd;
155 /* In-precess parameters. */
159 char poolname[LOV_MAXPOOLNAME + 1];
162 extern int llapi_ostlist(char *path, struct find_param *param);
163 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
164 extern int llapi_getstripe(char *path, struct find_param *param);
165 extern int llapi_find(char *path, struct find_param *param);
167 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
168 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
169 struct obd_statfs *stat_buf,
170 struct obd_uuid *uuid_buf);
171 extern int llapi_ping(char *obd_type, char *obd_name);
172 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
173 extern int llapi_catinfo(char *dir, char *keyword, char *node_name);
174 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
175 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
176 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
177 extern int llapi_is_lustre_mnttype(const char *type);
178 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
179 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
180 extern int parse_size(char *optarg, unsigned long long *size,
181 unsigned long long *size_units, int bytes_spec);
182 extern int llapi_path2fid(const char *path, lustre_fid *fid);
183 extern int llapi_search_mounts(const char *pathname, int index,
184 char *mntdir, char *fsname);
185 extern int llapi_search_fsname(const char *pathname, char *fsname);
186 extern void llapi_ping_target(char *obd_type, char *obd_name,
187 char *obd_uuid, void *args);
190 #define HAVE_LLAPI_IS_LUSTRE_MNT
191 extern int llapi_is_lustre_mnt(struct mntent *mnt);
192 extern int llapi_quotachown(char *path, int flag);
193 extern int llapi_quotacheck(char *mnt, int check_type);
194 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
195 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
196 extern int llapi_target_iterate(int type_num, char **obd_type, void *args, llapi_cb_t cb);
197 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
198 extern int llapi_lsetfacl(int argc, char *argv[]);
199 extern int llapi_lgetfacl(int argc, char *argv[]);
200 extern int llapi_rsetfacl(int argc, char *argv[]);
201 extern int llapi_rgetfacl(int argc, char *argv[]);
202 extern int llapi_cp(int argc, char *argv[]);
203 extern int llapi_ls(int argc, char *argv[]);
204 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
205 int pathlen, long long *recno, int *linkno);
206 extern int llapi_path2fid(const char *path, lustre_fid *fid);
208 /* Changelog interface. priv is private state, managed internally
209 by these functions */
210 #define CHANGELOG_FLAG_FOLLOW 0x01 /* Not yet implemented */
211 #define CHANGELOG_FLAG_BLOCK 0x02 /* Blocking IO makes sense in case of
212 slow user parsing of the records, but it also prevents us from cleaning
213 up if the records are not consumed. */
215 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
217 extern int llapi_changelog_fini(void **priv);
218 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
219 extern int llapi_changelog_free(struct changelog_rec **rech);
220 /* Allow records up to endrec to be destroyed; requires registered id. */
221 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
224 /* HSM copytool interface. priv is private state, managed internally
225 by these functions */
226 extern int llapi_copytool_start(void **priv, char *fsname, int flags,
227 int archive_count, int *archives);
228 extern int llapi_copytool_fini(void **priv);
229 extern int llapi_copytool_recv(void *priv, struct hsm_action_list **hal,
231 extern int llapi_copytool_free(struct hsm_action_list **hal);