xref: /openbmc/linux/fs/open.c (revision 054a7300)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  linux/fs/open.c
4  *
5  *  Copyright (C) 1991, 1992  Linus Torvalds
6  */
7 
8 #include <linux/string.h>
9 #include <linux/mm.h>
10 #include <linux/file.h>
11 #include <linux/fdtable.h>
12 #include <linux/fsnotify.h>
13 #include <linux/module.h>
14 #include <linux/tty.h>
15 #include <linux/namei.h>
16 #include <linux/backing-dev.h>
17 #include <linux/capability.h>
18 #include <linux/securebits.h>
19 #include <linux/security.h>
20 #include <linux/mount.h>
21 #include <linux/fcntl.h>
22 #include <linux/slab.h>
23 #include <linux/uaccess.h>
24 #include <linux/fs.h>
25 #include <linux/personality.h>
26 #include <linux/pagemap.h>
27 #include <linux/syscalls.h>
28 #include <linux/rcupdate.h>
29 #include <linux/audit.h>
30 #include <linux/falloc.h>
31 #include <linux/fs_struct.h>
32 #include <linux/ima.h>
33 #include <linux/dnotify.h>
34 #include <linux/compat.h>
35 #include <linux/mnt_idmapping.h>
36 #include <linux/filelock.h>
37 
38 #include "internal.h"
39 
40 int do_truncate(struct mnt_idmap *idmap, struct dentry *dentry,
41 		loff_t length, unsigned int time_attrs, struct file *filp)
42 {
43 	int ret;
44 	struct iattr newattrs;
45 
46 	/* Not pretty: "inode->i_size" shouldn't really be signed. But it is. */
47 	if (length < 0)
48 		return -EINVAL;
49 
50 	newattrs.ia_size = length;
51 	newattrs.ia_valid = ATTR_SIZE | time_attrs;
52 	if (filp) {
53 		newattrs.ia_file = filp;
54 		newattrs.ia_valid |= ATTR_FILE;
55 	}
56 
57 	/* Remove suid, sgid, and file capabilities on truncate too */
58 	ret = dentry_needs_remove_privs(idmap, dentry);
59 	if (ret < 0)
60 		return ret;
61 	if (ret)
62 		newattrs.ia_valid |= ret | ATTR_FORCE;
63 
64 	inode_lock(dentry->d_inode);
65 	/* Note any delegations or leases have already been broken: */
66 	ret = notify_change(idmap, dentry, &newattrs, NULL);
67 	inode_unlock(dentry->d_inode);
68 	return ret;
69 }
70 
71 long vfs_truncate(const struct path *path, loff_t length)
72 {
73 	struct mnt_idmap *idmap;
74 	struct inode *inode;
75 	long error;
76 
77 	inode = path->dentry->d_inode;
78 
79 	/* For directories it's -EISDIR, for other non-regulars - -EINVAL */
80 	if (S_ISDIR(inode->i_mode))
81 		return -EISDIR;
82 	if (!S_ISREG(inode->i_mode))
83 		return -EINVAL;
84 
85 	error = mnt_want_write(path->mnt);
86 	if (error)
87 		goto out;
88 
89 	idmap = mnt_idmap(path->mnt);
90 	error = inode_permission(idmap, inode, MAY_WRITE);
91 	if (error)
92 		goto mnt_drop_write_and_out;
93 
94 	error = -EPERM;
95 	if (IS_APPEND(inode))
96 		goto mnt_drop_write_and_out;
97 
98 	error = get_write_access(inode);
99 	if (error)
100 		goto mnt_drop_write_and_out;
101 
102 	/*
103 	 * Make sure that there are no leases.  get_write_access() protects
104 	 * against the truncate racing with a lease-granting setlease().
105 	 */
106 	error = break_lease(inode, O_WRONLY);
107 	if (error)
108 		goto put_write_and_out;
109 
110 	error = security_path_truncate(path);
111 	if (!error)
112 		error = do_truncate(idmap, path->dentry, length, 0, NULL);
113 
114 put_write_and_out:
115 	put_write_access(inode);
116 mnt_drop_write_and_out:
117 	mnt_drop_write(path->mnt);
118 out:
119 	return error;
120 }
121 EXPORT_SYMBOL_GPL(vfs_truncate);
122 
123 long do_sys_truncate(const char __user *pathname, loff_t length)
124 {
125 	unsigned int lookup_flags = LOOKUP_FOLLOW;
126 	struct path path;
127 	int error;
128 
129 	if (length < 0)	/* sorry, but loff_t says... */
130 		return -EINVAL;
131 
132 retry:
133 	error = user_path_at(AT_FDCWD, pathname, lookup_flags, &path);
134 	if (!error) {
135 		error = vfs_truncate(&path, length);
136 		path_put(&path);
137 	}
138 	if (retry_estale(error, lookup_flags)) {
139 		lookup_flags |= LOOKUP_REVAL;
140 		goto retry;
141 	}
142 	return error;
143 }
144 
145 SYSCALL_DEFINE2(truncate, const char __user *, path, long, length)
146 {
147 	return do_sys_truncate(path, length);
148 }
149 
150 #ifdef CONFIG_COMPAT
151 COMPAT_SYSCALL_DEFINE2(truncate, const char __user *, path, compat_off_t, length)
152 {
153 	return do_sys_truncate(path, length);
154 }
155 #endif
156 
157 long do_sys_ftruncate(unsigned int fd, loff_t length, int small)
158 {
159 	struct inode *inode;
160 	struct dentry *dentry;
161 	struct fd f;
162 	int error;
163 
164 	error = -EINVAL;
165 	if (length < 0)
166 		goto out;
167 	error = -EBADF;
168 	f = fdget(fd);
169 	if (!f.file)
170 		goto out;
171 
172 	/* explicitly opened as large or we are on 64-bit box */
173 	if (f.file->f_flags & O_LARGEFILE)
174 		small = 0;
175 
176 	dentry = f.file->f_path.dentry;
177 	inode = dentry->d_inode;
178 	error = -EINVAL;
179 	if (!S_ISREG(inode->i_mode) || !(f.file->f_mode & FMODE_WRITE))
180 		goto out_putf;
181 
182 	error = -EINVAL;
183 	/* Cannot ftruncate over 2^31 bytes without large file support */
184 	if (small && length > MAX_NON_LFS)
185 		goto out_putf;
186 
187 	error = -EPERM;
188 	/* Check IS_APPEND on real upper inode */
189 	if (IS_APPEND(file_inode(f.file)))
190 		goto out_putf;
191 	sb_start_write(inode->i_sb);
192 	error = security_file_truncate(f.file);
193 	if (!error)
194 		error = do_truncate(file_mnt_idmap(f.file), dentry, length,
195 				    ATTR_MTIME | ATTR_CTIME, f.file);
196 	sb_end_write(inode->i_sb);
197 out_putf:
198 	fdput(f);
199 out:
200 	return error;
201 }
202 
203 SYSCALL_DEFINE2(ftruncate, unsigned int, fd, unsigned long, length)
204 {
205 	return do_sys_ftruncate(fd, length, 1);
206 }
207 
208 #ifdef CONFIG_COMPAT
209 COMPAT_SYSCALL_DEFINE2(ftruncate, unsigned int, fd, compat_ulong_t, length)
210 {
211 	return do_sys_ftruncate(fd, length, 1);
212 }
213 #endif
214 
215 /* LFS versions of truncate are only needed on 32 bit machines */
216 #if BITS_PER_LONG == 32
217 SYSCALL_DEFINE2(truncate64, const char __user *, path, loff_t, length)
218 {
219 	return do_sys_truncate(path, length);
220 }
221 
222 SYSCALL_DEFINE2(ftruncate64, unsigned int, fd, loff_t, length)
223 {
224 	return do_sys_ftruncate(fd, length, 0);
225 }
226 #endif /* BITS_PER_LONG == 32 */
227 
228 #if defined(CONFIG_COMPAT) && defined(__ARCH_WANT_COMPAT_TRUNCATE64)
229 COMPAT_SYSCALL_DEFINE3(truncate64, const char __user *, pathname,
230 		       compat_arg_u64_dual(length))
231 {
232 	return ksys_truncate(pathname, compat_arg_u64_glue(length));
233 }
234 #endif
235 
236 #if defined(CONFIG_COMPAT) && defined(__ARCH_WANT_COMPAT_FTRUNCATE64)
237 COMPAT_SYSCALL_DEFINE3(ftruncate64, unsigned int, fd,
238 		       compat_arg_u64_dual(length))
239 {
240 	return ksys_ftruncate(fd, compat_arg_u64_glue(length));
241 }
242 #endif
243 
244 int vfs_fallocate(struct file *file, int mode, loff_t offset, loff_t len)
245 {
246 	struct inode *inode = file_inode(file);
247 	long ret;
248 
249 	if (offset < 0 || len <= 0)
250 		return -EINVAL;
251 
252 	/* Return error if mode is not supported */
253 	if (mode & ~FALLOC_FL_SUPPORTED_MASK)
254 		return -EOPNOTSUPP;
255 
256 	/* Punch hole and zero range are mutually exclusive */
257 	if ((mode & (FALLOC_FL_PUNCH_HOLE | FALLOC_FL_ZERO_RANGE)) ==
258 	    (FALLOC_FL_PUNCH_HOLE | FALLOC_FL_ZERO_RANGE))
259 		return -EOPNOTSUPP;
260 
261 	/* Punch hole must have keep size set */
262 	if ((mode & FALLOC_FL_PUNCH_HOLE) &&
263 	    !(mode & FALLOC_FL_KEEP_SIZE))
264 		return -EOPNOTSUPP;
265 
266 	/* Collapse range should only be used exclusively. */
267 	if ((mode & FALLOC_FL_COLLAPSE_RANGE) &&
268 	    (mode & ~FALLOC_FL_COLLAPSE_RANGE))
269 		return -EINVAL;
270 
271 	/* Insert range should only be used exclusively. */
272 	if ((mode & FALLOC_FL_INSERT_RANGE) &&
273 	    (mode & ~FALLOC_FL_INSERT_RANGE))
274 		return -EINVAL;
275 
276 	/* Unshare range should only be used with allocate mode. */
277 	if ((mode & FALLOC_FL_UNSHARE_RANGE) &&
278 	    (mode & ~(FALLOC_FL_UNSHARE_RANGE | FALLOC_FL_KEEP_SIZE)))
279 		return -EINVAL;
280 
281 	if (!(file->f_mode & FMODE_WRITE))
282 		return -EBADF;
283 
284 	/*
285 	 * We can only allow pure fallocate on append only files
286 	 */
287 	if ((mode & ~FALLOC_FL_KEEP_SIZE) && IS_APPEND(inode))
288 		return -EPERM;
289 
290 	if (IS_IMMUTABLE(inode))
291 		return -EPERM;
292 
293 	/*
294 	 * We cannot allow any fallocate operation on an active swapfile
295 	 */
296 	if (IS_SWAPFILE(inode))
297 		return -ETXTBSY;
298 
299 	/*
300 	 * Revalidate the write permissions, in case security policy has
301 	 * changed since the files were opened.
302 	 */
303 	ret = security_file_permission(file, MAY_WRITE);
304 	if (ret)
305 		return ret;
306 
307 	if (S_ISFIFO(inode->i_mode))
308 		return -ESPIPE;
309 
310 	if (S_ISDIR(inode->i_mode))
311 		return -EISDIR;
312 
313 	if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
314 		return -ENODEV;
315 
316 	/* Check for wrap through zero too */
317 	if (((offset + len) > inode->i_sb->s_maxbytes) || ((offset + len) < 0))
318 		return -EFBIG;
319 
320 	if (!file->f_op->fallocate)
321 		return -EOPNOTSUPP;
322 
323 	file_start_write(file);
324 	ret = file->f_op->fallocate(file, mode, offset, len);
325 
326 	/*
327 	 * Create inotify and fanotify events.
328 	 *
329 	 * To keep the logic simple always create events if fallocate succeeds.
330 	 * This implies that events are even created if the file size remains
331 	 * unchanged, e.g. when using flag FALLOC_FL_KEEP_SIZE.
332 	 */
333 	if (ret == 0)
334 		fsnotify_modify(file);
335 
336 	file_end_write(file);
337 	return ret;
338 }
339 EXPORT_SYMBOL_GPL(vfs_fallocate);
340 
341 int ksys_fallocate(int fd, int mode, loff_t offset, loff_t len)
342 {
343 	struct fd f = fdget(fd);
344 	int error = -EBADF;
345 
346 	if (f.file) {
347 		error = vfs_fallocate(f.file, mode, offset, len);
348 		fdput(f);
349 	}
350 	return error;
351 }
352 
353 SYSCALL_DEFINE4(fallocate, int, fd, int, mode, loff_t, offset, loff_t, len)
354 {
355 	return ksys_fallocate(fd, mode, offset, len);
356 }
357 
358 #if defined(CONFIG_COMPAT) && defined(__ARCH_WANT_COMPAT_FALLOCATE)
359 COMPAT_SYSCALL_DEFINE6(fallocate, int, fd, int, mode, compat_arg_u64_dual(offset),
360 		       compat_arg_u64_dual(len))
361 {
362 	return ksys_fallocate(fd, mode, compat_arg_u64_glue(offset),
363 			      compat_arg_u64_glue(len));
364 }
365 #endif
366 
367 /*
368  * access() needs to use the real uid/gid, not the effective uid/gid.
369  * We do this by temporarily clearing all FS-related capabilities and
370  * switching the fsuid/fsgid around to the real ones.
371  *
372  * Creating new credentials is expensive, so we try to skip doing it,
373  * which we can if the result would match what we already got.
374  */
375 static bool access_need_override_creds(int flags)
376 {
377 	const struct cred *cred;
378 
379 	if (flags & AT_EACCESS)
380 		return false;
381 
382 	cred = current_cred();
383 	if (!uid_eq(cred->fsuid, cred->uid) ||
384 	    !gid_eq(cred->fsgid, cred->gid))
385 		return true;
386 
387 	if (!issecure(SECURE_NO_SETUID_FIXUP)) {
388 		kuid_t root_uid = make_kuid(cred->user_ns, 0);
389 		if (!uid_eq(cred->uid, root_uid)) {
390 			if (!cap_isclear(cred->cap_effective))
391 				return true;
392 		} else {
393 			if (!cap_isidentical(cred->cap_effective,
394 			    cred->cap_permitted))
395 				return true;
396 		}
397 	}
398 
399 	return false;
400 }
401 
402 static const struct cred *access_override_creds(void)
403 {
404 	const struct cred *old_cred;
405 	struct cred *override_cred;
406 
407 	override_cred = prepare_creds();
408 	if (!override_cred)
409 		return NULL;
410 
411 	/*
412 	 * XXX access_need_override_creds performs checks in hopes of skipping
413 	 * this work. Make sure it stays in sync if making any changes in this
414 	 * routine.
415 	 */
416 
417 	override_cred->fsuid = override_cred->uid;
418 	override_cred->fsgid = override_cred->gid;
419 
420 	if (!issecure(SECURE_NO_SETUID_FIXUP)) {
421 		/* Clear the capabilities if we switch to a non-root user */
422 		kuid_t root_uid = make_kuid(override_cred->user_ns, 0);
423 		if (!uid_eq(override_cred->uid, root_uid))
424 			cap_clear(override_cred->cap_effective);
425 		else
426 			override_cred->cap_effective =
427 				override_cred->cap_permitted;
428 	}
429 
430 	/*
431 	 * The new set of credentials can *only* be used in
432 	 * task-synchronous circumstances, and does not need
433 	 * RCU freeing, unless somebody then takes a separate
434 	 * reference to it.
435 	 *
436 	 * NOTE! This is _only_ true because this credential
437 	 * is used purely for override_creds() that installs
438 	 * it as the subjective cred. Other threads will be
439 	 * accessing ->real_cred, not the subjective cred.
440 	 *
441 	 * If somebody _does_ make a copy of this (using the
442 	 * 'get_current_cred()' function), that will clear the
443 	 * non_rcu field, because now that other user may be
444 	 * expecting RCU freeing. But normal thread-synchronous
445 	 * cred accesses will keep things non-RCY.
446 	 */
447 	override_cred->non_rcu = 1;
448 
449 	old_cred = override_creds(override_cred);
450 
451 	/* override_cred() gets its own ref */
452 	put_cred(override_cred);
453 
454 	return old_cred;
455 }
456 
457 static long do_faccessat(int dfd, const char __user *filename, int mode, int flags)
458 {
459 	struct path path;
460 	struct inode *inode;
461 	int res;
462 	unsigned int lookup_flags = LOOKUP_FOLLOW;
463 	const struct cred *old_cred = NULL;
464 
465 	if (mode & ~S_IRWXO)	/* where's F_OK, X_OK, W_OK, R_OK? */
466 		return -EINVAL;
467 
468 	if (flags & ~(AT_EACCESS | AT_SYMLINK_NOFOLLOW | AT_EMPTY_PATH))
469 		return -EINVAL;
470 
471 	if (flags & AT_SYMLINK_NOFOLLOW)
472 		lookup_flags &= ~LOOKUP_FOLLOW;
473 	if (flags & AT_EMPTY_PATH)
474 		lookup_flags |= LOOKUP_EMPTY;
475 
476 	if (access_need_override_creds(flags)) {
477 		old_cred = access_override_creds();
478 		if (!old_cred)
479 			return -ENOMEM;
480 	}
481 
482 retry:
483 	res = user_path_at(dfd, filename, lookup_flags, &path);
484 	if (res)
485 		goto out;
486 
487 	inode = d_backing_inode(path.dentry);
488 
489 	if ((mode & MAY_EXEC) && S_ISREG(inode->i_mode)) {
490 		/*
491 		 * MAY_EXEC on regular files is denied if the fs is mounted
492 		 * with the "noexec" flag.
493 		 */
494 		res = -EACCES;
495 		if (path_noexec(&path))
496 			goto out_path_release;
497 	}
498 
499 	res = inode_permission(mnt_idmap(path.mnt), inode, mode | MAY_ACCESS);
500 	/* SuS v2 requires we report a read only fs too */
501 	if (res || !(mode & S_IWOTH) || special_file(inode->i_mode))
502 		goto out_path_release;
503 	/*
504 	 * This is a rare case where using __mnt_is_readonly()
505 	 * is OK without a mnt_want/drop_write() pair.  Since
506 	 * no actual write to the fs is performed here, we do
507 	 * not need to telegraph to that to anyone.
508 	 *
509 	 * By doing this, we accept that this access is
510 	 * inherently racy and know that the fs may change
511 	 * state before we even see this result.
512 	 */
513 	if (__mnt_is_readonly(path.mnt))
514 		res = -EROFS;
515 
516 out_path_release:
517 	path_put(&path);
518 	if (retry_estale(res, lookup_flags)) {
519 		lookup_flags |= LOOKUP_REVAL;
520 		goto retry;
521 	}
522 out:
523 	if (old_cred)
524 		revert_creds(old_cred);
525 
526 	return res;
527 }
528 
529 SYSCALL_DEFINE3(faccessat, int, dfd, const char __user *, filename, int, mode)
530 {
531 	return do_faccessat(dfd, filename, mode, 0);
532 }
533 
534 SYSCALL_DEFINE4(faccessat2, int, dfd, const char __user *, filename, int, mode,
535 		int, flags)
536 {
537 	return do_faccessat(dfd, filename, mode, flags);
538 }
539 
540 SYSCALL_DEFINE2(access, const char __user *, filename, int, mode)
541 {
542 	return do_faccessat(AT_FDCWD, filename, mode, 0);
543 }
544 
545 SYSCALL_DEFINE1(chdir, const char __user *, filename)
546 {
547 	struct path path;
548 	int error;
549 	unsigned int lookup_flags = LOOKUP_FOLLOW | LOOKUP_DIRECTORY;
550 retry:
551 	error = user_path_at(AT_FDCWD, filename, lookup_flags, &path);
552 	if (error)
553 		goto out;
554 
555 	error = path_permission(&path, MAY_EXEC | MAY_CHDIR);
556 	if (error)
557 		goto dput_and_out;
558 
559 	set_fs_pwd(current->fs, &path);
560 
561 dput_and_out:
562 	path_put(&path);
563 	if (retry_estale(error, lookup_flags)) {
564 		lookup_flags |= LOOKUP_REVAL;
565 		goto retry;
566 	}
567 out:
568 	return error;
569 }
570 
571 SYSCALL_DEFINE1(fchdir, unsigned int, fd)
572 {
573 	struct fd f = fdget_raw(fd);
574 	int error;
575 
576 	error = -EBADF;
577 	if (!f.file)
578 		goto out;
579 
580 	error = -ENOTDIR;
581 	if (!d_can_lookup(f.file->f_path.dentry))
582 		goto out_putf;
583 
584 	error = file_permission(f.file, MAY_EXEC | MAY_CHDIR);
585 	if (!error)
586 		set_fs_pwd(current->fs, &f.file->f_path);
587 out_putf:
588 	fdput(f);
589 out:
590 	return error;
591 }
592 
593 SYSCALL_DEFINE1(chroot, const char __user *, filename)
594 {
595 	struct path path;
596 	int error;
597 	unsigned int lookup_flags = LOOKUP_FOLLOW | LOOKUP_DIRECTORY;
598 retry:
599 	error = user_path_at(AT_FDCWD, filename, lookup_flags, &path);
600 	if (error)
601 		goto out;
602 
603 	error = path_permission(&path, MAY_EXEC | MAY_CHDIR);
604 	if (error)
605 		goto dput_and_out;
606 
607 	error = -EPERM;
608 	if (!ns_capable(current_user_ns(), CAP_SYS_CHROOT))
609 		goto dput_and_out;
610 	error = security_path_chroot(&path);
611 	if (error)
612 		goto dput_and_out;
613 
614 	set_fs_root(current->fs, &path);
615 	error = 0;
616 dput_and_out:
617 	path_put(&path);
618 	if (retry_estale(error, lookup_flags)) {
619 		lookup_flags |= LOOKUP_REVAL;
620 		goto retry;
621 	}
622 out:
623 	return error;
624 }
625 
626 int chmod_common(const struct path *path, umode_t mode)
627 {
628 	struct inode *inode = path->dentry->d_inode;
629 	struct inode *delegated_inode = NULL;
630 	struct iattr newattrs;
631 	int error;
632 
633 	error = mnt_want_write(path->mnt);
634 	if (error)
635 		return error;
636 retry_deleg:
637 	inode_lock(inode);
638 	error = security_path_chmod(path, mode);
639 	if (error)
640 		goto out_unlock;
641 	newattrs.ia_mode = (mode & S_IALLUGO) | (inode->i_mode & ~S_IALLUGO);
642 	newattrs.ia_valid = ATTR_MODE | ATTR_CTIME;
643 	error = notify_change(mnt_idmap(path->mnt), path->dentry,
644 			      &newattrs, &delegated_inode);
645 out_unlock:
646 	inode_unlock(inode);
647 	if (delegated_inode) {
648 		error = break_deleg_wait(&delegated_inode);
649 		if (!error)
650 			goto retry_deleg;
651 	}
652 	mnt_drop_write(path->mnt);
653 	return error;
654 }
655 
656 int vfs_fchmod(struct file *file, umode_t mode)
657 {
658 	audit_file(file);
659 	return chmod_common(&file->f_path, mode);
660 }
661 
662 SYSCALL_DEFINE2(fchmod, unsigned int, fd, umode_t, mode)
663 {
664 	struct fd f = fdget(fd);
665 	int err = -EBADF;
666 
667 	if (f.file) {
668 		err = vfs_fchmod(f.file, mode);
669 		fdput(f);
670 	}
671 	return err;
672 }
673 
674 static int do_fchmodat(int dfd, const char __user *filename, umode_t mode)
675 {
676 	struct path path;
677 	int error;
678 	unsigned int lookup_flags = LOOKUP_FOLLOW;
679 retry:
680 	error = user_path_at(dfd, filename, lookup_flags, &path);
681 	if (!error) {
682 		error = chmod_common(&path, mode);
683 		path_put(&path);
684 		if (retry_estale(error, lookup_flags)) {
685 			lookup_flags |= LOOKUP_REVAL;
686 			goto retry;
687 		}
688 	}
689 	return error;
690 }
691 
692 SYSCALL_DEFINE3(fchmodat, int, dfd, const char __user *, filename,
693 		umode_t, mode)
694 {
695 	return do_fchmodat(dfd, filename, mode);
696 }
697 
698 SYSCALL_DEFINE2(chmod, const char __user *, filename, umode_t, mode)
699 {
700 	return do_fchmodat(AT_FDCWD, filename, mode);
701 }
702 
703 /*
704  * Check whether @kuid is valid and if so generate and set vfsuid_t in
705  * ia_vfsuid.
706  *
707  * Return: true if @kuid is valid, false if not.
708  */
709 static inline bool setattr_vfsuid(struct iattr *attr, kuid_t kuid)
710 {
711 	if (!uid_valid(kuid))
712 		return false;
713 	attr->ia_valid |= ATTR_UID;
714 	attr->ia_vfsuid = VFSUIDT_INIT(kuid);
715 	return true;
716 }
717 
718 /*
719  * Check whether @kgid is valid and if so generate and set vfsgid_t in
720  * ia_vfsgid.
721  *
722  * Return: true if @kgid is valid, false if not.
723  */
724 static inline bool setattr_vfsgid(struct iattr *attr, kgid_t kgid)
725 {
726 	if (!gid_valid(kgid))
727 		return false;
728 	attr->ia_valid |= ATTR_GID;
729 	attr->ia_vfsgid = VFSGIDT_INIT(kgid);
730 	return true;
731 }
732 
733 int chown_common(const struct path *path, uid_t user, gid_t group)
734 {
735 	struct mnt_idmap *idmap;
736 	struct user_namespace *fs_userns;
737 	struct inode *inode = path->dentry->d_inode;
738 	struct inode *delegated_inode = NULL;
739 	int error;
740 	struct iattr newattrs;
741 	kuid_t uid;
742 	kgid_t gid;
743 
744 	uid = make_kuid(current_user_ns(), user);
745 	gid = make_kgid(current_user_ns(), group);
746 
747 	idmap = mnt_idmap(path->mnt);
748 	fs_userns = i_user_ns(inode);
749 
750 retry_deleg:
751 	newattrs.ia_vfsuid = INVALID_VFSUID;
752 	newattrs.ia_vfsgid = INVALID_VFSGID;
753 	newattrs.ia_valid =  ATTR_CTIME;
754 	if ((user != (uid_t)-1) && !setattr_vfsuid(&newattrs, uid))
755 		return -EINVAL;
756 	if ((group != (gid_t)-1) && !setattr_vfsgid(&newattrs, gid))
757 		return -EINVAL;
758 	inode_lock(inode);
759 	if (!S_ISDIR(inode->i_mode))
760 		newattrs.ia_valid |= ATTR_KILL_SUID | ATTR_KILL_PRIV |
761 				     setattr_should_drop_sgid(idmap, inode);
762 	/* Continue to send actual fs values, not the mount values. */
763 	error = security_path_chown(
764 		path,
765 		from_vfsuid(idmap, fs_userns, newattrs.ia_vfsuid),
766 		from_vfsgid(idmap, fs_userns, newattrs.ia_vfsgid));
767 	if (!error)
768 		error = notify_change(idmap, path->dentry, &newattrs,
769 				      &delegated_inode);
770 	inode_unlock(inode);
771 	if (delegated_inode) {
772 		error = break_deleg_wait(&delegated_inode);
773 		if (!error)
774 			goto retry_deleg;
775 	}
776 	return error;
777 }
778 
779 int do_fchownat(int dfd, const char __user *filename, uid_t user, gid_t group,
780 		int flag)
781 {
782 	struct path path;
783 	int error = -EINVAL;
784 	int lookup_flags;
785 
786 	if ((flag & ~(AT_SYMLINK_NOFOLLOW | AT_EMPTY_PATH)) != 0)
787 		goto out;
788 
789 	lookup_flags = (flag & AT_SYMLINK_NOFOLLOW) ? 0 : LOOKUP_FOLLOW;
790 	if (flag & AT_EMPTY_PATH)
791 		lookup_flags |= LOOKUP_EMPTY;
792 retry:
793 	error = user_path_at(dfd, filename, lookup_flags, &path);
794 	if (error)
795 		goto out;
796 	error = mnt_want_write(path.mnt);
797 	if (error)
798 		goto out_release;
799 	error = chown_common(&path, user, group);
800 	mnt_drop_write(path.mnt);
801 out_release:
802 	path_put(&path);
803 	if (retry_estale(error, lookup_flags)) {
804 		lookup_flags |= LOOKUP_REVAL;
805 		goto retry;
806 	}
807 out:
808 	return error;
809 }
810 
811 SYSCALL_DEFINE5(fchownat, int, dfd, const char __user *, filename, uid_t, user,
812 		gid_t, group, int, flag)
813 {
814 	return do_fchownat(dfd, filename, user, group, flag);
815 }
816 
817 SYSCALL_DEFINE3(chown, const char __user *, filename, uid_t, user, gid_t, group)
818 {
819 	return do_fchownat(AT_FDCWD, filename, user, group, 0);
820 }
821 
822 SYSCALL_DEFINE3(lchown, const char __user *, filename, uid_t, user, gid_t, group)
823 {
824 	return do_fchownat(AT_FDCWD, filename, user, group,
825 			   AT_SYMLINK_NOFOLLOW);
826 }
827 
828 int vfs_fchown(struct file *file, uid_t user, gid_t group)
829 {
830 	int error;
831 
832 	error = mnt_want_write_file(file);
833 	if (error)
834 		return error;
835 	audit_file(file);
836 	error = chown_common(&file->f_path, user, group);
837 	mnt_drop_write_file(file);
838 	return error;
839 }
840 
841 int ksys_fchown(unsigned int fd, uid_t user, gid_t group)
842 {
843 	struct fd f = fdget(fd);
844 	int error = -EBADF;
845 
846 	if (f.file) {
847 		error = vfs_fchown(f.file, user, group);
848 		fdput(f);
849 	}
850 	return error;
851 }
852 
853 SYSCALL_DEFINE3(fchown, unsigned int, fd, uid_t, user, gid_t, group)
854 {
855 	return ksys_fchown(fd, user, group);
856 }
857 
858 static int do_dentry_open(struct file *f,
859 			  struct inode *inode,
860 			  int (*open)(struct inode *, struct file *))
861 {
862 	static const struct file_operations empty_fops = {};
863 	int error;
864 
865 	path_get(&f->f_path);
866 	f->f_inode = inode;
867 	f->f_mapping = inode->i_mapping;
868 	f->f_wb_err = filemap_sample_wb_err(f->f_mapping);
869 	f->f_sb_err = file_sample_sb_err(f);
870 
871 	if (unlikely(f->f_flags & O_PATH)) {
872 		f->f_mode = FMODE_PATH | FMODE_OPENED;
873 		f->f_op = &empty_fops;
874 		return 0;
875 	}
876 
877 	if ((f->f_mode & (FMODE_READ | FMODE_WRITE)) == FMODE_READ) {
878 		i_readcount_inc(inode);
879 	} else if (f->f_mode & FMODE_WRITE && !special_file(inode->i_mode)) {
880 		error = get_write_access(inode);
881 		if (unlikely(error))
882 			goto cleanup_file;
883 		error = __mnt_want_write(f->f_path.mnt);
884 		if (unlikely(error)) {
885 			put_write_access(inode);
886 			goto cleanup_file;
887 		}
888 		f->f_mode |= FMODE_WRITER;
889 	}
890 
891 	/* POSIX.1-2008/SUSv4 Section XSI 2.9.7 */
892 	if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode))
893 		f->f_mode |= FMODE_ATOMIC_POS;
894 
895 	f->f_op = fops_get(inode->i_fop);
896 	if (WARN_ON(!f->f_op)) {
897 		error = -ENODEV;
898 		goto cleanup_all;
899 	}
900 
901 	error = security_file_open(f);
902 	if (error)
903 		goto cleanup_all;
904 
905 	error = break_lease(file_inode(f), f->f_flags);
906 	if (error)
907 		goto cleanup_all;
908 
909 	/* normally all 3 are set; ->open() can clear them if needed */
910 	f->f_mode |= FMODE_LSEEK | FMODE_PREAD | FMODE_PWRITE;
911 	if (!open)
912 		open = f->f_op->open;
913 	if (open) {
914 		error = open(inode, f);
915 		if (error)
916 			goto cleanup_all;
917 	}
918 	f->f_mode |= FMODE_OPENED;
919 	if ((f->f_mode & FMODE_READ) &&
920 	     likely(f->f_op->read || f->f_op->read_iter))
921 		f->f_mode |= FMODE_CAN_READ;
922 	if ((f->f_mode & FMODE_WRITE) &&
923 	     likely(f->f_op->write || f->f_op->write_iter))
924 		f->f_mode |= FMODE_CAN_WRITE;
925 	if ((f->f_mode & FMODE_LSEEK) && !f->f_op->llseek)
926 		f->f_mode &= ~FMODE_LSEEK;
927 	if (f->f_mapping->a_ops && f->f_mapping->a_ops->direct_IO)
928 		f->f_mode |= FMODE_CAN_ODIRECT;
929 
930 	f->f_flags &= ~(O_CREAT | O_EXCL | O_NOCTTY | O_TRUNC);
931 	f->f_iocb_flags = iocb_flags(f);
932 
933 	file_ra_state_init(&f->f_ra, f->f_mapping->host->i_mapping);
934 
935 	if ((f->f_flags & O_DIRECT) && !(f->f_mode & FMODE_CAN_ODIRECT))
936 		return -EINVAL;
937 
938 	/*
939 	 * XXX: Huge page cache doesn't support writing yet. Drop all page
940 	 * cache for this file before processing writes.
941 	 */
942 	if (f->f_mode & FMODE_WRITE) {
943 		/*
944 		 * Paired with smp_mb() in collapse_file() to ensure nr_thps
945 		 * is up to date and the update to i_writecount by
946 		 * get_write_access() is visible. Ensures subsequent insertion
947 		 * of THPs into the page cache will fail.
948 		 */
949 		smp_mb();
950 		if (filemap_nr_thps(inode->i_mapping)) {
951 			struct address_space *mapping = inode->i_mapping;
952 
953 			filemap_invalidate_lock(inode->i_mapping);
954 			/*
955 			 * unmap_mapping_range just need to be called once
956 			 * here, because the private pages is not need to be
957 			 * unmapped mapping (e.g. data segment of dynamic
958 			 * shared libraries here).
959 			 */
960 			unmap_mapping_range(mapping, 0, 0, 0);
961 			truncate_inode_pages(mapping, 0);
962 			filemap_invalidate_unlock(inode->i_mapping);
963 		}
964 	}
965 
966 	return 0;
967 
968 cleanup_all:
969 	if (WARN_ON_ONCE(error > 0))
970 		error = -EINVAL;
971 	fops_put(f->f_op);
972 	put_file_access(f);
973 cleanup_file:
974 	path_put(&f->f_path);
975 	f->f_path.mnt = NULL;
976 	f->f_path.dentry = NULL;
977 	f->f_inode = NULL;
978 	return error;
979 }
980 
981 /**
982  * finish_open - finish opening a file
983  * @file: file pointer
984  * @dentry: pointer to dentry
985  * @open: open callback
986  *
987  * This can be used to finish opening a file passed to i_op->atomic_open().
988  *
989  * If the open callback is set to NULL, then the standard f_op->open()
990  * filesystem callback is substituted.
991  *
992  * NB: the dentry reference is _not_ consumed.  If, for example, the dentry is
993  * the return value of d_splice_alias(), then the caller needs to perform dput()
994  * on it after finish_open().
995  *
996  * Returns zero on success or -errno if the open failed.
997  */
998 int finish_open(struct file *file, struct dentry *dentry,
999 		int (*open)(struct inode *, struct file *))
1000 {
1001 	BUG_ON(file->f_mode & FMODE_OPENED); /* once it's opened, it's opened */
1002 
1003 	file->f_path.dentry = dentry;
1004 	return do_dentry_open(file, d_backing_inode(dentry), open);
1005 }
1006 EXPORT_SYMBOL(finish_open);
1007 
1008 /**
1009  * finish_no_open - finish ->atomic_open() without opening the file
1010  *
1011  * @file: file pointer
1012  * @dentry: dentry or NULL (as returned from ->lookup())
1013  *
1014  * This can be used to set the result of a successful lookup in ->atomic_open().
1015  *
1016  * NB: unlike finish_open() this function does consume the dentry reference and
1017  * the caller need not dput() it.
1018  *
1019  * Returns "0" which must be the return value of ->atomic_open() after having
1020  * called this function.
1021  */
1022 int finish_no_open(struct file *file, struct dentry *dentry)
1023 {
1024 	file->f_path.dentry = dentry;
1025 	return 0;
1026 }
1027 EXPORT_SYMBOL(finish_no_open);
1028 
1029 char *file_path(struct file *filp, char *buf, int buflen)
1030 {
1031 	return d_path(&filp->f_path, buf, buflen);
1032 }
1033 EXPORT_SYMBOL(file_path);
1034 
1035 /**
1036  * vfs_open - open the file at the given path
1037  * @path: path to open
1038  * @file: newly allocated file with f_flag initialized
1039  */
1040 int vfs_open(const struct path *path, struct file *file)
1041 {
1042 	file->f_path = *path;
1043 	return do_dentry_open(file, d_backing_inode(path->dentry), NULL);
1044 }
1045 
1046 struct file *dentry_open(const struct path *path, int flags,
1047 			 const struct cred *cred)
1048 {
1049 	int error;
1050 	struct file *f;
1051 
1052 	validate_creds(cred);
1053 
1054 	/* We must always pass in a valid mount pointer. */
1055 	BUG_ON(!path->mnt);
1056 
1057 	f = alloc_empty_file(flags, cred);
1058 	if (!IS_ERR(f)) {
1059 		error = vfs_open(path, f);
1060 		if (error) {
1061 			fput(f);
1062 			f = ERR_PTR(error);
1063 		}
1064 	}
1065 	return f;
1066 }
1067 EXPORT_SYMBOL(dentry_open);
1068 
1069 /**
1070  * dentry_create - Create and open a file
1071  * @path: path to create
1072  * @flags: O_ flags
1073  * @mode: mode bits for new file
1074  * @cred: credentials to use
1075  *
1076  * Caller must hold the parent directory's lock, and have prepared
1077  * a negative dentry, placed in @path->dentry, for the new file.
1078  *
1079  * Caller sets @path->mnt to the vfsmount of the filesystem where
1080  * the new file is to be created. The parent directory and the
1081  * negative dentry must reside on the same filesystem instance.
1082  *
1083  * On success, returns a "struct file *". Otherwise a ERR_PTR
1084  * is returned.
1085  */
1086 struct file *dentry_create(const struct path *path, int flags, umode_t mode,
1087 			   const struct cred *cred)
1088 {
1089 	struct file *f;
1090 	int error;
1091 
1092 	validate_creds(cred);
1093 	f = alloc_empty_file(flags, cred);
1094 	if (IS_ERR(f))
1095 		return f;
1096 
1097 	error = vfs_create(mnt_idmap(path->mnt),
1098 			   d_inode(path->dentry->d_parent),
1099 			   path->dentry, mode, true);
1100 	if (!error)
1101 		error = vfs_open(path, f);
1102 
1103 	if (unlikely(error)) {
1104 		fput(f);
1105 		return ERR_PTR(error);
1106 	}
1107 	return f;
1108 }
1109 EXPORT_SYMBOL(dentry_create);
1110 
1111 /**
1112  * kernel_file_open - open a file for kernel internal use
1113  * @path:	path of the file to open
1114  * @flags:	open flags
1115  * @inode:	the inode
1116  * @cred:	credentials for open
1117  *
1118  * Open a file for use by in-kernel consumers. The file is not accounted
1119  * against nr_files and must not be installed into the file descriptor
1120  * table.
1121  *
1122  * Return: Opened file on success, an error pointer on failure.
1123  */
1124 struct file *kernel_file_open(const struct path *path, int flags,
1125 				struct inode *inode, const struct cred *cred)
1126 {
1127 	struct file *f;
1128 	int error;
1129 
1130 	f = alloc_empty_file_noaccount(flags, cred);
1131 	if (IS_ERR(f))
1132 		return f;
1133 
1134 	f->f_path = *path;
1135 	error = do_dentry_open(f, inode, NULL);
1136 	if (error) {
1137 		fput(f);
1138 		f = ERR_PTR(error);
1139 	}
1140 	return f;
1141 }
1142 EXPORT_SYMBOL_GPL(kernel_file_open);
1143 
1144 /**
1145  * backing_file_open - open a backing file for kernel internal use
1146  * @path:	path of the file to open
1147  * @flags:	open flags
1148  * @path:	path of the backing file
1149  * @cred:	credentials for open
1150  *
1151  * Open a backing file for a stackable filesystem (e.g., overlayfs).
1152  * @path may be on the stackable filesystem and backing inode on the
1153  * underlying filesystem. In this case, we want to be able to return
1154  * the @real_path of the backing inode. This is done by embedding the
1155  * returned file into a container structure that also stores the path of
1156  * the backing inode on the underlying filesystem, which can be
1157  * retrieved using backing_file_real_path().
1158  */
1159 struct file *backing_file_open(const struct path *path, int flags,
1160 			       const struct path *real_path,
1161 			       const struct cred *cred)
1162 {
1163 	struct file *f;
1164 	int error;
1165 
1166 	f = alloc_empty_backing_file(flags, cred);
1167 	if (IS_ERR(f))
1168 		return f;
1169 
1170 	f->f_path = *path;
1171 	path_get(real_path);
1172 	*backing_file_real_path(f) = *real_path;
1173 	error = do_dentry_open(f, d_inode(real_path->dentry), NULL);
1174 	if (error) {
1175 		fput(f);
1176 		f = ERR_PTR(error);
1177 	}
1178 
1179 	return f;
1180 }
1181 EXPORT_SYMBOL_GPL(backing_file_open);
1182 
1183 #define WILL_CREATE(flags)	(flags & (O_CREAT | __O_TMPFILE))
1184 #define O_PATH_FLAGS		(O_DIRECTORY | O_NOFOLLOW | O_PATH | O_CLOEXEC)
1185 
1186 inline struct open_how build_open_how(int flags, umode_t mode)
1187 {
1188 	struct open_how how = {
1189 		.flags = flags & VALID_OPEN_FLAGS,
1190 		.mode = mode & S_IALLUGO,
1191 	};
1192 
1193 	/* O_PATH beats everything else. */
1194 	if (how.flags & O_PATH)
1195 		how.flags &= O_PATH_FLAGS;
1196 	/* Modes should only be set for create-like flags. */
1197 	if (!WILL_CREATE(how.flags))
1198 		how.mode = 0;
1199 	return how;
1200 }
1201 
1202 inline int build_open_flags(const struct open_how *how, struct open_flags *op)
1203 {
1204 	u64 flags = how->flags;
1205 	u64 strip = __FMODE_NONOTIFY | O_CLOEXEC;
1206 	int lookup_flags = 0;
1207 	int acc_mode = ACC_MODE(flags);
1208 
1209 	BUILD_BUG_ON_MSG(upper_32_bits(VALID_OPEN_FLAGS),
1210 			 "struct open_flags doesn't yet handle flags > 32 bits");
1211 
1212 	/*
1213 	 * Strip flags that either shouldn't be set by userspace like
1214 	 * FMODE_NONOTIFY or that aren't relevant in determining struct
1215 	 * open_flags like O_CLOEXEC.
1216 	 */
1217 	flags &= ~strip;
1218 
1219 	/*
1220 	 * Older syscalls implicitly clear all of the invalid flags or argument
1221 	 * values before calling build_open_flags(), but openat2(2) checks all
1222 	 * of its arguments.
1223 	 */
1224 	if (flags & ~VALID_OPEN_FLAGS)
1225 		return -EINVAL;
1226 	if (how->resolve & ~VALID_RESOLVE_FLAGS)
1227 		return -EINVAL;
1228 
1229 	/* Scoping flags are mutually exclusive. */
1230 	if ((how->resolve & RESOLVE_BENEATH) && (how->resolve & RESOLVE_IN_ROOT))
1231 		return -EINVAL;
1232 
1233 	/* Deal with the mode. */
1234 	if (WILL_CREATE(flags)) {
1235 		if (how->mode & ~S_IALLUGO)
1236 			return -EINVAL;
1237 		op->mode = how->mode | S_IFREG;
1238 	} else {
1239 		if (how->mode != 0)
1240 			return -EINVAL;
1241 		op->mode = 0;
1242 	}
1243 
1244 	/*
1245 	 * Block bugs where O_DIRECTORY | O_CREAT created regular files.
1246 	 * Note, that blocking O_DIRECTORY | O_CREAT here also protects
1247 	 * O_TMPFILE below which requires O_DIRECTORY being raised.
1248 	 */
1249 	if ((flags & (O_DIRECTORY | O_CREAT)) == (O_DIRECTORY | O_CREAT))
1250 		return -EINVAL;
1251 
1252 	/* Now handle the creative implementation of O_TMPFILE. */
1253 	if (flags & __O_TMPFILE) {
1254 		/*
1255 		 * In order to ensure programs get explicit errors when trying
1256 		 * to use O_TMPFILE on old kernels we enforce that O_DIRECTORY
1257 		 * is raised alongside __O_TMPFILE.
1258 		 */
1259 		if (!(flags & O_DIRECTORY))
1260 			return -EINVAL;
1261 		if (!(acc_mode & MAY_WRITE))
1262 			return -EINVAL;
1263 	}
1264 	if (flags & O_PATH) {
1265 		/* O_PATH only permits certain other flags to be set. */
1266 		if (flags & ~O_PATH_FLAGS)
1267 			return -EINVAL;
1268 		acc_mode = 0;
1269 	}
1270 
1271 	/*
1272 	 * O_SYNC is implemented as __O_SYNC|O_DSYNC.  As many places only
1273 	 * check for O_DSYNC if the need any syncing at all we enforce it's
1274 	 * always set instead of having to deal with possibly weird behaviour
1275 	 * for malicious applications setting only __O_SYNC.
1276 	 */
1277 	if (flags & __O_SYNC)
1278 		flags |= O_DSYNC;
1279 
1280 	op->open_flag = flags;
1281 
1282 	/* O_TRUNC implies we need access checks for write permissions */
1283 	if (flags & O_TRUNC)
1284 		acc_mode |= MAY_WRITE;
1285 
1286 	/* Allow the LSM permission hook to distinguish append
1287 	   access from general write access. */
1288 	if (flags & O_APPEND)
1289 		acc_mode |= MAY_APPEND;
1290 
1291 	op->acc_mode = acc_mode;
1292 
1293 	op->intent = flags & O_PATH ? 0 : LOOKUP_OPEN;
1294 
1295 	if (flags & O_CREAT) {
1296 		op->intent |= LOOKUP_CREATE;
1297 		if (flags & O_EXCL) {
1298 			op->intent |= LOOKUP_EXCL;
1299 			flags |= O_NOFOLLOW;
1300 		}
1301 	}
1302 
1303 	if (flags & O_DIRECTORY)
1304 		lookup_flags |= LOOKUP_DIRECTORY;
1305 	if (!(flags & O_NOFOLLOW))
1306 		lookup_flags |= LOOKUP_FOLLOW;
1307 
1308 	if (how->resolve & RESOLVE_NO_XDEV)
1309 		lookup_flags |= LOOKUP_NO_XDEV;
1310 	if (how->resolve & RESOLVE_NO_MAGICLINKS)
1311 		lookup_flags |= LOOKUP_NO_MAGICLINKS;
1312 	if (how->resolve & RESOLVE_NO_SYMLINKS)
1313 		lookup_flags |= LOOKUP_NO_SYMLINKS;
1314 	if (how->resolve & RESOLVE_BENEATH)
1315 		lookup_flags |= LOOKUP_BENEATH;
1316 	if (how->resolve & RESOLVE_IN_ROOT)
1317 		lookup_flags |= LOOKUP_IN_ROOT;
1318 	if (how->resolve & RESOLVE_CACHED) {
1319 		/* Don't bother even trying for create/truncate/tmpfile open */
1320 		if (flags & (O_TRUNC | O_CREAT | O_TMPFILE))
1321 			return -EAGAIN;
1322 		lookup_flags |= LOOKUP_CACHED;
1323 	}
1324 
1325 	op->lookup_flags = lookup_flags;
1326 	return 0;
1327 }
1328 
1329 /**
1330  * file_open_name - open file and return file pointer
1331  *
1332  * @name:	struct filename containing path to open
1333  * @flags:	open flags as per the open(2) second argument
1334  * @mode:	mode for the new file if O_CREAT is set, else ignored
1335  *
1336  * This is the helper to open a file from kernelspace if you really
1337  * have to.  But in generally you should not do this, so please move
1338  * along, nothing to see here..
1339  */
1340 struct file *file_open_name(struct filename *name, int flags, umode_t mode)
1341 {
1342 	struct open_flags op;
1343 	struct open_how how = build_open_how(flags, mode);
1344 	int err = build_open_flags(&how, &op);
1345 	if (err)
1346 		return ERR_PTR(err);
1347 	return do_filp_open(AT_FDCWD, name, &op);
1348 }
1349 
1350 /**
1351  * filp_open - open file and return file pointer
1352  *
1353  * @filename:	path to open
1354  * @flags:	open flags as per the open(2) second argument
1355  * @mode:	mode for the new file if O_CREAT is set, else ignored
1356  *
1357  * This is the helper to open a file from kernelspace if you really
1358  * have to.  But in generally you should not do this, so please move
1359  * along, nothing to see here..
1360  */
1361 struct file *filp_open(const char *filename, int flags, umode_t mode)
1362 {
1363 	struct filename *name = getname_kernel(filename);
1364 	struct file *file = ERR_CAST(name);
1365 
1366 	if (!IS_ERR(name)) {
1367 		file = file_open_name(name, flags, mode);
1368 		putname(name);
1369 	}
1370 	return file;
1371 }
1372 EXPORT_SYMBOL(filp_open);
1373 
1374 struct file *file_open_root(const struct path *root,
1375 			    const char *filename, int flags, umode_t mode)
1376 {
1377 	struct open_flags op;
1378 	struct open_how how = build_open_how(flags, mode);
1379 	int err = build_open_flags(&how, &op);
1380 	if (err)
1381 		return ERR_PTR(err);
1382 	return do_file_open_root(root, filename, &op);
1383 }
1384 EXPORT_SYMBOL(file_open_root);
1385 
1386 static long do_sys_openat2(int dfd, const char __user *filename,
1387 			   struct open_how *how)
1388 {
1389 	struct open_flags op;
1390 	int fd = build_open_flags(how, &op);
1391 	struct filename *tmp;
1392 
1393 	if (fd)
1394 		return fd;
1395 
1396 	tmp = getname(filename);
1397 	if (IS_ERR(tmp))
1398 		return PTR_ERR(tmp);
1399 
1400 	fd = get_unused_fd_flags(how->flags);
1401 	if (fd >= 0) {
1402 		struct file *f = do_filp_open(dfd, tmp, &op);
1403 		if (IS_ERR(f)) {
1404 			put_unused_fd(fd);
1405 			fd = PTR_ERR(f);
1406 		} else {
1407 			fsnotify_open(f);
1408 			fd_install(fd, f);
1409 		}
1410 	}
1411 	putname(tmp);
1412 	return fd;
1413 }
1414 
1415 long do_sys_open(int dfd, const char __user *filename, int flags, umode_t mode)
1416 {
1417 	struct open_how how = build_open_how(flags, mode);
1418 	return do_sys_openat2(dfd, filename, &how);
1419 }
1420 
1421 
1422 SYSCALL_DEFINE3(open, const char __user *, filename, int, flags, umode_t, mode)
1423 {
1424 	if (force_o_largefile())
1425 		flags |= O_LARGEFILE;
1426 	return do_sys_open(AT_FDCWD, filename, flags, mode);
1427 }
1428 
1429 SYSCALL_DEFINE4(openat, int, dfd, const char __user *, filename, int, flags,
1430 		umode_t, mode)
1431 {
1432 	if (force_o_largefile())
1433 		flags |= O_LARGEFILE;
1434 	return do_sys_open(dfd, filename, flags, mode);
1435 }
1436 
1437 SYSCALL_DEFINE4(openat2, int, dfd, const char __user *, filename,
1438 		struct open_how __user *, how, size_t, usize)
1439 {
1440 	int err;
1441 	struct open_how tmp;
1442 
1443 	BUILD_BUG_ON(sizeof(struct open_how) < OPEN_HOW_SIZE_VER0);
1444 	BUILD_BUG_ON(sizeof(struct open_how) != OPEN_HOW_SIZE_LATEST);
1445 
1446 	if (unlikely(usize < OPEN_HOW_SIZE_VER0))
1447 		return -EINVAL;
1448 
1449 	err = copy_struct_from_user(&tmp, sizeof(tmp), how, usize);
1450 	if (err)
1451 		return err;
1452 
1453 	audit_openat2_how(&tmp);
1454 
1455 	/* O_LARGEFILE is only allowed for non-O_PATH. */
1456 	if (!(tmp.flags & O_PATH) && force_o_largefile())
1457 		tmp.flags |= O_LARGEFILE;
1458 
1459 	return do_sys_openat2(dfd, filename, &tmp);
1460 }
1461 
1462 #ifdef CONFIG_COMPAT
1463 /*
1464  * Exactly like sys_open(), except that it doesn't set the
1465  * O_LARGEFILE flag.
1466  */
1467 COMPAT_SYSCALL_DEFINE3(open, const char __user *, filename, int, flags, umode_t, mode)
1468 {
1469 	return do_sys_open(AT_FDCWD, filename, flags, mode);
1470 }
1471 
1472 /*
1473  * Exactly like sys_openat(), except that it doesn't set the
1474  * O_LARGEFILE flag.
1475  */
1476 COMPAT_SYSCALL_DEFINE4(openat, int, dfd, const char __user *, filename, int, flags, umode_t, mode)
1477 {
1478 	return do_sys_open(dfd, filename, flags, mode);
1479 }
1480 #endif
1481 
1482 #ifndef __alpha__
1483 
1484 /*
1485  * For backward compatibility?  Maybe this should be moved
1486  * into arch/i386 instead?
1487  */
1488 SYSCALL_DEFINE2(creat, const char __user *, pathname, umode_t, mode)
1489 {
1490 	int flags = O_CREAT | O_WRONLY | O_TRUNC;
1491 
1492 	if (force_o_largefile())
1493 		flags |= O_LARGEFILE;
1494 	return do_sys_open(AT_FDCWD, pathname, flags, mode);
1495 }
1496 #endif
1497 
1498 /*
1499  * "id" is the POSIX thread ID. We use the
1500  * files pointer for this..
1501  */
1502 int filp_close(struct file *filp, fl_owner_t id)
1503 {
1504 	int retval = 0;
1505 
1506 	if (CHECK_DATA_CORRUPTION(file_count(filp) == 0,
1507 			"VFS: Close: file count is 0 (f_op=%ps)",
1508 			filp->f_op)) {
1509 		return 0;
1510 	}
1511 
1512 	if (filp->f_op->flush)
1513 		retval = filp->f_op->flush(filp, id);
1514 
1515 	if (likely(!(filp->f_mode & FMODE_PATH))) {
1516 		dnotify_flush(filp, id);
1517 		locks_remove_posix(filp, id);
1518 	}
1519 	fput(filp);
1520 	return retval;
1521 }
1522 
1523 EXPORT_SYMBOL(filp_close);
1524 
1525 /*
1526  * Careful here! We test whether the file pointer is NULL before
1527  * releasing the fd. This ensures that one clone task can't release
1528  * an fd while another clone is opening it.
1529  */
1530 SYSCALL_DEFINE1(close, unsigned int, fd)
1531 {
1532 	int retval = close_fd(fd);
1533 
1534 	/* can't restart close syscall because file table entry was cleared */
1535 	if (unlikely(retval == -ERESTARTSYS ||
1536 		     retval == -ERESTARTNOINTR ||
1537 		     retval == -ERESTARTNOHAND ||
1538 		     retval == -ERESTART_RESTARTBLOCK))
1539 		retval = -EINTR;
1540 
1541 	return retval;
1542 }
1543 
1544 /**
1545  * close_range() - Close all file descriptors in a given range.
1546  *
1547  * @fd:     starting file descriptor to close
1548  * @max_fd: last file descriptor to close
1549  * @flags:  reserved for future extensions
1550  *
1551  * This closes a range of file descriptors. All file descriptors
1552  * from @fd up to and including @max_fd are closed.
1553  * Currently, errors to close a given file descriptor are ignored.
1554  */
1555 SYSCALL_DEFINE3(close_range, unsigned int, fd, unsigned int, max_fd,
1556 		unsigned int, flags)
1557 {
1558 	return __close_range(fd, max_fd, flags);
1559 }
1560 
1561 /*
1562  * This routine simulates a hangup on the tty, to arrange that users
1563  * are given clean terminals at login time.
1564  */
1565 SYSCALL_DEFINE0(vhangup)
1566 {
1567 	if (capable(CAP_SYS_TTY_CONFIG)) {
1568 		tty_vhangup_self();
1569 		return 0;
1570 	}
1571 	return -EPERM;
1572 }
1573 
1574 /*
1575  * Called when an inode is about to be open.
1576  * We use this to disallow opening large files on 32bit systems if
1577  * the caller didn't specify O_LARGEFILE.  On 64bit systems we force
1578  * on this flag in sys_open.
1579  */
1580 int generic_file_open(struct inode * inode, struct file * filp)
1581 {
1582 	if (!(filp->f_flags & O_LARGEFILE) && i_size_read(inode) > MAX_NON_LFS)
1583 		return -EOVERFLOW;
1584 	return 0;
1585 }
1586 
1587 EXPORT_SYMBOL(generic_file_open);
1588 
1589 /*
1590  * This is used by subsystems that don't want seekable
1591  * file descriptors. The function is not supposed to ever fail, the only
1592  * reason it returns an 'int' and not 'void' is so that it can be plugged
1593  * directly into file_operations structure.
1594  */
1595 int nonseekable_open(struct inode *inode, struct file *filp)
1596 {
1597 	filp->f_mode &= ~(FMODE_LSEEK | FMODE_PREAD | FMODE_PWRITE);
1598 	return 0;
1599 }
1600 
1601 EXPORT_SYMBOL(nonseekable_open);
1602 
1603 /*
1604  * stream_open is used by subsystems that want stream-like file descriptors.
1605  * Such file descriptors are not seekable and don't have notion of position
1606  * (file.f_pos is always 0 and ppos passed to .read()/.write() is always NULL).
1607  * Contrary to file descriptors of other regular files, .read() and .write()
1608  * can run simultaneously.
1609  *
1610  * stream_open never fails and is marked to return int so that it could be
1611  * directly used as file_operations.open .
1612  */
1613 int stream_open(struct inode *inode, struct file *filp)
1614 {
1615 	filp->f_mode &= ~(FMODE_LSEEK | FMODE_PREAD | FMODE_PWRITE | FMODE_ATOMIC_POS);
1616 	filp->f_mode |= FMODE_STREAM;
1617 	return 0;
1618 }
1619 
1620 EXPORT_SYMBOL(stream_open);
1621