4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/liblustre.h
38 * User-space Lustre headers.
44 /** \defgroup liblustre liblustre
49 #include <sys/queue.h>
52 #error Kernel files should not #include <liblustre.h>
55 #include <libcfs/libcfs.h>
56 #include <lnet/lnet.h>
58 /* definitions for liblustre */
62 #define loff_t long long
64 typedef unsigned short cfs_umode_t;
68 /* always adopt 2.6.9 definitions */
69 #define KERNEL_VERSION(a,b,c) ((a)*100+(b)*10+c)
70 #define LINUX_VERSION_CODE KERNEL_VERSION(2,6,9)
73 #define page_private(page) ((page)->private)
74 #define set_page_private(page, v) ((page)->private = (v))
79 * The inter_module_get implementation is specific to liblustre, so this needs
80 * to stay here for now.
82 static inline void inter_module_put(void *a)
86 void *inter_module_get(char *arg);
90 /* a long can be more than 32 bits, so use BITS_PER_LONG
91 * to allow the compiler to adjust the bit shifting accordingly
94 static __inline__ int ext2_set_bit(int nr, void *addr)
97 return cfs_set_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
99 return cfs_set_bit(nr, addr);
103 static __inline__ int ext2_clear_bit(int nr, void *addr)
106 return cfs_clear_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
108 return cfs_clear_bit(nr, addr);
112 static __inline__ int ext2_test_bit(int nr, void *addr)
115 __const__ unsigned char *tmp = (__const__ unsigned char *) addr;
116 return (tmp[nr >> 3] >> (nr & 7)) & 1;
118 return cfs_test_bit(nr, addr);
123 /* module initialization */
124 extern int init_obdclass(void);
125 extern int ptlrpc_init(void);
126 extern int ldlm_init(void);
127 extern int osc_init(void);
128 extern int lov_init(void);
129 extern int mdc_init(void);
130 extern int lmv_init(void);
131 extern int mgc_init(void);
132 extern int echo_client_init(void);
138 typedef __u64 kdev_t;
141 #define min(x,y) ((x)<(y) ? (x) : (y))
145 #define max(x,y) ((x)>(y) ? (x) : (y))
149 #define min_t(type,x,y) \
150 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
153 #define max_t(type,x,y) \
154 ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
157 #define simple_strtol strtol
159 /* registering symbols */
161 #define ERESTARTSYS ERESTART
167 void cfs_get_random_bytes(void *ptr, int size);
171 /* memory size: used for some client tunables */
172 #define cfs_num_physpages (256 * 1024) /* 1GB */
173 #define CFS_NUM_CACHEPAGES cfs_num_physpages
177 #define ATTR_MODE 0x0001
178 #define ATTR_UID 0x0002
179 #define ATTR_GID 0x0004
180 #define ATTR_SIZE 0x0008
181 #define ATTR_ATIME 0x0010
182 #define ATTR_MTIME 0x0020
183 #define ATTR_CTIME 0x0040
184 #define ATTR_ATIME_SET 0x0080
185 #define ATTR_MTIME_SET 0x0100
186 #define ATTR_FORCE 0x0200 /* Not a change, but a change it */
187 #define ATTR_ATTR_FLAG 0x0400
188 #define ATTR_RAW 0x0800 /* file system, not vfs will massage attrs */
189 #define ATTR_FROM_OPEN 0x1000 /* called from open path, ie O_TRUNC */
190 #define ATTR_CTIME_SET 0x2000
191 #define ATTR_BLOCKS 0x4000
192 #define ATTR_KILL_SUID 0
193 #define ATTR_KILL_SGID 0
197 unsigned int ia_valid;
205 unsigned int ia_attr_flags;
208 #define ll_iattr iattr
210 /* defined in kernel header include/linux/namei.h */
211 #define INTENT_MAGIC 0x19620323
213 struct lustre_intent_data {
216 __u64 it_lock_handle;
220 struct lookup_intent {
222 void (*it_op_release)(struct lookup_intent *);
227 struct lustre_intent_data lustre;
231 static inline void intent_init(struct lookup_intent *it, int op, int flags)
233 memset(it, 0, sizeof(*it));
234 it->it_magic = INTENT_MAGIC;
236 it->it_flags = flags;
251 #undef LL_TASK_CL_ENV
252 #define LL_TASK_CL_ENV cl_env
256 struct signal pending;
271 typedef struct task_struct cfs_task_t;
272 #define cfs_current() current
273 #define cfs_curproc_pid() (current->pid)
274 #define cfs_curproc_comm() (current->comm)
275 #define cfs_curproc_fsuid() (current->fsuid)
276 #define cfs_curproc_fsgid() (current->fsgid)
278 extern struct task_struct *current;
279 int cfs_curproc_is_in_groups(gid_t gid);
281 #define cfs_set_current_state(foo) do { current->state = foo; } while (0)
283 #define cfs_wait_event_interruptible(wq, condition, ret) \
285 struct l_wait_info lwi; \
286 int timeout = 100000000;/* for ever */ \
289 lwi = LWI_TIMEOUT(timeout, NULL, NULL); \
290 ret = l_wait_event(NULL, condition, &lwi); \
295 #define daemonize(l) do {} while (0)
296 #define sigfillset(l) do {} while (0)
297 #define recalc_sigpending(l) do {} while (0)
299 #define USERMODEHELPER(path, argv, envp) (0)
300 #define SIGNAL_MASK_ASSERT()
301 #define CFS_KERN_INFO
304 #error "liblustre's jiffies currently expects HZ to be 1"
308 unsigned long _ret = 0; \
310 if (gettimeofday(&tv, NULL) == 0) \
314 #define get_jiffies_64() (__u64)jiffies
317 #define likely(exp) (exp)
320 #define unlikely(exp) (exp)
323 #define cfs_might_sleep()
324 #define might_sleep_if(c)
327 /* FIXME sys/capability will finally included linux/fs.h thus
328 * cause numerous trouble on x86-64. as temporary solution for
329 * build broken at Cray, we copy definition we need from capability.h
333 typedef struct _cap_struct *cap_t;
334 typedef int cap_value_t;
345 cap_t cap_get_proc(void);
346 int cap_get_flag(cap_t, cap_value_t, cap_flag_t, cap_flag_value_t *);
348 static inline void libcfs_run_lbug_upcall(char *file, const char *fn,
352 struct liblustre_wait_callback {
353 cfs_list_t llwc_list;
354 const char *llwc_name;
355 int (*llwc_fn)(void *arg);
359 void *liblustre_register_wait_callback(const char *name,
360 int (*fn)(void *arg), void *arg);
361 void liblustre_deregister_wait_callback(void *notifier);
362 int liblustre_wait_event(int timeout);
364 void *liblustre_register_idle_callback(const char *name,
365 int (*fn)(void *arg), void *arg);
366 void liblustre_deregister_idle_callback(void *notifier);
367 void liblustre_wait_idle(void);
370 struct nfs_lock_info {
376 typedef struct file_lock {
377 struct file_lock *fl_next; /* singly linked list for this inode */
378 cfs_list_t fl_link; /* doubly linked list of all locks */
379 cfs_list_t fl_block; /* circular list of blocked processes */
383 struct file *fl_file;
384 unsigned char fl_flags;
385 unsigned char fl_type;
389 void (*fl_notify)(struct file_lock *); /* unblock callback */
390 void (*fl_insert)(struct file_lock *); /* lock insertion callback */
391 void (*fl_remove)(struct file_lock *); /* lock removal callback */
393 void *fl_fasync; /* for lease break notifications */
394 unsigned long fl_break_time; /* for nonblocking lease breaks */
397 struct nfs_lock_info nfs_fl;
401 #define cfs_flock_type(fl) ((fl)->fl_type)
402 #define cfs_flock_set_type(fl, type) do { (fl)->fl_type = (type); } while(0)
403 #define cfs_flock_pid(fl) ((fl)->fl_pid)
404 #define cfs_flock_set_pid(fl, pid) do { (fl)->fl_pid = (pid); } while(0)
405 #define cfs_flock_start(fl) ((fl)->fl_start)
406 #define cfs_flock_set_start(fl, start) do { (fl)->fl_start = (start); } while(0)
407 #define cfs_flock_end(fl) ((fl)->fl_end)
408 #define cfs_flock_set_end(fl, end) do { (fl)->fl_end = (end); } while(0)
411 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
412 #define OFFSET_MAX INT_LIMIT(loff_t)
415 #define i_atime i_stbuf.st_atime
416 #define i_mtime i_stbuf.st_mtime
417 #define i_ctime i_stbuf.st_ctime
418 /* use i_size_read() i_size_write() to access i_stbuf.st_size */
419 #define i_blocks i_stbuf.st_blocks
420 #define i_blksize i_stbuf.st_blksize
421 #define i_mode i_stbuf.st_mode
422 #define i_uid i_stbuf.st_uid
423 #define i_gid i_stbuf.st_gid
425 /* XXX: defined in kernel */
438 } posix_acl_xattr_entry;
441 cfs_atomic_t a_refcount;
442 unsigned int a_count;
443 posix_acl_xattr_entry a_entries[0];
448 posix_acl_xattr_entry a_entries[0];
449 } posix_acl_xattr_header;
451 static inline size_t posix_acl_xattr_size(int count)
453 return sizeof(posix_acl_xattr_header) + count *
454 sizeof(posix_acl_xattr_entry);
458 struct posix_acl * posix_acl_from_xattr(const void *value, size_t size)
464 int posix_acl_valid(const struct posix_acl *acl)
470 void posix_acl_release(struct posix_acl *acl)
474 #if defined(LIBLUSTRE_POSIX_ACL) && !defined(CONFIG_FS_POSIX_ACL)
475 # define CONFIG_FS_POSIX_ACL 1
479 #define ENOTSUPP ENOTSUP
482 typedef int mm_segment_t;
487 static inline mm_segment_t get_fs(void)
492 static inline void set_fs(mm_segment_t seg)
496 #define S_IRWXUGO (S_IRWXU|S_IRWXG|S_IRWXO)
497 #define S_IALLUGO (S_ISUID|S_ISGID|S_ISVTX|S_IRWXUGO)
499 #include <obd_support.h>
500 #include <lustre/lustre_idl.h>
501 #include <lustre_lib.h>
502 #include <lustre_import.h>
503 #include <lustre_export.h>
504 #include <lustre_net.h>