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 <stdarg.h>
  46 #include <lustre/lustre_user.h>
  47
  48 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
  49                            void *args);
  50
  51 /* lustreapi message severity level */
  52 enum llapi_message_level {
  53         LLAPI_MSG_OFF    = 0,
  54         LLAPI_MSG_FATAL  = 1,
  55         LLAPI_MSG_ERROR  = 2,
  56         LLAPI_MSG_WARN   = 3,
  57         LLAPI_MSG_NORMAL = 4,
  58         LLAPI_MSG_INFO   = 5,
  59         LLAPI_MSG_DEBUG  = 6,
  60         LLAPI_MSG_MAX
  61 };
  62
  63 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
  64                                      const char *fmt, va_list ap);
  65
  66
  67 /* the bottom three bits reserved for llapi_message_level */
  68 #define LLAPI_MSG_MASK          0x00000007
  69 #define LLAPI_MSG_NO_ERRNO      0x00000010
  70
  71 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
  72 {
  73         static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
  74                                                     "WARNING", "NORMAL",
  75                                                     "INFO", "DEBUG"};
  76
  77         if (level >= LLAPI_MSG_MAX)
  78                 return NULL;
  79
  80         return levels[level];
  81 }
  82 extern void llapi_msg_set_level(int level);
  83 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
  84 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
  85
  86 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
  87         __attribute__((__format__(__printf__, 3, 4)));
  88 #define llapi_err_noerrno(level, fmt, a...)                     \
  89         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
  90 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
  91         __attribute__((__format__(__printf__, 2, 3)));
  92
  93 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
  94                              int stripe_offset, int stripe_count,
  95                              int stripe_pattern);
  96 extern int llapi_file_open(const char *name, int flags, int mode,
  97                            unsigned long long stripe_size, int stripe_offset,
  98                            int stripe_count, int stripe_pattern);
  99 extern int llapi_file_create_pool(const char *name,
 100                                   unsigned long long stripe_size,
 101                                   int stripe_offset, int stripe_count,
 102                                   int stripe_pattern, char *pool_name);
 103 extern int llapi_file_open_pool(const char *name, int flags, int mode,
 104                                 unsigned long long stripe_size,
 105                                 int stripe_offset, int stripe_count,
 106                                 int stripe_pattern, char *pool_name);
 107 extern int llapi_poollist(const char *name);
 108 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
 109                               char *buffer, int buffer_size);
 110 extern int llapi_get_poolmembers(const char *poolname, char **members,
 111                                  int list_size, char *buffer, int buffer_size);
 112 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
 113 #define HAVE_LLAPI_FILE_LOOKUP
 114 extern int llapi_file_lookup(int dirfd, const char *name);
 115
 116 #define VERBOSE_COUNT           0x1
 117 #define VERBOSE_SIZE            0x2
 118 #define VERBOSE_OFFSET          0x4
 119 #define VERBOSE_POOL            0x8
 120 #define VERBOSE_DETAIL          0x10
 121 #define VERBOSE_OBJID           0x20
 122 #define VERBOSE_GENERATION      0x40
 123 #define VERBOSE_MDTINDEX        0x80
 124 #define VERBOSE_LAYOUT          0x100
 125 #define VERBOSE_ALL             (VERBOSE_COUNT | VERBOSE_SIZE | \
 126                                  VERBOSE_OFFSET | VERBOSE_POOL | \
 127                                  VERBOSE_OBJID | VERBOSE_GENERATION |\
 128                                  VERBOSE_LAYOUT)
 129
 130 struct find_param {
 131         unsigned int             fp_max_depth;
 132         dev_t                    fp_dev;
 133         mode_t                   fp_type; /* S_IFIFO,... */
 134         uid_t                    fp_uid;
 135         gid_t                    fp_gid;
 136         time_t                   fp_atime;
 137         time_t                   fp_mtime;
 138         time_t                   fp_ctime;
 139         /* {a,m,c}sign cannot be bitfields due to using pointers to
 140          * access them during argument parsing. */
 141         int                      fp_asign;
 142         int                      fp_msign;
 143         int                      fp_csign;
 144         /* these need to be signed values */
 145         int                      size_sign:2,
 146                                  stripesize_sign:2,
 147                                  stripecount_sign:2;
 148         unsigned long long       size;
 149         unsigned long long       size_units;
 150
 151         unsigned long            zeroend:1,
 152                                  recursive:1,
 153                                  exclude_pattern:1,
 154                                  fp_exclude_type:1,
 155                                  exclude_obd:1,
 156                                  exclude_mdt:1,
 157                                  fp_exclude_gid:1,
 158                                  fp_exclude_uid:1,
 159                                  fp_check_gid:1,
 160                                  fp_check_uid:1,
 161                                  check_pool:1,          /* LOV pool name */
 162                                  check_size:1,          /* file size */
 163                                  exclude_pool:1,
 164                                  exclude_size:1,
 165                                  fp_exclude_atime:1,
 166                                  fp_exclude_mtime:1,
 167                                  fp_exclude_ctime:1,
 168                                  get_lmv:1,     /* get MDT list from LMV */
 169                                  raw:1,         /* do not fill in defaults */
 170                                  check_stripesize:1,    /* LOV stripe size */
 171                                  exclude_stripesize:1,
 172                                  check_stripecount:1,   /* LOV stripe count */
 173                                  exclude_stripecount:1,
 174                                  check_layout:1,
 175                                  exclude_layout:1,
 176                                  get_default_lmv:1, /* Get default LMV */
 177                                  migrate:1;
 178
 179         int                      verbose;
 180         int                      quiet;
 181
 182         /* regular expression */
 183         char                    *pattern;
 184
 185         struct  obd_uuid        *obduuid;
 186         int                      num_obds;
 187         int                      num_alloc_obds;
 188         int                      obdindex;
 189         int                     *obdindexes;
 190
 191         struct  obd_uuid        *mdtuuid;
 192         int                      num_mdts;
 193         int                      num_alloc_mdts;
 194         int                      mdtindex;
 195         int                     *mdtindexes;
 196         int                      file_mdtindex;
 197
 198         int                      lumlen;
 199         struct  lov_user_mds_data       *lmd;
 200
 201         char                    poolname[LOV_MAXPOOLNAME + 1];
 202
 203         int                      fp_lmv_count;
 204         struct lmv_user_md      *fp_lmv_md;
 205
 206         unsigned long long       stripesize;
 207         unsigned long long       stripesize_units;
 208         unsigned long long       stripecount;
 209         __u32                    layout;
 210
 211         /* In-process parameters. */
 212         unsigned long            got_uuids:1,
 213                                  obds_printed:1,
 214                                  have_fileinfo:1; /* file attrs and LOV xattr */
 215         unsigned int             fp_depth;
 216 };
 217
 218 extern int llapi_ostlist(char *path, struct find_param *param);
 219 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
 220 extern int llapi_getstripe(char *path, struct find_param *param);
 221 extern int llapi_find(char *path, struct find_param *param);
 222
 223 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
 224 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
 225                                            int stripe_count, int stripe_pattern,
 226                                             const char *pool_name);
 227 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
 228                                  int stripe_count, int stripe_pattern,
 229                                  const char *poolname);
 230 int llapi_direntry_remove(char *dname);
 231 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
 232                      struct obd_statfs *stat_buf,
 233                      struct obd_uuid *uuid_buf);
 234 extern int llapi_ping(char *obd_type, char *obd_name);
 235 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
 236 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 237 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
 238 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
 239 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
 240 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
 241 extern int llapi_is_lustre_mnttype(const char *type);
 242 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
 243 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
 244 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
 245                             unsigned long long *size_units, int bytes_spec);
 246 extern int llapi_search_mounts(const char *pathname, int index,
 247                                char *mntdir, char *fsname);
 248 extern int llapi_search_fsname(const char *pathname, char *fsname);
 249 extern int llapi_getname(const char *path, char *buf, size_t size);
 250
 251 extern int llapi_search_rootpath(char *pathname, const char *fsname);
 252 extern int llapi_nodemap_exists(const char *name);
 253 extern int llapi_mv(char *path, struct find_param *param);
 254
 255 struct mntent;
 256 #define HAVE_LLAPI_IS_LUSTRE_MNT
 257 extern int llapi_is_lustre_mnt(struct mntent *mnt);
 258 extern int llapi_quotachown(char *path, int flag);
 259 extern int llapi_quotacheck(char *mnt, int check_type);
 260 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
 261 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 262 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
 263                                 llapi_cb_t cb);
 264 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
 265 extern int llapi_lsetfacl(int argc, char *argv[]);
 266 extern int llapi_lgetfacl(int argc, char *argv[]);
 267 extern int llapi_rsetfacl(int argc, char *argv[]);
 268 extern int llapi_rgetfacl(int argc, char *argv[]);
 269 extern int llapi_cp(int argc, char *argv[]);
 270 extern int llapi_ls(int argc, char *argv[]);
 271 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
 272                           int pathlen, long long *recno, int *linkno);
 273 extern int llapi_path2fid(const char *path, lustre_fid *fid);
 274 extern int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid,
 275                                       int *mdt_index);
 276 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
 277 extern int llapi_chomp_string(char *buf);
 278
 279 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
 280 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
 281 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
 282 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
 283 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
 284                                   __u32 archive_id);
 285 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
 286                                __u32 archive_id);
 287 extern int llapi_hsm_register_event_fifo(const char *path);
 288 extern int llapi_hsm_unregister_event_fifo(const char *path);
 289 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
 290                                 const char *fmt, va_list args);
 291
 292 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
 293 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
 294 static inline int llapi_create_volatile(char *directory, int mode)
 295 {
 296         return llapi_create_volatile_idx(directory, -1, mode);
 297 }
 298
 299
 300 extern int llapi_fswap_layouts(const int fd1, const int fd2,
 301                                __u64 dv1, __u64 dv2, __u64 flags);
 302 extern int llapi_swap_layouts(const char *path1, const char *path2,
 303                               __u64 dv1, __u64 dv2, __u64 flags);
 304
 305 /* Changelog interface.  priv is private state, managed internally
 306    by these functions */
 307 #define CHANGELOG_FLAG_FOLLOW 0x01   /* Not yet implemented */
 308 #define CHANGELOG_FLAG_BLOCK  0x02   /* Blocking IO makes sense in case of
 309    slow user parsing of the records, but it also prevents us from cleaning
 310    up if the records are not consumed. */
 311
 312 /* Records received are in extentded format now, though most of them are still
 313  * written in disk in changelog_rec format (to save space and time), it's
 314  * converted to extented format in the lustre api to ease changelog analysis. */
 315 #define HAVE_CHANGELOG_EXTEND_REC 1
 316
 317 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
 318                                  long long startrec);
 319 extern int llapi_changelog_fini(void **priv);
 320 extern int llapi_changelog_recv(void *priv, struct changelog_ext_rec **rech);
 321 extern int llapi_changelog_free(struct changelog_ext_rec **rech);
 322 /* Allow records up to endrec to be destroyed; requires registered id. */
 323 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
 324                                  long long endrec);
 325
 326 /* HSM copytool interface.
 327  * priv is private state, managed internally by these functions
 328  */
 329 struct hsm_copytool_private;
 330 struct hsm_copyaction_private;
 331
 332 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
 333                                        const char *mnt, int archive_count,
 334                                        int *archives, int rfd_flags);
 335 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
 336 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
 337 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
 338                                    struct hsm_action_list **hal, int *msgsize);
 339 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
 340                                   const struct hsm_copytool_private *ct,
 341                                   const struct hsm_action_item *hai,
 342                                   int restore_mdt_index, int restore_open_flags,
 343                                   bool is_error);
 344 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
 345                                 const struct hsm_extent *he,
 346                                 int hp_flags, int errval);
 347 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
 348                                      const struct hsm_extent *he, __u64 total,
 349                                      int hp_flags);
 350 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
 351                                      lustre_fid *fid);
 352 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
 353 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
 354                             unsigned long long stripe_size, int stripe_offset,
 355                             int stripe_count, int stripe_pattern,
 356                             char *pool_name, lustre_fid *newfid);
 357
 358 /* HSM user interface */
 359 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
 360                                                              int data_len);
 361 extern int llapi_hsm_request(const char *path,
 362                              const struct hsm_user_request *request);
 363 extern int llapi_hsm_current_action(const char *path,
 364                                     struct hsm_current_action *hca);
 365
 366 /* JSON handling */
 367 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
 368 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
 369 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
 370                                char *key, __u32 type, void *val);
 371 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
 372                                  FILE *fp);
 373 /** @} llapi */
 374
 375 #endif
 376
 377
 378