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, 2013, Intel Corporation.
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;
69 #define page_private(page) ((page)->private)
70 #define set_page_private(page, v) ((page)->private = (v))
75 * The inter_module_get implementation is specific to liblustre, so this needs
76 * to stay here for now.
78 static inline void inter_module_put(void *a)
82 void *inter_module_get(char *arg);
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
90 static __inline__ int ext2_set_bit(int nr, void *addr)
93 return set_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
95 return set_bit(nr, addr);
99 static inline int ext2_clear_bit(int nr, void *addr)
102 return clear_bit((nr ^ ((BITS_PER_LONG-1) & ~0x7)), addr);
104 return clear_bit(nr, addr);
108 static __inline__ int ext2_test_bit(int nr, void *addr)
111 __const__ unsigned char *tmp = (__const__ unsigned char *) addr;
112 return (tmp[nr >> 3] >> (nr & 7)) & 1;
114 return test_bit(nr, addr);
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);
135 #define min(x,y) ((x)<(y) ? (x) : (y))
139 #define max(x,y) ((x)>(y) ? (x) : (y))
143 #define min_t(type,x,y) \
144 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
147 #define max_t(type,x,y) \
148 ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
151 #define simple_strtol strtol
153 /* registering symbols */
155 #define ERESTARTSYS ERESTART
161 void cfs_get_random_bytes(void *ptr, int size);
165 /* memory size: used for some client tunables */
166 #define num_physpages (256 * 1024) /* 1GB */
167 #define NUM_CACHEPAGES num_physpages
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
191 unsigned int ia_valid;
199 unsigned int ia_attr_flags;
202 /* defined in kernel header include/linux/namei.h */
203 #define INTENT_MAGIC 0x19620323
205 struct lustre_intent_data {
208 __u64 it_lock_handle;
210 int it_remote_lock_mode;
211 __u64 it_remote_lock_handle;
214 unsigned int it_lock_set:1;
217 struct lookup_intent {
219 void (*it_op_release)(struct lookup_intent *);
224 struct lustre_intent_data lustre;
228 static inline void intent_init(struct lookup_intent *it, int op, int flags)
230 memset(it, 0, sizeof(*it));
231 it->it_magic = INTENT_MAGIC;
233 it->it_flags = flags;
248 #undef LL_TASK_CL_ENV
249 #define LL_TASK_CL_ENV cl_env
253 struct signal pending;
268 typedef struct task_struct cfs_task_t;
269 #define cfs_current() current
270 #define cfs_curproc_pid() (current->pid)
271 #define cfs_curproc_comm() (current->comm)
272 #define cfs_curproc_fsuid() (current->fsuid)
273 #define cfs_curproc_fsgid() (current->fsgid)
274 #define cfs_curproc_umask() ({ mode_t mask = umask(0); umask(mask); mask; })
276 extern struct task_struct *current;
277 int cfs_curproc_is_in_groups(gid_t gid);
279 #define cfs_set_current_state(foo) do { current->state = foo; } while (0)
281 #define cfs_wait_event_interruptible(wq, condition, ret) \
283 struct l_wait_info lwi; \
284 int timeout = 100000000;/* for ever */ \
287 lwi = LWI_TIMEOUT(timeout, NULL, NULL); \
288 ret = l_wait_event(NULL, condition, &lwi); \
293 #define daemonize(l) do {} while (0)
294 #define sigfillset(l) do {} while (0)
295 #define recalc_sigpending(l) do {} while (0)
297 #define USERMODEHELPER(path, argv, envp) (0)
298 #define SIGNAL_MASK_ASSERT()
299 #define CFS_KERN_INFO
302 #error "liblustre's jiffies currently expects HZ to be 1"
306 unsigned long _ret = 0; \
308 if (gettimeofday(&tv, NULL) == 0) \
312 #define get_jiffies_64() (__u64)jiffies
315 #define likely(exp) (exp)
318 #define unlikely(exp) (exp)
321 #define cfs_might_sleep()
322 #define might_sleep_if(c)
325 /* FIXME sys/capability will finally included linux/fs.h thus
326 * cause numerous trouble on x86-64. as temporary solution for
327 * build broken at Cray, we copy definition we need from capability.h
331 typedef struct _cap_struct *cap_t;
332 typedef int cap_value_t;
343 cap_t cap_get_proc(void);
344 int cap_get_flag(cap_t, cap_value_t, cap_flag_t, cap_flag_value_t *);
346 static inline void libcfs_run_lbug_upcall(char *file, const char *fn,
350 struct liblustre_wait_callback {
351 cfs_list_t llwc_list;
352 const char *llwc_name;
353 int (*llwc_fn)(void *arg);
357 void *liblustre_register_wait_callback(const char *name,
358 int (*fn)(void *arg), void *arg);
359 void liblustre_deregister_wait_callback(void *notifier);
360 int liblustre_wait_event(int timeout);
362 void *liblustre_register_idle_callback(const char *name,
363 int (*fn)(void *arg), void *arg);
364 void liblustre_deregister_idle_callback(void *notifier);
365 void liblustre_wait_idle(void);
368 struct nfs_lock_info {
375 struct file_lock *fl_next; /* singly linked list for this inode */
376 cfs_list_t fl_link; /* doubly linked list of all locks */
377 cfs_list_t fl_block; /* circular list of blocked processes */
381 struct file *fl_file;
382 unsigned char fl_flags;
383 unsigned char fl_type;
387 void (*fl_notify)(struct file_lock *); /* unblock callback */
388 void (*fl_insert)(struct file_lock *); /* lock insertion callback */
389 void (*fl_remove)(struct file_lock *); /* lock removal callback */
391 void *fl_fasync; /* for lease break notifications */
392 unsigned long fl_break_time; /* for nonblocking lease breaks */
395 struct nfs_lock_info nfs_fl;
399 #define flock_type(fl) ((fl)->fl_type)
400 #define flock_set_type(fl, type) do { (fl)->fl_type = (type); } while (0)
401 #define flock_pid(fl) ((fl)->fl_pid)
402 #define flock_set_pid(fl, pid) do { (fl)->fl_pid = (pid); } while (0)
403 #define flock_start(fl) ((fl)->fl_start)
404 #define flock_set_start(fl, st) do { (fl)->fl_start = (st); } while (0)
405 #define flock_end(fl) ((fl)->fl_end)
406 #define flock_set_end(fl, end) do { (fl)->fl_end = (end); } while (0)
409 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
410 #define OFFSET_MAX INT_LIMIT(loff_t)
413 #define i_atime i_stbuf.st_atime
414 #define i_mtime i_stbuf.st_mtime
415 #define i_ctime i_stbuf.st_ctime
416 /* use i_size_read() i_size_write() to access i_stbuf.st_size */
417 #define i_blocks i_stbuf.st_blocks
418 #define i_blksize i_stbuf.st_blksize
419 #define i_mode i_stbuf.st_mode
420 #define i_uid i_stbuf.st_uid
421 #define i_gid i_stbuf.st_gid
423 /* XXX: defined in kernel */
436 } posix_acl_xattr_entry;
439 cfs_atomic_t a_refcount;
440 unsigned int a_count;
441 posix_acl_xattr_entry a_entries[0];
446 posix_acl_xattr_entry a_entries[0];
447 } posix_acl_xattr_header;
449 static inline size_t posix_acl_xattr_size(int count)
451 return sizeof(posix_acl_xattr_header) + count *
452 sizeof(posix_acl_xattr_entry);
456 struct posix_acl * posix_acl_from_xattr(const void *value, size_t size)
461 /* The kernel version takes 3 arguments, so strip that off first. */
462 #define posix_acl_from_xattr(a,b,c) posix_acl_from_xattr(b,c)
463 #define posix_acl_to_xattr(a,b,c) posix_acl_to_xattr(b,c)
466 int posix_acl_valid(const struct posix_acl *acl)
472 void posix_acl_release(struct posix_acl *acl)
476 #if defined(LIBLUSTRE_POSIX_ACL) && !defined(CONFIG_FS_POSIX_ACL)
477 # define CONFIG_FS_POSIX_ACL 1
481 #define ENOTSUPP ENOTSUP
484 typedef int mm_segment_t;
489 static inline mm_segment_t get_fs(void)
494 static inline void set_fs(mm_segment_t seg)
498 #define S_IRWXUGO (S_IRWXU|S_IRWXG|S_IRWXO)
499 #define S_IALLUGO (S_ISUID|S_ISGID|S_ISVTX|S_IRWXUGO)
501 struct inode *igrab(struct inode *inode);
502 void iput(struct inode *inode);
504 #include <obd_support.h>
505 #include <lustre/lustre_idl.h>
506 #include <lustre_lib.h>
507 #include <lustre_import.h>
508 #include <lustre_export.h>
509 #include <lustre_net.h>