1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001 Cluster File Systems, Inc. <info@clusterfs.com>
6 * This file is part of Lustre, http://www.lustre.org.
8 * Lustre is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Lustre is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Lustre; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * User-space Lustre headers.
28 #error Kernel files should not #include <liblustre.h>
31 * The userspace implementations of linux/spinlock.h vary; we just
32 * include our own for all of them
34 #define __LINUX_SPINLOCK_H
41 #ifdef HAVE_ASM_PAGE_H
42 # include <asm/page.h>
44 #ifdef HAVE_SYS_USER_H
45 # include <sys/user.h>
47 #ifdef HAVE_SYS_IOCTL_H
48 # include <sys/ioctl.h>
55 #include <sys/ioctl.h>
67 #include <libcfs/list.h>
68 #include <lnet/lnet.h>
69 #include <libcfs/kp30.h>
71 /* definitions for liblustre */
75 #define CFS_PAGE_SHIFT 12
76 #define CFS_PAGE_SIZE (1UL << CFS_PAGE_SHIFT)
77 #define CFS_PAGE_MASK (~((__u64)CFS_PAGE_SIZE-1))
78 #define loff_t long long
80 typedef unsigned short umode_t;
84 #ifndef CURRENT_SECONDS
85 # define CURRENT_SECONDS time(0)
89 #define ARRAY_SIZE(a) ((sizeof (a))/(sizeof ((a)[0])))
92 /* This is because lprocfs_status.h gets included here indirectly. It would
93 * be much better to just avoid lprocfs being included into liblustre entirely
94 * but that requires more header surgery than I can handle right now.
96 #ifndef smp_processor_id
97 #define smp_processor_id() 0
100 #define smp_num_cpus 1
103 /* always adopt 2.5 definitions */
104 #define KERNEL_VERSION(a,b,c) ((a)*100+(b)*10+c)
105 #define LINUX_VERSION_CODE KERNEL_VERSION(2,5,0)
108 #define page_private(page) ((page)->private)
109 #define set_page_private(page, v) ((page)->private = (v))
113 static inline void inter_module_put(void *a)
118 void *inter_module_get(char *arg);
123 void (*ws_task)(void *arg);
127 static inline void prepare_work(struct work_struct *q, void (*t)(void *),
135 static inline void schedule_work(struct work_struct *q)
137 q->ws_task(q->ws_arg);
141 #define strnlen(a,b) strlen(a)
142 static inline void *kmalloc(int size, int prot)
146 #define vmalloc malloc
148 #define kfree(a) free(a)
150 #define GFP_HIGHUSER 1
153 #define IS_ERR(a) ((unsigned long)(a) > (unsigned long)-1000L)
154 #define PTR_ERR(a) ((long)(a))
155 #define ERR_PTR(a) ((void*)((long)(a)))
157 typedef int (read_proc_t)(char *page, char **start, off_t off,
158 int count, int *eof, void *data);
160 struct file; /* forward ref */
161 typedef int (write_proc_t)(struct file *file, const char *buffer,
162 unsigned long count, void *data);
164 #define NIPQUAD(addr) \
165 ((unsigned char *)&addr)[0], \
166 ((unsigned char *)&addr)[1], \
167 ((unsigned char *)&addr)[2], \
168 ((unsigned char *)&addr)[3]
170 #if defined(__LITTLE_ENDIAN)
171 #define HIPQUAD(addr) \
172 ((unsigned char *)&addr)[3], \
173 ((unsigned char *)&addr)[2], \
174 ((unsigned char *)&addr)[1], \
175 ((unsigned char *)&addr)[0]
176 #elif defined(__BIG_ENDIAN)
177 #define HIPQUAD NIPQUAD
179 #error "Undefined byteorder??"
180 #endif /* __LITTLE_ENDIAN */
184 /* a long can be more than 32 bits, so use BITS_PER_LONG
185 * to allow the compiler to adjust the bit shifting accordingly
188 /* test if bit nr is set in bitmap addr; returns previous value of bit nr */
189 static __inline__ int set_bit(int nr, long * addr)
193 addr += nr / BITS_PER_LONG;
194 mask = 1UL << (nr & (BITS_PER_LONG - 1));
195 nr = (mask & *addr) != 0;
200 /* clear bit nr in bitmap addr; returns previous value of bit nr*/
201 static __inline__ int clear_bit(int nr, long * addr)
205 addr += nr / BITS_PER_LONG;
206 mask = 1UL << (nr & (BITS_PER_LONG - 1));
207 nr = (mask & *addr) != 0;
212 static __inline__ int test_bit(int nr, const long * addr)
214 return ((1UL << (nr & (BITS_PER_LONG - 1))) & ((addr)[nr / BITS_PER_LONG])) != 0;
217 static __inline__ int ext2_set_bit(int nr, void *addr)
219 return set_bit(nr, (long*)addr);
222 static __inline__ int ext2_clear_bit(int nr, void *addr)
224 return clear_bit(nr, (long*)addr);
227 static __inline__ int ext2_test_bit(int nr, void *addr)
229 return test_bit(nr, (long*)addr);
238 static inline void MODULE_AUTHOR(char *name)
240 printf("%s\n", name);
242 #define MODULE_DESCRIPTION(name) MODULE_AUTHOR(name)
243 #define MODULE_LICENSE(name) MODULE_AUTHOR(name)
245 #define THIS_MODULE NULL
251 static inline int misc_register(void *foo)
256 static inline int misc_deregister(void *foo)
261 static inline int request_module(char *name)
266 #define __MOD_INC_USE_COUNT(m) do {} while (0)
267 #define __MOD_DEC_USE_COUNT(m) do {} while (0)
268 #define MOD_INC_USE_COUNT do {} while (0)
269 #define MOD_DEC_USE_COUNT do {} while (0)
270 static inline void __module_get(struct module *module)
274 static inline int try_module_get(struct module *module)
279 static inline void module_put(struct module *module)
283 /* module initialization */
284 extern int init_obdclass(void);
285 extern int ptlrpc_init(void);
286 extern int ldlm_init(void);
287 extern int osc_init(void);
288 extern int lov_init(void);
289 extern int mdc_init(void);
290 extern int lmv_init(void);
291 extern int mgc_init(void);
292 extern int echo_client_init(void);
298 #define EXPORT_SYMBOL(S)
302 typedef struct { } spinlock_t;
303 typedef __u64 kdev_t;
305 #define SPIN_LOCK_UNLOCKED (spinlock_t) { }
306 #define LASSERT_SPIN_LOCKED(lock) do {} while(0)
307 #define LASSERT_SEM_LOCKED(sem) do {} while(0)
309 static inline void spin_lock(spinlock_t *l) {return;}
310 static inline void spin_unlock(spinlock_t *l) {return;}
311 static inline void spin_lock_init(spinlock_t *l) {return;}
312 static inline void local_irq_save(unsigned long flag) {return;}
313 static inline void local_irq_restore(unsigned long flag) {return;}
314 static inline int spin_is_locked(spinlock_t *l) {return 1;}
316 static inline void spin_lock_bh(spinlock_t *l) {}
317 static inline void spin_unlock_bh(spinlock_t *l) {}
318 static inline void spin_lock_irqsave(spinlock_t *a, unsigned long b) {}
319 static inline void spin_unlock_irqrestore(spinlock_t *a, unsigned long b) {}
321 typedef spinlock_t rwlock_t;
322 #define RW_LOCK_UNLOCKED SPIN_LOCK_UNLOCKED
323 #define read_lock(l) spin_lock(l)
324 #define read_unlock(l) spin_unlock(l)
325 #define write_lock(l) spin_lock(l)
326 #define write_unlock(l) spin_unlock(l)
329 #define min(x,y) ((x)<(y) ? (x) : (y))
330 #define max(x,y) ((x)>(y) ? (x) : (y))
333 #define min_t(type,x,y) \
334 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
337 #define max_t(type,x,y) \
338 ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
341 #define simple_strtol strtol
343 /* registering symbols */
345 #define ERESTARTSYS ERESTART
351 void get_random_bytes(void *ptr, int size);
355 /* memory size: used for some client tunables */
356 #define num_physpages (256 * 1024) /* 1GB */
358 static inline int copy_from_user(void *a,void *b, int c)
364 static inline int copy_to_user(void *a,void *b, int c)
375 #define SLAB_HWCACHE_ALIGN 0
376 static inline kmem_cache_t *
377 kmem_cache_create(const char *name, size_t objsize, size_t cdum,
379 void (*e)(void *, kmem_cache_t *, unsigned long),
380 void (*f)(void *, kmem_cache_t *, unsigned long))
383 c = malloc(sizeof(*c));
387 CDEBUG(D_MALLOC, "alloc slab cache %s at %p, objsize %d\n",
388 name, c, (int)objsize);
392 static inline int kmem_cache_destroy(kmem_cache_t *a)
394 CDEBUG(D_MALLOC, "destroy slab cache %p, objsize %u\n", a, a->size);
399 /* struct page decl moved out from here into portals/include/libcfs/user-prim.h */
402 #define PAGE_LIST_ENTRY list
403 #define PAGE_LIST(page) ((page)->list)
405 #define kmap(page) (page)->addr
406 #define kunmap(a) do {} while (0)
408 static inline cfs_page_t *alloc_pages(int mask, unsigned long order)
410 cfs_page_t *pg = malloc(sizeof(*pg));
414 #if 0 //#ifdef MAP_ANONYMOUS
415 pg->addr = mmap(0, PAGE_SIZE << order, PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
417 pg->addr = malloc(CFS_PAGE_SIZE << order);
426 #define cfs_alloc_pages(mask, order) alloc_pages((mask), (order))
428 #define alloc_page(mask) alloc_pages((mask), 0)
429 #define cfs_alloc_page(mask) alloc_page(mask)
431 static inline void __free_pages(cfs_page_t *pg, int what)
433 #if 0 //#ifdef MAP_ANONYMOUS
434 munmap(pg->addr, PAGE_SIZE);
440 #define __cfs_free_pages(pg, order) __free_pages((pg), (order))
442 #define __free_page(page) __free_pages((page), 0)
443 #define free_page(page) __free_page(page)
444 #define __cfs_free_page(page) __cfs_free_pages((page), 0)
446 static inline cfs_page_t* __grab_cache_page(unsigned long index)
448 cfs_page_t *pg = alloc_pages(0, 0);
455 #define grab_cache_page(index) __grab_cache_page(index)
456 #define page_cache_release(page) __free_pages(page, 0)
459 #define do_div(a,b) \
461 unsigned long remainder;\
462 remainder = (a) % (b); \
468 #define ATTR_MODE 0x0001
469 #define ATTR_UID 0x0002
470 #define ATTR_GID 0x0004
471 #define ATTR_SIZE 0x0008
472 #define ATTR_ATIME 0x0010
473 #define ATTR_MTIME 0x0020
474 #define ATTR_CTIME 0x0040
475 #define ATTR_ATIME_SET 0x0080
476 #define ATTR_MTIME_SET 0x0100
477 #define ATTR_FORCE 0x0200 /* Not a change, but a change it */
478 #define ATTR_ATTR_FLAG 0x0400
479 #define ATTR_RAW 0x0800 /* file system, not vfs will massage attrs */
480 #define ATTR_FROM_OPEN 0x1000 /* called from open path, ie O_TRUNC */
481 #define ATTR_CTIME_SET 0x2000
482 #define ATTR_BLOCKS 0x4000
485 unsigned int ia_valid;
493 unsigned int ia_attr_flags;
496 #define ll_iattr iattr
498 #define IT_OPEN 0x0001
499 #define IT_CREAT 0x0002
500 #define IT_READDIR 0x0004
501 #define IT_GETATTR 0x0008
502 #define IT_LOOKUP 0x0010
503 #define IT_UNLINK 0x0020
504 #define IT_GETXATTR 0x0040
505 #define IT_EXEC 0x0080
506 #define IT_PIN 0x0100
508 #define IT_FL_LOCKED 0x0001
509 #define IT_FL_FOLLOWED 0x0002 /* set by vfs_follow_link */
511 #define INTENT_MAGIC 0x19620323
513 struct lustre_intent_data {
516 __u64 it_lock_handle;
521 struct lookup_intent {
523 void (*it_op_release)(struct lookup_intent *);
528 struct lustre_intent_data lustre;
532 static inline void intent_init(struct lookup_intent *it, int op, int flags)
534 memset(it, 0, sizeof(*it));
535 it->it_magic = INTENT_MAGIC;
537 it->it_flags = flags;
549 struct rw_semaphore {
558 /* use the macro's argument to avoid unused warnings */
559 #define down(a) do { (void)a; } while (0)
560 #define mutex_down(a) down(a)
561 #define up(a) do { (void)a; } while (0)
562 #define mutex_up(a) up(a)
563 #define down_read(a) do { (void)a; } while (0)
564 #define up_read(a) do { (void)a; } while (0)
565 #define down_write(a) do { (void)a; } while (0)
566 #define up_write(a) do { (void)a; } while (0)
567 #define sema_init(a,b) do { (void)a; } while (0)
568 #define init_rwsem(a) do { (void)a; } while (0)
569 #define DECLARE_MUTEX(name) \
570 struct semaphore name = { 1 }
571 static inline void init_MUTEX (struct semaphore *sem)
575 static inline void init_MUTEX_LOCKED (struct semaphore *sem)
580 #define init_mutex(s) init_MUTEX(s)
583 struct list_head sleepers;
587 struct list_head sleeping;
597 struct signal pending;
610 typedef struct task_struct cfs_task_t;
611 #define cfs_current() current
612 #define cfs_curproc_pid() (current->pid)
613 #define cfs_curproc_comm() (current->comm)
615 extern struct task_struct *current;
616 int in_group_p(gid_t gid);
617 static inline int capable(int cap)
619 if (current->cap_effective & (1 << cap))
625 #define set_current_state(foo) do { current->state = foo; } while (0)
627 #define init_waitqueue_entry(q,p) do { (q)->process = p; } while (0)
628 #define add_wait_queue(q,p) do { list_add(&(q)->sleepers, &(p)->sleeping); } while (0)
629 #define del_wait_queue(p) do { list_del(&(p)->sleeping); } while (0)
630 #define remove_wait_queue(q,p) do { list_del(&(p)->sleeping); } while (0)
632 #define DECLARE_WAIT_QUEUE_HEAD(HEAD) \
633 wait_queue_head_t HEAD = { \
634 .sleepers = LIST_HEAD_INIT(HEAD.sleepers) \
636 #define init_waitqueue_head(l) INIT_LIST_HEAD(&(l)->sleepers)
637 #define wake_up(l) do { int a; a++; } while (0)
638 #define TASK_INTERRUPTIBLE 0
639 #define TASK_UNINTERRUPTIBLE 1
640 #define TASK_RUNNING 2
642 #define wait_event_interruptible(wq, condition) \
644 struct l_wait_info lwi; \
645 int timeout = 100000000;/* for ever */ \
648 lwi = LWI_TIMEOUT(timeout, NULL, NULL); \
649 ret = l_wait_event(NULL, condition, &lwi); \
654 #define in_interrupt() (0)
656 #define schedule() do {} while (0)
657 static inline int schedule_timeout(signed long t)
662 #define lock_kernel() do {} while (0)
663 #define unlock_kernel() do {} while (0)
664 #define daemonize(l) do {} while (0)
665 #define sigfillset(l) do {} while (0)
666 #define recalc_sigpending(l) do {} while (0)
667 #define kernel_thread(l,m,n) LBUG()
669 #define USERMODEHELPER(path, argv, envp) (0)
670 #define SIGNAL_MASK_ASSERT()
673 #include <sys/time.h>
675 #error "liblustre's jiffies currently expects HZ to be 1"
679 unsigned long _ret = 0; \
681 if (gettimeofday(&tv, NULL) == 0) \
685 #define get_jiffies_64() (__u64)jiffies
686 #define time_after(a, b) ((long)(b) - (long)(a) < 0)
687 #define time_before(a, b) time_after(b,a)
688 #define time_after_eq(a,b) ((long)(a) - (long)(b) >= 0)
691 struct list_head tl_list;
692 void (*function)(unsigned long unused);
697 static inline int timer_pending(struct timer_list *l)
699 if (time_after(l->expires, jiffies))
705 static inline int init_timer(struct timer_list *l)
707 INIT_LIST_HEAD(&l->tl_list);
711 static inline void mod_timer(struct timer_list *l, int thetime)
713 l->expires = thetime;
716 static inline void del_timer(struct timer_list *l)
721 typedef struct { volatile int counter; } atomic_t;
723 #define ATOMIC_INIT(i) { (i) }
724 #define atomic_read(a) ((a)->counter)
725 #define atomic_set(a,b) do {(a)->counter = b; } while (0)
726 #define atomic_dec_and_test(a) ((--((a)->counter)) == 0)
727 #define atomic_dec_and_lock(a,b) ((--((a)->counter)) == 0)
728 #define atomic_inc(a) (((a)->counter)++)
729 #define atomic_dec(a) do { (a)->counter--; } while (0)
730 #define atomic_add(b,a) do {(a)->counter += b;} while (0)
731 #define atomic_sub(b,a) do {(a)->counter -= b;} while (0)
734 #define likely(exp) (exp)
737 #define unlikely(exp) (exp)
740 #define might_sleep()
741 #define might_sleep_if(c)
745 int test_and_set_bit(int nr, unsigned long *addr)
749 while (nr >= sizeof(long)) {
754 oldbit = (*addr) & (1 << nr);
760 int test_and_clear_bit(int nr, unsigned long *addr)
764 while (nr >= sizeof(long)) {
769 oldbit = (*addr) & (1 << nr);
774 /* FIXME sys/capability will finally included linux/fs.h thus
775 * cause numerous trouble on x86-64. as temporary solution for
776 * build broken at Cray, we copy definition we need from capability.h
780 typedef struct _cap_struct *cap_t;
781 typedef int cap_value_t;
792 #define CAP_DAC_OVERRIDE 1
793 #define CAP_DAC_READ_SEARCH 2
796 #define CAP_SYS_ADMIN 21
798 cap_t cap_get_proc(void);
799 int cap_get_flag(cap_t, cap_value_t, cap_flag_t, cap_flag_value_t *);
802 static inline int llog_init_commit_master(void) { return 0; }
803 static inline int llog_cleanup_commit_master(int force) { return 0; }
804 static inline void libcfs_run_lbug_upcall(char *file, const char *fn,
813 #define COMPLETION_INITIALIZER(work) \
814 { 0, __WAIT_QUEUE_HEAD_INITIALIZER((work).wait) }
816 #define DECLARE_COMPLETION(work) \
817 struct completion work = COMPLETION_INITIALIZER(work)
819 #define INIT_COMPLETION(x) ((x).done = 0)
821 static inline void init_completion(struct completion *x)
824 init_waitqueue_head(&x->wait);
827 struct liblustre_wait_callback {
828 struct list_head llwc_list;
829 const char *llwc_name;
830 int (*llwc_fn)(void *arg);
834 void *liblustre_register_wait_callback(const char *name,
835 int (*fn)(void *arg), void *arg);
836 void liblustre_deregister_wait_callback(void *notifier);
837 int liblustre_wait_event(int timeout);
839 void *liblustre_register_idle_callback(const char *name,
840 int (*fn)(void *arg), void *arg);
841 void liblustre_deregister_idle_callback(void *notifier);
842 void liblustre_wait_idle(void);
845 struct nfs_lock_info {
851 typedef struct file_lock {
852 struct file_lock *fl_next; /* singly linked list for this inode */
853 struct list_head fl_link; /* doubly linked list of all locks */
854 struct list_head fl_block; /* circular list of blocked processes */
858 struct file *fl_file;
859 unsigned char fl_flags;
860 unsigned char fl_type;
864 void (*fl_notify)(struct file_lock *); /* unblock callback */
865 void (*fl_insert)(struct file_lock *); /* lock insertion callback */
866 void (*fl_remove)(struct file_lock *); /* lock removal callback */
868 void *fl_fasync; /* for lease break notifications */
869 unsigned long fl_break_time; /* for nonblocking lease breaks */
872 struct nfs_lock_info nfs_fl;
876 #define cfs_flock_type(fl) ((fl)->fl_type)
877 #define cfs_flock_set_type(fl, type) do { (fl)->fl_type = (type); } while(0)
878 #define cfs_flock_pid(fl) ((fl)->fl_pid)
879 #define cfs_flock_set_pid(fl, pid) do { (fl)->fl_pid = (pid); } while(0)
880 #define cfs_flock_start(fl) ((fl)->fl_start)
881 #define cfs_flock_set_start(fl, start) do { (fl)->fl_start = (start); } while(0)
882 #define cfs_flock_end(fl) ((fl)->fl_end)
883 #define cfs_flock_set_end(fl, end) do { (fl)->fl_end = (end); } while(0)
886 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
887 #define OFFSET_MAX INT_LIMIT(loff_t)
890 /* XXX: defined in kernel */
899 struct posix_acl_entry {
901 unsigned short e_perm;
907 unsigned int a_count;
908 struct posix_acl_entry a_entries[0];
919 xattr_acl_entry a_entries[0];
922 static inline size_t xattr_acl_size(int count)
924 return sizeof(xattr_acl_header) + count * sizeof(xattr_acl_entry);
928 struct posix_acl * posix_acl_from_xattr(const void *value, size_t size)
934 int posix_acl_valid(const struct posix_acl *acl)
940 void posix_acl_release(struct posix_acl *acl)
945 #define ENOTSUPP ENOTSUP
948 typedef int mm_segment_t;
953 static inline mm_segment_t get_fs(void)
958 static inline void set_fs(mm_segment_t seg)
962 #include <obd_support.h>
963 #include <lustre/lustre_idl.h>
964 #include <lustre_lib.h>
965 #include <lustre_import.h>
966 #include <lustre_export.h>
967 #include <lustre_net.h>
969 /* Fast hashing routine for a long.
970 (C) 2002 William Lee Irwin III, IBM */
973 * Knuth recommends primes in approximately golden ratio to the maximum
974 * integer representable by a machine word for multiplicative hashing.
975 * Chuck Lever verified the effectiveness of this technique:
976 * http://www.citi.umich.edu/techreports/reports/citi-tr-00-1.pdf
978 * These primes are chosen to be bit-sparse, that is operations on
979 * them can use shifts and additions instead of multiplications for
980 * machines where multiplications are slow.
982 #if BITS_PER_LONG == 32
983 /* 2^31 + 2^29 - 2^25 + 2^22 - 2^19 - 2^16 + 1 */
984 #define GOLDEN_RATIO_PRIME 0x9e370001UL
985 #elif BITS_PER_LONG == 64
986 /* 2^63 + 2^61 - 2^57 + 2^54 - 2^51 - 2^18 + 1 */
987 #define GOLDEN_RATIO_PRIME 0x9e37fffffffc0001UL
989 #error Define GOLDEN_RATIO_PRIME for your wordsize.
992 static inline unsigned long hash_long(unsigned long val, unsigned int bits)
994 unsigned long hash = val;
996 #if BITS_PER_LONG == 64
997 /* Sigh, gcc can't optimise this alone like it does for 32 bits. */
998 unsigned long n = hash;
1012 /* On some cpus multiply is faster, on others gcc will do shifts */
1013 hash *= GOLDEN_RATIO_PRIME;
1016 /* High bits are more random, so use them. */
1017 return hash >> (BITS_PER_LONG - bits);
1020 static inline unsigned long hash_ptr(void *ptr, unsigned int bits)
1022 return hash_long((unsigned long)ptr, bits);