orangefs: don't let orangefs_new_inode return NULL
[linux-block.git] / fs / orangefs / inode.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
5db11c21
MM
2/*
3 * (C) 2001 Clemson University and The University of Chicago
4 *
5 * See COPYING in top-level directory.
6 */
7
8/*
9 * Linux VFS inode operations.
10 */
11
2f8b5444 12#include <linux/bvec.h>
5db11c21 13#include "protocol.h"
575e9461
MM
14#include "orangefs-kernel.h"
15#include "orangefs-bufmap.h"
5db11c21
MM
16
17static int read_one_page(struct page *page)
18{
5db11c21
MM
19 int ret;
20 int max_block;
21 ssize_t bytes_read = 0;
22 struct inode *inode = page->mapping->host;
9f8fd53c
MB
23 const __u32 blocksize = PAGE_SIZE;
24 const __u32 blockbits = PAGE_SHIFT;
74f68fce
AV
25 struct iov_iter to;
26 struct bio_vec bv = {.bv_page = page, .bv_len = PAGE_SIZE};
27
28 iov_iter_bvec(&to, ITER_BVEC | READ, &bv, 1, PAGE_SIZE);
5db11c21
MM
29
30 gossip_debug(GOSSIP_INODE_DEBUG,
8bb8aefd 31 "orangefs_readpage called with page %p\n",
5db11c21 32 page);
5db11c21
MM
33
34 max_block = ((inode->i_size / blocksize) + 1);
35
36 if (page->index < max_block) {
37 loff_t blockptr_offset = (((loff_t) page->index) << blockbits);
38
8bb8aefd
YL
39 bytes_read = orangefs_inode_read(inode,
40 &to,
41 &blockptr_offset,
42 inode->i_size);
5db11c21 43 }
74f68fce
AV
44 /* this will only zero remaining unread portions of the page data */
45 iov_iter_zero(~0U, &to);
5db11c21
MM
46 /* takes care of potential aliasing */
47 flush_dcache_page(page);
48 if (bytes_read < 0) {
49 ret = bytes_read;
50 SetPageError(page);
51 } else {
52 SetPageUptodate(page);
53 if (PageError(page))
54 ClearPageError(page);
55 ret = 0;
56 }
5db11c21
MM
57 /* unlock the page after the ->readpage() routine completes */
58 unlock_page(page);
59 return ret;
60}
61
8bb8aefd 62static int orangefs_readpage(struct file *file, struct page *page)
5db11c21
MM
63{
64 return read_one_page(page);
65}
66
8bb8aefd 67static int orangefs_readpages(struct file *file,
5db11c21
MM
68 struct address_space *mapping,
69 struct list_head *pages,
70 unsigned nr_pages)
71{
72 int page_idx;
73 int ret;
74
8bb8aefd 75 gossip_debug(GOSSIP_INODE_DEBUG, "orangefs_readpages called\n");
5db11c21
MM
76
77 for (page_idx = 0; page_idx < nr_pages; page_idx++) {
78 struct page *page;
79
80 page = list_entry(pages->prev, struct page, lru);
81 list_del(&page->lru);
82 if (!add_to_page_cache(page,
83 mapping,
84 page->index,
8a5c743e 85 readahead_gfp_mask(mapping))) {
5db11c21
MM
86 ret = read_one_page(page);
87 gossip_debug(GOSSIP_INODE_DEBUG,
88 "failure adding page to cache, read_one_page returned: %d\n",
89 ret);
90 } else {
09cbfeaf 91 put_page(page);
5db11c21
MM
92 }
93 }
94 BUG_ON(!list_empty(pages));
95 return 0;
96}
97
8bb8aefd 98static void orangefs_invalidatepage(struct page *page,
5db11c21
MM
99 unsigned int offset,
100 unsigned int length)
101{
102 gossip_debug(GOSSIP_INODE_DEBUG,
8bb8aefd 103 "orangefs_invalidatepage called on page %p "
5db11c21
MM
104 "(offset is %u)\n",
105 page,
106 offset);
107
108 ClearPageUptodate(page);
109 ClearPageMappedToDisk(page);
110 return;
111
112}
113
8bb8aefd 114static int orangefs_releasepage(struct page *page, gfp_t foo)
5db11c21
MM
115{
116 gossip_debug(GOSSIP_INODE_DEBUG,
8bb8aefd 117 "orangefs_releasepage called on page %p\n",
5db11c21
MM
118 page);
119 return 0;
120}
121
122/*
123 * Having a direct_IO entry point in the address_space_operations
124 * struct causes the kernel to allows us to use O_DIRECT on
125 * open. Nothing will ever call this thing, but in the future we
126 * will need to be able to use O_DIRECT on open in order to support
127 * AIO. Modeled after NFS, they do this too.
128 */
3903f150
MM
129
130static ssize_t orangefs_direct_IO(struct kiocb *iocb,
131 struct iov_iter *iter)
132{
133 gossip_debug(GOSSIP_INODE_DEBUG,
f66debf1
AV
134 "orangefs_direct_IO: %pD\n",
135 iocb->ki_filp);
3903f150
MM
136
137 return -EINVAL;
138}
5db11c21 139
8bb8aefd 140/** ORANGEFS2 implementation of address space operations */
bdd6f083 141static const struct address_space_operations orangefs_address_operations = {
8bb8aefd
YL
142 .readpage = orangefs_readpage,
143 .readpages = orangefs_readpages,
144 .invalidatepage = orangefs_invalidatepage,
145 .releasepage = orangefs_releasepage,
3903f150 146 .direct_IO = orangefs_direct_IO,
5db11c21
MM
147};
148
8bb8aefd 149static int orangefs_setattr_size(struct inode *inode, struct iattr *iattr)
5db11c21 150{
8bb8aefd
YL
151 struct orangefs_inode_s *orangefs_inode = ORANGEFS_I(inode);
152 struct orangefs_kernel_op_s *new_op;
fecd86aa 153 loff_t orig_size;
5db11c21
MM
154 int ret = -EINVAL;
155
156 gossip_debug(GOSSIP_INODE_DEBUG,
157 "%s: %pU: Handle is %pU | fs_id %d | size is %llu\n",
158 __func__,
159 get_khandle_from_ino(inode),
8bb8aefd
YL
160 &orangefs_inode->refn.khandle,
161 orangefs_inode->refn.fs_id,
5db11c21
MM
162 iattr->ia_size);
163
fecd86aa 164 /* Ensure that we have a up to date size, so we know if it changed. */
68a24a6c 165 ret = orangefs_inode_getattr(inode, 0, 1, STATX_SIZE);
fecd86aa
MB
166 if (ret == -ESTALE)
167 ret = -EIO;
168 if (ret) {
169 gossip_err("%s: orangefs_inode_getattr failed, ret:%d:.\n",
170 __func__, ret);
171 return ret;
172 }
173 orig_size = i_size_read(inode);
174
5db11c21
MM
175 truncate_setsize(inode, iattr->ia_size);
176
8bb8aefd 177 new_op = op_alloc(ORANGEFS_VFS_OP_TRUNCATE);
5db11c21
MM
178 if (!new_op)
179 return -ENOMEM;
180
8bb8aefd 181 new_op->upcall.req.truncate.refn = orangefs_inode->refn;
5db11c21
MM
182 new_op->upcall.req.truncate.size = (__s64) iattr->ia_size;
183
95f5f88f
MM
184 ret = service_operation(new_op,
185 __func__,
186 get_interruptible_flag(inode));
5db11c21
MM
187
188 /*
189 * the truncate has no downcall members to retrieve, but
190 * the status value tells us if it went through ok or not
191 */
95f5f88f 192 gossip_debug(GOSSIP_INODE_DEBUG, "%s: ret:%d:\n", __func__, ret);
5db11c21
MM
193
194 op_release(new_op);
195
196 if (ret != 0)
197 return ret;
198
f83140c1 199 if (orig_size != i_size_read(inode))
5db11c21 200 iattr->ia_valid |= ATTR_CTIME | ATTR_MTIME;
5db11c21
MM
201
202 return ret;
203}
204
205/*
206 * Change attributes of an object referenced by dentry.
207 */
8bb8aefd 208int orangefs_setattr(struct dentry *dentry, struct iattr *iattr)
5db11c21
MM
209{
210 int ret = -EINVAL;
211 struct inode *inode = dentry->d_inode;
212
213 gossip_debug(GOSSIP_INODE_DEBUG,
95f5f88f
MM
214 "%s: called on %pd\n",
215 __func__,
216 dentry);
5db11c21 217
31051c85 218 ret = setattr_prepare(dentry, iattr);
5db11c21
MM
219 if (ret)
220 goto out;
221
53950ef5 222 if (iattr->ia_valid & ATTR_SIZE) {
8bb8aefd 223 ret = orangefs_setattr_size(inode, iattr);
5db11c21
MM
224 if (ret)
225 goto out;
226 }
227
228 setattr_copy(inode, iattr);
229 mark_inode_dirty(inode);
230
8bb8aefd 231 ret = orangefs_inode_setattr(inode, iattr);
5db11c21 232 gossip_debug(GOSSIP_INODE_DEBUG,
95f5f88f
MM
233 "%s: orangefs_inode_setattr returned %d\n",
234 __func__,
235 ret);
5db11c21
MM
236
237 if (!ret && (iattr->ia_valid & ATTR_MODE))
238 /* change mod on a file that has ACLs */
239 ret = posix_acl_chmod(inode, inode->i_mode);
240
241out:
95f5f88f 242 gossip_debug(GOSSIP_INODE_DEBUG, "%s: ret:%d:\n", __func__, ret);
5db11c21
MM
243 return ret;
244}
245
246/*
247 * Obtain attributes of an object given a dentry
248 */
a528d35e
DH
249int orangefs_getattr(const struct path *path, struct kstat *stat,
250 u32 request_mask, unsigned int flags)
5db11c21
MM
251{
252 int ret = -ENOENT;
a528d35e 253 struct inode *inode = path->dentry->d_inode;
5db11c21
MM
254
255 gossip_debug(GOSSIP_INODE_DEBUG,
f66debf1 256 "orangefs_getattr: called on %pd\n",
a528d35e 257 path->dentry);
5db11c21 258
68a24a6c 259 ret = orangefs_inode_getattr(inode, 0, 0, request_mask);
5db11c21 260 if (ret == 0) {
a528d35e 261 generic_fillattr(inode, stat);
a7d3e78a 262
5db11c21 263 /* override block size reported to stat */
68a24a6c
MB
264 if (request_mask & STATX_SIZE)
265 stat->result_mask = STATX_BASIC_STATS;
266 else
267 stat->result_mask = STATX_BASIC_STATS &
268 ~STATX_SIZE;
7f54910f
MB
269
270 stat->attributes_mask = STATX_ATTR_IMMUTABLE |
271 STATX_ATTR_APPEND;
272 if (inode->i_flags & S_IMMUTABLE)
273 stat->attributes |= STATX_ATTR_IMMUTABLE;
274 if (inode->i_flags & S_APPEND)
275 stat->attributes |= STATX_ATTR_APPEND;
5db11c21
MM
276 }
277 return ret;
278}
279
933287da
MB
280int orangefs_permission(struct inode *inode, int mask)
281{
282 int ret;
283
284 if (mask & MAY_NOT_BLOCK)
285 return -ECHILD;
286
287 gossip_debug(GOSSIP_INODE_DEBUG, "%s: refreshing\n", __func__);
288
289 /* Make sure the permission (and other common attrs) are up to date. */
68a24a6c 290 ret = orangefs_inode_getattr(inode, 0, 0, STATX_MODE);
933287da
MB
291 if (ret < 0)
292 return ret;
293
294 return generic_permission(inode, mask);
295}
296
95582b00 297int orangefs_update_time(struct inode *inode, struct timespec64 *time, int flags)
a55f2d86
MB
298{
299 struct iattr iattr;
300 gossip_debug(GOSSIP_INODE_DEBUG, "orangefs_update_time: %pU\n",
301 get_khandle_from_ino(inode));
302 generic_update_time(inode, time, flags);
303 memset(&iattr, 0, sizeof iattr);
304 if (flags & S_ATIME)
305 iattr.ia_valid |= ATTR_ATIME;
306 if (flags & S_CTIME)
307 iattr.ia_valid |= ATTR_CTIME;
308 if (flags & S_MTIME)
309 iattr.ia_valid |= ATTR_MTIME;
310 return orangefs_inode_setattr(inode, &iattr);
311}
312
95f5f88f 313/* ORANGEFS2 implementation of VFS inode operations for files */
bdd6f083 314static const struct inode_operations orangefs_file_inode_operations = {
8bb8aefd
YL
315 .get_acl = orangefs_get_acl,
316 .set_acl = orangefs_set_acl,
317 .setattr = orangefs_setattr,
318 .getattr = orangefs_getattr,
8bb8aefd 319 .listxattr = orangefs_listxattr,
933287da 320 .permission = orangefs_permission,
a55f2d86 321 .update_time = orangefs_update_time,
5db11c21
MM
322};
323
8bb8aefd 324static int orangefs_init_iops(struct inode *inode)
5db11c21 325{
8bb8aefd 326 inode->i_mapping->a_ops = &orangefs_address_operations;
5db11c21
MM
327
328 switch (inode->i_mode & S_IFMT) {
329 case S_IFREG:
8bb8aefd
YL
330 inode->i_op = &orangefs_file_inode_operations;
331 inode->i_fop = &orangefs_file_operations;
5db11c21
MM
332 break;
333 case S_IFLNK:
8bb8aefd 334 inode->i_op = &orangefs_symlink_inode_operations;
5db11c21
MM
335 break;
336 case S_IFDIR:
8bb8aefd
YL
337 inode->i_op = &orangefs_dir_inode_operations;
338 inode->i_fop = &orangefs_dir_operations;
5db11c21
MM
339 break;
340 default:
341 gossip_debug(GOSSIP_INODE_DEBUG,
342 "%s: unsupported mode\n",
343 __func__);
344 return -EINVAL;
345 }
346
347 return 0;
348}
349
350/*
95f5f88f
MM
351 * Given an ORANGEFS object identifier (fsid, handle), convert it into
352 * a ino_t type that will be used as a hash-index from where the handle will
5db11c21
MM
353 * be searched for in the VFS hash table of inodes.
354 */
8bb8aefd 355static inline ino_t orangefs_handle_hash(struct orangefs_object_kref *ref)
5db11c21
MM
356{
357 if (!ref)
358 return 0;
8bb8aefd 359 return orangefs_khandle_to_ino(&(ref->khandle));
5db11c21
MM
360}
361
362/*
363 * Called to set up an inode from iget5_locked.
364 */
8bb8aefd 365static int orangefs_set_inode(struct inode *inode, void *data)
5db11c21 366{
8bb8aefd 367 struct orangefs_object_kref *ref = (struct orangefs_object_kref *) data;
a4c680a0
MB
368 ORANGEFS_I(inode)->refn.fs_id = ref->fs_id;
369 ORANGEFS_I(inode)->refn.khandle = ref->khandle;
5db11c21
MM
370 return 0;
371}
372
373/*
374 * Called to determine if handles match.
375 */
8bb8aefd 376static int orangefs_test_inode(struct inode *inode, void *data)
5db11c21 377{
8bb8aefd
YL
378 struct orangefs_object_kref *ref = (struct orangefs_object_kref *) data;
379 struct orangefs_inode_s *orangefs_inode = NULL;
5db11c21 380
8bb8aefd 381 orangefs_inode = ORANGEFS_I(inode);
95f5f88f
MM
382 /* test handles and fs_ids... */
383 return (!ORANGEFS_khandle_cmp(&(orangefs_inode->refn.khandle),
384 &(ref->khandle)) &&
385 orangefs_inode->refn.fs_id == ref->fs_id);
5db11c21
MM
386}
387
388/*
8bb8aefd 389 * Front-end to lookup the inode-cache maintained by the VFS using the ORANGEFS
5db11c21
MM
390 * file handle.
391 *
392 * @sb: the file system super block instance.
95f5f88f 393 * @ref: The ORANGEFS object for which we are trying to locate an inode.
5db11c21 394 */
95f5f88f
MM
395struct inode *orangefs_iget(struct super_block *sb,
396 struct orangefs_object_kref *ref)
5db11c21
MM
397{
398 struct inode *inode = NULL;
399 unsigned long hash;
400 int error;
401
8bb8aefd 402 hash = orangefs_handle_hash(ref);
95f5f88f
MM
403 inode = iget5_locked(sb,
404 hash,
405 orangefs_test_inode,
406 orangefs_set_inode,
407 ref);
5db11c21
MM
408 if (!inode || !(inode->i_state & I_NEW))
409 return inode;
410
68a24a6c 411 error = orangefs_inode_getattr(inode, 1, 1, STATX_ALL);
5db11c21
MM
412 if (error) {
413 iget_failed(inode);
414 return ERR_PTR(error);
415 }
416
417 inode->i_ino = hash; /* needed for stat etc */
8bb8aefd 418 orangefs_init_iops(inode);
5db11c21
MM
419 unlock_new_inode(inode);
420
421 gossip_debug(GOSSIP_INODE_DEBUG,
422 "iget handle %pU, fsid %d hash %ld i_ino %lu\n",
423 &ref->khandle,
424 ref->fs_id,
425 hash,
426 inode->i_ino);
427
428 return inode;
429}
430
431/*
432 * Allocate an inode for a newly created file and insert it into the inode hash.
433 */
8bb8aefd
YL
434struct inode *orangefs_new_inode(struct super_block *sb, struct inode *dir,
435 int mode, dev_t dev, struct orangefs_object_kref *ref)
5db11c21 436{
8bb8aefd 437 unsigned long hash = orangefs_handle_hash(ref);
5db11c21
MM
438 struct inode *inode;
439 int error;
440
441 gossip_debug(GOSSIP_INODE_DEBUG,
5253487e
MM
442 "%s:(sb is %p | MAJOR(dev)=%u | MINOR(dev)=%u mode=%o)\n",
443 __func__,
5db11c21
MM
444 sb,
445 MAJOR(dev),
446 MINOR(dev),
447 mode);
448
449 inode = new_inode(sb);
450 if (!inode)
56249998 451 return ERR_PTR(-ENOMEM);
5db11c21 452
8bb8aefd 453 orangefs_set_inode(inode, ref);
5db11c21
MM
454 inode->i_ino = hash; /* needed for stat etc */
455
68a24a6c 456 error = orangefs_inode_getattr(inode, 1, 1, STATX_ALL);
5db11c21
MM
457 if (error)
458 goto out_iput;
459
8bb8aefd 460 orangefs_init_iops(inode);
5db11c21
MM
461
462 inode->i_mode = mode;
463 inode->i_uid = current_fsuid();
464 inode->i_gid = current_fsgid();
078cd827 465 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
09cbfeaf 466 inode->i_size = PAGE_SIZE;
5db11c21
MM
467 inode->i_rdev = dev;
468
8bb8aefd 469 error = insert_inode_locked4(inode, hash, orangefs_test_inode, ref);
5db11c21
MM
470 if (error < 0)
471 goto out_iput;
472
473 gossip_debug(GOSSIP_INODE_DEBUG,
474 "Initializing ACL's for inode %pU\n",
475 get_khandle_from_ino(inode));
8bb8aefd 476 orangefs_init_acl(inode, dir);
5db11c21
MM
477 return inode;
478
479out_iput:
480 iput(inode);
481 return ERR_PTR(error);
482}