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>
66 #include <libcfs/list.h>
67 #include <lnet/lnet.h>
68 #include <libcfs/kp30.h>
69 #include <libcfs/user-bitops.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
99 #ifndef num_online_cpus
100 #define num_online_cpus() 1
102 #ifndef num_possible_cpus
103 #define num_possible_cpus() 1
106 /* always adopt 2.5 definitions */
107 #define KERNEL_VERSION(a,b,c) ((a)*100+(b)*10+c)
108 #define LINUX_VERSION_CODE KERNEL_VERSION(2,5,0)
111 #define page_private(page) ((page)->private)
112 #define set_page_private(page, v) ((page)->private = (v))
116 static inline void inter_module_put(void *a)
121 void *inter_module_get(char *arg);
126 void (*ws_task)(void *arg);
130 static inline void prepare_work(struct work_struct *q, void (*t)(void *),
138 static inline void schedule_work(struct work_struct *q)
140 q->ws_task(q->ws_arg);
144 #define strnlen(a,b) strlen(a)
145 static inline void *kmalloc(int size, int prot)
149 #define vmalloc malloc
151 #define kfree(a) free(a)
153 #define GFP_HIGHUSER 1
156 #define IS_ERR(a) ((unsigned long)(a) > (unsigned long)-1000L)
157 #define PTR_ERR(a) ((long)(a))
158 #define ERR_PTR(a) ((void*)((long)(a)))
164 typedef int (read_proc_t)(char *page, char **start, off_t off,
165 int count, int *eof, void *data);
167 struct file; /* forward ref */
168 typedef int (write_proc_t)(struct file *file, const char *buffer,
169 unsigned long count, void *data);
171 #define NIPQUAD(addr) \
172 ((unsigned char *)&addr)[0], \
173 ((unsigned char *)&addr)[1], \
174 ((unsigned char *)&addr)[2], \
175 ((unsigned char *)&addr)[3]
177 #if defined(__LITTLE_ENDIAN)
178 #define HIPQUAD(addr) \
179 ((unsigned char *)&addr)[3], \
180 ((unsigned char *)&addr)[2], \
181 ((unsigned char *)&addr)[1], \
182 ((unsigned char *)&addr)[0]
183 #elif defined(__BIG_ENDIAN)
184 #define HIPQUAD NIPQUAD
186 #error "Undefined byteorder??"
187 #endif /* __LITTLE_ENDIAN */
191 /* a long can be more than 32 bits, so use BITS_PER_LONG
192 * to allow the compiler to adjust the bit shifting accordingly
195 static __inline__ int ext2_set_bit(int nr, void *addr)
197 return set_bit(nr, (long*)addr);
200 static __inline__ int ext2_clear_bit(int nr, void *addr)
202 return clear_bit(nr, (long*)addr);
205 static __inline__ int ext2_test_bit(int nr, void *addr)
207 return test_bit(nr, (long*)addr);
216 static inline void MODULE_AUTHOR(char *name)
218 printf("%s\n", name);
220 #define MODULE_DESCRIPTION(name) MODULE_AUTHOR(name)
221 #define MODULE_LICENSE(name) MODULE_AUTHOR(name)
223 #define THIS_MODULE NULL
229 static inline int misc_register(void *foo)
234 static inline int misc_deregister(void *foo)
239 static inline int request_module(char *name)
244 #define __MOD_INC_USE_COUNT(m) do {} while (0)
245 #define __MOD_DEC_USE_COUNT(m) do {} while (0)
246 #define MOD_INC_USE_COUNT do {} while (0)
247 #define MOD_DEC_USE_COUNT do {} while (0)
248 static inline void __module_get(struct module *module)
252 static inline int try_module_get(struct module *module)
257 static inline void module_put(struct module *module)
261 /* module initialization */
262 extern int init_obdclass(void);
263 extern int ptlrpc_init(void);
264 extern int ldlm_init(void);
265 extern int osc_init(void);
266 extern int lov_init(void);
267 extern int mdc_init(void);
268 extern int mgc_init(void);
269 extern int echo_client_init(void);
275 #define EXPORT_SYMBOL(S)
279 typedef struct { } spinlock_t;
280 typedef __u64 kdev_t;
282 #define SPIN_LOCK_UNLOCKED (spinlock_t) { }
283 #define LASSERT_SPIN_LOCKED(lock) do {} while(0)
284 #define LASSERT_SEM_LOCKED(sem) do {} while(0)
286 static inline void spin_lock(spinlock_t *l) {return;}
287 static inline void spin_unlock(spinlock_t *l) {return;}
288 static inline void spin_lock_init(spinlock_t *l) {return;}
289 static inline void local_irq_save(unsigned long flag) {return;}
290 static inline void local_irq_restore(unsigned long flag) {return;}
291 static inline int spin_is_locked(spinlock_t *l) {return 1;}
293 static inline void spin_lock_bh(spinlock_t *l) {}
294 static inline void spin_unlock_bh(spinlock_t *l) {}
295 static inline void spin_lock_irqsave(spinlock_t *a, unsigned long b) {}
296 static inline void spin_unlock_irqrestore(spinlock_t *a, unsigned long b) {}
298 #define min(x,y) ((x)<(y) ? (x) : (y))
299 #define max(x,y) ((x)>(y) ? (x) : (y))
302 #define min_t(type,x,y) \
303 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
306 #define max_t(type,x,y) \
307 ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
310 #define simple_strtol strtol
312 /* registering symbols */
314 #define ERESTARTSYS ERESTART
320 void get_random_bytes(void *ptr, int size);
324 /* memory size: used for some client tunables */
325 #define num_physpages (256 * 1024) /* 1GB */
327 static inline int copy_from_user(void *a,void *b, int c)
333 static inline int copy_to_user(void *a,void *b, int c)
344 #define SLAB_HWCACHE_ALIGN 0
345 static inline kmem_cache_t *
346 kmem_cache_create(const char *name, size_t objsize, size_t cdum,
348 void (*e)(void *, kmem_cache_t *, unsigned long),
349 void (*f)(void *, kmem_cache_t *, unsigned long))
352 c = malloc(sizeof(*c));
356 CDEBUG(D_MALLOC, "alloc slab cache %s at %p, objsize %d\n",
357 name, c, (int)objsize);
361 static inline int kmem_cache_destroy(kmem_cache_t *a)
363 CDEBUG(D_MALLOC, "destroy slab cache %p, objsize %u\n", a, a->size);
368 /* struct page decl moved out from here into portals/include/libcfs/user-prim.h */
371 #define PAGE_LIST_ENTRY list
372 #define PAGE_LIST(page) ((page)->list)
374 #define kmap(page) (page)->addr
375 #define kunmap(a) do {} while (0)
377 static inline cfs_page_t *alloc_pages(int mask, unsigned long order)
379 cfs_page_t *pg = malloc(sizeof(*pg));
383 #if 0 //#ifdef MAP_ANONYMOUS
384 pg->addr = mmap(0, PAGE_SIZE << order, PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
386 pg->addr = malloc(CFS_PAGE_SIZE << order);
395 #define cfs_alloc_pages(mask, order) alloc_pages((mask), (order))
397 #define alloc_page(mask) alloc_pages((mask), 0)
398 #define cfs_alloc_page(mask) alloc_page(mask)
400 static inline void __free_pages(cfs_page_t *pg, int what)
402 #if 0 //#ifdef MAP_ANONYMOUS
403 munmap(pg->addr, PAGE_SIZE);
409 #define __cfs_free_pages(pg, order) __free_pages((pg), (order))
411 #define __free_page(page) __free_pages((page), 0)
412 #define free_page(page) __free_page(page)
413 #define __cfs_free_page(page) __cfs_free_pages((page), 0)
415 static inline cfs_page_t* __grab_cache_page(unsigned long index)
417 cfs_page_t *pg = alloc_pages(0, 0);
424 #define grab_cache_page(index) __grab_cache_page(index)
425 #define page_cache_release(page) __free_pages(page, 0)
428 #define do_div(a,b) \
430 unsigned long remainder;\
431 remainder = (a) % (b); \
437 #define ATTR_MODE 0x0001
438 #define ATTR_UID 0x0002
439 #define ATTR_GID 0x0004
440 #define ATTR_SIZE 0x0008
441 #define ATTR_ATIME 0x0010
442 #define ATTR_MTIME 0x0020
443 #define ATTR_CTIME 0x0040
444 #define ATTR_ATIME_SET 0x0080
445 #define ATTR_MTIME_SET 0x0100
446 #define ATTR_FORCE 0x0200 /* Not a change, but a change it */
447 #define ATTR_ATTR_FLAG 0x0400
448 #define ATTR_RAW 0x0800 /* file system, not vfs will massage attrs */
449 #define ATTR_FROM_OPEN 0x1000 /* called from open path, ie O_TRUNC */
450 #define ATTR_CTIME_SET 0x2000
451 #define ATTR_KILL_SUID 0
452 #define ATTR_KILL_SGID 0
455 unsigned int ia_valid;
463 unsigned int ia_attr_flags;
465 #define ll_iattr_struct iattr
467 #define IT_OPEN 0x0001
468 #define IT_CREAT 0x0002
469 #define IT_READDIR 0x0004
470 #define IT_GETATTR 0x0008
471 #define IT_LOOKUP 0x0010
472 #define IT_UNLINK 0x0020
473 #define IT_GETXATTR 0x0040
474 #define IT_EXEC 0x0080
475 #define IT_PIN 0x0100
477 #define IT_FL_LOCKED 0x0001
478 #define IT_FL_FOLLOWED 0x0002 /* set by vfs_follow_link */
480 #define INTENT_MAGIC 0x19620323
482 struct lustre_intent_data {
485 __u64 it_lock_handle;
490 struct lookup_intent {
492 void (*it_op_release)(struct lookup_intent *);
497 struct lustre_intent_data lustre;
501 static inline void intent_init(struct lookup_intent *it, int op, int flags)
503 memset(it, 0, sizeof(*it));
504 it->it_magic = INTENT_MAGIC;
506 it->it_flags = flags;
519 struct rw_semaphore {
528 /* use the macro's argument to avoid unused warnings */
529 #define down(a) do { (void)a; } while (0)
530 #define mutex_down(a) down(a)
531 #define up(a) do { (void)a; } while (0)
532 #define mutex_up(a) up(a)
533 #define down_read(a) do { (void)a; } while (0)
534 #define up_read(a) do { (void)a; } while (0)
535 #define down_write(a) do { (void)a; } while (0)
536 #define up_write(a) do { (void)a; } while (0)
537 #define sema_init(a,b) do { (void)a; } while (0)
538 #define init_rwsem(a) do { (void)a; } while (0)
539 #define DECLARE_MUTEX(name) \
540 struct semaphore name = { 1 }
541 static inline void init_MUTEX (struct semaphore *sem)
545 static inline void init_MUTEX_LOCKED (struct semaphore *sem)
550 #define init_mutex(s) init_MUTEX(s)
553 struct list_head sleepers;
557 struct list_head sleeping;
567 struct signal pending;
578 typedef struct task_struct cfs_task_t;
579 #define cfs_current() current
580 #define cfs_curproc_pid() (current->pid)
581 #define cfs_curproc_comm() (current->comm)
583 extern struct task_struct *current;
584 int in_group_p(gid_t gid);
585 static inline int capable(int cap)
587 if (current->cap_effective & (1 << cap))
593 #define set_current_state(foo) do { current->state = foo; } while (0)
595 #define init_waitqueue_entry(q,p) do { (q)->process = p; } while (0)
596 #define add_wait_queue(q,p) do { list_add(&(q)->sleepers, &(p)->sleeping); } while (0)
597 #define del_wait_queue(p) do { list_del(&(p)->sleeping); } while (0)
598 #define remove_wait_queue(q,p) do { list_del(&(p)->sleeping); } while (0)
600 #define DECLARE_WAIT_QUEUE_HEAD(HEAD) \
601 wait_queue_head_t HEAD = { \
602 .sleepers = LIST_HEAD_INIT(HEAD.sleepers) \
604 #define init_waitqueue_head(l) INIT_LIST_HEAD(&(l)->sleepers)
605 #define wake_up(l) do { int a = 0; a++; } while (0)
606 #define TASK_INTERRUPTIBLE 0
607 #define TASK_UNINTERRUPTIBLE 1
608 #define TASK_RUNNING 2
610 #define wait_event_interruptible(wq, condition) \
612 struct l_wait_info lwi; \
613 int timeout = 100000000;/* for ever */ \
616 lwi = LWI_TIMEOUT(timeout, NULL, NULL); \
617 ret = l_wait_event(NULL, condition, &lwi); \
622 #define in_interrupt() (0)
624 #define schedule() do {} while (0)
625 static inline int schedule_timeout(signed long t)
630 #define lock_kernel() do {} while (0)
631 #define unlock_kernel() do {} while (0)
632 #define daemonize(l) do {} while (0)
633 #define sigfillset(l) do {} while (0)
634 #define recalc_sigpending(l) do {} while (0)
635 #define kernel_thread(l,m,n) LBUG()
637 #define USERMODEHELPER(path, argv, envp) (0)
638 #define SIGNAL_MASK_ASSERT()
641 #include <sys/time.h>
643 #error "liblustre's jiffies currently expects HZ to be 1"
647 unsigned long _ret = 0; \
649 if (gettimeofday(&tv, NULL) == 0) \
653 #define get_jiffies_64() (__u64)jiffies
654 #define time_after(a, b) ((long)(b) - (long)(a) < 0)
655 #define time_before(a, b) time_after(b,a)
656 #define time_after_eq(a,b) ((long)(a) - (long)(b) >= 0)
659 struct list_head tl_list;
660 void (*function)(unsigned long unused);
665 static inline int timer_pending(struct timer_list *l)
667 if (time_after(l->expires, jiffies))
673 static inline int init_timer(struct timer_list *l)
675 INIT_LIST_HEAD(&l->tl_list);
679 static inline void mod_timer(struct timer_list *l, int thetime)
681 l->expires = thetime;
684 static inline void del_timer(struct timer_list *l)
689 typedef struct { volatile int counter; } atomic_t;
691 #define ATOMIC_INIT(i) { i }
693 #define atomic_read(a) ((a)->counter)
694 #define atomic_set(a,b) do {(a)->counter = b; } while (0)
695 #define atomic_dec_and_test(a) ((--((a)->counter)) == 0)
696 #define atomic_dec_and_lock(a,b) ((--((a)->counter)) == 0)
697 #define atomic_inc(a) (((a)->counter)++)
698 #define atomic_dec(a) do { (a)->counter--; } while (0)
699 #define atomic_add(b,a) do {(a)->counter += b;} while (0)
700 #define atomic_add_return(n,a) ((a)->counter = n)
701 #define atomic_inc_return(a) atomic_add_return(1,a)
702 #define atomic_sub(b,a) do {(a)->counter -= b;} while (0)
703 #define atomic_sub_return(n,a) ((a)->counter -= n)
704 #define atomic_dec_return(a) atomic_sub_return(1,a)
707 #define likely(exp) (exp)
710 #define unlikely(exp) (exp)
713 /* FIXME sys/capability will finally included linux/fs.h thus
714 * cause numerous trouble on x86-64. as temporary solution for
715 * build broken at cary, we copy definition we need from capability.h
719 typedef struct _cap_struct *cap_t;
720 typedef int cap_value_t;
731 #define CAP_DAC_OVERRIDE 1
732 #define CAP_DAC_READ_SEARCH 2
735 #define CAP_SYS_ADMIN 21
737 cap_t cap_get_proc(void);
738 int cap_get_flag(cap_t, cap_value_t, cap_flag_t, cap_flag_value_t *);
740 static inline void libcfs_run_lbug_upcall(char *file, const char *fn,
749 #define COMPLETION_INITIALIZER(work) \
750 { 0, __WAIT_QUEUE_HEAD_INITIALIZER((work).wait) }
752 #define DECLARE_COMPLETION(work) \
753 struct completion work = COMPLETION_INITIALIZER(work)
755 #define INIT_COMPLETION(x) ((x).done = 0)
757 static inline void init_completion(struct completion *x)
760 init_waitqueue_head(&x->wait);
763 struct liblustre_wait_callback {
764 struct list_head llwc_list;
765 const char *llwc_name;
766 int (*llwc_fn)(void *arg);
770 void *liblustre_register_wait_callback(const char *name,
771 int (*fn)(void *arg), void *arg);
772 void liblustre_deregister_wait_callback(void *notifier);
773 int liblustre_wait_event(int timeout);
775 void *liblustre_register_idle_callback(const char *name,
776 int (*fn)(void *arg), void *arg);
777 void liblustre_deregister_idle_callback(void *notifier);
778 void liblustre_wait_idle(void);
781 struct nfs_lock_info {
787 typedef struct file_lock {
788 struct file_lock *fl_next; /* singly linked list for this inode */
789 struct list_head fl_link; /* doubly linked list of all locks */
790 struct list_head fl_block; /* circular list of blocked processes */
794 struct file *fl_file;
795 unsigned char fl_flags;
796 unsigned char fl_type;
800 void (*fl_notify)(struct file_lock *); /* unblock callback */
801 void (*fl_insert)(struct file_lock *); /* lock insertion callback */
802 void (*fl_remove)(struct file_lock *); /* lock removal callback */
804 void *fl_fasync; /* for lease break notifications */
805 unsigned long fl_break_time; /* for nonblocking lease breaks */
808 struct nfs_lock_info nfs_fl;
812 #define cfs_flock_type(fl) ((fl)->fl_type)
813 #define cfs_flock_set_type(fl, type) do { (fl)->fl_type = (type); } while(0)
814 #define cfs_flock_pid(fl) ((fl)->fl_pid)
815 #define cfs_flock_set_pid(fl, pid) do { (fl)->fl_pid = (pid); } while(0)
816 #define cfs_flock_start(fl) ((fl)->fl_start)
817 #define cfs_flock_set_start(fl, start) do { (fl)->fl_start = (start); } while(0)
818 #define cfs_flock_end(fl) ((fl)->fl_end)
819 #define cfs_flock_set_end(fl, end) do { (fl)->fl_end = (end); } while(0)
822 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
823 #define OFFSET_MAX INT_LIMIT(loff_t)
826 /* XXX: defined in kernel */
835 struct posix_acl_entry {
837 unsigned short e_perm;
843 unsigned int a_count;
844 struct posix_acl_entry a_entries[0];
855 xattr_acl_entry a_entries[0];
858 static inline size_t xattr_acl_size(int count)
860 return sizeof(xattr_acl_header) + count * sizeof(xattr_acl_entry);
864 struct posix_acl * posix_acl_from_xattr(const void *value, size_t size)
870 int posix_acl_valid(const struct posix_acl *acl)
876 void posix_acl_release(struct posix_acl *acl)
880 #ifdef LIBLUSTRE_POSIX_ACL
881 #ifndef posix_acl_xattr_entry
882 #define posix_acl_xattr_entry xattr_acl_entry
884 #ifndef posix_acl_xattr_header
885 #define posix_acl_xattr_header xattr_acl_header
887 #ifndef posix_acl_xattr_size
888 #define posix_acl_xattr_size(entry) xattr_acl_size(entry)
890 #ifndef CONFIG_FS_POSIX_ACL
891 #define CONFIG_FS_POSIX_ACL 1
896 #define ENOTSUPP ENOTSUP
899 #include <obd_support.h>
900 #include <lustre/lustre_idl.h>
901 #include <lustre_lib.h>
902 #include <lustre_import.h>
903 #include <lustre_export.h>
904 #include <lustre_net.h>