LINUX: Use struct vfs_path on RHEL5
[openafs.git] / src / afs / LINUX / osi_compat.h
1 /* Kernel compatibility routines
2  *
3  * This file contains definitions to provide compatibility between different
4  * versions of the Linux kernel. It is an ifdef maze, but the idea is that
5  * by concentrating the horror here, the rest of the tree may remaing a
6  * little cleaner...
7  */
8
9 #ifndef AFS_LINUX_OSI_COMPAT_H
10 #define AFS_LINUX_OSI_COMPAT_H
11
12 #if defined(HAVE_LINUX_FREEZER_H)
13 # include <linux/freezer.h>
14 #endif
15
16 #if defined(LINUX_KEYRING_SUPPORT)
17 # include <linux/rwsem.h>
18 # include <linux/key.h>
19 # if defined(HAVE_LINUX_KEY_TYPE_H)
20 #  include <linux/key-type.h>
21 # endif
22 # ifndef KEY_ALLOC_IN_QUOTA
23 /* Before these flags were added in Linux commit v2.6.18-rc1~816,
24  * key_alloc just took a boolean not_in_quota */
25 #  define KEY_ALLOC_IN_QUOTA 0
26 #  define KEY_ALLOC_NOT_IN_QUOTA 1
27 # endif
28 #endif
29
30 #ifdef HAVE_LINUX_STRUCT_VFS_PATH
31 typedef struct vfs_path afs_linux_path_t;
32 #else
33 typedef struct path afs_linux_path_t;
34 #endif
35
36 #ifndef HAVE_LINUX_DO_SYNC_READ
37 static inline int
38 do_sync_read(struct file *fp, char *buf, size_t count, loff_t *offp) {
39     return generic_file_read(fp, buf, count, offp);
40 }
41
42 static inline int
43 do_sync_write(struct file *fp, char *buf, size_t count, loff_t *offp) {
44     return generic_file_write(fp, buf, count, offp);
45 }
46
47 #endif /* DO_SYNC_READ */
48
49 static inline int
50 afs_posix_lock_file(struct file *fp, struct file_lock *flp) {
51 #ifdef POSIX_LOCK_FILE_WAIT_ARG
52     return posix_lock_file(fp, flp, NULL);
53 #else
54     flp->fl_flags &=~ FL_SLEEP;
55     return posix_lock_file(fp, flp);
56 #endif
57 }
58
59 static inline void
60 afs_posix_test_lock(struct file *fp, struct file_lock *flp) {
61 #if defined(POSIX_TEST_LOCK_CONFLICT_ARG)
62     struct file_lock conflict;
63     if (posix_test_lock(fp, flp, &conflict)) {
64         locks_copy_lock(flp, &conflict);
65         flp->fl_type = F_UNLCK;
66     }
67 #elif defined(POSIX_TEST_LOCK_RETURNS_CONFLICT)
68     struct file_lock *conflict;
69     conflict = posix_test_lock(fp, flp);
70     if (conflict) {
71         locks_copy_lock(flp, conflict);
72         flp->fl_type = F_UNLCK;
73     }
74 #else
75     posix_test_lock(fp, flp);
76 #endif
77 }
78
79 #ifdef DCACHE_NFSFS_RENAMED
80 static inline void
81 afs_linux_clear_nfsfs_renamed(struct dentry *dp) {
82     spin_lock(&dp->d_lock);
83     dp->d_flags &= ~DCACHE_NFSFS_RENAMED;
84     spin_unlock(&dp->d_lock);
85 }
86
87 static inline void
88 afs_linux_set_nfsfs_renamed(struct dentry *dp) {
89     spin_lock(&dp->d_lock);
90     dp->d_flags |= DCACHE_NFSFS_RENAMED;
91     spin_unlock(&dp->d_lock);
92 }
93
94 static inline int
95 afs_linux_nfsfs_renamed(struct dentry *dp) {
96     return dp->d_flags & DCACHE_NFSFS_RENAMED;
97 }
98
99 #else
100 static inline void afs_linux_clear_nfsfs_renamed(void) { return; }
101 static inline void afs_linux_set_nfsfs_renamed(void) { return; }
102 #endif
103
104 #ifndef HAVE_LINUX_HLIST_UNHASHED
105 static void
106 hlist_unhashed(const struct hlist_node *h) {
107     return (!h->pprev == NULL);
108 }
109 #endif
110
111 #if defined(WRITEPAGE_ACTIVATE)
112 #define AOP_WRITEPAGE_ACTIVATE WRITEPAGE_ACTIVATE
113 #endif
114
115 #if defined(STRUCT_ADDRESS_SPACE_OPERATIONS_HAS_WRITE_BEGIN) && !defined(HAVE_LINUX_GRAB_CACHE_PAGE_WRITE_BEGIN)
116 static inline struct page *
117 grab_cache_page_write_begin(struct address_space *mapping, pgoff_t index,
118                             unsigned int flags) {
119     return __grab_cache_page(mapping, index);
120 }
121 #endif
122
123 #if defined(HAVE_KMEM_CACHE_T)
124 #define afs_kmem_cache_t kmem_cache_t
125 #else
126 #define afs_kmem_cache_t struct kmem_cache
127 #endif
128
129 extern void init_once(void *);
130 #if defined(HAVE_KMEM_CACHE_T)
131 static inline void
132 init_once_func(void * foo, kmem_cache_t * cachep, unsigned long flags) {
133 #if defined(SLAB_CTOR_VERIFY)
134     if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
135         SLAB_CTOR_CONSTRUCTOR)
136 #endif
137     init_once(foo);
138 }
139 #elif defined(KMEM_CACHE_INIT)
140 static inline void
141 init_once_func(struct kmem_cache * cachep, void * foo) {
142     init_once(foo);
143 }
144 #elif !defined(KMEM_CACHE_CTOR_TAKES_VOID)
145 static inline void
146 init_once_func(void * foo, struct kmem_cache * cachep, unsigned long flags) {
147 #if defined(SLAB_CTOR_VERIFY)
148     if ((flags & (SLAB_CTOR_VERIFY|SLAB_CTOR_CONSTRUCTOR)) ==
149         SLAB_CTOR_CONSTRUCTOR)
150 #endif
151     init_once(foo);
152 }
153 #else
154 static inline void
155 init_once_func(void * foo) {
156     init_once(foo);
157 }
158 #endif
159
160 #ifndef SLAB_RECLAIM_ACCOUNT
161 #define SLAB_RECLAIM_ACCOUNT 0
162 #endif
163
164 #if defined(SLAB_KERNEL)
165 #define KALLOC_TYPE SLAB_KERNEL
166 #else
167 #define KALLOC_TYPE GFP_KERNEL
168 #endif
169
170 #ifdef LINUX_KEYRING_SUPPORT
171 static inline struct key *
172 afs_linux_key_alloc(struct key_type *type, const char *desc, uid_t uid,
173                     gid_t gid, key_perm_t perm, unsigned long flags)
174 {
175 # if defined(KEY_ALLOC_NEEDS_STRUCT_TASK)
176     return key_alloc(type, desc, uid, gid, current, perm, flags);
177 # elif defined(KEY_ALLOC_NEEDS_CRED)
178     return key_alloc(type, desc, uid, gid, current_cred(), perm, flags);
179 # else
180     return key_alloc(type, desc, uid, gid, perm, flags);
181 # endif
182 }
183
184 # if defined(STRUCT_TASK_STRUCT_HAS_CRED)
185 static inline struct key*
186 afs_linux_search_keyring(afs_ucred_t *cred, struct key_type *type)
187 {
188     key_ref_t key_ref;
189
190     if (cred->tgcred->session_keyring) {
191         key_ref = keyring_search(
192                       make_key_ref(cred->tgcred->session_keyring, 1),
193                       type, "_pag");
194         if (IS_ERR(key_ref))
195             return ERR_CAST(key_ref);
196
197         return key_ref_to_ptr(key_ref);
198     }
199
200     return ERR_PTR(-ENOKEY);
201 }
202 # else
203 static inline struct key*
204 afs_linux_search_keyring(afs_ucred_t *cred, struct key_type *type)
205 {
206     return request_key(type, "_pag", NULL);
207 }
208 # endif /* STRUCT_TASK_STRUCT_HAS_CRED */
209 #endif /* LINUX_KEYRING_SUPPORT */
210
211 #ifdef STRUCT_TASK_STRUCT_HAS_CRED
212 static inline int
213 afs_linux_cred_is_current(afs_ucred_t *cred)
214 {
215     return (cred == current_cred());
216 }
217 #else
218 static inline int
219 afs_linux_cred_is_current(afs_ucred_t *cred)
220 {
221     return 1;
222 }
223 #endif
224
225 #ifndef HAVE_LINUX_PAGE_OFFSET
226 static inline loff_t
227 page_offset(struct page *pp)
228 {
229     return (((loff_t) pp->index) << PAGE_CACHE_SHIFT);
230 }
231 #endif
232
233 #ifndef HAVE_LINUX_ZERO_USER_SEGMENTS
234 static inline void
235 zero_user_segments(struct page *pp, unsigned int from1, unsigned int to1,
236                    unsigned int from2, unsigned int to2)
237 {
238     void *base = kmap_atomic(pp, KM_USER0);
239
240     if (to1 > from1)
241         memset(base + from1, 0, to1 - from1);
242
243     if (to2 > from2)
244         memset(base + from2, 0, to2 - from2);
245
246     flush_dcache_page(pp);
247     kunmap_atomic(base, KM_USER0);
248 }
249
250 static inline void
251 zero_user_segment(struct page *pp, unsigned int from1, unsigned int to1)
252 {
253     zero_user_segments(pp, from1, to1, 0, 0);
254 }
255 #endif
256
257 #ifndef HAVE_LINUX_KERNEL_SETSOCKOPT
258 /* Available from 2.6.19 */
259
260 static inline int
261 kernel_setsockopt(struct socket *sockp, int level, int name, char *val,
262                   unsigned int len) {
263     mm_segment_t old_fs = get_fs();
264     int ret;
265
266     set_fs(get_ds());
267     ret = sockp->ops->setsockopt(sockp, level, name, val, len);
268     set_fs(old_fs);
269
270     return ret;
271 }
272
273 static inline int
274 kernel_getsockopt(struct socket *sockp, int level, int name, char *val,
275                   int *len) {
276     mm_segment_t old_fs = get_fs();
277     int ret;
278
279     set_fs(get_ds());
280     ret = sockp->ops->getsockopt(sockp, level, name, val, len);
281     set_fs(old_fs);
282
283     return ret;
284 }
285 #endif
286
287 #ifdef HAVE_TRY_TO_FREEZE
288 static inline int
289 afs_try_to_freeze(void) {
290 # ifdef LINUX_REFRIGERATOR_TAKES_PF_FREEZE
291     return try_to_freeze(PF_FREEZE);
292 # else
293     return try_to_freeze();
294 # endif
295 }
296 #else
297 static inline int
298 afs_try_to_freeze(void) {
299 # ifdef CONFIG_PM
300     if (current->flags & PF_FREEZE) {
301         refrigerator(PF_FREEZE);
302         return 1;
303     }
304 # endif
305     return 0;
306 }
307 #endif
308
309 /* The commit which changed refrigerator so that it takes no arguments
310  * also added freezing(), so if LINUX_REFRIGERATOR_TAKES_PF_FREEZE is
311  * true, the kernel doesn't have a freezing() function.
312  */
313 #ifdef LINUX_REFRIGERATOR_TAKES_PF_FREEZE
314 static inline int
315 freezing(struct task_struct *p)
316 {
317 # ifdef CONFIG_PM
318     return p->flags & PF_FREEZE;
319 # else
320     return 0;
321 # endif
322 }
323 #endif
324
325 #if !defined(HAVE_LINUX_PAGECHECKED)
326 # if defined(HAVE_LINUX_PAGEFSMISC)
327 #  include <linux/page-flags.h>
328
329 #  define PageChecked(p)            PageFsMisc((p))
330 #  define SetPageChecked(p)         SetPageFsMisc((p))
331 #  define ClearPageChecked(p)       ClearPageFsMisc((p))
332
333 # endif
334 #endif
335
336 #if !defined(NEW_EXPORT_OPS)
337 extern struct export_operations export_op_default;
338 #endif
339
340 static inline struct dentry *
341 afs_get_dentry_from_fh(struct super_block *afs_cacheSBp, afs_dcache_id_t *ainode,
342                 int cache_fh_len, int cache_fh_type,
343                 int (*afs_fh_acceptable)(void *, struct dentry *)) {
344 #if defined(NEW_EXPORT_OPS)
345     return afs_cacheSBp->s_export_op->fh_to_dentry(afs_cacheSBp, &ainode->ufs.fh,
346                 cache_fh_len, cache_fh_type);
347 #else
348     if (afs_cacheSBp->s_export_op && afs_cacheSBp->s_export_op->decode_fh)
349         return afs_cacheSBp->s_export_op->decode_fh(afs_cacheSBp, ainode->ufs.raw,
350                         cache_fh_len, cache_fh_type, afs_fh_acceptable, NULL);
351     else
352         return export_op_default.decode_fh(afs_cacheSBp, ainode->ufs.raw,
353                         cache_fh_len, cache_fh_type, afs_fh_acceptable, NULL);
354 #endif
355 }
356
357 static inline int
358 afs_get_fh_from_dentry(struct dentry *dp, afs_ufs_dcache_id_t *ainode, int *max_lenp) {
359     if (dp->d_sb->s_export_op->encode_fh)
360 #if defined(EXPORT_OP_ENCODE_FH_TAKES_INODES)
361         return dp->d_sb->s_export_op->encode_fh(dp->d_inode, &ainode->raw[0], max_lenp, NULL);
362 #else
363         return dp->d_sb->s_export_op->encode_fh(dp, &ainode->raw[0], max_lenp, 0);
364 #endif
365 #if defined(NEW_EXPORT_OPS)
366     /* If fs doesn't provide an encode_fh method, assume the default INO32 type */
367     *max_lenp = sizeof(struct fid)/4;
368     ainode->fh.i32.ino = dp->d_inode->i_ino;
369     ainode->fh.i32.gen = dp->d_inode->i_generation;
370     return FILEID_INO32_GEN;
371 #else
372     /* or call the default encoding function for the old API */
373     return export_op_default.encode_fh(dp, &ainode->raw[0], max_lenp, 0);
374 #endif
375 }
376
377 static inline void
378 afs_init_sb_export_ops(struct super_block *sb) {
379 #if !defined(NEW_EXPORT_OPS)
380     /*
381      * decode_fh will call this function.  If not defined for this FS, make
382      * sure it points to the default
383      */
384     if (!sb->s_export_op->find_exported_dentry) {
385         /* Some kernels (at least 2.6.9) do not prototype find_exported_dentry,
386          * even though it is exported, so prototype it ourselves. Newer
387          * kernels do prototype it, but as long as our protoype matches the
388          * real one (the signature never changed before NEW_EXPORT_OPS came
389          * into play), there should be no problems. */
390         extern struct dentry * find_exported_dentry(struct super_block *sb, void *obj, void *parent,
391                                                     int (*acceptable)(void *context, struct dentry *de),
392                                                     void *context);
393         sb->s_export_op->find_exported_dentry = find_exported_dentry;
394     }
395 #endif
396 }
397
398 static inline void
399 afs_linux_lock_inode(struct inode *ip) {
400 #ifdef STRUCT_INODE_HAS_I_MUTEX
401     mutex_lock(&ip->i_mutex);
402 #else
403     down(&ip->i_sem);
404 #endif
405 }
406
407 static inline void
408 afs_linux_unlock_inode(struct inode *ip) {
409 #ifdef STRUCT_INODE_HAS_I_MUTEX
410     mutex_unlock(&ip->i_mutex);
411 #else
412     up(&ip->i_sem);
413 #endif
414 }
415
416 static inline int
417 afs_inode_setattr(struct osi_file *afile, struct iattr *newattrs) {
418
419     int code = 0;
420     struct inode *inode = OSIFILE_INODE(afile);
421 #if !defined(HAVE_LINUX_INODE_SETATTR)
422     code = inode->i_op->setattr(afile->filp->f_dentry, newattrs);
423 #elif defined(INODE_SETATTR_NOT_VOID)
424     if (inode->i_op && inode->i_op->setattr)
425         code = inode->i_op->setattr(afile->filp->f_dentry, newattrs);
426     else
427         code = inode_setattr(inode, newattrs);
428 #else
429     inode_setattr(inode, newattrs);
430 #endif
431     return code;
432 }
433
434 #if defined(HAVE_LINUX_PATH_LOOKUP)
435 static inline int
436 afs_kern_path(char *aname, int flags, struct nameidata *nd) {
437     return path_lookup(aname, flags, nd);
438 }
439 #else
440 static inline int
441 afs_kern_path(char *aname, int flags, afs_linux_path_t *path) {
442     return kern_path(aname, flags, path);
443 }
444 #endif
445
446 static inline void
447 #if defined(HAVE_LINUX_PATH_LOOKUP)
448 afs_get_dentry_ref(struct nameidata *nd, struct vfsmount **mnt, struct dentry **dpp) {
449 #else
450 afs_get_dentry_ref(afs_linux_path_t *path, struct vfsmount **mnt, struct dentry **dpp) {
451 #endif
452 #if defined(STRUCT_NAMEIDATA_HAS_PATH)
453 # if defined(HAVE_LINUX_PATH_LOOKUP)
454     *dpp = dget(nd->path.dentry);
455     if (mnt)
456         *mnt = mntget(nd->path.mnt);
457     path_put(&nd->path);
458 # else
459     *dpp = dget(path->dentry);
460     if (mnt)
461         *mnt = mntget(path->mnt);
462     path_put(path);
463 # endif
464 #else
465     *dpp = dget(nd->dentry);
466     if (mnt)
467         *mnt = mntget(nd->mnt);
468     path_release(nd);
469 #endif
470 }
471
472 /* wait_event_freezable appeared with 2.6.24 */
473
474 /* These implement the original AFS wait behaviour, with respect to the
475  * refrigerator, rather than the behaviour of the current wait_event_freezable
476  * implementation.
477  */
478
479 #ifndef wait_event_freezable
480 # define wait_event_freezable(waitqueue, condition)                             \
481 ({                                                                              \
482     int _ret;                                                                   \
483     do {                                                                        \
484         _ret = wait_event_interruptible(waitqueue,                              \
485                                         (condition) || freezing(current));      \
486         if (_ret && !freezing(current))                                 \
487             break;                                                              \
488         else if (!(condition))                                                  \
489             _ret = -EINTR;                                                      \
490     } while (afs_try_to_freeze());                                              \
491     _ret;                                                                       \
492 })
493
494 # define wait_event_freezable_timeout(waitqueue, condition, timeout)            \
495 ({                                                                              \
496      int _ret;                                                                  \
497      do {                                                                       \
498         _ret = wait_event_interruptible_timeout(waitqueue,                      \
499                                                 (condition ||                   \
500                                                  freezing(current)),            \
501                                                 timeout);                       \
502      } while (afs_try_to_freeze());                                             \
503      _ret;                                                                      \
504 })
505 #endif
506
507 #if defined(STRUCT_TASK_STRUCT_HAS_CRED)
508 static inline struct file *
509 afs_dentry_open(struct dentry *dp, struct vfsmount *mnt, int flags, const struct cred *creds) {
510 #if defined(DENTRY_OPEN_TAKES_PATH)
511     afs_linux_path_t path;
512     struct file *filp;
513     path.mnt = mnt;
514     path.dentry = dp;
515     filp = dentry_open(&path, flags, creds);
516     return filp;
517 #else
518     return dentry_open(dp, mntget(mnt), flags, creds);
519 #endif
520 }
521 #endif
522
523 #endif /* AFS_LINUX_OSI_COMPAT_H */