Whamcloud - gitweb
Revert "LU-1756 kernel: cleanup lustre_compat25.h"
[fs/lustre-release.git] / lustre / include / liblustre.h
index cb184a3..bf34f04 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) 2003, 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 LIBLUSTRE_H__
 #define LIBLUSTRE_H__
 
+/** \defgroup liblustre liblustre
+ *
+ * @{
+ */
+#include <fcntl.h>
+#include <sys/queue.h>
+
 #ifdef __KERNEL__
 #error Kernel files should not #include <liblustre.h>
 #endif
 
 #define loff_t long long
 #define ERESTART 2001
-typedef unsigned short umode_t;
+typedef unsigned short cfs_umode_t;
 
 #endif
 
-/* always adopt 2.5 definitions */
-#define KERNEL_VERSION(a,b,c) ((a)*100+(b)*10+c)
-#define LINUX_VERSION_CODE KERNEL_VERSION(2,6,5)
-
 #ifndef page_private
 #define page_private(page) ((page)->private)
 #define set_page_private(page, v) ((page)->private = (v))
@@ -87,18 +90,18 @@ void *inter_module_get(char *arg);
 static __inline__ int ext2_set_bit(int nr, void *addr)
 {
 #ifdef __BIG_ENDIAN
-        return set_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
+        return cfs_set_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
 #else
-        return set_bit(nr, addr);
+        return cfs_set_bit(nr, addr);
 #endif
 }
 
 static __inline__ int ext2_clear_bit(int nr, void *addr)
 {
 #ifdef __BIG_ENDIAN
-        return clear_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
+        return cfs_clear_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
 #else
-        return clear_bit(nr, addr);
+        return cfs_clear_bit(nr, addr);
 #endif
 }
 
@@ -108,7 +111,7 @@ static __inline__ int ext2_test_bit(int nr, void *addr)
         __const__ unsigned char *tmp = (__const__ unsigned char *) addr;
         return (tmp[nr >> 3] >> (nr & 7)) & 1;
 #else
-        return test_bit(nr, addr);
+        return cfs_test_bit(nr, addr);
 #endif
 }
 
@@ -128,14 +131,13 @@ extern int echo_client_init(void);
 
 /* general stuff */
 
-#define EXPORT_SYMBOL(S)
-
-struct rcu_head { };
-
-typedef __u64 kdev_t;
-
+#ifndef min
 #define min(x,y) ((x)<(y) ? (x) : (y))
+#endif
+
+#ifndef max
 #define max(x,y) ((x)>(y) ? (x) : (y))
+#endif
 
 #ifndef min_t
 #define min_t(type,x,y) \
@@ -152,17 +154,17 @@ typedef __u64 kdev_t;
 #ifndef ERESTARTSYS
 #define ERESTARTSYS ERESTART
 #endif
-#define HZ 1
+#define CFS_HZ 1
 
 /* random */
 
-void get_random_bytes(void *ptr, int size);
+void cfs_get_random_bytes(void *ptr, int size);
 
 /* memory */
 
 /* memory size: used for some client tunables */
-#define num_physpages      (256 * 1024) /* 1GB */
-#define CFS_NUM_CACHEPAGES num_physpages
+#define cfs_num_physpages  (256 * 1024) /* 1GB */
+#define CFS_NUM_CACHEPAGES cfs_num_physpages
 
 
 /* VFS stuff */
@@ -183,10 +185,11 @@ void get_random_bytes(void *ptr, int size);
 #define ATTR_BLOCKS     0x4000
 #define ATTR_KILL_SUID  0
 #define ATTR_KILL_SGID  0
