Whamcloud - gitweb
LU-680 lfs: instance <-> mount point mapping from lfs
[fs/lustre-release.git] / lustre / include / lustre / liblustreapi.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
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.
11  *
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).
17  *
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
21  *
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
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
31  */
32 /*
33  * Copyright (c) 2011 Whamcloud, Inc.
34  */
35 /*
36  * This file is part of Lustre, http://www.lustre.org/
37  * Lustre is a trademark of Sun Microsystems, Inc.
38  */
39
40 #ifndef _LIBLUSTREAPI_H_
41 #define _LIBLUSTREAPI_H_
42
43 /** \defgroup llapi llapi
44  *
45  * @{
46  */
47
48 #include <lustre/lustre_user.h>
49
50 /* Initially allocate for these many OSTs, realloc if needed */
51 #define INIT_ALLOC_NUM_OSTS     1024
52
53 /* Maximum number of osts that can be specified to lfs find */
54 #define FIND_MAX_OSTS   1024
55
56 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid, void *args);
57
58 /* liblustreapi message severity level */
59 enum llapi_message_level {
60         LLAPI_MSG_OFF    = 0,
61         LLAPI_MSG_FATAL  = 1,
62         LLAPI_MSG_ERROR  = 2,
63         LLAPI_MSG_WARN   = 3,
64         LLAPI_MSG_NORMAL = 4,
65         LLAPI_MSG_INFO   = 5,
66         LLAPI_MSG_DEBUG  = 6,
67         LLAPI_MSG_MAX
68 };
69
70 /* the bottom three bits reserved for llapi_message_level */
71 #define LLAPI_MSG_MASK          0x00000007
72 #define LLAPI_MSG_NO_ERRNO      0x00000010
73
74 /* liblustreapi.c */
75 extern void llapi_msg_set_level(int level);
76 extern void llapi_error(int level, int rc, char *fmt, ...);
77 #define llapi_err_noerrno(level, fmt, a...)                             \
78         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
79 extern void llapi_printf(int level, char *fmt, ...);
80 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
81                              int stripe_offset, int stripe_count,
82                              int stripe_pattern);
83 extern int llapi_file_open(const char *name, int flags, int mode,
84                            unsigned long long stripe_size, int stripe_offset,
85                            int stripe_count, int stripe_pattern);
86 extern int llapi_file_create_pool(const char *name,
87                                   unsigned long long stripe_size,
88                                   int stripe_offset, int stripe_count,
89                                   int stripe_pattern, char *pool_name);
90 extern int llapi_file_open_pool(const char *name, int flags, int mode,
91                                 unsigned long long stripe_size,
92                                 int stripe_offset, int stripe_count,
93                                 int stripe_pattern, char *pool_name);
94 extern int llapi_poollist(const char *name);
95 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
96                               char *buffer, int buffer_size);
97 extern int llapi_get_poolmembers(const char *poolname, char **members,
98                                  int list_size, char *buffer, int buffer_size);
99 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
100 #define HAVE_LLAPI_FILE_LOOKUP
101 extern int llapi_file_lookup(int dirfd, const char *name);
102
103 #define VERBOSE_COUNT   0x1
104 #define VERBOSE_SIZE    0x2
105 #define VERBOSE_OFFSET  0x4
106 #define VERBOSE_POOL    0x8
107 #define VERBOSE_DETAIL  0x10
108 #define VERBOSE_OBJID   0x20
109 #define VERBOSE_ALL     (VERBOSE_COUNT | VERBOSE_SIZE | VERBOSE_OFFSET | \
110                          VERBOSE_POOL | VERBOSE_OBJID)
111
112 struct find_param {
113         unsigned int maxdepth;
114         time_t  atime;
115         time_t  mtime;
116         time_t  ctime;
117         int     asign;
118         int     csign;
119         int     msign;
120         int     type;
121         unsigned long long size;
122         int     size_sign;
123         unsigned long long size_units;
124         uid_t uid;
125         gid_t gid;
126
127         unsigned long   zeroend:1,
128                         recursive:1,
129                         got_uuids:1,
130                         obds_printed:1,
131                         exclude_pattern:1,
132                         exclude_type:1,
133                         exclude_obd:1,
134                         have_fileinfo:1,
135                         exclude_gid:1,
136                         exclude_uid:1,
137                         check_gid:1,
138                         check_uid:1,
139                         check_pool:1,
140                         check_size:1,
141                         exclude_pool:1,
142                         exclude_size:1,
143                         exclude_atime:1,
144                         exclude_mtime:1,
145                         exclude_ctime:1,
146                         get_mdt_index:1,
147                         raw:1;
148
149         int     verbose;
150         int     quiet;
151
152         /* regular expression */
153         char   *pattern;
154
155         char   *print_fmt;
156
157         struct  obd_uuid        *obduuid;
158         int                     num_obds;
159         int                     num_alloc_obds;
160         int                     obdindex;
161         int                     *obdindexes;
162
163         int     lumlen;
164         struct  lov_user_mds_data *lmd;
165
166         /* In-precess parameters. */
167         unsigned int depth;
168         dev_t   st_dev;
169
170         char poolname[LOV_MAXPOOLNAME + 1];
171 };
172
173 extern int llapi_ostlist(char *path, struct find_param *param);
174 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
175 extern int llapi_getstripe(char *path, struct find_param *param);
176 extern int llapi_find(char *path, struct find_param *param);
177
178 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
179 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
180                      struct obd_statfs *stat_buf,
181                      struct obd_uuid *uuid_buf);
182 extern int llapi_ping(char *obd_type, char *obd_name);
183 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
184 extern int llapi_catinfo(char *dir, char *keyword, char *node_name);
185 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
186 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
187 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
188 extern int llapi_is_lustre_mnttype(const char *type);
189 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
190 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
191 extern int parse_size(char *optarg, unsigned long long *size,
192                       unsigned long long *size_units, int bytes_spec);
193 extern int llapi_path2fid(const char *path, lustre_fid *fid);
194 extern int llapi_search_mounts(const char *pathname, int index,
195                                char *mntdir, char *fsname);
196 extern int llapi_search_fsname(const char *pathname, char *fsname);
197 extern int llapi_getname(const char *path, char *buf, size_t size);
198
199 extern void llapi_ping_target(char *obd_type, char *obd_name,
200                               char *obd_uuid, void *args);
201
202 struct mntent;
203 #define HAVE_LLAPI_IS_LUSTRE_MNT
204 extern int llapi_is_lustre_mnt(struct mntent *mnt);
205 extern int llapi_quotachown(char *path, int flag);
206 extern int llapi_quotacheck(char *mnt, int check_type);
207 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
208 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
209 extern int llapi_target_iterate(int type_num, char **obd_type, void *args, llapi_cb_t cb);
210 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
211 extern int llapi_lsetfacl(int argc, char *argv[]);
212 extern int llapi_lgetfacl(int argc, char *argv[]);
213 extern int llapi_rsetfacl(int argc, char *argv[]);
214 extern int llapi_rgetfacl(int argc, char *argv[]);
215 extern int llapi_cp(int argc, char *argv[]);
216 extern int llapi_ls(int argc, char *argv[]);
217 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
218                           int pathlen, long long *recno, int *linkno);
219 extern int llapi_path2fid(const char *path, lustre_fid *fid);
220 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
221
222 /* Changelog interface.  priv is private state, managed internally
223    by these functions */
224 #define CHANGELOG_FLAG_FOLLOW 0x01   /* Not yet implemented */
225 #define CHANGELOG_FLAG_BLOCK  0x02   /* Blocking IO makes sense in case of
226    slow user parsing of the records, but it also prevents us from cleaning
227    up if the records are not consumed. */
228
229 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
230                                  long long startrec);
231 extern int llapi_changelog_fini(void **priv);
232 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
233 extern int llapi_changelog_free(struct changelog_rec **rech);
234 /* Allow records up to endrec to be destroyed; requires registered id. */
235 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
236                                  long long endrec);
237
238 /* HSM copytool interface.  priv is private state, managed internally
239    by these functions */
240 extern int llapi_copytool_start(void **priv, char *fsname, int flags,
241                                 int archive_count, int *archives);
242 extern int llapi_copytool_fini(void **priv);
243 extern int llapi_copytool_recv(void *priv, struct hsm_action_list **hal,
244                                int *msgsize);
245 extern int llapi_copytool_free(struct hsm_action_list **hal);
246
247 /** @} llapi */
248
249 #endif
250
251
252