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