Whamcloud - gitweb
LU-1710 general: add LVB type connect flag
[fs/lustre-release.git] / lustre / include / lustre / liblustreapi.h
index 6e4ec38..8a87398 100644 (file)
@@ -1,6 +1,4 @@
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
- *
+/*
  * GPL HEADER START
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  * GPL HEADER END
  */
 /*
- * Copyright  2008 Sun Microsystems, Inc. All rights reserved
+ * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
+ *
+ * Copyright (c) 2011, 2012, Whamcloud, Inc.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
 #ifndef _LIBLUSTREAPI_H_
 #define _LIBLUSTREAPI_H_
 
-#include <lustre/lustre_user.h>
-
-/* Initially allocate for these many OSTs, realloc if needed */
-#define INIT_ALLOC_NUM_OSTS     1024
+/** \defgroup llapi llapi
+ *
+ * @{
+ */
 
-/* Maximum number of osts that can be specified to lfs find */
-#define FIND_MAX_OSTS   1024
+#include <lustre/lustre_user.h>
 
 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid, void *args);
 
@@ -65,7 +64,9 @@ enum llapi_message_level {
 
 /* liblustreapi.c */
 extern void llapi_msg_set_level(int level);
-extern void llapi_err(int level, char *fmt, ...);
+extern void llapi_error(int level, int rc, char *fmt, ...);
+#define llapi_err_noerrno(level, fmt, a...)                             \
+       llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
 extern void llapi_printf(int level, char *fmt, ...);
 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
                              int stripe_offset, int stripe_count,
@@ -90,43 +91,57 @@ extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
 #define HAVE_LLAPI_FILE_LOOKUP
 extern int llapi_file_lookup(int dirfd, const char *name);
 
-#define VERBOSE_COUNT   0x1
-#define VERBOSE_SIZE    0x2
-#define VERBOSE_OFFSET  0x4
-#define VERBOSE_POOL    0x8
-#define VERBOSE_DETAIL  0x10
-#define VERBOSE_OBJID   0x20
-#define VERBOSE_ALL     (VERBOSE_COUNT | VERBOSE_SIZE | VERBOSE_OFFSET | \
-                         VERBOSE_POOL | VERBOSE_OBJID)
+#define VERBOSE_COUNT      0x1
+#define VERBOSE_SIZE       0x2
+#define VERBOSE_OFFSET     0x4
+#define VERBOSE_POOL       0x8
+#define VERBOSE_DETAIL     0x10
+#define VERBOSE_OBJID      0x20
+#define VERBOSE_GENERATION 0x40
+#define VERBOSE_MDTINDEX   0x80
+#define VERBOSE_ALL        (VERBOSE_COUNT | VERBOSE_SIZE | VERBOSE_OFFSET | \
+                            VERBOSE_POOL | VERBOSE_OBJID | VERBOSE_GENERATION)
 
 struct find_param {
         unsigned int maxdepth;
         time_t  atime;
         time_t  mtime;
         time_t  ctime;
-        int     asign;
-        int     csign;
+        int     asign;  /* cannot be bitfields due to using pointers to */
+        int     csign;  /* access them during argument parsing. */
         int     msign;
         int     type;
+        int             size_sign:2,        /* these need to be signed values */
+                        stripesize_sign:2,
+                        stripecount_sign:2;
         unsigned long long size;
-        int     size_sign;
         unsigned long long size_units;
         uid_t uid;
         gid_t gid;
 
         unsigned long   zeroend:1,
                         recursive:1,
-                        got_uuids:1,
-                        obds_printed:1,
                         exclude_pattern:1,
                         exclude_type:1,
-                        have_fileinfo:1,
+                        exclude_obd:1,
+                        exclude_mdt:1,
                         exclude_gid:1,
                         exclude_uid:1,
-                        check_gid:1,
-                        check_uid:1,
-                        check_pool:1,
-                        exclude_pool:1;
+                        check_gid:1,            /* group ID */
+                        check_uid:1,            /* user ID */
+                        check_pool:1,           /* LOV pool name */
+                        check_size:1,           /* file size */
+                        exclude_pool:1,
+                        exclude_size:1,
+                        exclude_atime:1,
+                        exclude_mtime:1,
+                        exclude_ctime:1,
+                        get_lmv:1,              /* get MDT list from LMV */
+                        raw:1,                  /* do not fill in defaults */
+                        check_stripesize:1,     /* LOV stripe size */
+                        exclude_stripesize:1,
+                        check_stripecount:1,    /* LOV stripe count */
+                        exclude_stripecount:1;
 
         int     verbose;
         int     quiet;
@@ -136,20 +151,34 @@ struct find_param {
 
         char   *print_fmt;
 
-        struct  obd_uuid        *obduuid;
+        struct  obd_uuid       *obduuid;
         int                     num_obds;
         int                     num_alloc_obds;
         int                     obdindex;
-        int                     *obdindexes;
+        int                    *obdindexes;
+
+        struct  obd_uuid       *mdtuuid;
+        int                     num_mdts;
+        int                     num_alloc_mdts;
+        int                     mdtindex;
+        int                    *mdtindexes;
+        int                     file_mdtindex;
 
         int     lumlen;
         struct  lov_user_mds_data *lmd;
 
-        /* In-precess parameters. */
-        unsigned int depth;
-        dev_t   st_dev;
-
         char poolname[LOV_MAXPOOLNAME + 1];
+
+        unsigned long long stripesize;
+        unsigned long long stripesize_units;
+        unsigned long long stripecount;
+
+        /* In-process parameters. */
+        unsigned long   got_uuids:1,
+                        obds_printed:1,
+                        have_fileinfo:1;        /* file attrs and LOV xattr */
+        unsigned int    depth;
+        dev_t           st_dev;
 };
 
 extern int llapi_ostlist(char *path, struct find_param *param);
@@ -157,15 +186,16 @@ extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
 extern int llapi_getstripe(char *path, struct find_param *param);
 extern int llapi_find(char *path, struct find_param *param);
 
+extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
                      struct obd_statfs *stat_buf,
                      struct obd_uuid *uuid_buf);
 extern int llapi_ping(char *obd_type, char *obd_name);
 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