+#define ATTR_FILE       0
 
 struct iattr {
         unsigned int    ia_valid;
-        umode_t         ia_mode;
+        cfs_umode_t     ia_mode;
         uid_t           ia_uid;
         gid_t           ia_gid;
         loff_t          ia_size;
@@ -196,21 +199,7 @@ struct iattr {
         unsigned int    ia_attr_flags;
 };
 
-#define ll_iattr iattr
-
-#define IT_OPEN     0x0001
-#define IT_CREAT    0x0002
-#define IT_READDIR  0x0004
-#define IT_GETATTR  0x0008
-#define IT_LOOKUP   0x0010
-#define IT_UNLINK   0x0020
-#define IT_GETXATTR 0x0040
-#define IT_EXEC     0x0080
-#define IT_PIN      0x0100
-
-#define IT_FL_LOCKED   0x0001
-#define IT_FL_FOLLOWED 0x0002 /* set by vfs_follow_link */
-
+/* defined in kernel header include/linux/namei.h */
 #define INTENT_MAGIC 0x19620323
 
 struct lustre_intent_data {
@@ -219,7 +208,6 @@ struct lustre_intent_data {
         __u64     it_lock_handle;
         void     *it_data;
         int       it_lock_mode;
-        int it_int_flags;
 };
 struct lookup_intent {
         int     it_magic;
@@ -252,6 +240,9 @@ struct signal {
         int signal;
 };
 
+#undef  LL_TASK_CL_ENV
+#define LL_TASK_CL_ENV          cl_env
+
 struct task_struct {
         int state;
         struct signal pending;
@@ -264,6 +255,7 @@ struct task_struct {
         int max_groups;
         int ngroups;
         gid_t *groups;
+        void  *cl_env;
         __u32 cap_effective;
 };
 
@@ -272,14 +264,16 @@ typedef struct task_struct cfs_task_t;
 #define cfs_current()           current
 #define cfs_curproc_pid()       (current->pid)
 #define cfs_curproc_comm()      (current->comm)
+#define cfs_curproc_fsuid()     (current->fsuid)
+#define cfs_curproc_fsgid()     (current->fsgid)
 
 extern struct task_struct *current;
-int in_group_p(gid_t gid);
+int cfs_curproc_is_in_groups(gid_t gid);
 
-#define set_current_state(foo) do { current->state = foo; } while (0)
+#define cfs_set_current_state(foo) do { current->state = foo; } while (0)
 
-#define wait_event_interruptible(wq, condition)                         \
-({                                                                      \
+#define cfs_wait_event_interruptible(wq, condition, ret)                \
+                                                                      \
         struct l_wait_info lwi;                                         \
         int timeout = 100000000;/* for ever */                          \
         int ret;                                                        \
@@ -288,20 +282,17 @@ int in_group_p(gid_t gid);
         ret = l_wait_event(NULL, condition, &lwi);                      \
                                                                         \
         ret;                                                            \
-})
+}
 
-#define lock_kernel() do {} while (0)
-#define unlock_kernel() do {} while (0)
 #define daemonize(l) do {} while (0)
 #define sigfillset(l) do {} while (0)
 #define recalc_sigpending(l) do {} while (0)
-#define kernel_thread(l,m,n) LBUG()
 
 #define USERMODEHELPER(path, argv, envp) (0)
 #define SIGNAL_MASK_ASSERT()
-#define KERN_INFO
+#define CFS_KERN_INFO
 
-#if HZ != 1
+#if CFS_HZ != 1
 #error "liblustre's jiffies currently expects HZ to be 1"
 #endif
 #define jiffies                                 \
@@ -321,14 +312,10 @@ int in_group_p(gid_t gid);
 #define unlikely(exp) (exp)
 #endif
 
-#define might_sleep()
+#define cfs_might_sleep()
 #define might_sleep_if(c)
 #define smp_mb()
 
-#define libcfs_memory_pressure_get() (0) 
-#define libcfs_memory_pressure_put() do {} while (0) 
-#define libcfs_memory_pressure_clr() do {} while (0)
-
 /* FIXME sys/capability will finally included linux/fs.h thus
  * cause numerous trouble on x86-64. as temporary solution for
  * build broken at Cray, we copy definition we need from capability.h
@@ -355,10 +342,10 @@ static inline void libcfs_run_lbug_upcall(char *file, const char *fn,
 
 
 struct liblustre_wait_callback {
-        struct list_head    llwc_list;
-        const char         *llwc_name;
-        int               (*llwc_fn)(void *arg);
-        void               *llwc_arg;
+        cfs_list_t              llwc_list;
+        const char             *llwc_name;
+        int                   (*llwc_fn)(void *arg);
+        void                   *llwc_arg;
 };
 
 void *liblustre_register_wait_callback(const char *name,
@@ -379,9 +366,9 @@ struct nfs_lock_info {
 };
 
 typedef struct file_lock {
-        struct file_lock *fl_next;      /* singly linked list for this inode  */
-        struct list_head fl_link;       /* doubly linked list of all locks */
-        struct list_head fl_block;      /* circular list of blocked processes */
+        struct file_lock *fl_next;  /* singly linked list for this inode  */
+        cfs_list_t fl_link;   /* doubly linked list of all locks */
+        cfs_list_t fl_block;  /* circular list of blocked processes */
         void *fl_owner;
         unsigned int fl_pid;
         cfs_waitq_t fl_wait;
@@ -417,6 +404,16 @@ typedef struct file_lock {
 #define OFFSET_MAX      INT_LIMIT(loff_t)
 #endif
 
+#define i_atime                     i_stbuf.st_atime
+#define i_mtime                     i_stbuf.st_mtime
+#define i_ctime                     i_stbuf.st_ctime
+/* use i_size_read() i_size_write() to access i_stbuf.st_size */
+#define i_blocks                    i_stbuf.st_blocks
+#define i_blksize                   i_stbuf.st_blksize
+#define i_mode                      i_stbuf.st_mode
+#define i_uid                       i_stbuf.st_uid
+#define i_gid                       i_stbuf.st_gid
+
 /* XXX: defined in kernel */
 #define FL_POSIX        1
 #define FL_SLEEP        128
@@ -426,32 +423,27 @@ typedef struct file_lock {
 #define NO_QUOTA 1
 
 /* ACL */
-struct posix_acl_entry {
-        short                   e_tag;
-        unsigned short          e_perm;
-        unsigned int            e_id;
-};
-
-struct posix_acl {
-        atomic_t                a_refcount;
-        unsigned int            a_count;
-        struct posix_acl_entry  a_entries[0];
-};
-
 typedef struct {
         __u16           e_tag;
         __u16           e_perm;
         __u32           e_id;
-} xattr_acl_entry;
+} posix_acl_xattr_entry;
+
+struct posix_acl {
+        cfs_atomic_t           a_refcount;
+        unsigned int           a_count;
+        posix_acl_xattr_entry  a_entries[0];
+};
 
 typedef struct {
-        __u32           a_version;
-        xattr_acl_entry a_entries[0];
-} xattr_acl_header;
+        __u32                 a_version;
+        posix_acl_xattr_entry a_entries[0];
+} posix_acl_xattr_header;
 
-static inline size_t xattr_acl_size(int count)
+static inline size_t posix_acl_xattr_size(int count)
 {
-        return sizeof(xattr_acl_header) + count * sizeof(xattr_acl_entry);
+        return sizeof(posix_acl_xattr_header) + count *
+               sizeof(posix_acl_xattr_entry);
 }
 
 static inline
@@ -471,19 +463,8 @@ void posix_acl_release(struct posix_acl *acl)
 {
 }
 
-#ifdef LIBLUSTRE_POSIX_ACL
-# ifndef posix_acl_xattr_entry
-#  define posix_acl_xattr_entry xattr_acl_entry
-# endif
-# ifndef posix_acl_xattr_header
-#  define posix_acl_xattr_header xattr_acl_header
-# endif
-# ifndef posix_acl_xattr_size
-#  define posix_acl_xattr_size(entry) xattr_acl_size(entry)
-# endif
-# ifndef CONFIG_FS_POSIX_ACL
-#  define CONFIG_FS_POSIX_ACL 1
-# endif
+#if defined(LIBLUSTRE_POSIX_ACL) && !defined(CONFIG_FS_POSIX_ACL)
+# define CONFIG_FS_POSIX_ACL 1
 #endif
 
 #ifndef ENOTSUPP
@@ -504,6 +485,9 @@ static inline void set_fs(mm_segment_t seg)
 {
 }
 
+#define S_IRWXUGO       (S_IRWXU|S_IRWXG|S_IRWXO)
+#define S_IALLUGO       (S_ISUID|S_ISGID|S_ISVTX|S_IRWXUGO)
+
 #include <obd_support.h>
 #include <lustre/lustre_idl.h>
 #include <lustre_lib.h>
@@ -511,4 +495,6 @@ static inline void set_fs(mm_segment_t seg)
 #include <lustre_export.h>
 #include <lustre_net.h>
 
+/** @} liblustre */
+
 #endif