lustre/include/lustre/lustreapi.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, 2013, Intel Corporation.
  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 _LUSTREAPI_H_
  38 #define _LUSTREAPI_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 /* lustreapi 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 extern void llapi_msg_set_level(int level);
  66
  67 void llapi_error(int level, int rc, const char *fmt, ...)
  68         __attribute__((__format__(__printf__, 3, 4)));
  69 #define llapi_err_noerrno(level, fmt, a...)                     \
  70         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
  71 void llapi_printf(int level, const char *fmt, ...)
  72         __attribute__((__format__(__printf__, 2, 3)));
  73
  74 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
  75                              int stripe_offset, int stripe_count,
  76                              int stripe_pattern);
  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);
  96
  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_MDTINDEX        0x80
 105 #define VERBOSE_LAYOUT          0x100
 106 #define VERBOSE_ALL             (VERBOSE_COUNT | VERBOSE_SIZE | \
 107                                  VERBOSE_OFFSET | VERBOSE_POOL | \
 108                                  VERBOSE_OBJID | VERBOSE_GENERATION |\
 109                                  VERBOSE_LAYOUT)
 110
 111 struct find_param {
 112         unsigned int             maxdepth;
 113         time_t                   atime;
 114         time_t                   mtime;
 115         time_t                   ctime;
 116         /* cannot be bitfields due to using pointers to */
 117         int                      asign;
 118         /* access them during argument parsing. */
 119         int                      csign;
 120         int                      msign;
 121         int                      type;
 122         /* these need to be signed values */
 123         int                      size_sign:2,
 124                                  stripesize_sign:2,
 125                                  stripecount_sign:2;
 126         unsigned long long       size;
 127         unsigned long long       size_units;
 128         uid_t                    uid;
 129         gid_t                    gid;
 130
 131         unsigned long            zeroend:1,
 132                                  recursive:1,
 133                                  exclude_pattern:1,
 134                                  exclude_type:1,
 135                                  exclude_obd:1,
 136                                  exclude_mdt:1,
 137                                  exclude_gid:1,
 138                                  exclude_uid:1,
 139                                  check_gid:1,           /* group ID */
 140                                  check_uid:1,           /* user ID */
 141                                  check_pool:1,          /* LOV pool name */
 142                                  check_size:1,          /* file size */
 143                                  exclude_pool:1,
 144                                  exclude_size:1,
 145                                  exclude_atime:1,
 146                                  exclude_mtime:1,
 147                                  exclude_ctime:1,
 148                                  get_lmv:1,     /* get MDT list from LMV */
 149                                  raw:1,         /* do not fill in defaults */
 150                                  check_stripesize:1,    /* LOV stripe size */
 151                                  exclude_stripesize:1,
 152                                  check_stripecount:1,   /* LOV stripe count */
 153                                  exclude_stripecount:1,
 154                                  check_layout:1,
 155                                  exclude_layout:1;
 156
 157         int                      verbose;
 158         int                      quiet;
 159
 160         /* regular expression */
 161         char                    *pattern;
 162
 163         char                    *print_fmt;
 164
 165         struct  obd_uuid        *obduuid;
 166         int                      num_obds;
 167         int                      num_alloc_obds;
 168         int                      obdindex;
 169         int                     *obdindexes;
 170
 171         struct  obd_uuid        *mdtuuid;
 172         int                      num_mdts;
 173         int                      num_alloc_mdts;
 174         int                      mdtindex;
 175         int                     *mdtindexes;
 176         int                      file_mdtindex;
 177
 178         int                      lumlen;
 179         struct  lov_user_mds_data       *lmd;
 180
 181         char                    poolname[LOV_MAXPOOLNAME + 1];
 182
 183         int                      fp_lmv_count;
 184         struct lmv_user_md      *fp_lmv_md;
 185
 186         unsigned long long       stripesize;
 187         unsigned long long       stripesize_units;
 188         unsigned long long       stripecount;
 189         __u32                    layout;
 190
 191         /* In-process parameters. */
 192         unsigned long            got_uuids:1,
 193                                  obds_printed:1,
 194                                  have_fileinfo:1; /* file attrs and LOV xattr */
 195         unsigned int             depth;
 196         dev_t                    st_dev;
 197         __u64                    padding1;
 198         __u64                    padding2;
 199         __u64                    padding3;
 200         __u64                    padding4;
 201 };
 202
 203 extern int llapi_ostlist(char *path, struct find_param *param);
 204 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
 205 extern int llapi_getstripe(char *path, struct find_param *param);
 206 extern int llapi_find(char *path, struct find_param *param);
 207
 208 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
 209 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
 210                                  int stripe_count, int stripe_pattern,
 211                                  char *poolname);
 212 int llapi_direntry_remove(char *dname);
 213 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
 214                      struct obd_statfs *stat_buf,
 215                      struct obd_uuid *uuid_buf);
 216 extern int llapi_ping(char *obd_type, char *obd_name);
 217 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
 218 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 219 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
 220 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
 221 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
 222 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
 223 extern int llapi_is_lustre_mnttype(const char *type);
 224 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
 225 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
 226 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
 227                             unsigned long long *size_units, int bytes_spec);
 228 extern int llapi_search_mounts(const char *pathname, int index,
 229                                char *mntdir, char *fsname);
 230 extern int llapi_search_fsname(const char *pathname, char *fsname);
 231 extern int llapi_getname(const char *path, char *buf, size_t size);
 232
 233 extern void llapi_ping_target(char *obd_type, char *obd_name,
 234                               char *obd_uuid, void *args);
 235
 236 extern int llapi_search_rootpath(char *pathname, const char *fsname);
 237
 238 struct mntent;
 239 #define HAVE_LLAPI_IS_LUSTRE_MNT
 240 extern int llapi_is_lustre_mnt(struct mntent *mnt);
 241 extern int llapi_quotachown(char *path, int flag);
 242 extern int llapi_quotacheck(char *mnt, int check_type);
 243 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
 244 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 245 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
 246                                 llapi_cb_t cb);
 247 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
 248 extern int llapi_lsetfacl(int argc, char *argv[]);
 249 extern int llapi_lgetfacl(int argc, char *argv[]);
 250 extern int llapi_rsetfacl(int argc, char *argv[]);
 251 extern int llapi_rgetfacl(int argc, char *argv[]);
 252 extern int llapi_cp(int argc, char *argv[]);
 253 extern int llapi_ls(int argc, char *argv[]);
 254 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
 255                           int pathlen, long long *recno, int *linkno);
 256 extern int llapi_path2fid(const char *path, lustre_fid *fid);
 257 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
 258
 259 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
 260 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
 261 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
 262 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
 263 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
 264                                   __u32 archive_id);
 265 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
 266                                __u32 archive_id);
 267
 268 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
 269 static inline int llapi_create_volatile(char *directory, int mode)
 270 {
 271         return llapi_create_volatile_idx(directory, -1, mode);
 272 }
 273
 274
 275 extern int llapi_fswap_layouts(const int fd1, const int fd2,
 276                                __u64 dv1, __u64 dv2, __u64 flags);
 277 extern int llapi_swap_layouts(const char *path1, const char *path2,
 278                               __u64 dv1, __u64 dv2, __u64 flags);
 279
 280 /* Changelog interface.  priv is private state, managed internally
 281    by these functions */
 282 #define CHANGELOG_FLAG_FOLLOW 0x01   /* Not yet implemented */
 283 #define CHANGELOG_FLAG_BLOCK  0x02   /* Blocking IO makes sense in case of
 284    slow user parsing of the records, but it also prevents us from cleaning
 285    up if the records are not consumed. */
 286
 287 /* Records received are in extentded format now, though most of them are still
 288  * written in disk in changelog_rec format (to save space and time), it's
 289  * converted to extented format in the lustre api to ease changelog analysis. */
 290 #define HAVE_CHANGELOG_EXTEND_REC 1
 291
 292 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
 293                                  long long startrec);
 294 extern int llapi_changelog_fini(void **priv);
 295 extern int llapi_changelog_recv(void *priv, struct changelog_ext_rec **rech);
 296 extern int llapi_changelog_free(struct changelog_ext_rec **rech);
 297 /* Allow records up to endrec to be destroyed; requires registered id. */
 298 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
 299                                  long long endrec);
 300
 301 /* HSM copytool interface.
 302  * priv is private state, managed internally by these functions
 303  */
 304 struct hsm_copytool_private;
 305 struct hsm_copyaction_private;
 306
 307 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
 308                                        const char *mnt, int flags,
 309                                        int archive_count, int *archives);
 310 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
 311 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
 312                                    struct hsm_action_list **hal, int *msgsize);
 313 extern void llapi_hsm_action_list_free(struct hsm_action_list **hal);
 314 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
 315                                   const struct hsm_copytool_private *ct,
 316                                   const struct hsm_action_item *hai,
 317                                   int restore_mdt_index, int restore_open_flags,
 318                                   bool is_error);
 319 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
 320                                 const struct hsm_extent *he,
 321                                 int hp_flags, int errval);
 322 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
 323                                      const struct hsm_extent *he, int hp_flags);
 324 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
 325                                      lustre_fid *fid);
 326 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
 327 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
 328                             unsigned long long stripe_size, int stripe_offset,
 329                             int stripe_count, int stripe_pattern,
 330                             char *pool_name, lustre_fid *newfid);
 331
 332 /* HSM user interface */
 333 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
 334                                                              int data_len);
 335 extern int llapi_hsm_request(const char *path,
 336                              const struct hsm_user_request *request);
 337 extern int llapi_hsm_current_action(const char *path,
 338                                     struct hsm_current_action *hca);
 339 /** @} llapi */
 340
 341 #endif
 342
 343
 344