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
50 #include <sys/queue.h>
53 #error Kernel files should not #include <liblustre.h>
56 #include <libcfs/libcfs.h>
57 #include <lnet/lnet.h>
59 /* definitions for liblustre */
63 #define loff_t long long
65 typedef unsigned short umode_t;
70 #define page_private(page) ((page)->private)
71 #define set_page_private(page, v) ((page)->private = (v))
76 /* a long can be more than 32 bits, so use BITS_PER_LONG
77 * to allow the compiler to adjust the bit shifting accordingly
80 static inline int ext2_set_bit(int nr, void *addr)
82 #if __BYTE_ORDER == __BIG_ENDIAN
83 return set_bit((nr ^ ((BITS_PER_LONG - 1) & ~0x7)), addr);
85 return set_bit(nr, addr);
89 static inline int ext2_clear_bit(int nr, void *addr)
91 #if __BYTE_ORDER == __BIG_ENDIAN
92 return clear_bit((nr ^ ((BITS_PER_LONG - 1) & ~0x7)), addr);
94 return clear_bit(nr, addr);
98 static inline int ext2_test_bit(int nr, const void *addr)
100 #if __BYTE_ORDER == __BIG_ENDIAN
101 const unsigned char *tmp = addr;
102 return (tmp[nr >> 3] >> (nr & 7)) & 1;
104 return test_bit(nr, addr);
108 /* module initialization */
109 extern int init_obdclass(void);
110 extern int ptlrpc_init(void);
111 extern int ldlm_init(void);
112 extern int osc_init(void);
113 extern int lov_init(void);
114 extern int mdc_init(void);
115 extern int lmv_init(void);
116 extern int mgc_init(void);
121 #define min(x,y) ((x)<(y) ? (x) : (y))
125 #define max(x,y) ((x)>(y) ? (x) : (y))
129 #define min_t(type,x,y) \
130 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
133 #define max_t(type,x,y) \
134 ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
137 #define simple_strtol strtol
146 void cfs_get_random_bytes(void *ptr, int size);
150 /* memory size: used for some client tunables */
151 #define totalram_pages (256 * 1024) /* 1GB */
152 #define NUM_CACHEPAGES totalram_pages
156 #define ATTR_MODE 0x0001
157 #define ATTR_UID 0x0002
158 #define ATTR_GID 0x0004
159 #define ATTR_SIZE 0x0008
160 #define ATTR_ATIME 0x0010
161 #define ATTR_MTIME 0x0020
162 #define ATTR_CTIME 0x0040
163 #define ATTR_ATIME_SET 0x0080
164 #define ATTR_MTIME_SET 0x0100
165 #define ATTR_FORCE 0x0200 /* Not a change, but a change it */
166 #define ATTR_ATTR_FLAG 0x0400
167 #define ATTR_RAW 0x0800 /* file system, not vfs will massage attrs */
168 #define ATTR_FROM_OPEN 0x1000 /* called from open path, ie O_TRUNC */
169 #define ATTR_CTIME_SET 0x2000
170 #define ATTR_BLOCKS 0x4000
171 #define ATTR_KILL_SUID 0
172 #define ATTR_KILL_SGID 0
176 unsigned int ia_valid;
184 unsigned int ia_attr_flags;
187 /* defined in kernel header include/linux/namei.h */
188 #define INTENT_MAGIC 0x19620323
190 struct lustre_intent_data {
193 __u64 it_lock_handle;
195 int it_remote_lock_mode;
196 __u64 it_remote_lock_handle;
199 unsigned int it_lock_set:1;
202 struct lookup_intent {
204 void (*it_op_release)(struct lookup_intent *);
209 struct lustre_intent_data lustre;
213 static inline int it_disposition(const struct lookup_intent *it, int flag)
215 return it->d.lustre.it_disposition & flag;
218 static inline void it_set_disposition(struct lookup_intent *it, int flag)
220 it->d.lustre.it_disposition |= flag;
223 static inline void it_clear_disposition(struct lookup_intent *it, int flag)
225 it->d.lustre.it_disposition &= ~flag;
228 #undef LL_TASK_CL_ENV
229 #define LL_TASK_CL_ENV cl_env
247 #define current_pid() (current->pid)
248 #define current_comm() (current->comm)
249 #define current_fsuid() (current->fsuid)
250 #define current_fsgid() (current->fsgid)
251 #define current_umask() ({ mode_t mask = umask(0); umask(mask); mask; })
253 extern struct task_struct *current;
254 int in_group_p(gid_t gid);
256 #define set_current_state(foo) do { current->state = foo; } while (0)
258 #define wait_event_interruptible(wq, condition) \
260 struct l_wait_info lwi; \
261 int timeout = 100000000;/* forever */ \
264 lwi = LWI_TIMEOUT(timeout, NULL, NULL); \
265 ret = l_wait_event(NULL, condition, &lwi); \
270 #define call_usermodehelper(path, argv, envp, wait) (0)
273 #error "liblustre's jiffies currently expects HZ to be 1"
277 unsigned long _ret = 0; \
279 if (gettimeofday(&tv, NULL) == 0) \
283 #define get_jiffies_64() (__u64)jiffies
286 #define likely(exp) (exp)
289 #define unlikely(exp) (exp)
292 #define might_sleep()
293 #define might_sleep_if(c)
296 /* FIXME sys/capability will finally included linux/fs.h thus
297 * cause numerous trouble on x86-64. as temporary solution for
298 * build broken at Cray, we copy definition we need from capability.h
302 typedef struct _cap_struct *cap_t;
303 typedef int cap_value_t;
314 cap_t cap_get_proc(void);
315 int cap_get_flag(cap_t, cap_value_t, cap_flag_t, cap_flag_value_t *);
317 struct liblustre_wait_callback {
318 cfs_list_t llwc_list;
319 const char *llwc_name;
320 int (*llwc_fn)(void *arg);
324 void *liblustre_register_wait_callback(const char *name,
325 int (*fn)(void *arg), void *arg);
326 void liblustre_deregister_wait_callback(void *notifier);
327 int liblustre_wait_event(int timeout);
329 void *liblustre_register_idle_callback(const char *name,
330 int (*fn)(void *arg), void *arg);
331 void liblustre_deregister_idle_callback(void *notifier);
332 void liblustre_wait_idle(void);
335 struct file_lock *fl_next; /* singly linked list for this inode */
336 cfs_list_t fl_link; /* doubly linked list of all locks */
337 cfs_list_t fl_block; /* circular list of blocked processes */
340 wait_queue_head_t fl_wait;
341 struct file *fl_file;
342 unsigned char fl_flags;
343 unsigned char fl_type;
347 void (*fl_notify)(struct file_lock *); /* unblock callback */
348 void (*fl_insert)(struct file_lock *); /* lock insertion callback */
349 void (*fl_remove)(struct file_lock *); /* lock removal callback */
351 void *fl_fasync; /* for lease break notifications */
352 unsigned long fl_break_time; /* for nonblocking lease breaks */
355 #define flock_type(fl) ((fl)->fl_type)
356 #define flock_set_type(fl, type) do { (fl)->fl_type = (type); } while (0)
357 #define flock_pid(fl) ((fl)->fl_pid)
358 #define flock_set_pid(fl, pid) do { (fl)->fl_pid = (pid); } while (0)
359 #define flock_start(fl) ((fl)->fl_start)
360 #define flock_set_start(fl, st) do { (fl)->fl_start = (st); } while (0)
361 #define flock_end(fl) ((fl)->fl_end)
362 #define flock_set_end(fl, end) do { (fl)->fl_end = (end); } while (0)
365 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
366 #define OFFSET_MAX INT_LIMIT(loff_t)
369 #define i_atime i_stbuf.st_atime
370 #define i_mtime i_stbuf.st_mtime
371 #define i_ctime i_stbuf.st_ctime
372 /* use i_size_read() i_size_write() to access i_stbuf.st_size */
373 #define i_blocks i_stbuf.st_blocks
374 #define i_blksize i_stbuf.st_blksize
375 #define i_mode i_stbuf.st_mode
376 #define i_uid i_stbuf.st_uid
377 #define i_gid i_stbuf.st_gid
379 /* XXX: defined in kernel */
392 } posix_acl_xattr_entry;
396 unsigned int a_count;
397 posix_acl_xattr_entry a_entries[0];
402 posix_acl_xattr_entry a_entries[0];
403 } posix_acl_xattr_header;
405 static inline size_t posix_acl_xattr_size(int count)
407 return sizeof(posix_acl_xattr_header) + count *
408 sizeof(posix_acl_xattr_entry);
412 struct posix_acl * posix_acl_from_xattr(const void *value, size_t size)
417 /* The kernel version takes 3 arguments, so strip that off first. */
418 #define posix_acl_from_xattr(a,b,c) posix_acl_from_xattr(b,c)
419 #define posix_acl_to_xattr(a,b,c) posix_acl_to_xattr(b,c)
422 int posix_acl_valid(const struct posix_acl *acl)
428 void posix_acl_release(struct posix_acl *acl)
432 #if defined(LIBLUSTRE_POSIX_ACL) && !defined(CONFIG_FS_POSIX_ACL)
433 # define CONFIG_FS_POSIX_ACL 1
437 #define ENOTSUPP ENOTSUP
440 typedef int mm_segment_t;
442 #define S_IRWXUGO (S_IRWXU|S_IRWXG|S_IRWXO)
443 #define S_IALLUGO (S_ISUID|S_ISGID|S_ISVTX|S_IRWXUGO)
445 #include <obd_support.h>
446 #include <lustre/lustre_idl.h>
447 #include <lustre_lib.h>
448 #include <lustre_import.h>
449 #include <lustre_export.h>
450 #include <lustre_net.h>