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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 #ifndef _LUSTRE_COMPAT_H
33 #define _LUSTRE_COMPAT_H
35 #include <linux/aio.h>
37 #include <linux/namei.h>
38 #include <linux/pagemap.h>
39 #include <linux/posix_acl_xattr.h>
40 #include <linux/bio.h>
41 #include <linux/xattr.h>
42 #include <linux/workqueue.h>
43 #include <linux/blkdev.h>
44 #include <linux/backing-dev.h>
45 #include <linux/slab.h>
46 #include <linux/security.h>
47 #include <libcfs/linux/linux-fs.h>
48 #ifdef HAVE_XARRAY_SUPPORT
49 #include <linux/xarray.h>
51 #include <libcfs/linux/xarray.h>
53 #include <obd_support.h>
55 #ifdef HAVE_4ARGS_VFS_SYMLINK
56 #define ll_vfs_symlink(dir, dentry, mnt, path, mode) \
57 vfs_symlink(dir, dentry, path, mode)
59 #define ll_vfs_symlink(dir, dentry, mnt, path, mode) \
60 vfs_symlink(dir, dentry, path)
64 #define bio_idx(bio) (bio->bi_iter.bi_idx)
65 #define bio_set_sector(bio, sector) (bio->bi_iter.bi_sector = sector)
66 #define bvl_to_page(bvl) (bvl->bv_page)
68 #define bio_idx(bio) (bio->bi_idx)
69 #define bio_set_sector(bio, sector) (bio->bi_sector = sector)
70 #define bio_sectors(bio) ((bio)->bi_size >> 9)
71 #define bvl_to_page(bvl) (bvl->bv_page)
75 #define bio_start_sector(bio) (bio->bi_iter.bi_sector)
77 #define bio_start_sector(bio) (bio->bi_sector)
81 # define bio_get_dev(bio) ((bio)->bi_bdev)
82 # define bio_get_disk(bio) (bio_get_dev(bio)->bd_disk)
83 # define bio_get_queue(bio) bdev_get_queue(bio_get_dev(bio))
85 # ifndef HAVE_BIO_SET_DEV
86 # define bio_set_dev(bio, bdev) (bio_get_dev(bio) = (bdev))
89 # define bio_get_disk(bio) ((bio)->bi_disk)
90 # define bio_get_queue(bio) (bio_get_disk(bio)->queue)
97 static inline struct bio *cfs_bio_alloc(struct block_device *bdev,
98 unsigned short nr_vecs,
99 __u32 op, gfp_t gfp_mask)
102 #ifdef HAVE_BIO_ALLOC_WITH_BDEV
103 bio = bio_alloc(bdev, nr_vecs, op, gfp_mask);
105 bio = bio_alloc(gfp_mask, nr_vecs);
107 bio_set_dev(bio, bdev);
110 #endif /* HAVE_BIO_ALLOC_WITH_BDEV */
114 #ifndef HAVE_DENTRY_D_CHILD
115 #define d_child d_u.d_child
118 #ifndef HAVE_D_IN_LOOKUP
119 static inline int d_in_lookup(struct dentry *dentry)
125 #ifndef HAVE_VM_FAULT_T
126 #define vm_fault_t int
129 #ifndef HAVE_FOP_ITERATE_SHARED
130 #define iterate_shared iterate
133 #ifdef HAVE_OLDSIZE_TRUNCATE_PAGECACHE
134 #define ll_truncate_pagecache(inode, size) truncate_pagecache(inode, 0, size)
136 #define ll_truncate_pagecache(inode, size) truncate_pagecache(inode, size)
139 #ifdef HAVE_VFS_RENAME_5ARGS
140 #define ll_vfs_rename(a, b, c, d) vfs_rename(a, b, c, d, NULL)
141 #elif defined HAVE_VFS_RENAME_6ARGS
142 #define ll_vfs_rename(a, b, c, d) vfs_rename(a, b, c, d, NULL, 0)
144 #define ll_vfs_rename(a, b, c, d) vfs_rename(a, b, c, d)
147 #ifdef HAVE_USER_NAMESPACE_ARG
148 #define vfs_unlink(ns, dir, de) vfs_unlink(ns, dir, de, NULL)
149 #elif defined HAVE_VFS_UNLINK_3ARGS
150 #define vfs_unlink(ns, dir, de) vfs_unlink(dir, de, NULL)
152 #define vfs_unlink(ns, dir, de) vfs_unlink(dir, de)
155 #ifndef HAVE_MNT_IDMAP_ARG
156 #define mnt_idmap user_namespace
157 #define nop_mnt_idmap init_user_ns
160 static inline int ll_vfs_getattr(struct path *path, struct kstat *st,
161 u32 request_mask, unsigned int flags)
165 #if defined(HAVE_USER_NAMESPACE_ARG) || defined(HAVE_INODEOPS_ENHANCED_GETATTR)
166 rc = vfs_getattr(path, st, request_mask, flags);
168 rc = vfs_getattr(path, st);
173 #ifndef HAVE_D_IS_POSITIVE
174 static inline bool d_is_positive(const struct dentry *dentry)
176 return dentry->d_inode != NULL;
180 #ifndef HAVE_INODE_LOCK
181 # define inode_lock(inode) mutex_lock(&(inode)->i_mutex)
182 # define inode_unlock(inode) mutex_unlock(&(inode)->i_mutex)
183 # define inode_trylock(inode) mutex_trylock(&(inode)->i_mutex)
186 #ifndef HAVE_PAGECACHE_GET_PAGE
187 #define pagecache_get_page(mapping, index, fp, gfp) \
188 grab_cache_page_nowait(mapping, index)
191 /* Old kernels lacked both Xarray support and the page cache
192 * using Xarrays. Our back ported Xarray support introduces
193 * the real xa_is_value() but we need a wrapper as well for
194 * the page cache interaction. Lets keep xa_is_value() separate
195 * in old kernels for Xarray support and page cache handling.
197 #ifndef HAVE_XARRAY_SUPPORT
198 static inline bool ll_xa_is_value(void *entry)
200 return radix_tree_exceptional_entry(entry);
203 #define ll_xa_is_value xa_is_value
206 /* Linux kernel version v5.0 commit fd9dc93e36231fb6d520e0edd467058fad4fd12d
207 * ("XArray: Change xa_insert to return -EBUSY")
210 static inline int __must_check ll_xa_insert(struct xarray *xa,
212 void *entry, gfp_t gpf)
214 int rc = xa_insert(xa, index, entry, gpf);
221 #ifndef HAVE_TRUNCATE_INODE_PAGES_FINAL
222 static inline void truncate_inode_pages_final(struct address_space *map)
224 truncate_inode_pages(map, 0);
228 #ifdef HAVE_U64_CAPABILITY
229 #define ll_capability_u32(kcap) \
230 ((kcap).val & 0xFFFFFFFF)
231 #define ll_set_capability_u32(kcap, val32) \
232 ((kcap)->val = ((kcap)->val & 0xffffffff00000000ull) | (val32))
234 #define ll_capability_u32(kcap) \
236 #define ll_set_capability_u32(kcap, val32) \
237 ((kcap)->cap[0] = val32)
240 #ifndef HAVE_PTR_ERR_OR_ZERO
241 static inline int __must_check PTR_ERR_OR_ZERO(__force const void *ptr)
250 #ifdef HAVE_PID_NS_FOR_CHILDREN
251 # define ll_task_pid_ns(task) \
252 ((task)->nsproxy ? ((task)->nsproxy->pid_ns_for_children) : NULL)
254 # define ll_task_pid_ns(task) \
255 ((task)->nsproxy ? ((task)->nsproxy->pid_ns) : NULL)
258 #ifdef HAVE_FULL_NAME_HASH_3ARGS
259 # define ll_full_name_hash(salt, name, len) full_name_hash(salt, name, len)
261 # define ll_full_name_hash(salt, name, len) full_name_hash(name, len)
264 #ifdef HAVE_STRUCT_POSIX_ACL_XATTR
265 # define posix_acl_xattr_header struct posix_acl_xattr_header
266 # define posix_acl_xattr_entry struct posix_acl_xattr_entry
267 # define GET_POSIX_ACL_XATTR_ENTRY(head) ((void *)((head) + 1))
269 # define GET_POSIX_ACL_XATTR_ENTRY(head) ((head)->a_entries)
272 #ifdef HAVE_IOP_XATTR
273 #define ll_setxattr generic_setxattr
274 #define ll_getxattr generic_getxattr
275 #define ll_removexattr generic_removexattr
276 #endif /* HAVE_IOP_XATTR */
278 #ifndef HAVE_POSIX_ACL_VALID_USER_NS
279 #define posix_acl_valid(a,b) posix_acl_valid(b)
282 #ifdef HAVE_IOP_SET_ACL
283 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
284 #if !defined(HAVE_USER_NAMESPACE_ARG) \
285 && !defined(HAVE_POSIX_ACL_UPDATE_MODE) \
286 && !defined(HAVE_MNT_IDMAP_ARG)
287 static inline int posix_acl_update_mode(struct inode *inode, umode_t *mode_p,
288 struct posix_acl **acl)
290 umode_t mode = inode->i_mode;
293 error = posix_acl_equiv_mode(*acl, &mode);
298 if (!in_group_p(inode->i_gid) &&
299 !capable_wrt_inode_uidgid(inode, CAP_FSETID))
304 #endif /* HAVE_POSIX_ACL_UPDATE_MODE */
308 #ifndef HAVE_IOV_ITER_TRUNCATE
309 static inline void iov_iter_truncate(struct iov_iter *i, u64 count)
311 if (i->count > count)
317 * mount MS_* flags split from superblock SB_* flags
318 * if the SB_* flags are not available use the MS_* flags
320 #if !defined(SB_RDONLY) && defined(MS_RDONLY)
321 # define SB_RDONLY MS_RDONLY
323 #if !defined(SB_ACTIVE) && defined(MS_ACTIVE)
324 # define SB_ACTIVE MS_ACTIVE
326 #if !defined(SB_NOSEC) && defined(MS_NOSEC)
327 # define SB_NOSEC MS_NOSEC
329 #if !defined(SB_POSIXACL) && defined(MS_POSIXACL)
330 # define SB_POSIXACL MS_POSIXACL
332 #if !defined(SB_NODIRATIME) && defined(MS_NODIRATIME)
333 # define SB_NODIRATIME MS_NODIRATIME
335 #if !defined(SB_KERNMOUNT) && defined(MS_KERNMOUNT)
336 # define SB_KERNMOUNT MS_KERNMOUNT
339 #ifndef HAVE_FILE_OPERATIONS_READ_WRITE_ITER
340 static inline void iov_iter_reexpand(struct iov_iter *i, size_t count)
345 static inline struct iovec iov_iter_iovec(const struct iov_iter *iter)
347 return (struct iovec) {
348 .iov_base = iter->iov->iov_base + iter->iov_offset,
349 .iov_len = min(iter->count,
350 iter->iov->iov_len - iter->iov_offset),
354 #define iov_for_each(iov, iter, start) \
355 for (iter = (start); \
356 (iter).count && ((iov = iov_iter_iovec(&(iter))), 1); \
357 iov_iter_advance(&(iter), (iov).iov_len))
359 static inline ssize_t
360 generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
366 iov_for_each(iov, i, *iter) {
369 res = generic_file_aio_read(iocb, &iov, 1, iocb->ki_pos);
377 if (res < iov.iov_len)
382 iov_iter_advance(iter, bytes);
386 static inline ssize_t
387 __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *iter)
393 /* Since LLITE updates file size at the end of I/O in
394 * vvp_io_commit_write(), append write has to be done in atomic when
395 * there are multiple segments because otherwise each iteration to
396 * __generic_file_aio_write() will see original file size */
397 if (unlikely(iocb->ki_filp->f_flags & O_APPEND && iter->nr_segs > 1)) {
398 struct iovec *iov_copy;
401 OBD_ALLOC_PTR_ARRAY(iov_copy, iter->nr_segs);
405 iov_for_each(iov, i, *iter)
406 iov_copy[count++] = iov;
408 bytes = __generic_file_aio_write(iocb, iov_copy, count,
410 OBD_FREE_PTR_ARRAY(iov_copy, iter->nr_segs);
413 iov_iter_advance(iter, bytes);
417 iov_for_each(iov, i, *iter) {
420 res = __generic_file_aio_write(iocb, &iov, 1, &iocb->ki_pos);
428 if (res < iov.iov_len)
433 iov_iter_advance(iter, bytes);
436 #endif /* HAVE_FILE_OPERATIONS_READ_WRITE_ITER */
438 static inline void __user *get_vmf_address(struct vm_fault *vmf)
440 #ifdef HAVE_VM_FAULT_ADDRESS
441 return (void __user *)vmf->address;
443 return vmf->virtual_address;
447 #ifdef HAVE_VM_OPS_USE_VM_FAULT_ONLY
448 # define __ll_filemap_fault(vma, vmf) filemap_fault(vmf)
450 # define __ll_filemap_fault(vma, vmf) filemap_fault(vma, vmf)
453 #ifndef HAVE_CURRENT_TIME
454 static inline struct timespec current_time(struct inode *inode)
462 * time_after32 - compare two 32-bit relative times
463 * @a: the time which may be after @b
464 * @b: the time which may be before @a
466 * Needed for kernels earlier than v4.14-rc1~134^2
468 * time_after32(a, b) returns true if the time @a is after time @b.
469 * time_before32(b, a) returns true if the time @b is before time @a.
471 * Similar to time_after(), compare two 32-bit timestamps for relative
472 * times. This is useful for comparing 32-bit seconds values that can't
473 * be converted to 64-bit values (e.g. due to disk format or wire protocol
474 * issues) when it is known that the times are less than 68 years apart.
476 #define time_after32(a, b) ((s32)((u32)(b) - (u32)(a)) < 0)
477 #define time_before32(b, a) time_after32(a, b)
482 #define smp_store_mb(var, value) set_mb(var, value)
485 #ifdef HAVE_PAGEVEC_INIT_ONE_PARAM
486 #define ll_pagevec_init(pvec, n) pagevec_init(pvec)
488 #define ll_pagevec_init(pvec, n) pagevec_init(pvec, n)
492 # define ll_d_count(d) d_count(d)
494 # define ll_d_count(d) ((d)->d_count)
495 #endif /* HAVE_D_COUNT */
497 #ifndef HAVE_IN_COMPAT_SYSCALL
498 #define in_compat_syscall is_compat_task
502 #define page_tree i_pages
503 #define ll_xa_lock_irqsave(lockp, flags) xa_lock_irqsave(lockp, flags)
504 #define ll_xa_unlock_irqrestore(lockp, flags) xa_unlock_irqrestore(lockp, flags)
506 #define i_pages tree_lock
507 #define ll_xa_lock_irqsave(lockp, flags) spin_lock_irqsave(lockp, flags)
508 #define ll_xa_unlock_irqrestore(lockp, flags) spin_unlock_irqrestore(lockp, flags)
511 /* Linux commit v5.15-12273-gab2f9d2d3626
512 * mm: unexport {,un}lock_page_memcg
514 * Note that the functions are still defined or declared breaking
515 * the simple approach of just defining the missing functions here
517 #ifdef HAVE_LOCK_PAGE_MEMCG
518 #define vvp_lock_page_memcg(page) lock_page_memcg((page))
519 #define vvp_unlock_page_memcg(page) unlock_page_memcg((page))
521 #define vvp_lock_page_memcg(page)
522 #define vvp_unlock_page_memcg(page)
525 #ifndef KMEM_CACHE_USERCOPY
526 #define kmem_cache_create_usercopy(name, size, align, flags, useroffset, \
528 kmem_cache_create(name, size, align, flags, ctor)
531 static inline bool ll_security_xattr_wanted(struct inode *in)
533 #ifdef CONFIG_SECURITY
534 return in->i_security && in->i_sb->s_security;
540 static inline int ll_vfs_getxattr(struct dentry *dentry, struct inode *inode,
542 void *value, size_t size)
544 #if defined(HAVE_MNT_IDMAP_ARG) || defined(HAVE_USER_NAMESPACE_ARG)
545 return vfs_getxattr(&nop_mnt_idmap, dentry, name, value, size);
546 #elif defined(HAVE_VFS_SETXATTR)
547 return __vfs_getxattr(dentry, inode, name, value, size);
549 if (unlikely(!inode->i_op->getxattr))
552 return inode->i_op->getxattr(dentry, name, value, size);
556 static inline int ll_vfs_setxattr(struct dentry *dentry, struct inode *inode,
558 const void *value, size_t size, int flags)
560 #if defined(HAVE_MNT_IDMAP_ARG) || defined(HAVE_USER_NAMESPACE_ARG)
561 return vfs_setxattr(&nop_mnt_idmap, dentry, name,
562 VFS_SETXATTR_VALUE(value), size, flags);
563 #elif defined(HAVE_VFS_SETXATTR)
564 return __vfs_setxattr(dentry, inode, name, value, size, flags);
566 if (unlikely(!inode->i_op->setxattr))
569 return inode->i_op->setxattr(dentry, name, value, size, flags);
573 static inline int ll_vfs_removexattr(struct dentry *dentry, struct inode *inode,
576 #if defined(HAVE_MNT_IDMAP_ARG) || defined(HAVE_USER_NAMESPACE_ARG)
577 return vfs_removexattr(&nop_mnt_idmap, dentry, name);
578 #elif defined(HAVE_VFS_SETXATTR)
579 return __vfs_removexattr(dentry, name);
581 if (unlikely(!inode->i_op->setxattr))
584 return inode->i_op->removexattr(dentry, name);
588 /* until v3.19-rc5-3-gb4caecd48005 */
589 #ifndef BDI_CAP_MAP_COPY
590 #define BDI_CAP_MAP_COPY 0
593 /* from v4.1-rc2-56-g89e9b9e07a39, until v5.9-rc3-161-gf56753ac2a90 */
594 #ifndef BDI_CAP_CGROUP_WRITEBACK
595 #define BDI_CAP_CGROUP_WRITEBACK 0
598 /* from v5.9-rc3-161-gf56753ac2a90 */
599 #ifndef BDI_CAP_WRITEBACK
600 #define BDI_CAP_WRITEBACK 0
603 /* from v5.9-rc3-161-gf56753ac2a90 */
604 #ifndef BDI_CAP_WRITEBACK_ACCT
605 #define BDI_CAP_WRITEBACK_ACCT 0
608 #define LL_BDI_CAP_FLAGS (BDI_CAP_CGROUP_WRITEBACK | BDI_CAP_MAP_COPY | \
609 BDI_CAP_WRITEBACK | BDI_CAP_WRITEBACK_ACCT)
611 #ifndef FALLOC_FL_COLLAPSE_RANGE
612 #define FALLOC_FL_COLLAPSE_RANGE 0x08 /* remove a range of a file */
615 #ifndef FALLOC_FL_ZERO_RANGE
616 #define FALLOC_FL_ZERO_RANGE 0x10 /* convert range to zeros */
619 #ifndef FALLOC_FL_INSERT_RANGE
620 #define FALLOC_FL_INSERT_RANGE 0x20 /* insert space within file */
624 #define raw_cpu_ptr(p) __this_cpu_ptr(p)
627 #ifndef HAVE_IS_ROOT_INODE
628 static inline bool is_root_inode(struct inode *inode)
630 return inode == inode->i_sb->s_root->d_inode;
634 #ifndef HAVE_IOV_ITER_GET_PAGES_ALLOC2
635 #define iov_iter_get_pages_alloc2(i, p, m, s) \
636 iov_iter_get_pages_alloc((i), (p), (m), (s))
639 #ifdef HAVE_AOPS_MIGRATE_FOLIO
640 #define folio_migr folio
642 #define folio_migr page
643 #define migrate_folio migratepage
646 #ifdef HAVE_REGISTER_SHRINKER_FORMAT_NAMED
647 #define register_shrinker(_s) register_shrinker((_s), "%ps", (_s))
648 #elif !defined(HAVE_REGISTER_SHRINKER_RET)
649 #define register_shrinker(_s) (register_shrinker(_s), 0)
653 # if defined(__GNUC__) && __GNUC__ >= 7
654 # define fallthrough __attribute__((fallthrough)) /* fallthrough */
656 # define fallthrough do {} while (0) /* fallthrough */
660 #ifdef VERIFY_WRITE /* removed in kernel commit v4.20-10979-g96d4f267e40f */
661 #define ll_access_ok(ptr, len) access_ok(VERIFY_WRITE, ptr, len)
663 #define ll_access_ok(ptr, len) access_ok(ptr, len)
666 #ifdef HAVE_SEC_RELEASE_SECCTX_1ARG
667 #ifndef HAVE_LSMCONTEXT_INIT
669 static inline void lsmcontext_init(struct lsmcontext *cp, char *context,
673 cp->context = context;
679 static inline void ll_security_release_secctx(char *secdata, u32 seclen,
682 #ifdef HAVE_SEC_RELEASE_SECCTX_1ARG
683 struct lsmcontext context = { };
685 lsmcontext_init(&context, secdata, seclen, slot);
686 return security_release_secctx(&context);
688 return security_release_secctx(secdata, seclen);
692 #if !defined(HAVE_USER_NAMESPACE_ARG) && !defined(HAVE_MNT_IDMAP_ARG)
693 #define posix_acl_update_mode(ns, inode, mode, acl) \
694 posix_acl_update_mode(inode, mode, acl)
695 #define notify_change(ns, de, attr, inode) notify_change(de, attr, inode)
696 #define inode_owner_or_capable(ns, inode) inode_owner_or_capable(inode)
697 #define vfs_create(ns, dir, de, mode, ex) vfs_create(dir, de, mode, ex)
698 #define vfs_mkdir(ns, dir, de, mode) vfs_mkdir(dir, de, mode)
699 #define ll_set_acl(ns, inode, acl, type) ll_set_acl(inode, acl, type)
703 * delete_from_page_cache is not exported anymore
705 #ifdef HAVE_DELETE_FROM_PAGE_CACHE
706 #define cfs_delete_from_page_cache(page) delete_from_page_cache((page))
708 static inline void cfs_delete_from_page_cache(struct page *page)
712 LASSERT(PageLocked(page));
715 /* on entry page is locked */
716 if (S_ISREG(page->mapping->host->i_mode)) {
717 generic_error_remove_page(page->mapping, page);
719 loff_t lstart = page->index << PAGE_SHIFT;
720 loff_t lend = lstart + PAGE_SIZE - 1;
722 truncate_inode_pages_range(page->mapping, lstart, lend);
729 static inline struct page *ll_read_cache_page(struct address_space *mapping,
730 pgoff_t index, filler_t *filler,
733 #ifdef HAVE_READ_CACHE_PAGE_WANTS_FILE
734 struct file dummy_file;
736 dummy_file.f_ra.ra_pages = 32; /* unused, modified on ra error */
737 dummy_file.private_data = data;
738 return read_cache_page(mapping, index, filler, &dummy_file);
740 return read_cache_page(mapping, index, filler, data);
741 #endif /* HAVE_READ_CACHE_PAGE_WANTS_FILE */
744 #endif /* _LUSTRE_COMPAT_H */