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  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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 #include <lustre/lustre_user.h>
  41
  42 /* Initially allocate for these many OSTs, realloc if needed */
  43 #define INIT_ALLOC_NUM_OSTS     1024
  44
  45 /* Maximum number of osts that can be specified to lfs find */
  46 #define FIND_MAX_OSTS   1024
  47
  48 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid, void *args);
  49
  50 /* liblustreapi message severity level */
  51 enum llapi_message_level {
  52         LLAPI_MSG_OFF    = 0,
  53         LLAPI_MSG_FATAL  = 1,
  54         LLAPI_MSG_ERROR  = 2,
  55         LLAPI_MSG_WARN   = 3,
  56         LLAPI_MSG_NORMAL = 4,
  57         LLAPI_MSG_INFO   = 5,
  58         LLAPI_MSG_DEBUG  = 6,
  59         LLAPI_MSG_MAX
  60 };
  61
  62 /* the bottom three bits reserved for llapi_message_level */
  63 #define LLAPI_MSG_MASK          0x00000007
  64 #define LLAPI_MSG_NO_ERRNO      0x00000010
  65
  66 /* liblustreapi.c */
  67 extern void llapi_msg_set_level(int level);
  68 extern void llapi_err(int level, char *fmt, ...);
  69 extern void llapi_printf(int level, char *fmt, ...);
  70 extern int llapi_file_create(const char *name, unsigned long stripe_size,
  71                              int stripe_offset, int stripe_count,
  72                              int stripe_pattern);
  73 extern int llapi_file_open(const char *name, int flags, int mode,
  74                            unsigned long stripe_size, int stripe_offset,
  75                            int stripe_count, int stripe_pattern);
  76 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
  77 #define HAVE_LLAPI_FILE_LOOKUP
  78 extern int llapi_file_lookup(int dirfd, const char *name);
  79
  80 struct find_param {
  81         unsigned int maxdepth;
  82         time_t  atime;
  83         time_t  mtime;
  84         time_t  ctime;
  85         int     asign;
  86         int     csign;
  87         int     msign;
  88         int     type;
  89         unsigned long long size;
  90         int     size_sign;
  91         unsigned long long size_units;
  92         uid_t uid;
  93         gid_t gid;
  94
  95         unsigned long   zeroend:1,
  96                         recursive:1,
  97                         got_uuids:1,
  98                         obds_printed:1,
  99                         exclude_pattern:1,
 100                         exclude_type:1,
 101                         have_fileinfo:1,
 102                         exclude_gid:1,
 103                         exclude_uid:1,
 104                         check_gid:1,
 105                         check_uid:1;
 106
 107         int     verbose;
 108         int     quiet;
 109
 110         /* regular expression */
 111         char   *pattern;
 112
 113         char   *print_fmt;
 114
 115         struct  obd_uuid        *obduuid;
 116         int                     num_obds;
 117         int                     num_alloc_obds;
 118         int                     obdindex;
 119         int                     *obdindexes;
 120
 121         int     lumlen;
 122         struct  lov_user_mds_data *lmd;
 123
 124         /* In-precess parameters. */
 125         unsigned int depth;
 126         dev_t   st_dev;
 127 };
 128
 129 extern int llapi_getstripe(char *path, struct find_param *param);
 130 extern int llapi_find(char *path, struct find_param *param);
 131
 132 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
 133                      struct obd_statfs *stat_buf,
 134                      struct obd_uuid *uuid_buf);
 135 extern int llapi_ping(char *obd_type, char *obd_name);
 136 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
 137 extern int llapi_catinfo(char *dir, char *keyword, char *node_name);
 138 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 139 extern int llapi_file_get_lov_fuuid(int fd, struct obd_uuid *lov_uuid);
 140 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
 141 extern int llapi_is_lustre_mnttype(const char *type);
 142 extern int parse_size(char *optarg, unsigned long long *size,
 143                       unsigned long long *size_units);
 144 struct mntent;
 145 #define HAVE_LLAPI_IS_LUSTRE_MNT
 146 extern int llapi_is_lustre_mnt(struct mntent *mnt);
 147 extern int llapi_quotachown(char *path, int flag);
 148 extern int llapi_quotacheck(char *mnt, int check_type);
 149 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
 150 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 151 extern int llapi_target_iterate(int type_num, char **obd_type, void *args, llapi_cb_t cb);
 152 extern int llapi_lsetfacl(int argc, char *argv[]);
 153 extern int llapi_lgetfacl(int argc, char *argv[]);
 154 extern int llapi_rsetfacl(int argc, char *argv[]);
 155 extern int llapi_rgetfacl(int argc, char *argv[]);
 156 extern int llapi_cp(int argc, char *argv[]);
 157 extern int llapi_ls(int argc, char *argv[]);
 158 #endif