Whamcloud - gitweb
LU-1346 libcfs: replace libcfs wrappers with kernel API
[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, 2012, Whamcloud, Inc.
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 cfs_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 #define CFS_HZ 1
158
159 /* random */
160
161 void cfs_get_random_bytes(void *ptr, int size);
162
163 /* memory */
164
165 /* memory size: used for some client tunables */
166 #define cfs_num_physpages  (256 * 1024) /* 1GB */
167 #define CFS_NUM_CACHEPAGES cfs_num_physpages
168
169
170 /* VFS stuff */
171 #define ATTR_MODE       0x0001
172 #define ATTR_UID        0x0002
173 #define ATTR_GID        0x0004
174 #define ATTR_SIZE       0x0008
175 #define ATTR_ATIME      0x0010
176 #define ATTR_MTIME      0x0020
177 #define ATTR_CTIME      0x0040
178 #define ATTR_ATIME_SET  0x0080
179 #define ATTR_MTIME_SET  0x0100
180 #define ATTR_FORCE      0x0200  /* Not a change, but a change it */
181 #define ATTR_ATTR_FLAG  0x0400
182 #define ATTR_RAW        0x0800  /* file system, not vfs will massage attrs */
183 #define ATTR_FROM_OPEN  0x1000  /* called from open path, ie O_TRUNC */
184 #define ATTR_CTIME_SET  0x2000
185 #define ATTR_BLOCKS     0x4000
186 #define ATTR_KILL_SUID  0
187 #define ATTR_KILL_SGID  0
188 #define ATTR_FILE       0
189
190 struct iattr {
191         unsigned int    ia_valid;
192         cfs_umode_t     ia_mode;
193         uid_t           ia_uid;
194         gid_t           ia_gid;
195         loff_t          ia_size;
196         time_t          ia_atime;
197         time_t          ia_mtime;
198         time_t          ia_ctime;
199         unsigned int    ia_attr_flags;
200 };
201
202 /* defined in kernel header include/linux/namei.h */
203 #define INTENT_MAGIC 0x19620323
204
205 struct lustre_intent_data {
206         int       it_disposition;
207         int       it_status;
208         __u64     it_lock_handle;
209         void     *it_data;
210         int       it_lock_mode;
211 };
212 struct lookup_intent {
213         int     it_magic;
214         void    (*it_op_release)(struct lookup_intent *);
215         int     it_op;
216         int     it_flags;
217         int     it_create_mode;
218         union {
219                 struct lustre_intent_data lustre;
220         } d;
221 };
222
223 static inline void intent_init(struct lookup_intent *it, int op, int flags)
224 {
225         memset(it, 0, sizeof(*it));
226         it->it_magic = INTENT_MAGIC;
227         it->it_op = op;
228         it->it_flags = flags;
229 }
230
231 struct dentry {
232         int d_count;
233 };
234
235 struct vfsmount {
236         void *pwd;
237 };
238
239 struct signal {
240         int signal;
241 };
242
243 #undef  LL_TASK_CL_ENV
244 #define LL_TASK_CL_ENV          cl_env
245
246 struct task_struct {
247         int state;
248         struct signal pending;
249         char comm[32];
250         int uid;
251         int gid;
252         int pid;
253         int fsuid;
254         int fsgid;
255         int max_groups;
256         int ngroups;
257         gid_t *groups;
258         void  *cl_env;
259         __u32 cap_effective;
260 };
261
262
263 typedef struct task_struct cfs_task_t;
264 #define cfs_current()           current
265 #define cfs_curproc_pid()       (current->pid)
266 #define cfs_curproc_comm()      (current->comm)
267 #define cfs_curproc_fsuid()     (current->fsuid)
268 #define cfs_curproc_fsgid()     (current->fsgid)
269 #define cfs_curproc_umask()     ({ mode_t mask = umask(0); umask(mask); mask; })
270
271 extern struct task_struct *current;
272 int cfs_curproc_is_in_groups(gid_t gid);
273
274 #define cfs_set_current_state(foo) do { current->state = foo; } while (0)
275
276 #define cfs_wait_event_interruptible(wq, condition, ret)                \
277 {                                                                       \
278         struct l_wait_info lwi;                                         \
279         int timeout = 100000000;/* for ever */                          \
280         int ret;                                                        \
281                                                                         \
282         lwi = LWI_TIMEOUT(timeout, NULL, NULL);                         \
283         ret = l_wait_event(NULL, condition, &lwi);                      \
284                                                                         \
285         ret;                                                            \
286 }
287
288 #define daemonize(l) do {} while (0)
289 #define sigfillset(l) do {} while (0)
290 #define recalc_sigpending(l) do {} while (0)
291
292 #define USERMODEHELPER(path, argv, envp) (0)
293 #define SIGNAL_MASK_ASSERT()
294 #define CFS_KERN_INFO
295
296 #if CFS_HZ != 1
297 #error "liblustre's jiffies currently expects HZ to be 1"
298 #endif
299 #define jiffies                                 \
300 ({                                              \
301         unsigned long _ret = 0;                 \
302         struct timeval tv;                      \
303         if (gettimeofday(&tv, NULL) == 0)       \
304                 _ret = tv.tv_sec;               \
305         _ret;                                   \
306 })
307 #define get_jiffies_64()  (__u64)jiffies
308
309 #ifndef likely
310 #define likely(exp) (exp)
311 #endif
312 #ifndef unlikely
313 #define unlikely(exp) (exp)
314 #endif
315
316 #define cfs_might_sleep()
317 #define might_sleep_if(c)
318 #define smp_mb()
319
320 /* FIXME sys/capability will finally included linux/fs.h thus
321  * cause numerous trouble on x86-64. as temporary solution for
322  * build broken at Cray, we copy definition we need from capability.h
323  * FIXME
324  */
325 struct _cap_struct;
326 typedef struct _cap_struct *cap_t;
327 typedef int cap_value_t;
328 typedef enum {
329     CAP_EFFECTIVE=0,
330     CAP_PERMITTED=1,
331     CAP_INHERITABLE=2
332 } cap_flag_t;
333 typedef enum {
334     CAP_CLEAR=0,
335     CAP_SET=1
336 } cap_flag_value_t;
337
338 cap_t   cap_get_proc(void);
339 int     cap_get_flag(cap_t, cap_value_t, cap_flag_t, cap_flag_value_t *);
340
341 static inline void libcfs_run_lbug_upcall(char *file, const char *fn,
342                                            const int l){}
343
344
345 struct liblustre_wait_callback {
346         cfs_list_t              llwc_list;
347         const char             *llwc_name;
348         int                   (*llwc_fn)(void *arg);
349         void                   *llwc_arg;
350 };
351
352 void *liblustre_register_wait_callback(const char *name,
353                                        int (*fn)(void *arg), void *arg);
354 void liblustre_deregister_wait_callback(void *notifier);
355 int liblustre_wait_event(int timeout);
356
357 void *liblustre_register_idle_callback(const char *name,
358                                        int (*fn)(void *arg), void *arg);
359 void liblustre_deregister_idle_callback(void *notifier);
360 void liblustre_wait_idle(void);
361
362 /* flock related */
363 struct nfs_lock_info {
364         __u32             state;
365         __u32             flags;
366         void            *host;
367 };
368
369 typedef struct file_lock {
370         struct file_lock *fl_next;  /* singly linked list for this inode  */
371         cfs_list_t fl_link;   /* doubly linked list of all locks */
372         cfs_list_t fl_block;  /* circular list of blocked processes */
373         void *fl_owner;
374         unsigned int fl_pid;
375         cfs_waitq_t fl_wait;
376         struct file *fl_file;
377         unsigned char fl_flags;
378         unsigned char fl_type;
379         loff_t fl_start;
380         loff_t fl_end;
381
382         void (*fl_notify)(struct file_lock *);  /* unblock callback */
383         void (*fl_insert)(struct file_lock *);  /* lock insertion callback */
384         void (*fl_remove)(struct file_lock *);  /* lock removal callback */
385
386         void *fl_fasync; /* for lease break notifications */
387         unsigned long fl_break_time;    /* for nonblocking lease breaks */
388
389         union {
390                 struct nfs_lock_info    nfs_fl;
391         } fl_u;
392 } cfs_flock_t;
393
394 #define cfs_flock_type(fl)                  ((fl)->fl_type)
395 #define cfs_flock_set_type(fl, type)        do { (fl)->fl_type = (type); } while(0)
396 #define cfs_flock_pid(fl)                   ((fl)->fl_pid)
397 #define cfs_flock_set_pid(fl, pid)          do { (fl)->fl_pid = (pid); } while(0)
398 #define cfs_flock_start(fl)                 ((fl)->fl_start)
399 #define cfs_flock_set_start(fl, start)      do { (fl)->fl_start = (start); } while(0)
400 #define cfs_flock_end(fl)                   ((fl)->fl_end)
401 #define cfs_flock_set_end(fl, end)          do { (fl)->fl_end = (end); } while(0)
402
403 #ifndef OFFSET_MAX
404 #define INT_LIMIT(x)    (~((x)1 << (sizeof(x)*8 - 1)))
405 #define OFFSET_MAX      INT_LIMIT(loff_t)
406 #endif
407
408 #define i_atime                     i_stbuf.st_atime
409 #define i_mtime                     i_stbuf.st_mtime
410 #define i_ctime                     i_stbuf.st_ctime
411 /* use i_size_read() i_size_write() to access i_stbuf.st_size */
412 #define i_blocks                    i_stbuf.st_blocks
413 #define i_blksize                   i_stbuf.st_blksize
414 #define i_mode                      i_stbuf.st_mode
415 #define i_uid                       i_stbuf.st_uid
416 #define i_gid                       i_stbuf.st_gid
417
418 /* XXX: defined in kernel */
419 #define FL_POSIX        1
420 #define FL_SLEEP        128
421
422 /* quota */
423 #define QUOTA_OK 0
424 #define NO_QUOTA 1
425
426 /* ACL */
427 typedef struct {
428         __u16           e_tag;
429         __u16           e_perm;
430         __u32           e_id;
431 } posix_acl_xattr_entry;
432
433 struct posix_acl {
434         cfs_atomic_t           a_refcount;
435         unsigned int           a_count;
436         posix_acl_xattr_entry  a_entries[0];
437 };
438
439 typedef struct {
440         __u32                 a_version;
441         posix_acl_xattr_entry a_entries[0];
442 } posix_acl_xattr_header;
443
444 static inline size_t posix_acl_xattr_size(int count)
445 {
446         return sizeof(posix_acl_xattr_header) + count *
447                sizeof(posix_acl_xattr_entry);
448 }
449
450 static inline
451 struct posix_acl * posix_acl_from_xattr(const void *value, size_t size)
452 {
453         return NULL;
454 }
455
456 static inline
457 int posix_acl_valid(const struct posix_acl *acl)
458 {
459         return 0;
460 }
461
462 static inline
463 void posix_acl_release(struct posix_acl *acl)
464 {
465 }
466
467 #if defined(LIBLUSTRE_POSIX_ACL) && !defined(CONFIG_FS_POSIX_ACL)
468 # define CONFIG_FS_POSIX_ACL 1
469 #endif
470
471 #ifndef ENOTSUPP
472 #define ENOTSUPP ENOTSUP
473 #endif
474
475 typedef int mm_segment_t;
476 enum {
477         KERNEL_DS,
478         USER_DS
479 };
480 static inline mm_segment_t get_fs(void)
481 {
482         return USER_DS;
483 }
484
485 static inline void set_fs(mm_segment_t seg)
486 {
487 }
488
489 #define S_IRWXUGO       (S_IRWXU|S_IRWXG|S_IRWXO)
490 #define S_IALLUGO       (S_ISUID|S_ISGID|S_ISVTX|S_IRWXUGO)
491
492 #include <obd_support.h>
493 #include <lustre/lustre_idl.h>
494 #include <lustre_lib.h>
495 #include <lustre_import.h>
496 #include <lustre_export.h>
497 #include <lustre_net.h>
498
499 /** @} liblustre */
500
501 #endif