Whamcloud - gitweb
LU-4217 build: bump build warnings to 2.7 development
[fs/lustre-release.git] / lustre / include / liblustre.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2013, Intel Corporation.
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 umode_t;
65
66 #endif
67
68 #ifndef page_private
69 #define page_private(page) ((page)->private)
70 #define set_page_private(page, v) ((page)->private = (v))
71 #endif
72
73
74 /*
75  * The inter_module_get implementation is specific to liblustre, so this needs
76  * to stay here for now.
77  */
78 static inline void inter_module_put(void *a)
79 {
80         return;
81 }
82 void *inter_module_get(char *arg);
83
84 /* bits ops */
85
86 /* a long can be more than 32 bits, so use BITS_PER_LONG
87  * to allow the compiler to adjust the bit shifting accordingly
88  */
89
90 static __inline__ int ext2_set_bit(int nr, void *addr)
91 {
92 #ifdef __BIG_ENDIAN
93         return set_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
94 #else
95         return set_bit(nr, addr);
96 #endif
97 }
98
99 static inline int ext2_clear_bit(int nr, void *addr)
100 {
101 #ifdef __BIG_ENDIAN
102         return clear_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
103 #else
104         return clear_bit(nr, addr);
105 #endif
106 }
107
108 static __inline__ int ext2_test_bit(int nr, void *addr)
109 {
110 #ifdef __BIG_ENDIAN
111         __const__ unsigned char *tmp = (__const__ unsigned char *) addr;
112         return (tmp[nr >> 3] >> (nr & 7)) & 1;
113 #else
114         return test_bit(nr, addr);
115 #endif
116 }
117
118
119 /* module initialization */
120 extern int init_obdclass(void);
121 extern int ptlrpc_init(void);
122 extern int ldlm_init(void);
123 extern int osc_init(void);
124 extern int lov_init(void);
125 extern int mdc_init(void);
126 extern int lmv_init(void);
127 extern int mgc_init(void);
128 extern int echo_client_init(void);
129
130
131
132 /* general stuff */
133
134 #ifndef min
135 #define min(x,y) ((x)<(y) ? (x) : (y))
136 #endif
137
138 #ifndef max
139 #define max(x,y) ((x)>(y) ? (x) : (y))
140 #endif
141
142 #ifndef min_t
143 #define min_t(type,x,y) \
144         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
145 #endif
146 #ifndef max_t
147 #define max_t(type,x,y) \
148         ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
149 #endif
150
151 #define simple_strtol strtol
152
153 /* registering symbols */
154 #ifndef ERESTARTSYS
155 #define ERESTARTSYS ERESTART
156 #endif
157
158 #ifdef HZ
159 #undef HZ
160 #endif
161 #define HZ 1
162
163 /* random */
164
165 void cfs_get_random_bytes(void *ptr, int size);
166
167 /* memory */
168
169 /* memory size: used for some client tunables */
170 #define totalram_pages  (256 * 1024) /* 1GB */
171 #define NUM_CACHEPAGES totalram_pages
172
173
174 /* VFS stuff */
175 #define ATTR_MODE       0x0001
176 #define ATTR_UID        0x0002
177 #define ATTR_GID        0x0004
178 #define ATTR_SIZE       0x0008
179 #define ATTR_ATIME      0x0010
180 #define ATTR_MTIME      0x0020
181 #define ATTR_CTIME      0x0040
182 #define ATTR_ATIME_SET  0x0080
183 #define ATTR_MTIME_SET  0x0100
184 #define ATTR_FORCE      0x0200  /* Not a change, but a change it */
185 #define ATTR_ATTR_FLAG  0x0400
186 #define ATTR_RAW        0x0800  /* file system, not vfs will massage attrs */
187 #define ATTR_FROM_OPEN  0x1000  /* called from open path, ie O_TRUNC */
188 #define ATTR_CTIME_SET  0x2000
189 #define ATTR_BLOCKS     0x4000
190 #define ATTR_KILL_SUID  0
191 #define ATTR_KILL_SGID  0
192 #define ATTR_FILE       0
193
194 struct iattr {
195         unsigned int    ia_valid;
196         umode_t         ia_mode;
197         uid_t           ia_uid;
198         gid_t           ia_gid;
199         loff_t          ia_size;
200         time_t          ia_atime;
201         time_t          ia_mtime;
202         time_t          ia_ctime;
203         unsigned int    ia_attr_flags;
204 };
205
206 /* defined in kernel header include/linux/namei.h */
207 #define INTENT_MAGIC 0x19620323
208
209 struct lustre_intent_data {
210         int       it_disposition;
211         int       it_status;
212         __u64     it_lock_handle;
213         int       it_lock_mode;
214         int       it_remote_lock_mode;
215         __u64     it_remote_lock_handle;
216         void     *it_data;
217
218         unsigned int    it_lock_set:1;
219 };
220
221 struct lookup_intent {
222         int     it_magic;
223         void    (*it_op_release)(struct lookup_intent *);
224         int     it_op;
225         int     it_create_mode;
226         __u64   it_flags;
227         union {
228                 struct lustre_intent_data lustre;
229         } d;
230 };
231
232 static inline void intent_init(struct lookup_intent *it, int op, int flags)
233 {
234         memset(it, 0, sizeof(*it));
235         it->it_magic = INTENT_MAGIC;
236         it->it_op = op;
237         it->it_flags = flags;
238 }
239
240 struct dentry {
241         int d_count;
242 };
243
244 struct vfsmount {
245         void *pwd;
246 };
247
248 struct signal {
249         int signal;
250 };
251
252 #undef  LL_TASK_CL_ENV
253 #define LL_TASK_CL_ENV          cl_env
254
255 struct task_struct {
256         int state;
257         struct signal pending;
258         char comm[32];
259         int uid;
260         int gid;
261         int pid;
262         int fsuid;
263         int fsgid;
264         int max_groups;
265         int ngroups;
266         gid_t *groups;
267         void  *cl_env;
268         __u32 cap_effective;
269 };
270
271
272 #define current_pid()       (current->pid)
273 #define current_comm()      (current->comm)
274 #define current_fsuid()     (current->fsuid)
275 #define current_fsgid()     (current->fsgid)
276 #define current_umask()     ({ mode_t mask = umask(0); umask(mask); mask; })
277
278 extern struct task_struct *current;
279 int in_group_p(gid_t gid);
280
281 #define set_current_state(foo) do { current->state = foo; } while (0)
282
283 #define wait_event_interruptible(wq, condition)                         \
284 {                                                                       \
285         struct l_wait_info lwi;                                         \
286         int timeout = 100000000;/* forever */                           \
287         int ret;                                                        \
288                                                                         \
289         lwi = LWI_TIMEOUT(timeout, NULL, NULL);                         \
290         ret = l_wait_event(NULL, condition, &lwi);                      \
291                                                                         \
292         ret;                                                            \
293 }
294
295 #define daemonize(l) do {} while (0)
296 #define sigfillset(l) do {} while (0)
297 #define recalc_sigpending(l) do {} while (0)
298
299 #define call_usermodehelper(path, argv, envp, wait) (0)
300 #define KERN_INFO
301
302 #if HZ != 1
303 #error "liblustre's jiffies currently expects HZ to be 1"
304 #endif
305 #define jiffies                                 \
306 ({                                              \
307         unsigned long _ret = 0;                 \
308         struct timeval tv;                      \
309         if (gettimeofday(&tv, NULL) == 0)       \
310                 _ret = tv.tv_sec;               \
311         _ret;                                   \
312 })
313 #define get_jiffies_64()  (__u64)jiffies
314
315 #ifndef likely
316 #define likely(exp) (exp)
317 #endif
318 #ifndef unlikely
319 #define unlikely(exp) (exp)
320 #endif
321
322 #define might_sleep()
323 #define might_sleep_if(c)
324 #define smp_mb()
325
326 /* FIXME sys/capability will finally included linux/fs.h thus
327  * cause numerous trouble on x86-64. as temporary solution for
328  * build broken at Cray, we copy definition we need from capability.h
329  * FIXME
330  */
331 struct _cap_struct;
332 typedef struct _cap_struct *cap_t;
333 typedef int cap_value_t;
334 typedef enum {
335     CAP_EFFECTIVE=0,
336     CAP_PERMITTED=1,
337     CAP_INHERITABLE=2
338 } cap_flag_t;
339 typedef enum {
340     CAP_CLEAR=0,
341     CAP_SET=1
342 } cap_flag_value_t;
343
344 cap_t   cap_get_proc(void);
345 int     cap_get_flag(cap_t, cap_value_t, cap_flag_t, cap_flag_value_t *);
346
347 static inline void libcfs_run_lbug_upcall(char *file, const char *fn,
348                                            const int l){}
349
350
351 struct liblustre_wait_callback {
352         cfs_list_t              llwc_list;
353         const char             *llwc_name;
354         int                   (*llwc_fn)(void *arg);
355         void                   *llwc_arg;
356 };
357
358 void *liblustre_register_wait_callback(const char *name,
359                                        int (*fn)(void *arg), void *arg);
360 void liblustre_deregister_wait_callback(void *notifier);
361 int liblustre_wait_event(int timeout);
362
363 void *liblustre_register_idle_callback(const char *name,
364                                        int (*fn)(void *arg), void *arg);
365 void liblustre_deregister_idle_callback(void *notifier);
366 void liblustre_wait_idle(void);
367
368 /* flock related */
369 struct nfs_lock_info {
370         __u32             state;
371         __u32             flags;
372         void            *host;
373 };
374
375 struct file_lock {
376         struct file_lock *fl_next;  /* singly linked list for this inode  */
377         cfs_list_t fl_link;   /* doubly linked list of all locks */
378         cfs_list_t fl_block;  /* circular list of blocked processes */
379         void *fl_owner;
380         unsigned int fl_pid;
381         wait_queue_head_t fl_wait;
382         struct file *fl_file;
383         unsigned char fl_flags;
384         unsigned char fl_type;
385         loff_t fl_start;
386         loff_t fl_end;
387
388         void (*fl_notify)(struct file_lock *);  /* unblock callback */
389         void (*fl_insert)(struct file_lock *);  /* lock insertion callback */
390         void (*fl_remove)(struct file_lock *);  /* lock removal callback */
391
392         void *fl_fasync; /* for lease break notifications */
393         unsigned long fl_break_time;    /* for nonblocking lease breaks */
394
395         union {
396                 struct nfs_lock_info    nfs_fl;
397         } fl_u;
398 };
399
400 #define flock_type(fl)                  ((fl)->fl_type)
401 #define flock_set_type(fl, type)        do { (fl)->fl_type = (type); } while (0)
402 #define flock_pid(fl)                   ((fl)->fl_pid)
403 #define flock_set_pid(fl, pid)          do { (fl)->fl_pid = (pid); } while (0)
404 #define flock_start(fl)                 ((fl)->fl_start)
405 #define flock_set_start(fl, st)         do { (fl)->fl_start = (st); } while (0)
406 #define flock_end(fl)                   ((fl)->fl_end)
407 #define flock_set_end(fl, end)          do { (fl)->fl_end = (end); } while (0)
408
409 #ifndef OFFSET_MAX
410 #define INT_LIMIT(x)    (~((x)1 << (sizeof(x)*8 - 1)))
411 #define OFFSET_MAX      INT_LIMIT(loff_t)
412 #endif
413
414 #define i_atime                     i_stbuf.st_atime
415 #define i_mtime                     i_stbuf.st_mtime
416 #define i_ctime                     i_stbuf.st_ctime
417 /* use i_size_read() i_size_write() to access i_stbuf.st_size */
418 #define i_blocks                    i_stbuf.st_blocks
419 #define i_blksize                   i_stbuf.st_blksize
420 #define i_mode                      i_stbuf.st_mode
421 #define i_uid                       i_stbuf.st_uid
422 #define i_gid                       i_stbuf.st_gid
423
424 /* XXX: defined in kernel */
425 #define FL_POSIX        1
426 #define FL_SLEEP        128
427
428 /* quota */
429 #define QUOTA_OK 0
430 #define NO_QUOTA 1
431
432 /* ACL */
433 typedef struct {
434         __u16           e_tag;
435         __u16           e_perm;
436         __u32           e_id;
437 } posix_acl_xattr_entry;
438
439 struct posix_acl {
440         cfs_atomic_t           a_refcount;
441         unsigned int           a_count;
442         posix_acl_xattr_entry  a_entries[0];
443 };
444
445 typedef struct {
446         __u32                 a_version;
447         posix_acl_xattr_entry a_entries[0];
448 } posix_acl_xattr_header;
449
450 static inline size_t posix_acl_xattr_size(int count)
451 {
452         return sizeof(posix_acl_xattr_header) + count *
453                sizeof(posix_acl_xattr_entry);
454 }
455
456 static inline
457 struct posix_acl * posix_acl_from_xattr(const void *value, size_t size)
458 {
459         return NULL;
460 }
461
462 /* The kernel version takes 3 arguments, so strip that off first. */
463 #define posix_acl_from_xattr(a,b,c)     posix_acl_from_xattr(b,c)
464 #define posix_acl_to_xattr(a,b,c)       posix_acl_to_xattr(b,c)
465
466 static inline
467 int posix_acl_valid(const struct posix_acl *acl)
468 {
469         return 0;
470 }
471
472 static inline
473 void posix_acl_release(struct posix_acl *acl)
474 {
475 }
476
477 #if defined(LIBLUSTRE_POSIX_ACL) && !defined(CONFIG_FS_POSIX_ACL)
478 # define CONFIG_FS_POSIX_ACL 1
479 #endif
480
481 #ifndef ENOTSUPP
482 #define ENOTSUPP ENOTSUP
483 #endif
484
485 typedef int mm_segment_t;
486 enum {
487         KERNEL_DS,
488         USER_DS
489 };
490 static inline mm_segment_t get_fs(void)
491 {
492         return USER_DS;
493 }
494
495 static inline void set_fs(mm_segment_t seg)
496 {
497 }
498
499 #define S_IRWXUGO       (S_IRWXU|S_IRWXG|S_IRWXO)
500 #define S_IALLUGO       (S_ISUID|S_ISGID|S_ISVTX|S_IRWXUGO)
501
502 struct inode *igrab(struct inode *inode);
503 void iput(struct inode *inode);
504
505 #include <obd_support.h>
506 #include <lustre/lustre_idl.h>
507 #include <lustre_lib.h>
508 #include <lustre_import.h>
509 #include <lustre_export.h>
510 #include <lustre_net.h>
511
512 /** @} liblustre */
513
514 #endif