Whamcloud - gitweb
ef010dc87237cf500dbb903d998bb75c1dcfe73e
[fs/lustre-release.git] / lustre / include / liblustre.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  *  Copyright (C) 2001 Cluster File Systems, Inc. <info@clusterfs.com>
5  *
6  *   This file is part of Lustre, http://www.lustre.org.
7  *
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.
11  *
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.
16  *
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.
20  *
21  * User-space Lustre headers.
22  *
23  */
24 #ifndef LIBLUSTRE_H__
25 #define LIBLUSTRE_H__
26
27 #include <asm/byteorder.h>
28 #include <sys/mman.h>
29 #ifndef  __CYGWIN__
30 #include <stdint.h>
31 #include <asm/page.h>
32 #else
33 #include <sys/types.h>
34 #include "ioctl.h"
35 #endif
36 #include <stdio.h>
37 #include <sys/ioctl.h>
38 #include <stdlib.h>
39 #include <string.h>
40 #include <errno.h>
41 #include <sys/stat.h>
42 #include <sys/vfs.h>
43
44 #include <portals/list.h>
45 #include <portals/p30.h>
46 #include <linux/kp30.h>
47
48 /* definitions for liblustre */
49
50 #ifdef __CYGWIN__
51
52 #define PAGE_SHIFT 12
53 #define PAGE_SIZE (1UL << PAGE_SHIFT)
54 #define PAGE_MASK (~(PAGE_SIZE-1))
55 #define loff_t long long
56 #define ERESTART 2001
57 typedef unsigned short umode_t;
58
59 #endif
60
61 /* This is because lprocfs_status.h gets included here indirectly.  It would
62  * be much better to just avoid lprocfs being included into liblustre entirely
63  * but that requires more header surgery than I can handle right now.
64  */
65 #ifndef smp_processor_id
66 #define smp_processor_id() 0
67 #endif
68
69 /* always adopt 2.5 definitions */
70 #define KERNEL_VERSION(a,b,c) ((a)*100+(b)*10+c)
71 #define LINUX_VERSION_CODE (2*200+5*10+0)
72
73 static inline void inter_module_put(void *a)
74 {
75         return;
76 }
77
78 extern ptl_handle_ni_t         tcpnal_ni;
79
80 void *inter_module_get(char *arg);
81
82 /* cheats for now */
83
84 struct work_struct {
85         void (*ws_task)(void *arg);
86         void *ws_arg;
87 };
88
89 static inline void prepare_work(struct work_struct *q, void (*t)(void *),
90                                 void *arg)
91 {
92         q->ws_task = t;
93         q->ws_arg = arg;
94         return;
95 }
96
97 static inline void schedule_work(struct work_struct *q)
98 {
99         q->ws_task(q->ws_arg);
100 }
101
102
103 #define strnlen(a,b) strlen(a)
104 static inline void *kmalloc(int size, int prot)
105 {
106         return malloc(size);
107 }
108 #define vmalloc malloc
109 #define vfree free
110 #define kfree(a) free(a)
111 #define GFP_KERNEL 1
112 #define GFP_HIGHUSER 1
113 #define GFP_ATOMIC 1
114 #define GFP_NOFS 1
115 #define IS_ERR(a) (((a) && abs((long)(a)) < 500) ? 1 : 0)
116 #define PTR_ERR(a) ((long)(a))
117 #define ERR_PTR(a) ((void*)((long)(a)))
118
119 #define capable(foo) 1
120 #define CAP_SYS_ADMIN 1
121
122 typedef struct {
123         void *cwd;
124 }mm_segment_t;
125
126 typedef int (read_proc_t)(char *page, char **start, off_t off,
127                           int count, int *eof, void *data);
128
129 struct file; /* forward ref */
130 typedef int (write_proc_t)(struct file *file, const char *buffer,
131                            unsigned long count, void *data);
132
133 # define le16_to_cpu(x) __le16_to_cpu(x)
134 # define cpu_to_le16(x) __cpu_to_le16(x)
135 # define le32_to_cpu(x) __le32_to_cpu(x)
136 # define cpu_to_le32(x) __cpu_to_le32(x)
137 # define le64_to_cpu(x) __le64_to_cpu(x)
138 # define cpu_to_le64(x) __cpu_to_le64(x)
139
140 #define NIPQUAD(addr) \
141         ((unsigned char *)&addr)[0], \
142         ((unsigned char *)&addr)[1], \
143         ((unsigned char *)&addr)[2], \
144         ((unsigned char *)&addr)[3]
145                                                                                                                         
146 #if defined(__LITTLE_ENDIAN)
147 #define HIPQUAD(addr) \
148         ((unsigned char *)&addr)[3], \
149         ((unsigned char *)&addr)[2], \
150         ((unsigned char *)&addr)[1], \
151         ((unsigned char *)&addr)[0]
152 #elif defined(__BIG_ENDIAN)
153 #define HIPQUAD NIPQUAD
154 #else
155 #error "Undefined byteorder??"
156 #endif /* __LITTLE_ENDIAN */
157
158 /* bits ops */
159 static __inline__ int set_bit(int nr,long * addr)
160 {
161         int     mask, retval;
162
163         addr += nr >> 5;
164         mask = 1 << (nr & 0x1f);
165         retval = (mask & *addr) != 0;
166         *addr |= mask;
167         return retval;
168 }
169
170 static __inline__ int clear_bit(int nr, long * addr)
171 {
172         int     mask, retval;
173
174         addr += nr >> 5;
175         mask = 1 << (nr & 0x1f);
176         retval = (mask & *addr) != 0;
177         *addr &= ~mask;
178         return retval;
179 }
180
181 static __inline__ int test_bit(int nr, long * addr)
182 {
183         int     mask;
184
185         addr += nr >> 5;
186         mask = 1 << (nr & 0x1f);
187         return ((mask & *addr) != 0);
188 }
189
190 static __inline__ int ext2_set_bit(int nr, void *addr)
191 {
192         return set_bit(nr, (long*)addr);
193 }
194
195 static __inline__ int ext2_clear_bit(int nr, void *addr)
196 {
197         return clear_bit(nr, (long*)addr);
198 }
199
200 static __inline__ int ext2_test_bit(int nr, void *addr)
201 {
202         return test_bit(nr, (long*)addr);
203 }
204
205 /* modules */
206
207 struct module {
208         int count;
209 };
210
211 static inline void MODULE_AUTHOR(char *name)
212 {
213         printf("%s\n", name);
214 }
215 #define MODULE_DESCRIPTION(name) MODULE_AUTHOR(name)
216 #define MODULE_LICENSE(name) MODULE_AUTHOR(name)
217
218 #define THIS_MODULE NULL
219 #define __init
220 #define __exit
221
222 /* devices */
223
224 static inline int misc_register(void *foo)
225 {
226         return 0;
227 }
228
229 static inline int misc_deregister(void *foo)
230 {
231         return 0;
232 }
233
234 static inline int request_module(char *name)
235 {
236         return (-EINVAL);
237 }
238
239 #define __MOD_INC_USE_COUNT(m)  do {} while (0)
240 #define __MOD_DEC_USE_COUNT(m)  do {} while (0)
241 #define MOD_INC_USE_COUNT       do {} while (0)
242 #define MOD_DEC_USE_COUNT       do {} while (0)
243 #define try_module_get          __MOD_INC_USE_COUNT
244 #define module_put              __MOD_DEC_USE_COUNT
245
246 /* module initialization */
247 extern int init_obdclass(void);
248 extern int ptlrpc_init(void);
249 extern int ldlm_init(void);
250 extern int osc_init(void);
251 extern int lov_init(void);
252 extern int mdc_init(void);
253 extern int echo_client_init(void);
254
255
256
257 /* general stuff */
258 #define jiffies 0
259
260 #define EXPORT_SYMBOL(S)
261
262 typedef int spinlock_t;
263 typedef __u64 kdev_t;
264
265 #define SPIN_LOCK_UNLOCKED 0
266 #define LASSERT_SPIN_LOCKED(lock) do {} while(0)
267
268 static inline void spin_lock(spinlock_t *l) {return;}
269 static inline void spin_unlock(spinlock_t *l) {return;}
270 static inline void spin_lock_init(spinlock_t *l) {return;}
271 static inline void local_irq_save(unsigned long flag) {return;}
272 static inline void local_irq_restore(unsigned long flag) {return;}
273 static inline int spin_is_locked(spinlock_t *l) {return 1;}
274
275 static inline void spin_lock_bh(spinlock_t *l) {}
276 static inline void spin_unlock_bh(spinlock_t *l) {}
277 static inline void spin_lock_irqsave(spinlock_t *a, unsigned long b) {}
278 static inline void spin_unlock_irqrestore(spinlock_t *a, unsigned long b) {}
279
280 #define min(x,y) ((x)<(y) ? (x) : (y))
281 #define max(x,y) ((x)>(y) ? (x) : (y))
282
283 #ifndef min_t
284 #define min_t(type,x,y) \
285         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
286 #endif
287 #ifndef max_t
288 #define max_t(type,x,y) \
289         ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
290 #endif
291
292 /* registering symbols */
293
294 #define ERESTARTSYS ERESTART
295 #define HZ 1
296
297 /* random */
298
299 static inline void get_random_bytes(void *ptr, int size)
300 {
301         int *p = (int *)ptr;
302         int i, count = size/sizeof(int);
303
304         for (i = 0; i< count; i++)
305                 *p++ = rand();
306 }
307
308 /* memory */
309
310 /* FIXME */
311 #define num_physpages (16 * 1024)
312
313 static inline int copy_from_user(void *a,void *b, int c)
314 {
315         memcpy(a,b,c);
316         return 0;
317 }
318
319 static inline int copy_to_user(void *a,void *b, int c)
320 {
321         memcpy(a,b,c);
322         return 0;
323 }
324
325
326 /* slabs */
327 typedef struct {
328          int size;
329 } kmem_cache_t;
330 #define SLAB_HWCACHE_ALIGN 0
331 static inline kmem_cache_t *
332 kmem_cache_create(const char *name, size_t objsize, size_t cdum,
333                   unsigned long d,
334                   void (*e)(void *, kmem_cache_t *, unsigned long),
335                   void (*f)(void *, kmem_cache_t *, unsigned long))
336 {
337         kmem_cache_t *c;
338         c = malloc(sizeof(*c));
339         if (!c)
340                 return NULL;
341         c->size = objsize;
342         CDEBUG(D_MALLOC, "alloc slab cache %s at %p, objsize %d\n",
343                name, c, (int)objsize);
344         return c;
345 };
346
347 static inline int kmem_cache_destroy(kmem_cache_t *a)
348 {
349         CDEBUG(D_MALLOC, "destroy slab cache %p, objsize %u\n", a, a->size);
350         free(a);
351         return 0;
352 }
353 #define kmem_cache_alloc(cache, prio) malloc(cache->size)
354 #define kmem_cache_free(cache, obj) free(obj)
355
356 #define PAGE_CACHE_SIZE PAGE_SIZE
357 #define PAGE_CACHE_SHIFT 12
358 #define PAGE_CACHE_MASK PAGE_MASK
359
360 /* XXX
361  * for this moment, liblusre will not rely OST for non-page-aligned write
362  */
363 #define LIBLUSTRE_HANDLE_UNALIGNED_PAGE
364
365 struct page {
366         void   *addr;
367         unsigned long index;
368         struct list_head list;
369         unsigned long private;
370
371         /* internally used by liblustre file i/o */
372         int     _offset;
373         int     _count;
374 #ifdef LIBLUSTRE_HANDLE_UNALIGNED_PAGE
375         int     _managed;
376 #endif
377 };
378
379 /* 2.4 defines */
380 #define PAGE_LIST_ENTRY list
381 #define PAGE_LIST(page) ((page)->list)
382
383 #define kmap(page) (page)->addr
384 #define kunmap(a) do {} while (0)
385
386 static inline struct page *alloc_pages(int mask, unsigned long order)
387 {
388         struct page *pg = malloc(sizeof(*pg));
389
390         if (!pg)
391                 return NULL;
392 #if 0 //#ifdef MAP_ANONYMOUS
393         pg->addr = mmap(0, PAGE_SIZE << order, PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
394 #else
395         pg->addr = malloc(PAGE_SIZE << order);
396 #endif
397
398         if (!pg->addr) {
399                 free(pg);
400                 return NULL;
401         }
402         return pg;
403 }
404
405 #define alloc_page(mask) alloc_pages((mask), 0)
406
407 static inline void __free_pages(struct page *pg, int what)
408 {
409 #if 0 //#ifdef MAP_ANONYMOUS
410         munmap(pg->addr, PAGE_SIZE);
411 #else
412         free(pg->addr);
413 #endif
414         free(pg);
415 }
416
417 #define __free_page(page) __free_pages((page), 0)
418 #define free_page(page) __free_page(page)
419
420 static inline struct page* __grab_cache_page(unsigned long index)
421 {
422         struct page *pg = alloc_pages(0, 0);
423
424         if (pg)
425                 pg->index = index;
426         return pg;
427 }
428
429 #define grab_cache_page(index) __grab_cache_page(index)
430 #define page_cache_release(page) __free_pages(page, 0)
431
432 /* arithmetic */
433 #define do_div(a,b)                     \
434         ({                              \
435                 unsigned long remainder;\
436                 remainder = (a) % (b);  \
437                 (a) = (a) / (b);        \
438                 (remainder);            \
439         })
440
441 /* VFS stuff */
442 #define ATTR_MODE       0x0001
443 #define ATTR_UID        0x0002
444 #define ATTR_GID        0x0004
445 #define ATTR_SIZE       0x0008
446 #define ATTR_ATIME      0x0010
447 #define ATTR_MTIME      0x0020
448 #define ATTR_CTIME      0x0040
449 #define ATTR_ATIME_SET  0x0080
450 #define ATTR_MTIME_SET  0x0100
451 #define ATTR_FORCE      0x0200  /* Not a change, but a change it */
452 #define ATTR_ATTR_FLAG  0x0400
453 #define ATTR_RAW        0x0800  /* file system, not vfs will massage attrs */
454 #define ATTR_FROM_OPEN  0x1000  /* called from open path, ie O_TRUNC */
455 #define ATTR_CTIME_SET  0x2000
456
457 struct iattr {
458         unsigned int    ia_valid;
459         umode_t         ia_mode;
460         uid_t           ia_uid;
461         gid_t           ia_gid;
462         loff_t          ia_size;
463         time_t          ia_atime;
464         time_t          ia_mtime;
465         time_t          ia_ctime;
466         unsigned int    ia_attr_flags;
467 };
468
469 #define IT_OPEN     0x0001
470 #define IT_CREAT    0x0002
471 #define IT_READDIR  0x0004
472 #define IT_GETATTR  0x0008
473 #define IT_LOOKUP   0x0010
474 #define IT_UNLINK   0x0020
475 #define IT_GETXATTR 0x0040
476 #define IT_EXEC     0x0080
477 #define IT_PIN      0x0100
478
479 #define IT_FL_LOCKED   0x0001
480 #define IT_FL_FOLLOWED 0x0002 /* set by vfs_follow_link */
481
482 #define INTENT_MAGIC 0x19620323
483
484 struct lustre_intent_data {
485         int       it_disposition;
486         int       it_status;
487         __u64     it_lock_handle;
488         void     *it_data;
489         int       it_lock_mode;
490         int it_int_flags;
491 };
492 struct lookup_intent {
493         int     it_magic;
494         void    (*it_op_release)(struct lookup_intent *);
495         int     it_op;
496         int     it_flags;
497         int     it_create_mode;
498         union {
499                 struct lustre_intent_data lustre;
500         } d;
501 };
502
503 static inline void intent_init(struct lookup_intent *it, int op, int flags)
504 {
505         memset(it, 0, sizeof(*it));
506         it->it_magic = INTENT_MAGIC;
507         it->it_op = op;
508         it->it_flags = flags;
509 }
510
511
512 struct dentry {
513         int d_count;
514 };
515
516 struct vfsmount {
517         void *pwd;
518 };
519
520 /* semaphores */
521 struct rw_semaphore {
522         int count;
523 };
524
525 /* semaphores */
526 struct semaphore {
527         int count;
528 };
529
530 #define down(a) do {} while (0)
531 #define up(a) do {} while (0)
532 #define down_read(a) do {} while (0)
533 #define up_read(a) do {} while (0)
534 #define down_write(a) do {} while (0)
535 #define up_write(a) do {} while (0)
536 #define sema_init(a,b) do {} while (0)
537 #define init_rwsem(a) do {} while (0)
538 #define DECLARE_MUTEX(name)     \
539         struct semaphore name = { 1 }
540 static inline void init_MUTEX (struct semaphore *sem)
541 {
542         sema_init(sem, 1);
543 }
544
545
546 typedef struct  {
547         struct list_head sleepers;
548 } wait_queue_head_t;
549
550 typedef struct  {
551         struct list_head sleeping;
552         void *process;
553 } wait_queue_t;
554
555 struct signal {
556         int signal;
557 };
558
559 struct fs_struct {
560         int umask;
561 };
562
563 struct task_struct {
564         struct fs_struct *fs;
565         int state;
566         struct signal pending;
567         char comm[32];
568         int pid;
569         int fsuid;
570         int fsgid;
571         __u32 cap_effective;
572 };
573
574 extern struct task_struct *current;
575
576 #define in_group_p(a) 0 /* FIXME */
577
578 #define set_current_state(foo) do { current->state = foo; } while (0)
579
580 #define init_waitqueue_entry(q,p) do { (q)->process = p; } while (0)
581 #define add_wait_queue(q,p) do {  list_add(&(q)->sleepers, &(p)->sleeping); } while (0)
582 #define del_wait_queue(p) do { list_del(&(p)->sleeping); } while (0)
583 #define remove_wait_queue(q,p) do { list_del(&(p)->sleeping); } while (0)
584
585 #define DECLARE_WAIT_QUEUE_HEAD(HEAD)                           \
586         wait_queue_head_t HEAD = {                              \
587                 .sleepers = LIST_HEAD_INIT(HEAD.sleepers)       \
588         }
589 #define init_waitqueue_head(l) INIT_LIST_HEAD(&(l)->sleepers)
590 #define wake_up(l) do { int a; a++; } while (0)
591 #define TASK_INTERRUPTIBLE 0
592 #define TASK_UNINTERRUPTIBLE 1
593 #define TASK_RUNNING 2
594
595 #define wait_event_interruptible(wq, condition)                         \
596 ({                                                                      \
597         struct l_wait_info lwi;                                         \
598         int timeout = 100000000;/* for ever */                          \
599         int ret;                                                        \
600                                                                         \
601         lwi = LWI_TIMEOUT(timeout, NULL, NULL);                         \
602         ret = l_wait_event(NULL, condition, &lwi);                      \
603                                                                         \
604         ret;                                                            \
605 })
606
607 #define in_interrupt() (0)
608
609 #define schedule() do {} while (0)
610 static inline int schedule_timeout(signed long t)
611 {
612         return 0;
613 }
614
615 #define lock_kernel() do {} while (0)
616 #define daemonize(l) do {} while (0)
617 #define sigfillset(l) do {} while (0)
618 #define recalc_sigpending(l) do {} while (0)
619 #define kernel_thread(l,m,n) LBUG()
620
621 #define USERMODEHELPER(path, argv, envp) (0)
622 #define SIGNAL_MASK_ASSERT()
623 #define KERN_INFO
624
625
626 struct timer_list {
627         struct list_head tl_list;
628         void (*function)(unsigned long unused);
629         unsigned long data;
630         long expires;
631 };
632
633 static inline int timer_pending(struct timer_list *l)
634 {
635         if (l->expires > jiffies)
636                 return 1;
637         else
638                 return 0;
639 }
640
641 static inline int init_timer(struct timer_list *l)
642 {
643         INIT_LIST_HEAD(&l->tl_list);
644         return 0;
645 }
646
647 static inline void mod_timer(struct timer_list *l, int thetime)
648 {
649         l->expires = thetime;
650 }
651
652 static inline void del_timer(struct timer_list *l)
653 {
654         free(l);
655 }
656
657 #define time_after(a, b)                                        \
658 ({                                                              \
659         1;                                                      \
660 })
661
662 typedef struct { volatile int counter; } atomic_t;
663
664 #define atomic_read(a) ((a)->counter)
665 #define atomic_set(a,b) do {(a)->counter = b; } while (0)
666 #define atomic_dec_and_test(a) ((--((a)->counter)) == 0)
667 #define atomic_inc(a)  (((a)->counter)++)
668 #define atomic_dec(a)  do { (a)->counter--; } while (0)
669 #define atomic_add(b,a)  do {(a)->counter += b;} while (0)
670 #define atomic_sub(b,a)  do {(a)->counter -= b;} while (0)
671
672 #ifndef likely
673 #define likely(exp) (exp)
674 #endif
675 #ifndef unlikely
676 #define unlikely(exp) (exp)
677 #endif
678
679 /* log related */
680 static inline int llog_init_commit_master(void) { return 0; }
681 static inline int llog_cleanup_commit_master(int force) { return 0; }
682 static inline void portals_run_lbug_upcall(char *file, const char *fn,
683                                            const int l){}
684
685 #define LBUG()                                                          \
686         do {                                                            \
687                 printf("!!!LBUG at %s:%d\n", __FILE__, __LINE__);       \
688                 sleep(1000000);                                         \
689         } while (0)
690
691
692
693 /* completion */
694 struct completion {
695         unsigned int done;
696         wait_queue_head_t wait;
697 };
698
699 #define COMPLETION_INITIALIZER(work) \
700         { 0, __WAIT_QUEUE_HEAD_INITIALIZER((work).wait) }
701
702 #define DECLARE_COMPLETION(work) \
703         struct completion work = COMPLETION_INITIALIZER(work)
704
705 #define INIT_COMPLETION(x)      ((x).done = 0)
706
707 static inline void init_completion(struct completion *x)
708 {
709         x->done = 0;
710         init_waitqueue_head(&x->wait);
711 }
712
713 struct liblustre_wait_callback {
714         struct list_head    llwc_list;
715         int               (*llwc_fn)(void *arg);
716         void               *llwc_arg;
717 };
718
719 void *liblustre_register_wait_callback(int (*fn)(void *arg), void *arg);
720 void liblustre_deregister_wait_callback(void *notifier);
721 int liblustre_wait_event(int timeout);
722
723 #include <linux/obd_support.h>
724 #include <linux/lustre_idl.h>
725 #include <linux/lustre_lib.h>
726 #include <linux/lustre_import.h>
727 #include <linux/lustre_export.h>
728 #include <linux/lustre_net.h>
729
730
731 #endif