-extern int llapi_catinfo(char *dir, char *keyword, char *node_name);
 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
+extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
 extern int llapi_is_lustre_mnttype(const char *type);
 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
@@ -175,6 +205,8 @@ extern int llapi_path2fid(const char *path, lustre_fid *fid);
 extern int llapi_search_mounts(const char *pathname, int index,
                                char *mntdir, char *fsname);
 extern int llapi_search_fsname(const char *pathname, char *fsname);
+extern int llapi_getname(const char *path, char *buf, size_t size);
+
 extern void llapi_ping_target(char *obd_type, char *obd_name,
                               char *obd_uuid, void *args);
 
@@ -186,6 +218,7 @@ extern int llapi_quotacheck(char *mnt, int check_type);
 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 extern int llapi_target_iterate(int type_num, char **obd_type, void *args, llapi_cb_t cb);
+extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
 extern int llapi_lsetfacl(int argc, char *argv[]);
 extern int llapi_lgetfacl(int argc, char *argv[]);
 extern int llapi_rsetfacl(int argc, char *argv[]);
@@ -195,6 +228,9 @@ extern int llapi_ls(int argc, char *argv[]);
 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
                           int pathlen, long long *recno, int *linkno);
 extern int llapi_path2fid(const char *path, lustre_fid *fid);
+extern int llapi_get_version(char *buffer, int buffer_size, char **version);
+
+extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
 
 /* Changelog interface.  priv is private state, managed internally
    by these functions */
@@ -203,24 +239,31 @@ extern int llapi_path2fid(const char *path, lustre_fid *fid);
    slow user parsing of the records, but it also prevents us from cleaning
    up if the records are not consumed. */
 
+/* Records received are in extentded format now, though most of them are still
+ * written in disk in changelog_rec format (to save space and time), it's
+ * converted to extented format in liblustre to ease changelog analysis. */
+#define HAVE_CHANGELOG_EXTEND_REC 1
+
 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
                                  long long startrec);
 extern int llapi_changelog_fini(void **priv);
-extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
-extern int llapi_changelog_free(struct changelog_rec **rech);
+extern int llapi_changelog_recv(void *priv, struct changelog_ext_rec **rech);
+extern int llapi_changelog_free(struct changelog_ext_rec **rech);
 /* Allow records up to endrec to be destroyed; requires registered id. */
 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
                                  long long endrec);
 
 /* HSM copytool interface.  priv is private state, managed internally
    by these functions */
-extern int llapi_copytool_start(void **priv, int flags, int archive_num_count,
-                                int *archive_nums);
+extern int llapi_copytool_start(void **priv, char *fsname, int flags,
+                                int archive_count, int *archives);
 extern int llapi_copytool_fini(void **priv);
 extern int llapi_copytool_recv(void *priv, struct hsm_action_list **hal,
                                int *msgsize);
 extern int llapi_copytool_free(struct hsm_action_list **hal);
 
+/** @} llapi */
+
 #endif