Whamcloud - gitweb
LU-16205 sec: fid2path for encrypted files
[fs/lustre-release.git] / lustre / include / lustre_compat.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  */
31
32 #ifndef _LUSTRE_COMPAT_H
33 #define _LUSTRE_COMPAT_H
34
35 #include <linux/aio.h>
36 #include <linux/fs.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/slab.h>
45 #include <linux/security.h>
46 #include <libcfs/linux/linux-fs.h>
47 #include <obd_support.h>
48
49 #ifdef HAVE_4ARGS_VFS_SYMLINK
50 #define ll_vfs_symlink(dir, dentry, mnt, path, mode) \
51                 vfs_symlink(dir, dentry, path, mode)
52 #else
53 #define ll_vfs_symlink(dir, dentry, mnt, path, mode) \
54                        vfs_symlink(dir, dentry, path)
55 #endif
56
57 #ifdef HAVE_BVEC_ITER
58 #define bio_idx(bio)                    (bio->bi_iter.bi_idx)
59 #define bio_set_sector(bio, sector)     (bio->bi_iter.bi_sector = sector)
60 #define bvl_to_page(bvl)                (bvl->bv_page)
61 #else
62 #define bio_idx(bio)                    (bio->bi_idx)
63 #define bio_set_sector(bio, sector)     (bio->bi_sector = sector)
64 #define bio_sectors(bio)                ((bio)->bi_size >> 9)
65 #define bvl_to_page(bvl)                (bvl->bv_page)
66 #endif
67
68 #ifdef HAVE_BVEC_ITER
69 #define bio_start_sector(bio) (bio->bi_iter.bi_sector)
70 #else
71 #define bio_start_sector(bio) (bio->bi_sector)
72 #endif
73
74 #ifdef HAVE_BI_BDEV
75 # define bio_get_dev(bio)       ((bio)->bi_bdev)
76 # define bio_get_disk(bio)      (bio_get_dev(bio)->bd_disk)
77 # define bio_get_queue(bio)     bdev_get_queue(bio_get_dev(bio))
78
79 # ifndef HAVE_BIO_SET_DEV
80 #  define bio_set_dev(bio, bdev) (bio_get_dev(bio) = (bdev))
81 # endif
82 #else
83 # define bio_get_disk(bio)      ((bio)->bi_disk)
84 # define bio_get_queue(bio)     (bio_get_disk(bio)->queue)
85 #endif
86
87 #ifndef HAVE_BI_OPF
88 #define bi_opf bi_rw
89 #endif
90
91 static inline struct bio *cfs_bio_alloc(struct block_device *bdev,
92                                         unsigned short nr_vecs,
93                                         __u32 op, gfp_t gfp_mask)
94 {
95         struct bio *bio;
96 #ifdef HAVE_BIO_ALLOC_WITH_BDEV
97         bio = bio_alloc(bdev, nr_vecs, op, gfp_mask);
98 #else
99         bio = bio_alloc(gfp_mask, nr_vecs);
100         if (bio) {
101                 bio_set_dev(bio, bdev);
102                 bio->bi_opf = op;
103         }
104 #endif /* HAVE_BIO_ALLOC_WITH_BDEV */
105         return bio;
106 }
107
108 #ifndef HAVE_DENTRY_D_CHILD
109 #define d_child                 d_u.d_child
110 #endif
111
112 #ifndef HAVE_D_IN_LOOKUP
113 static inline int d_in_lookup(struct dentry *dentry)
114 {
115         return false;
116 }
117 #endif
118
119 #ifndef HAVE_VM_FAULT_T
120 #define vm_fault_t int
121 #endif
122
123 #ifndef HAVE_FOP_ITERATE_SHARED
124 #define iterate_shared iterate
125 #endif
126
127 #ifdef HAVE_OLDSIZE_TRUNCATE_PAGECACHE
128 #define ll_truncate_pagecache(inode, size) truncate_pagecache(inode, 0, size)
129 #else
130 #define ll_truncate_pagecache(inode, size) truncate_pagecache(inode, size)
131 #endif
132
133 #ifdef HAVE_VFS_RENAME_5ARGS
134 #define ll_vfs_rename(a, b, c, d) vfs_rename(a, b, c, d, NULL)
135 #elif defined HAVE_VFS_RENAME_6ARGS
136 #define ll_vfs_rename(a, b, c, d) vfs_rename(a, b, c, d, NULL, 0)
137 #else
138 #define ll_vfs_rename(a, b, c, d) vfs_rename(a, b, c, d)
139 #endif
140
141 #ifdef HAVE_USER_NAMESPACE_ARG
142 #define vfs_unlink(ns, dir, de) vfs_unlink(ns, dir, de, NULL)
143 #elif defined HAVE_VFS_UNLINK_3ARGS
144 #define vfs_unlink(ns, dir, de) vfs_unlink(dir, de, NULL)
145 #else
146 #define vfs_unlink(ns, dir, de) vfs_unlink(dir, de)
147 #endif
148
149 static inline int ll_vfs_getattr(struct path *path, struct kstat *st,
150                                  u32 request_mask, unsigned int flags)
151 {
152         int rc;
153
154 #if defined(HAVE_USER_NAMESPACE_ARG) || defined(HAVE_INODEOPS_ENHANCED_GETATTR)
155         rc = vfs_getattr(path, st, request_mask, flags);
156 #else
157         rc = vfs_getattr(path, st);
158 #endif
159         return rc;
160 }
161
162 #ifndef HAVE_D_IS_POSITIVE
163 static inline bool d_is_positive(const struct dentry *dentry)
164 {
165         return dentry->d_inode != NULL;
166 }
167 #endif
168
169 #ifndef HAVE_INODE_LOCK
170 # define inode_lock(inode) mutex_lock(&(inode)->i_mutex)
171 # define inode_unlock(inode) mutex_unlock(&(inode)->i_mutex)
172 # define inode_trylock(inode) mutex_trylock(&(inode)->i_mutex)
173 #endif
174
175 /* Old kernels lacked both Xarray support and the page cache
176  * using Xarrays. Our back ported Xarray support introduces
177  * the real xa_is_value() but we need a wrapper as well for
178  * the page cache interaction. Lets keep xa_is_value() separate
179  * in old kernels for Xarray support and page cache handling.
180  */
181 #ifndef HAVE_XARRAY_SUPPORT
182 static inline bool ll_xa_is_value(void *entry)
183 {
184         return radix_tree_exceptional_entry(entry);
185 }
186 #else
187 #define ll_xa_is_value  xa_is_value
188 #endif
189
190 #ifndef HAVE_TRUNCATE_INODE_PAGES_FINAL
191 static inline void truncate_inode_pages_final(struct address_space *map)
192 {
193         truncate_inode_pages(map, 0);
194 }
195 #endif
196
197 #ifndef HAVE_PTR_ERR_OR_ZERO
198 static inline int __must_check PTR_ERR_OR_ZERO(__force const void *ptr)
199 {
200         if (IS_ERR(ptr))
201                 return PTR_ERR(ptr);
202         else
203                 return 0;
204 }
205 #endif
206
207 #ifdef HAVE_PID_NS_FOR_CHILDREN
208 # define ll_task_pid_ns(task) \
209          ((task)->nsproxy ? ((task)->nsproxy->pid_ns_for_children) : NULL)
210 #else
211 # define ll_task_pid_ns(task) \
212          ((task)->nsproxy ? ((task)->nsproxy->pid_ns) : NULL)
213 #endif
214
215 #ifdef HAVE_FULL_NAME_HASH_3ARGS
216 # define ll_full_name_hash(salt, name, len) full_name_hash(salt, name, len)
217 #else
218 # define ll_full_name_hash(salt, name, len) full_name_hash(name, len)
219 #endif
220
221 #ifdef HAVE_STRUCT_POSIX_ACL_XATTR
222 # define posix_acl_xattr_header struct posix_acl_xattr_header
223 # define posix_acl_xattr_entry  struct posix_acl_xattr_entry
224 # define GET_POSIX_ACL_XATTR_ENTRY(head) ((void *)((head) + 1))
225 #else
226 # define GET_POSIX_ACL_XATTR_ENTRY(head) ((head)->a_entries)
227 #endif
228
229 #ifdef HAVE_IOP_XATTR
230 #define ll_setxattr     generic_setxattr
231 #define ll_getxattr     generic_getxattr
232 #define ll_removexattr  generic_removexattr
233 #endif /* HAVE_IOP_XATTR */
234
235 #ifndef HAVE_POSIX_ACL_VALID_USER_NS
236 #define posix_acl_valid(a,b)            posix_acl_valid(b)
237 #endif
238
239 #ifdef HAVE_IOP_SET_ACL
240 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
241 #if !defined(HAVE_USER_NAMESPACE_ARG) && !defined(HAVE_POSIX_ACL_UPDATE_MODE)
242 static inline int posix_acl_update_mode(struct inode *inode, umode_t *mode_p,
243                           struct posix_acl **acl)
244 {
245         umode_t mode = inode->i_mode;
246         int error;
247
248         error = posix_acl_equiv_mode(*acl, &mode);
249         if (error < 0)
250                 return error;
251         if (error == 0)
252                 *acl = NULL;
253         if (!in_group_p(inode->i_gid) &&
254             !capable_wrt_inode_uidgid(inode, CAP_FSETID))
255                 mode &= ~S_ISGID;
256         *mode_p = mode;
257         return 0;
258 }
259 #endif /* HAVE_POSIX_ACL_UPDATE_MODE */
260 #endif
261 #endif
262
263 #ifndef HAVE_IOV_ITER_TRUNCATE
264 static inline void iov_iter_truncate(struct iov_iter *i, u64 count)
265 {
266         if (i->count > count)
267                 i->count = count;
268 }
269 #endif
270
271 /*
272  * mount MS_* flags split from superblock SB_* flags
273  * if the SB_* flags are not available use the MS_* flags
274  */
275 #if !defined(SB_RDONLY) && defined(MS_RDONLY)
276 # define SB_RDONLY MS_RDONLY
277 #endif
278 #if !defined(SB_ACTIVE) && defined(MS_ACTIVE)
279 # define SB_ACTIVE MS_ACTIVE
280 #endif
281 #if !defined(SB_NOSEC) && defined(MS_NOSEC)
282 # define SB_NOSEC MS_NOSEC
283 #endif
284 #if !defined(SB_POSIXACL) && defined(MS_POSIXACL)
285 # define SB_POSIXACL MS_POSIXACL
286 #endif
287 #if !defined(SB_NODIRATIME) && defined(MS_NODIRATIME)
288 # define SB_NODIRATIME MS_NODIRATIME
289 #endif
290
291 #ifndef HAVE_FILE_OPERATIONS_READ_WRITE_ITER
292 static inline void iov_iter_reexpand(struct iov_iter *i, size_t count)
293 {
294         i->count = count;
295 }
296
297 static inline struct iovec iov_iter_iovec(const struct iov_iter *iter)
298 {
299         return (struct iovec) {
300                 .iov_base = iter->iov->iov_base + iter->iov_offset,
301                 .iov_len = min(iter->count,
302                                iter->iov->iov_len - iter->iov_offset),
303         };
304 }
305
306 #define iov_for_each(iov, iter, start)                                  \
307         for (iter = (start);                                            \
308              (iter).count && ((iov = iov_iter_iovec(&(iter))), 1);      \
309              iov_iter_advance(&(iter), (iov).iov_len))
310
311 static inline ssize_t
312 generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
313 {
314         struct iovec iov;
315         struct iov_iter i;
316         ssize_t bytes = 0;
317
318         iov_for_each(iov, i, *iter) {
319                 ssize_t res;
320
321                 res = generic_file_aio_read(iocb, &iov, 1, iocb->ki_pos);
322                 if (res <= 0) {
323                         if (bytes == 0)
324                                 bytes = res;
325                         break;
326                 }
327
328                 bytes += res;
329                 if (res < iov.iov_len)
330                         break;
331         }
332
333         if (bytes > 0)
334                 iov_iter_advance(iter, bytes);
335         return bytes;
336 }
337
338 static inline ssize_t
339 __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *iter)
340 {
341         struct iovec iov;
342         struct iov_iter i;
343         ssize_t bytes = 0;
344
345         /* Since LLITE updates file size at the end of I/O in
346          * vvp_io_commit_write(), append write has to be done in atomic when
347          * there are multiple segments because otherwise each iteration to
348          * __generic_file_aio_write() will see original file size */
349         if (unlikely(iocb->ki_filp->f_flags & O_APPEND && iter->nr_segs > 1)) {
350                 struct iovec *iov_copy;
351                 int count = 0;
352
353                 OBD_ALLOC_PTR_ARRAY(iov_copy, iter->nr_segs);
354                 if (!iov_copy)
355                         return -ENOMEM;
356
357                 iov_for_each(iov, i, *iter)
358                         iov_copy[count++] = iov;
359
360                 bytes = __generic_file_aio_write(iocb, iov_copy, count,
361                                                  &iocb->ki_pos);
362                 OBD_FREE_PTR_ARRAY(iov_copy, iter->nr_segs);
363
364                 if (bytes > 0)
365                         iov_iter_advance(iter, bytes);
366                 return bytes;
367         }
368
369         iov_for_each(iov, i, *iter) {
370                 ssize_t res;
371
372                 res = __generic_file_aio_write(iocb, &iov, 1, &iocb->ki_pos);
373                 if (res <= 0) {
374                         if (bytes == 0)
375                                 bytes = res;
376                         break;
377                 }
378
379                 bytes += res;
380                 if (res < iov.iov_len)
381                         break;
382         }
383
384         if (bytes > 0)
385                 iov_iter_advance(iter, bytes);
386         return bytes;
387 }
388 #endif /* HAVE_FILE_OPERATIONS_READ_WRITE_ITER */
389
390 static inline void __user *get_vmf_address(struct vm_fault *vmf)
391 {
392 #ifdef HAVE_VM_FAULT_ADDRESS
393         return (void __user *)vmf->address;
394 #else
395         return vmf->virtual_address;
396 #endif
397 }
398
399 #ifdef HAVE_VM_OPS_USE_VM_FAULT_ONLY
400 # define __ll_filemap_fault(vma, vmf) filemap_fault(vmf)
401 #else
402 # define __ll_filemap_fault(vma, vmf) filemap_fault(vma, vmf)
403 #endif
404
405 #ifndef HAVE_CURRENT_TIME
406 static inline struct timespec current_time(struct inode *inode)
407 {
408         return CURRENT_TIME;
409 }
410 #endif
411
412 #ifndef time_after32
413 /**
414  * time_after32 - compare two 32-bit relative times
415  * @a: the time which may be after @b
416  * @b: the time which may be before @a
417  *
418  * Needed for kernels earlier than v4.14-rc1~134^2
419  *
420  * time_after32(a, b) returns true if the time @a is after time @b.
421  * time_before32(b, a) returns true if the time @b is before time @a.
422  *
423  * Similar to time_after(), compare two 32-bit timestamps for relative
424  * times.  This is useful for comparing 32-bit seconds values that can't
425  * be converted to 64-bit values (e.g. due to disk format or wire protocol
426  * issues) when it is known that the times are less than 68 years apart.
427  */
428 #define time_after32(a, b)     ((s32)((u32)(b) - (u32)(a)) < 0)
429 #define time_before32(b, a)    time_after32(a, b)
430
431 #endif
432
433 #ifndef smp_store_mb
434 #define smp_store_mb(var, value)        set_mb(var, value)
435 #endif
436
437 #ifdef HAVE_PAGEVEC_INIT_ONE_PARAM
438 #define ll_pagevec_init(pvec, n) pagevec_init(pvec)
439 #else
440 #define ll_pagevec_init(pvec, n) pagevec_init(pvec, n)
441 #endif
442
443 #ifdef HAVE_D_COUNT
444 #  define ll_d_count(d)         d_count(d)
445 #else
446 #  define ll_d_count(d)         ((d)->d_count)
447 #endif /* HAVE_D_COUNT */
448
449 #ifndef HAVE_IN_COMPAT_SYSCALL
450 #define in_compat_syscall       is_compat_task
451 #endif
452
453 #ifdef HAVE_I_PAGES
454 #define page_tree i_pages
455 #define ll_xa_lock_irqsave(lockp, flags) xa_lock_irqsave(lockp, flags)
456 #define ll_xa_unlock_irqrestore(lockp, flags) xa_unlock_irqrestore(lockp, flags)
457 #else
458 #define i_pages tree_lock
459 #define ll_xa_lock_irqsave(lockp, flags) spin_lock_irqsave(lockp, flags)
460 #define ll_xa_unlock_irqrestore(lockp, flags) spin_unlock_irqrestore(lockp, flags)
461 #endif
462
463 /* Linux commit v5.15-12273-gab2f9d2d3626
464  *   mm: unexport {,un}lock_page_memcg
465  *
466  * Note that the functions are still defined or declared breaking
467  * the simple approach of just defining the missing functions here
468  */
469 #ifdef HAVE_LOCK_PAGE_MEMCG
470 #define vvp_lock_page_memcg(page)       lock_page_memcg((page))
471 #define vvp_unlock_page_memcg(page)     unlock_page_memcg((page))
472 #else
473 #define vvp_lock_page_memcg(page)
474 #define vvp_unlock_page_memcg(page)
475 #endif
476
477 #ifndef KMEM_CACHE_USERCOPY
478 #define kmem_cache_create_usercopy(name, size, align, flags, useroffset, \
479                                    usersize, ctor)                       \
480         kmem_cache_create(name, size, align, flags, ctor)
481 #endif
482
483 static inline bool ll_security_xattr_wanted(struct inode *in)
484 {
485 #ifdef CONFIG_SECURITY
486         return in->i_security && in->i_sb->s_security;
487 #else
488         return false;
489 #endif
490 }
491
492 static inline int ll_vfs_getxattr(struct dentry *dentry, struct inode *inode,
493                                   const char *name,
494                                   void *value, size_t size)
495 {
496 #ifdef HAVE_USER_NAMESPACE_ARG
497         return vfs_getxattr(&init_user_ns, dentry, name, value, size);
498 #elif defined(HAVE_VFS_SETXATTR)
499         return __vfs_getxattr(dentry, inode, name, value, size);
500 #else
501         if (unlikely(!inode->i_op->getxattr))
502                 return -ENODATA;
503
504         return inode->i_op->getxattr(dentry, name, value, size);
505 #endif
506 }
507
508 static inline int ll_vfs_setxattr(struct dentry *dentry, struct inode *inode,
509                                   const char *name,
510                                   const void *value, size_t size, int flags)
511 {
512 #ifdef HAVE_USER_NAMESPACE_ARG
513         return vfs_setxattr(&init_user_ns, dentry, name, value, size, flags);
514 #elif defined(HAVE_VFS_SETXATTR)
515         return __vfs_setxattr(dentry, inode, name, value, size, flags);
516 #else
517         if (unlikely(!inode->i_op->setxattr))
518                 return -EOPNOTSUPP;
519
520         return inode->i_op->setxattr(dentry, name, value, size, flags);
521 #endif
522 }
523
524 static inline int ll_vfs_removexattr(struct dentry *dentry, struct inode *inode,
525                                      const char *name)
526 {
527 #ifdef HAVE_USER_NAMESPACE_ARG
528         return vfs_removexattr(&init_user_ns, dentry, name);
529 #elif defined(HAVE_VFS_SETXATTR)
530         return __vfs_removexattr(dentry, name);
531 #else
532         if (unlikely(!inode->i_op->setxattr))
533                 return -EOPNOTSUPP;
534
535         return inode->i_op->removexattr(dentry, name);
536 #endif
537 }
538
539 #ifndef FALLOC_FL_COLLAPSE_RANGE
540 #define FALLOC_FL_COLLAPSE_RANGE 0x08 /* remove a range of a file */
541 #endif
542
543 #ifndef FALLOC_FL_ZERO_RANGE
544 #define FALLOC_FL_ZERO_RANGE 0x10 /* convert range to zeros */
545 #endif
546
547 #ifndef FALLOC_FL_INSERT_RANGE
548 #define FALLOC_FL_INSERT_RANGE 0x20 /* insert space within file */
549 #endif
550
551 #ifndef raw_cpu_ptr
552 #define raw_cpu_ptr(p) __this_cpu_ptr(p)
553 #endif
554
555 #ifndef HAVE_IS_ROOT_INODE
556 static inline bool is_root_inode(struct inode *inode)
557 {
558         return inode == inode->i_sb->s_root->d_inode;
559 }
560 #endif
561
562 #ifndef HAVE_REGISTER_SHRINKER_RET
563 #define register_shrinker(_s) (register_shrinker(_s), 0)
564 #endif
565
566 #ifndef fallthrough
567 # if defined(__GNUC__) && __GNUC__ >= 7
568 #  define fallthrough  __attribute__((fallthrough)) /* fallthrough */
569 # else
570 #  define fallthrough do {} while (0)  /* fallthrough */
571 # endif
572 #endif
573
574 static inline void ll_security_release_secctx(char *secdata, u32 seclen)
575 {
576 #ifdef HAVE_SEC_RELEASE_SECCTX_1ARG
577         struct lsmcontext context = { };
578
579         lsmcontext_init(&context, secdata, seclen, 0);
580         return security_release_secctx(&context);
581 #else
582         return security_release_secctx(secdata, seclen);
583 #endif
584 }
585
586 #ifndef HAVE_USER_NAMESPACE_ARG
587 #define posix_acl_update_mode(ns, inode, mode, acl) \
588         posix_acl_update_mode(inode, mode, acl)
589 #define notify_change(ns, de, attr, inode)      notify_change(de, attr, inode)
590 #define inode_owner_or_capable(ns, inode)       inode_owner_or_capable(inode)
591 #define vfs_create(ns, dir, de, mode, ex)       vfs_create(dir, de, mode, ex)
592 #define vfs_mkdir(ns, dir, de, mode)            vfs_mkdir(dir, de, mode)
593 #define ll_set_acl(ns, inode, acl, type)        ll_set_acl(inode, acl, type)
594 #endif
595
596 #endif /* _LUSTRE_COMPAT_H */