lustre/include/liblustre.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  * lustre/include/liblustre.h
  37  *
  38  * User-space Lustre headers.
  39  */
  40
  41 #ifndef LIBLUSTRE_H__
  42 #define LIBLUSTRE_H__
  43
  44 #ifdef __KERNEL__
  45 #error Kernel files should not #include <liblustre.h>
  46 #endif
  47
  48 #include <libcfs/libcfs.h>
  49 #include <lnet/lnet.h>
  50
  51 /* definitions for liblustre */
  52
  53 #ifdef __CYGWIN__
  54
  55 #define loff_t long long
  56 #define ERESTART 2001
  57 typedef unsigned short cfs_umode_t;
  58
  59 #endif
  60
  61 /* always adopt 2.5 definitions */
  62 #define KERNEL_VERSION(a,b,c) ((a)*100+(b)*10+c)
  63 #define LINUX_VERSION_CODE KERNEL_VERSION(2,6,5)
  64
  65 #ifndef page_private
  66 #define page_private(page) ((page)->private)
  67 #define set_page_private(page, v) ((page)->private = (v))
  68 #endif
  69
  70
  71 /*
  72  * The inter_module_get implementation is specific to liblustre, so this needs
  73  * to stay here for now.
  74  */
  75 static inline void inter_module_put(void *a)
  76 {
  77         return;
  78 }
  79 void *inter_module_get(char *arg);
  80
  81 /* bits ops */
  82
  83 /* a long can be more than 32 bits, so use BITS_PER_LONG
  84  * to allow the compiler to adjust the bit shifting accordingly
  85  */
  86
  87 static __inline__ int ext2_set_bit(int nr, void *addr)
  88 {
  89 #ifdef __BIG_ENDIAN
  90         return cfs_set_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
  91 #else
  92         return cfs_set_bit(nr, addr);
  93 #endif
  94 }
  95
  96 static __inline__ int ext2_clear_bit(int nr, void *addr)
  97 {
  98 #ifdef __BIG_ENDIAN
  99         return cfs_clear_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
 100 #else
 101         return cfs_clear_bit(nr, addr);
 102 #endif
 103 }
 104
 105 static __inline__ int ext2_test_bit(int nr, void *addr)
 106 {
 107 #ifdef __BIG_ENDIAN
 108         __const__ unsigned char *tmp = (__const__ unsigned char *) addr;
 109         return (tmp[nr >> 3] >> (nr & 7)) & 1;
 110 #else
 111         return cfs_test_bit(nr, addr);
 112 #endif
 113 }
 114
 115
 116 /* module initialization */
 117 extern int init_obdclass(void);
 118 extern int ptlrpc_init(void);
 119 extern int ldlm_init(void);
 120 extern int osc_init(void);
 121 extern int lov_init(void);
 122 extern int mdc_init(void);
 123 extern int lmv_init(void);
 124 extern int mgc_init(void);
 125 extern int echo_client_init(void);
 126
 127
 128
 129 /* general stuff */
 130
 131 #define EXPORT_SYMBOL(S)
 132
 133 typedef struct cfs_rcu_head { } cfs_rcu_head_t;
 134
 135 typedef __u64 kdev_t;
 136
 137 #ifndef min
 138 #define min(x,y) ((x)<(y) ? (x) : (y))
 139 #endif
 140
 141 #ifndef max
 142 #define max(x,y) ((x)>(y) ? (x) : (y))
 143 #endif
 144
 145 #ifndef min_t
 146 #define min_t(type,x,y) \
 147         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
 148 #endif
 149 #ifndef max_t
 150 #define max_t(type,x,y) \
 151         ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
 152 #endif
 153
 154 #define simple_strtol strtol
 155
 156 /* registering symbols */
 157 #ifndef ERESTARTSYS
 158 #define ERESTARTSYS ERESTART
 159 #endif
 160 #define CFS_HZ 1
 161
 162 /* random */
 163
 164 void cfs_get_random_bytes(void *ptr, int size);
 165
 166 /* memory */
 167
 168 /* memory size: used for some client tunables */
 169 #define cfs_num_physpages  (256 * 1024) /* 1GB */
 170 #define CFS_NUM_CACHEPAGES cfs_num_physpages
 171
 172
 173 /* VFS stuff */
 174 #define ATTR_MODE       0x0001
 175 #define ATTR_UID        0x0002
 176 #define ATTR_GID        0x0004
 177 #define ATTR_SIZE       0x0008
 178 #define ATTR_ATIME      0x0010
 179 #define ATTR_MTIME      0x0020
 180 #define ATTR_CTIME      0x0040
 181 #define ATTR_ATIME_SET  0x0080
 182 #define ATTR_MTIME_SET  0x0100
 183 #define ATTR_FORCE      0x0200  /* Not a change, but a change it */
 184 #define ATTR_ATTR_FLAG  0x0400
 185 #define ATTR_RAW        0x0800  /* file system, not vfs will massage attrs */
 186 #define ATTR_FROM_OPEN  0x1000  /* called from open path, ie O_TRUNC */
 187 #define ATTR_CTIME_SET  0x2000
 188 #define ATTR_BLOCKS     0x4000
 189 #define ATTR_KILL_SUID  0
 190 #define ATTR_KILL_SGID  0
 191
 192 struct iattr {
 193         unsigned int    ia_valid;
 194         cfs_umode_t     ia_mode;
 195         uid_t           ia_uid;
 196         gid_t           ia_gid;
 197         loff_t          ia_size;
 198         time_t          ia_atime;
 199         time_t          ia_mtime;
 200         time_t          ia_ctime;
 201         unsigned int    ia_attr_flags;
 202 };
 203
 204 #define ll_iattr iattr
 205
 206 #define IT_OPEN     0x0001
 207 #define IT_CREAT    0x0002
 208 #define IT_READDIR  0x0004
 209 #define IT_GETATTR  0x0008
 210 #define IT_LOOKUP   0x0010
 211 #define IT_UNLINK   0x0020
 212 #define IT_GETXATTR 0x0040
 213 #define IT_EXEC     0x0080
 214 #define IT_PIN      0x0100
 215
 216 #define IT_FL_LOCKED   0x0001
 217 #define IT_FL_FOLLOWED 0x0002 /* set by vfs_follow_link */
 218
 219 #define INTENT_MAGIC 0x19620323
 220
 221 struct lustre_intent_data {
 222         int       it_disposition;
 223         int       it_status;
 224         __u64     it_lock_handle;
 225         void     *it_data;
 226         int       it_lock_mode;
 227         int it_int_flags;
 228 };
 229 struct lookup_intent {
 230         int     it_magic;
 231         void    (*it_op_release)(struct lookup_intent *);
 232         int     it_op;
 233         int     it_flags;
 234         int     it_create_mode;
 235         union {
 236                 struct lustre_intent_data lustre;
 237         } d;
 238 };
 239
 240 static inline void intent_init(struct lookup_intent *it, int op, int flags)
 241 {
 242         memset(it, 0, sizeof(*it));
 243         it->it_magic = INTENT_MAGIC;
 244         it->it_op = op;
 245         it->it_flags = flags;
 246 }
 247
 248 struct dentry {
 249         int d_count;
 250 };
 251
 252 struct vfsmount {
 253         void *pwd;
 254 };
 255
 256 struct signal {
 257         int signal;
 258 };
 259
 260 struct task_struct {
 261         int state;
 262         struct signal pending;
 263         char comm[32];
 264         int uid;
 265         int gid;
 266         int pid;
 267         int fsuid;
 268         int fsgid;
 269         int max_groups;
 270         int ngroups;
 271         gid_t *groups;
 272         __u32 cap_effective;
 273 };
 274
 275
 276 typedef struct task_struct cfs_task_t;
 277 #define cfs_current()           current
 278 #define cfs_curproc_pid()       (current->pid)
 279 #define cfs_curproc_comm()      (current->comm)
 280 #define cfs_curproc_fsuid()     (current->fsuid)
 281 #define cfs_curproc_fsgid()     (current->fsgid)
 282
 283 extern struct task_struct *current;
 284 int cfs_curproc_is_in_groups(gid_t gid);
 285
 286 #define cfs_set_current_state(foo) do { current->state = foo; } while (0)
 287
 288 #define cfs_wait_event_interruptible(wq, condition, ret)                \
 289 {                                                                       \
 290         struct l_wait_info lwi;                                         \
 291         int timeout = 100000000;/* for ever */                          \
 292         int ret;                                                        \
 293                                                                         \
 294         lwi = LWI_TIMEOUT(timeout, NULL, NULL);                         \
 295         ret = l_wait_event(NULL, condition, &lwi);                      \
 296                                                                         \
 297         ret;                                                            \
 298 }
 299
 300 #define cfs_lock_kernel() do {} while (0)
 301 #define cfs_unlock_kernel() do {} while (0)
 302 #define daemonize(l) do {} while (0)
 303 #define sigfillset(l) do {} while (0)
 304 #define recalc_sigpending(l) do {} while (0)
 305 #define cfs_kernel_thread(l,m,n) LBUG()
 306
 307 #define USERMODEHELPER(path, argv, envp) (0)
 308 #define SIGNAL_MASK_ASSERT()
 309 #define CFS_KERN_INFO
 310
 311 #if CFS_HZ != 1
 312 #error "liblustre's jiffies currently expects HZ to be 1"
 313 #endif
 314 #define jiffies                                 \
 315 ({                                              \
 316         unsigned long _ret = 0;                 \
 317         struct timeval tv;                      \
 318         if (gettimeofday(&tv, NULL) == 0)       \
 319                 _ret = tv.tv_sec;               \
 320         _ret;                                   \
 321 })
 322 #define get_jiffies_64()  (__u64)jiffies
 323
 324 #ifndef likely
 325 #define likely(exp) (exp)
 326 #endif
 327 #ifndef unlikely
 328 #define unlikely(exp) (exp)
 329 #endif
 330
 331 #define cfs_might_sleep()
 332 #define might_sleep_if(c)
 333 #define smp_mb()
 334
 335 #define libcfs_memory_pressure_get() (0)
 336 #define libcfs_memory_pressure_put() do {} while (0)
 337 #define libcfs_memory_pressure_clr() do {} while (0)
 338
 339 /* FIXME sys/capability will finally included linux/fs.h thus
 340  * cause numerous trouble on x86-64. as temporary solution for
 341  * build broken at Cray, we copy definition we need from capability.h
 342  * FIXME
 343  */
 344 struct _cap_struct;
 345 typedef struct _cap_struct *cap_t;
 346 typedef int cap_value_t;
 347 typedef enum {
 348     CAP_EFFECTIVE=0,
 349     CAP_PERMITTED=1,
 350     CAP_INHERITABLE=2
 351 } cap_flag_t;
 352 typedef enum {
 353     CAP_CLEAR=0,
 354     CAP_SET=1
 355 } cap_flag_value_t;
 356
 357 cap_t   cap_get_proc(void);
 358 int     cap_get_flag(cap_t, cap_value_t, cap_flag_t, cap_flag_value_t *);
 359
 360 static inline void libcfs_run_lbug_upcall(char *file, const char *fn,
 361                                            const int l){}
 362
 363
 364 struct liblustre_wait_callback {
 365         cfs_list_t              llwc_list;
 366         const char             *llwc_name;
 367         int                   (*llwc_fn)(void *arg);
 368         void                   *llwc_arg;
 369 };
 370
 371 void *liblustre_register_wait_callback(const char *name,
 372                                        int (*fn)(void *arg), void *arg);
 373 void liblustre_deregister_wait_callback(void *notifier);
 374 int liblustre_wait_event(int timeout);
 375
 376 void *liblustre_register_idle_callback(const char *name,
 377                                        int (*fn)(void *arg), void *arg);
 378 void liblustre_deregister_idle_callback(void *notifier);
 379 void liblustre_wait_idle(void);
 380
 381 /* flock related */
 382 struct nfs_lock_info {
 383         __u32             state;
 384         __u32             flags;
 385         void            *host;
 386 };
 387
 388 typedef struct file_lock {
 389         struct file_lock *fl_next;  /* singly linked list for this inode  */
 390         cfs_list_t fl_link;   /* doubly linked list of all locks */
 391         cfs_list_t fl_block;  /* circular list of blocked processes */
 392         void *fl_owner;
 393         unsigned int fl_pid;
 394         cfs_waitq_t fl_wait;
 395         struct file *fl_file;
 396         unsigned char fl_flags;
 397         unsigned char fl_type;
 398         loff_t fl_start;
 399         loff_t fl_end;
 400
 401         void (*fl_notify)(struct file_lock *);  /* unblock callback */
 402         void (*fl_insert)(struct file_lock *);  /* lock insertion callback */
 403         void (*fl_remove)(struct file_lock *);  /* lock removal callback */
 404
 405         void *fl_fasync; /* for lease break notifications */
 406         unsigned long fl_break_time;    /* for nonblocking lease breaks */
 407
 408         union {
 409                 struct nfs_lock_info    nfs_fl;
 410         } fl_u;
 411 } cfs_flock_t;
 412
 413 #define cfs_flock_type(fl)                  ((fl)->fl_type)
 414 #define cfs_flock_set_type(fl, type)        do { (fl)->fl_type = (type); } while(0)
 415 #define cfs_flock_pid(fl)                   ((fl)->fl_pid)
 416 #define cfs_flock_set_pid(fl, pid)          do { (fl)->fl_pid = (pid); } while(0)
 417 #define cfs_flock_start(fl)                 ((fl)->fl_start)
 418 #define cfs_flock_set_start(fl, start)      do { (fl)->fl_start = (start); } while(0)
 419 #define cfs_flock_end(fl)                   ((fl)->fl_end)
 420 #define cfs_flock_set_end(fl, end)          do { (fl)->fl_end = (end); } while(0)
 421
 422 #ifndef OFFSET_MAX
 423 #define INT_LIMIT(x)    (~((x)1 << (sizeof(x)*8 - 1)))
 424 #define OFFSET_MAX      INT_LIMIT(loff_t)
 425 #endif
 426
 427 /* XXX: defined in kernel */
 428 #define FL_POSIX        1
 429 #define FL_SLEEP        128
 430
 431 /* quota */
 432 #define QUOTA_OK 0
 433 #define NO_QUOTA 1
 434
 435 /* ACL */
 436 struct posix_acl_entry {
 437         short                   e_tag;
 438         unsigned short          e_perm;
 439         unsigned int            e_id;
 440 };
 441
 442 struct posix_acl {
 443         cfs_atomic_t            a_refcount;
 444         unsigned int            a_count;
 445         struct posix_acl_entry  a_entries[0];
 446 };
 447
 448 typedef struct {
 449         __u16           e_tag;
 450         __u16           e_perm;
 451         __u32           e_id;
 452 } xattr_acl_entry;
 453
 454 typedef struct {
 455         __u32           a_version;
 456         xattr_acl_entry a_entries[0];
 457 } xattr_acl_header;
 458
 459 static inline size_t xattr_acl_size(int count)
 460 {
 461         return sizeof(xattr_acl_header) + count * sizeof(xattr_acl_entry);
 462 }
 463
 464 static inline
 465 struct posix_acl * posix_acl_from_xattr(const void *value, size_t size)
 466 {
 467         return NULL;
 468 }
 469
 470 static inline
 471 int posix_acl_valid(const struct posix_acl *acl)
 472 {
 473         return 0;
 474 }
 475
 476 static inline
 477 void posix_acl_release(struct posix_acl *acl)
 478 {
 479 }
 480
 481 #ifdef LIBLUSTRE_POSIX_ACL
 482 # ifndef posix_acl_xattr_entry
 483 #  define posix_acl_xattr_entry xattr_acl_entry
 484 # endif
 485 # ifndef posix_acl_xattr_header
 486 #  define posix_acl_xattr_header xattr_acl_header
 487 # endif
 488 # ifndef posix_acl_xattr_size
 489 #  define posix_acl_xattr_size(entry) xattr_acl_size(entry)
 490 # endif
 491 # ifndef CONFIG_FS_POSIX_ACL
 492 #  define CONFIG_FS_POSIX_ACL 1
 493 # endif
 494 #endif
 495
 496 #ifndef ENOTSUPP
 497 #define ENOTSUPP ENOTSUP
 498 #endif
 499
 500 typedef int mm_segment_t;
 501 enum {
 502         KERNEL_DS,
 503         USER_DS
 504 };
 505 static inline mm_segment_t get_fs(void)
 506 {
 507         return USER_DS;
 508 }
 509
 510 static inline void set_fs(mm_segment_t seg)
 511 {
 512 }
 513
 514 #include <obd_support.h>
 515 #include <lustre/lustre_idl.h>
 516 #include <lustre_lib.h>
 517 #include <lustre_import.h>
 518 #include <lustre_export.h>
 519 #include <lustre_net.h>
 520
 521 #endif