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 __u64
  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 static inline void spin_lock(spinlock_t *l) {return;}
 267 static inline void spin_unlock(spinlock_t *l) {return;}
 268 static inline void spin_lock_init(spinlock_t *l) {return;}
 269 static inline void local_irq_save(unsigned long flag) {return;}
 270 static inline void local_irq_restore(unsigned long flag) {return;}
 271 static inline int spin_is_locked(spinlock_t *l) {return 1;}
 272
 273 static inline void spin_lock_bh(spinlock_t *l) {}
 274 static inline void spin_unlock_bh(spinlock_t *l) {}
 275 static inline void spin_lock_irqsave(spinlock_t *a, unsigned long b) {}
 276 static inline void spin_unlock_irqrestore(spinlock_t *a, unsigned long b) {}
 277
 278 #define min(x,y) ((x)<(y) ? (x) : (y))
 279 #define max(x,y) ((x)>(y) ? (x) : (y))
 280
 281 #ifndef min_t
 282 #define min_t(type,x,y) \
 283         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
 284 #endif
 285 #ifndef max_t
 286 #define max_t(type,x,y) \
 287         ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
 288 #endif
 289
 290 /* registering symbols */
 291
 292 #define ERESTARTSYS ERESTART
 293 #define HZ 1
 294
 295 /* random */
 296
 297 static inline void get_random_bytes(void *ptr, int size)
 298 {
 299         int *p = (int *)ptr;
 300         int i, count = size/sizeof(int);
 301
 302         for (i = 0; i< count; i++)
 303                 *p++ = rand();
 304 }
 305
 306 /* memory */
 307
 308 /* FIXME */
 309 #define num_physpages (16 * 1024)
 310
 311 static inline int copy_from_user(void *a,void *b, int c)
 312 {
 313         memcpy(a,b,c);
 314         return 0;
 315 }
 316
 317 static inline int copy_to_user(void *a,void *b, int c)
 318 {
 319         memcpy(a,b,c);
 320         return 0;
 321 }
 322
 323
 324 /* slabs */
 325 typedef struct {
 326          int size;
 327 } kmem_cache_t;
 328 #define SLAB_HWCACHE_ALIGN 0
 329 static inline kmem_cache_t *
 330 kmem_cache_create(const char *name, size_t objsize, size_t cdum,
 331                   unsigned long d,
 332                   void (*e)(void *, kmem_cache_t *, unsigned long),
 333                   void (*f)(void *, kmem_cache_t *, unsigned long))
 334 {
 335         kmem_cache_t *c;
 336         c = malloc(sizeof(*c));
 337         if (!c)
 338                 return NULL;
 339         c->size = objsize;
 340         CDEBUG(D_MALLOC, "alloc slab cache %s at %p, objsize %d\n",
 341                name, c, (int)objsize);
 342         return c;
 343 };
 344
 345 static inline int kmem_cache_destroy(kmem_cache_t *a)
 346 {
 347         CDEBUG(D_MALLOC, "destroy slab cache %p, objsize %u\n", a, a->size);
 348         free(a);
 349         return 0;
 350 }
 351 #define kmem_cache_alloc(cache, prio) malloc(cache->size)
 352 #define kmem_cache_free(cache, obj) free(obj)
 353
 354 #define PAGE_CACHE_SIZE PAGE_SIZE
 355 #define PAGE_CACHE_SHIFT 12
 356 #define PAGE_CACHE_MASK PAGE_MASK
 357
 358 /* XXX
 359  * for this moment, liblusre will not rely OST for non-page-aligned write
 360  */
 361 #define LIBLUSTRE_HANDLE_UNALIGNED_PAGE
 362
 363 struct page {
 364         void   *addr;
 365         unsigned long index;
 366         struct list_head list;
 367         unsigned long private;
 368
 369         /* internally used by liblustre file i/o */
 370         int     _offset;
 371         int     _count;
 372 #ifdef LIBLUSTRE_HANDLE_UNALIGNED_PAGE
 373         int     _managed;
 374 #endif
 375 };
 376
 377 #define kmap(page) (page)->addr
 378 #define kunmap(a) do {} while (0)
 379
 380 static inline struct page *alloc_pages(int mask, unsigned long order)
 381 {
 382         struct page *pg = malloc(sizeof(*pg));
 383
 384         if (!pg)
 385                 return NULL;
 386 #if 0 //#ifdef MAP_ANONYMOUS
 387         pg->addr = mmap(0, PAGE_SIZE << order, PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
 388 #else
 389         pg->addr = malloc(PAGE_SIZE << order);
 390 #endif
 391
 392         if (!pg->addr) {
 393                 free(pg);
 394                 return NULL;
 395         }
 396         return pg;
 397 }
 398
 399 #define alloc_page(mask) alloc_pages((mask), 0)
 400
 401 static inline void __free_pages(struct page *pg, int what)
 402 {
 403 #if 0 //#ifdef MAP_ANONYMOUS
 404         munmap(pg->addr, PAGE_SIZE);
 405 #else
 406         free(pg->addr);
 407 #endif
 408         free(pg);
 409 }
 410
 411 #define __free_page(page) __free_pages((page), 0)
 412 #define free_page(page) __free_page(page)
 413
 414 static inline struct page* __grab_cache_page(unsigned long index)
 415 {
 416         struct page *pg = alloc_pages(0, 0);
 417
 418         if (pg)
 419                 pg->index = index;
 420         return pg;
 421 }
 422
 423 #define grab_cache_page(index) __grab_cache_page(index)
 424 #define page_cache_release(page) __free_pages(page, 0)
 425
 426 /* arithmetic */
 427 #define do_div(a,b)                     \
 428         ({                              \
 429                 unsigned long remainder;\
 430                 remainder = (a) % (b);  \
 431                 (a) = (a) / (b);        \
 432                 (remainder);            \
 433         })
 434
 435 /* VFS stuff */
 436 #define ATTR_MODE       0x0001
 437 #define ATTR_UID        0x0002
 438 #define ATTR_GID        0x0004
 439 #define ATTR_SIZE       0x0008
 440 #define ATTR_ATIME      0x0010
 441 #define ATTR_MTIME      0x0020
 442 #define ATTR_CTIME      0x0040
 443 #define ATTR_ATIME_SET  0x0080
 444 #define ATTR_MTIME_SET  0x0100
 445 #define ATTR_FORCE      0x0200  /* Not a change, but a change it */
 446 #define ATTR_ATTR_FLAG  0x0400
 447 #define ATTR_RAW        0x0800  /* file system, not vfs will massage attrs */
 448 #define ATTR_FROM_OPEN  0x1000  /* called from open path, ie O_TRUNC */
 449 #define ATTR_CTIME_SET  0x2000
 450
 451 struct iattr {
 452         unsigned int    ia_valid;
 453         umode_t         ia_mode;
 454         uid_t           ia_uid;
 455         gid_t           ia_gid;
 456         loff_t          ia_size;
 457         time_t          ia_atime;
 458         time_t          ia_mtime;
 459         time_t          ia_ctime;
 460         unsigned int    ia_attr_flags;
 461 };
 462
 463 #define IT_OPEN     0x0001
 464 #define IT_CREAT    0x0002
 465 #define IT_READDIR  0x0004
 466 #define IT_GETATTR  0x0008
 467 #define IT_LOOKUP   0x0010
 468 #define IT_UNLINK   0x0020
 469 #define IT_GETXATTR 0x0040
 470 #define IT_EXEC     0x0080
 471 #define IT_PIN      0x0100
 472
 473 #define IT_FL_LOCKED   0x0001
 474 #define IT_FL_FOLLOWED 0x0002 /* set by vfs_follow_link */
 475
 476 #define INTENT_MAGIC 0x19620323
 477
 478 struct lustre_intent_data {
 479         int       it_disposition;
 480         int       it_status;
 481         __u64     it_lock_handle;
 482         void     *it_data;
 483         int       it_lock_mode;
 484         int it_int_flags;
 485 };
 486 struct lookup_intent {
 487         int     it_magic;
 488         void    (*it_op_release)(struct lookup_intent *);
 489         int     it_op;
 490         int     it_flags;
 491         int     it_create_mode;
 492         union {
 493                 struct lustre_intent_data lustre;
 494         } d;
 495 };
 496
 497 static inline void intent_init(struct lookup_intent *it, int op, int flags)
 498 {
 499         memset(it, 0, sizeof(*it));
 500         it->it_magic = INTENT_MAGIC;
 501         it->it_op = op;
 502         it->it_flags = flags;
 503 }
 504
 505
 506 struct dentry {
 507         int d_count;
 508 };
 509
 510 struct vfsmount {
 511         void *pwd;
 512 };
 513
 514 /* semaphores */
 515 struct rw_semaphore {
 516         int count;
 517 };
 518
 519 /* semaphores */
 520 struct semaphore {
 521         int count;
 522 };
 523
 524 #define down(a) do {} while (0)
 525 #define up(a) do {} while (0)
 526 #define down_read(a) do {} while (0)
 527 #define up_read(a) do {} while (0)
 528 #define down_write(a) do {} while (0)
 529 #define up_write(a) do {} while (0)
 530 #define sema_init(a,b) do {} while (0)
 531 #define init_rwsem(a) do {} while (0)
 532 #define DECLARE_MUTEX(name)     \
 533         struct semaphore name = { 1 }
 534 static inline void init_MUTEX (struct semaphore *sem)
 535 {
 536         sema_init(sem, 1);
 537 }
 538
 539
 540 typedef struct  {
 541         struct list_head sleepers;
 542 } wait_queue_head_t;
 543
 544 typedef struct  {
 545         struct list_head sleeping;
 546         void *process;
 547 } wait_queue_t;
 548
 549 struct signal {
 550         int signal;
 551 };
 552
 553 struct fs_struct {
 554         int umask;
 555 };
 556
 557 struct task_struct {
 558         struct fs_struct *fs;
 559         int state;
 560         struct signal pending;
 561         char comm[32];
 562         int pid;
 563         int fsuid;
 564         int fsgid;
 565         __u32 cap_effective;
 566 };
 567
 568 extern struct task_struct *current;
 569
 570 #define in_group_p(a) 0 /* FIXME */
 571
 572 #define set_current_state(foo) do { current->state = foo; } while (0)
 573
 574 #define init_waitqueue_entry(q,p) do { (q)->process = p; } while (0)
 575 #define add_wait_queue(q,p) do {  list_add(&(q)->sleepers, &(p)->sleeping); } while (0)
 576 #define del_wait_queue(p) do { list_del(&(p)->sleeping); } while (0)
 577 #define remove_wait_queue(q,p) do { list_del(&(p)->sleeping); } while (0)
 578
 579 #define init_waitqueue_head(l) INIT_LIST_HEAD(&(l)->sleepers)
 580 #define wake_up(l) do { int a; a++; } while (0)
 581 #define TASK_INTERRUPTIBLE 0
 582 #define TASK_UNINTERRUPTIBLE 1
 583 #define TASK_RUNNING 2
 584
 585 #define wait_event_interruptible(wq, condition)                         \
 586 ({                                                                      \
 587         struct l_wait_info lwi;                                         \
 588         int timeout = 100000000;/* for ever */                          \
 589         int ret;                                                        \
 590                                                                         \
 591         lwi = LWI_TIMEOUT(timeout, NULL, NULL);                         \
 592         ret = l_wait_event(NULL, condition, &lwi);                      \
 593                                                                         \
 594         ret;                                                            \
 595 })
 596
 597 #define in_interrupt() (0)
 598
 599 #define schedule() do {} while (0)
 600 static inline int schedule_timeout(signed long t)
 601 {
 602         return 0;
 603 }
 604
 605 #define lock_kernel() do {} while (0)
 606 #define daemonize(l) do {} while (0)
 607 #define sigfillset(l) do {} while (0)
 608 #define recalc_sigpending(l) do {} while (0)
 609 #define kernel_thread(l,m,n) LBUG()
 610
 611 #define USERMODEHELPER(path, argv, envp) (0)
 612 #define SIGNAL_MASK_ASSERT()
 613 #define KERN_INFO
 614
 615
 616 struct timer_list {
 617         struct list_head tl_list;
 618         void (*function)(unsigned long unused);
 619         unsigned long data;
 620         long expires;
 621 };
 622
 623 static inline int timer_pending(struct timer_list *l)
 624 {
 625         if (l->expires > jiffies)
 626                 return 1;
 627         else
 628                 return 0;
 629 }
 630
 631 static inline int init_timer(struct timer_list *l)
 632 {
 633         INIT_LIST_HEAD(&l->tl_list);
 634         return 0;
 635 }
 636
 637 static inline void mod_timer(struct timer_list *l, int thetime)
 638 {
 639         l->expires = thetime;
 640 }
 641
 642 static inline void del_timer(struct timer_list *l)
 643 {
 644         free(l);
 645 }
 646
 647 #define time_after(a, b)                                        \
 648 ({                                                              \
 649         1;                                                      \
 650 })
 651
 652 typedef struct { volatile int counter; } atomic_t;
 653
 654 #define atomic_read(a) ((a)->counter)
 655 #define atomic_set(a,b) do {(a)->counter = b; } while (0)
 656 #define atomic_dec_and_test(a) ((--((a)->counter)) == 0)
 657 #define atomic_inc(a)  (((a)->counter)++)
 658 #define atomic_dec(a)  do { (a)->counter--; } while (0)
 659 #define atomic_add(b,a)  do {(a)->counter += b;} while (0)
 660 #define atomic_sub(b,a)  do {(a)->counter -= b;} while (0)
 661
 662 #ifndef likely
 663 #define likely(exp) (exp)
 664 #endif
 665 #ifndef unlikely
 666 #define unlikely(exp) (exp)
 667 #endif
 668
 669 /* log related */
 670 static inline int llog_init_commit_master(void) { return 0; }
 671 static inline int llog_cleanup_commit_master(int force) { return 0; }
 672 static inline void portals_run_lbug_upcall(char *file, const char *fn,
 673                                            const int l){}
 674
 675 #define LBUG()                                                          \
 676         do {                                                            \
 677                 printf("!!!LBUG at %s:%d\n", __FILE__, __LINE__);       \
 678                 sleep(1000000);                                         \
 679         } while (0)
 680
 681
 682
 683 /* completion */
 684 struct completion {
 685         unsigned int done;
 686         wait_queue_head_t wait;
 687 };
 688
 689 #define COMPLETION_INITIALIZER(work) \
 690         { 0, __WAIT_QUEUE_HEAD_INITIALIZER((work).wait) }
 691
 692 #define DECLARE_COMPLETION(work) \
 693         struct completion work = COMPLETION_INITIALIZER(work)
 694
 695 #define INIT_COMPLETION(x)      ((x).done = 0)
 696
 697 static inline void init_completion(struct completion *x)
 698 {
 699         x->done = 0;
 700         init_waitqueue_head(&x->wait);
 701 }
 702
 703 struct liblustre_wait_callback {
 704         struct list_head    llwc_list;
 705         int               (*llwc_fn)(void *arg);
 706         void               *llwc_arg;
 707 };
 708
 709 void *liblustre_register_wait_callback(int (*fn)(void *arg), void *arg);
 710 void liblustre_deregister_wait_callback(void *notifier);
 711 int liblustre_wait_event(int timeout);
 712
 713 #include <linux/obd_support.h>
 714 #include <linux/lustre_idl.h>
 715 #include <linux/lustre_lib.h>
 716 #include <linux/lustre_import.h>
 717 #include <linux/lustre_export.h>
 718 #include <linux/lustre_net.h>
 719
 720
 721 #endif