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