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