lustre/include/lustre/liblustreapi.h

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