1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/compiler_types.h>
4 #include <linux/errno.h>
6 #include <linux/fsnotify.h>
9 #include <linux/init.h>
10 #include <linux/ipc_namespace.h>
11 #include <linux/kdev_t.h>
12 #include <linux/kernel.h>
13 #include <linux/list.h>
14 #include <linux/namei.h>
15 #include <linux/magic.h>
16 #include <linux/major.h>
17 #include <linux/miscdevice.h>
18 #include <linux/module.h>
19 #include <linux/mutex.h>
20 #include <linux/mount.h>
21 #include <linux/fs_parser.h>
22 #include <linux/radix-tree.h>
23 #include <linux/sched.h>
24 #include <linux/seq_file.h>
25 #include <linux/slab.h>
26 #include <linux/spinlock_types.h>
27 #include <linux/stddef.h>
28 #include <linux/string.h>
29 #include <linux/types.h>
30 #include <linux/uaccess.h>
31 #include <linux/user_namespace.h>
32 #include <linux/xarray.h>
33 #include <uapi/asm-generic/errno-base.h>
34 #include <uapi/linux/android/binder.h>
35 #include <uapi/linux/android/binderfs.h>
37 #include "binder_internal.h"
40 #define SECOND_INODE 2
41 #define INODE_OFFSET 3
43 #define BINDERFS_MAX_MINOR (1U << MINORBITS)
44 /* Ensure that the initial ipc namespace always has devices available. */
45 #define BINDERFS_MAX_MINOR_CAPPED (BINDERFS_MAX_MINOR - 4)
47 static dev_t binderfs_dev;
48 static DEFINE_MUTEX(binderfs_minors_mutex);
49 static DEFINE_IDA(binderfs_minors);
56 enum binderfs_stats_mode {
57 binderfs_stats_mode_unset,
58 binderfs_stats_mode_global,
61 struct binder_features {
62 bool oneway_spam_detection;
66 static const struct constant_table binderfs_param_stats[] = {
67 { "global", binderfs_stats_mode_global },
71 static const struct fs_parameter_spec binderfs_fs_parameters[] = {
72 fsparam_u32("max", Opt_max),
73 fsparam_enum("stats", Opt_stats_mode, binderfs_param_stats),
77 static struct binder_features binder_features = {
78 .oneway_spam_detection = true,
79 .extended_error = true,
82 static inline struct binderfs_info *BINDERFS_SB(const struct super_block *sb)
87 bool is_binderfs_device(const struct inode *inode)
89 if (inode->i_sb->s_magic == BINDERFS_SUPER_MAGIC)
96 * binderfs_binder_device_create - allocate inode from super block of a
98 * @ref_inode: inode from wich the super block will be taken
99 * @userp: buffer to copy information about new device for userspace to
100 * @req: struct binderfs_device as copied from userspace
102 * This function allocates a new binder_device and reserves a new minor
104 * Minor numbers are limited and tracked globally in binderfs_minors. The
105 * function will stash a struct binder_device for the specific binder
106 * device in i_private of the inode.
107 * It will go on to allocate a new inode from the super block of the
108 * filesystem mount, stash a struct binder_device in its i_private field
109 * and attach a dentry to that inode.
111 * Return: 0 on success, negative errno on failure
113 static int binderfs_binder_device_create(struct inode *ref_inode,
114 struct binderfs_device __user *userp,
115 struct binderfs_device *req)
118 struct dentry *dentry, *root;
119 struct binder_device *device;
122 struct inode *inode = NULL;
123 struct super_block *sb = ref_inode->i_sb;
124 struct binderfs_info *info = sb->s_fs_info;
125 #if defined(CONFIG_IPC_NS)
126 bool use_reserve = (info->ipc_ns == &init_ipc_ns);
128 bool use_reserve = true;
131 /* Reserve new minor number for the new device. */
132 mutex_lock(&binderfs_minors_mutex);
133 if (++info->device_count <= info->mount_opts.max)
134 minor = ida_alloc_max(&binderfs_minors,
135 use_reserve ? BINDERFS_MAX_MINOR :
136 BINDERFS_MAX_MINOR_CAPPED,
141 --info->device_count;
142 mutex_unlock(&binderfs_minors_mutex);
145 mutex_unlock(&binderfs_minors_mutex);
148 device = kzalloc(sizeof(*device), GFP_KERNEL);
152 inode = new_inode(sb);
156 inode->i_ino = minor + INODE_OFFSET;
157 inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
158 init_special_inode(inode, S_IFCHR | 0600,
159 MKDEV(MAJOR(binderfs_dev), minor));
160 inode->i_fop = &binder_fops;
161 inode->i_uid = info->root_uid;
162 inode->i_gid = info->root_gid;
164 req->name[BINDERFS_MAX_NAME] = '\0'; /* NUL-terminate */
165 name_len = strlen(req->name);
166 /* Make sure to include terminating NUL byte */
167 name = kmemdup(req->name, name_len + 1, GFP_KERNEL);
171 refcount_set(&device->ref, 1);
172 device->binderfs_inode = inode;
173 device->context.binder_context_mgr_uid = INVALID_UID;
174 device->context.name = name;
175 device->miscdev.name = name;
176 device->miscdev.minor = minor;
177 mutex_init(&device->context.context_mgr_node_lock);
179 req->major = MAJOR(binderfs_dev);
182 if (userp && copy_to_user(userp, req, sizeof(*req))) {
188 inode_lock(d_inode(root));
191 dentry = lookup_one_len(name, root, name_len);
192 if (IS_ERR(dentry)) {
193 inode_unlock(d_inode(root));
194 ret = PTR_ERR(dentry);
198 if (d_really_is_positive(dentry)) {
201 inode_unlock(d_inode(root));
206 inode->i_private = device;
207 d_instantiate(dentry, inode);
208 fsnotify_create(root->d_inode, dentry);
209 inode_unlock(d_inode(root));
216 mutex_lock(&binderfs_minors_mutex);
217 --info->device_count;
218 ida_free(&binderfs_minors, minor);
219 mutex_unlock(&binderfs_minors_mutex);
226 * binderfs_ctl_ioctl - handle binder device node allocation requests
228 * The request handler for the binder-control device. All requests operate on
229 * the binderfs mount the binder-control device resides in:
231 * Allocate a new binder device.
233 * Return: 0 on success, negative errno on failure
235 static long binder_ctl_ioctl(struct file *file, unsigned int cmd,
239 struct inode *inode = file_inode(file);
240 struct binderfs_device __user *device = (struct binderfs_device __user *)arg;
241 struct binderfs_device device_req;
245 ret = copy_from_user(&device_req, device, sizeof(device_req));
251 ret = binderfs_binder_device_create(inode, device, &device_req);
260 static void binderfs_evict_inode(struct inode *inode)
262 struct binder_device *device = inode->i_private;
263 struct binderfs_info *info = BINDERFS_SB(inode->i_sb);
267 if (!S_ISCHR(inode->i_mode) || !device)
270 mutex_lock(&binderfs_minors_mutex);
271 --info->device_count;
272 ida_free(&binderfs_minors, device->miscdev.minor);
273 mutex_unlock(&binderfs_minors_mutex);
275 if (refcount_dec_and_test(&device->ref)) {
276 kfree(device->context.name);
281 static int binderfs_fs_context_parse_param(struct fs_context *fc,
282 struct fs_parameter *param)
285 struct binderfs_mount_opts *ctx = fc->fs_private;
286 struct fs_parse_result result;
288 opt = fs_parse(fc, binderfs_fs_parameters, param, &result);
294 if (result.uint_32 > BINDERFS_MAX_MINOR)
295 return invalfc(fc, "Bad value for '%s'", param->key);
297 ctx->max = result.uint_32;
300 if (!capable(CAP_SYS_ADMIN))
303 ctx->stats_mode = result.uint_32;
306 return invalfc(fc, "Unsupported parameter '%s'", param->key);
312 static int binderfs_fs_context_reconfigure(struct fs_context *fc)
314 struct binderfs_mount_opts *ctx = fc->fs_private;
315 struct binderfs_info *info = BINDERFS_SB(fc->root->d_sb);
317 if (info->mount_opts.stats_mode != ctx->stats_mode)
318 return invalfc(fc, "Binderfs stats mode cannot be changed during a remount");
320 info->mount_opts.stats_mode = ctx->stats_mode;
321 info->mount_opts.max = ctx->max;
325 static int binderfs_show_options(struct seq_file *seq, struct dentry *root)
327 struct binderfs_info *info = BINDERFS_SB(root->d_sb);
329 if (info->mount_opts.max <= BINDERFS_MAX_MINOR)
330 seq_printf(seq, ",max=%d", info->mount_opts.max);
332 switch (info->mount_opts.stats_mode) {
333 case binderfs_stats_mode_unset:
335 case binderfs_stats_mode_global:
336 seq_printf(seq, ",stats=global");
343 static void binderfs_put_super(struct super_block *sb)
345 struct binderfs_info *info = sb->s_fs_info;
347 if (info && info->ipc_ns)
348 put_ipc_ns(info->ipc_ns);
351 sb->s_fs_info = NULL;
354 static const struct super_operations binderfs_super_ops = {
355 .evict_inode = binderfs_evict_inode,
356 .show_options = binderfs_show_options,
357 .statfs = simple_statfs,
358 .put_super = binderfs_put_super,
361 static inline bool is_binderfs_control_device(const struct dentry *dentry)
363 struct binderfs_info *info = dentry->d_sb->s_fs_info;
365 return info->control_dentry == dentry;
368 static int binderfs_rename(struct user_namespace *mnt_userns,
369 struct inode *old_dir, struct dentry *old_dentry,
370 struct inode *new_dir, struct dentry *new_dentry,
373 if (is_binderfs_control_device(old_dentry) ||
374 is_binderfs_control_device(new_dentry))
377 return simple_rename(&init_user_ns, old_dir, old_dentry, new_dir,
381 static int binderfs_unlink(struct inode *dir, struct dentry *dentry)
383 if (is_binderfs_control_device(dentry))
386 return simple_unlink(dir, dentry);
389 static const struct file_operations binder_ctl_fops = {
390 .owner = THIS_MODULE,
391 .open = nonseekable_open,
392 .unlocked_ioctl = binder_ctl_ioctl,
393 .compat_ioctl = binder_ctl_ioctl,
394 .llseek = noop_llseek,
398 * binderfs_binder_ctl_create - create a new binder-control device
399 * @sb: super block of the binderfs mount
401 * This function creates a new binder-control device node in the binderfs mount
402 * referred to by @sb.
404 * Return: 0 on success, negative errno on failure
406 static int binderfs_binder_ctl_create(struct super_block *sb)
409 struct dentry *dentry;
410 struct binder_device *device;
411 struct inode *inode = NULL;
412 struct dentry *root = sb->s_root;
413 struct binderfs_info *info = sb->s_fs_info;
414 #if defined(CONFIG_IPC_NS)
415 bool use_reserve = (info->ipc_ns == &init_ipc_ns);
417 bool use_reserve = true;
420 device = kzalloc(sizeof(*device), GFP_KERNEL);
424 /* If we have already created a binder-control node, return. */
425 if (info->control_dentry) {
431 inode = new_inode(sb);
435 /* Reserve a new minor number for the new device. */
436 mutex_lock(&binderfs_minors_mutex);
437 minor = ida_alloc_max(&binderfs_minors,
438 use_reserve ? BINDERFS_MAX_MINOR :
439 BINDERFS_MAX_MINOR_CAPPED,
441 mutex_unlock(&binderfs_minors_mutex);
447 inode->i_ino = SECOND_INODE;
448 inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
449 init_special_inode(inode, S_IFCHR | 0600,
450 MKDEV(MAJOR(binderfs_dev), minor));
451 inode->i_fop = &binder_ctl_fops;
452 inode->i_uid = info->root_uid;
453 inode->i_gid = info->root_gid;
455 refcount_set(&device->ref, 1);
456 device->binderfs_inode = inode;
457 device->miscdev.minor = minor;
459 dentry = d_alloc_name(root, "binder-control");
463 inode->i_private = device;
464 info->control_dentry = dentry;
465 d_add(dentry, inode);
476 static const struct inode_operations binderfs_dir_inode_operations = {
477 .lookup = simple_lookup,
478 .rename = binderfs_rename,
479 .unlink = binderfs_unlink,
482 static struct inode *binderfs_make_inode(struct super_block *sb, int mode)
488 ret->i_ino = iunique(sb, BINDERFS_MAX_MINOR + INODE_OFFSET);
490 ret->i_atime = ret->i_mtime = ret->i_ctime = current_time(ret);
495 static struct dentry *binderfs_create_dentry(struct dentry *parent,
498 struct dentry *dentry;
500 dentry = lookup_one_len(name, parent, strlen(name));
504 /* Return error if the file/dir already exists. */
505 if (d_really_is_positive(dentry)) {
507 return ERR_PTR(-EEXIST);
513 void binderfs_remove_file(struct dentry *dentry)
515 struct inode *parent_inode;
517 parent_inode = d_inode(dentry->d_parent);
518 inode_lock(parent_inode);
519 if (simple_positive(dentry)) {
521 simple_unlink(parent_inode, dentry);
525 inode_unlock(parent_inode);
528 struct dentry *binderfs_create_file(struct dentry *parent, const char *name,
529 const struct file_operations *fops,
532 struct dentry *dentry;
533 struct inode *new_inode, *parent_inode;
534 struct super_block *sb;
536 parent_inode = d_inode(parent);
537 inode_lock(parent_inode);
539 dentry = binderfs_create_dentry(parent, name);
543 sb = parent_inode->i_sb;
544 new_inode = binderfs_make_inode(sb, S_IFREG | 0444);
547 dentry = ERR_PTR(-ENOMEM);
551 new_inode->i_fop = fops;
552 new_inode->i_private = data;
553 d_instantiate(dentry, new_inode);
554 fsnotify_create(parent_inode, dentry);
557 inode_unlock(parent_inode);
561 static struct dentry *binderfs_create_dir(struct dentry *parent,
564 struct dentry *dentry;
565 struct inode *new_inode, *parent_inode;
566 struct super_block *sb;
568 parent_inode = d_inode(parent);
569 inode_lock(parent_inode);
571 dentry = binderfs_create_dentry(parent, name);
575 sb = parent_inode->i_sb;
576 new_inode = binderfs_make_inode(sb, S_IFDIR | 0755);
579 dentry = ERR_PTR(-ENOMEM);
583 new_inode->i_fop = &simple_dir_operations;
584 new_inode->i_op = &simple_dir_inode_operations;
586 set_nlink(new_inode, 2);
587 d_instantiate(dentry, new_inode);
588 inc_nlink(parent_inode);
589 fsnotify_mkdir(parent_inode, dentry);
592 inode_unlock(parent_inode);
596 static int binder_features_show(struct seq_file *m, void *unused)
598 bool *feature = m->private;
600 seq_printf(m, "%d\n", *feature);
604 DEFINE_SHOW_ATTRIBUTE(binder_features);
606 static int init_binder_features(struct super_block *sb)
608 struct dentry *dentry, *dir;
610 dir = binderfs_create_dir(sb->s_root, "features");
614 dentry = binderfs_create_file(dir, "oneway_spam_detection",
615 &binder_features_fops,
616 &binder_features.oneway_spam_detection);
618 return PTR_ERR(dentry);
620 dentry = binderfs_create_file(dir, "extended_error",
621 &binder_features_fops,
622 &binder_features.extended_error);
624 return PTR_ERR(dentry);
629 static int init_binder_logs(struct super_block *sb)
631 struct dentry *binder_logs_root_dir, *dentry, *proc_log_dir;
632 struct binderfs_info *info;
635 binder_logs_root_dir = binderfs_create_dir(sb->s_root,
637 if (IS_ERR(binder_logs_root_dir)) {
638 ret = PTR_ERR(binder_logs_root_dir);
642 dentry = binderfs_create_file(binder_logs_root_dir, "stats",
643 &binder_stats_fops, NULL);
644 if (IS_ERR(dentry)) {
645 ret = PTR_ERR(dentry);
649 dentry = binderfs_create_file(binder_logs_root_dir, "state",
650 &binder_state_fops, NULL);
651 if (IS_ERR(dentry)) {
652 ret = PTR_ERR(dentry);
656 dentry = binderfs_create_file(binder_logs_root_dir, "transactions",
657 &binder_transactions_fops, NULL);
658 if (IS_ERR(dentry)) {
659 ret = PTR_ERR(dentry);
663 dentry = binderfs_create_file(binder_logs_root_dir,
665 &binder_transaction_log_fops,
666 &binder_transaction_log);
667 if (IS_ERR(dentry)) {
668 ret = PTR_ERR(dentry);
672 dentry = binderfs_create_file(binder_logs_root_dir,
673 "failed_transaction_log",
674 &binder_transaction_log_fops,
675 &binder_transaction_log_failed);
676 if (IS_ERR(dentry)) {
677 ret = PTR_ERR(dentry);
681 proc_log_dir = binderfs_create_dir(binder_logs_root_dir, "proc");
682 if (IS_ERR(proc_log_dir)) {
683 ret = PTR_ERR(proc_log_dir);
686 info = sb->s_fs_info;
687 info->proc_log_dir = proc_log_dir;
693 static int binderfs_fill_super(struct super_block *sb, struct fs_context *fc)
696 struct binderfs_info *info;
697 struct binderfs_mount_opts *ctx = fc->fs_private;
698 struct inode *inode = NULL;
699 struct binderfs_device device_info = {};
703 sb->s_blocksize = PAGE_SIZE;
704 sb->s_blocksize_bits = PAGE_SHIFT;
707 * The binderfs filesystem can be mounted by userns root in a
708 * non-initial userns. By default such mounts have the SB_I_NODEV flag
709 * set in s_iflags to prevent security issues where userns root can
710 * just create random device nodes via mknod() since it owns the
711 * filesystem mount. But binderfs does not allow to create any files
712 * including devices nodes. The only way to create binder devices nodes
713 * is through the binder-control device which userns root is explicitly
714 * allowed to do. So removing the SB_I_NODEV flag from s_iflags is both
715 * necessary and safe.
717 sb->s_iflags &= ~SB_I_NODEV;
718 sb->s_iflags |= SB_I_NOEXEC;
719 sb->s_magic = BINDERFS_SUPER_MAGIC;
720 sb->s_op = &binderfs_super_ops;
723 sb->s_fs_info = kzalloc(sizeof(struct binderfs_info), GFP_KERNEL);
726 info = sb->s_fs_info;
728 info->ipc_ns = get_ipc_ns(current->nsproxy->ipc_ns);
730 info->root_gid = make_kgid(sb->s_user_ns, 0);
731 if (!gid_valid(info->root_gid))
732 info->root_gid = GLOBAL_ROOT_GID;
733 info->root_uid = make_kuid(sb->s_user_ns, 0);
734 if (!uid_valid(info->root_uid))
735 info->root_uid = GLOBAL_ROOT_UID;
736 info->mount_opts.max = ctx->max;
737 info->mount_opts.stats_mode = ctx->stats_mode;
739 inode = new_inode(sb);
743 inode->i_ino = FIRST_INODE;
744 inode->i_fop = &simple_dir_operations;
745 inode->i_mode = S_IFDIR | 0755;
746 inode->i_mtime = inode->i_atime = inode->i_ctime = current_time(inode);
747 inode->i_op = &binderfs_dir_inode_operations;
750 sb->s_root = d_make_root(inode);
754 ret = binderfs_binder_ctl_create(sb);
758 name = binder_devices_param;
759 for (len = strcspn(name, ","); len > 0; len = strcspn(name, ",")) {
760 strscpy(device_info.name, name, len + 1);
761 ret = binderfs_binder_device_create(inode, NULL, &device_info);
769 ret = init_binder_features(sb);
773 if (info->mount_opts.stats_mode == binderfs_stats_mode_global)
774 return init_binder_logs(sb);
779 static int binderfs_fs_context_get_tree(struct fs_context *fc)
781 return get_tree_nodev(fc, binderfs_fill_super);
784 static void binderfs_fs_context_free(struct fs_context *fc)
786 struct binderfs_mount_opts *ctx = fc->fs_private;
791 static const struct fs_context_operations binderfs_fs_context_ops = {
792 .free = binderfs_fs_context_free,
793 .get_tree = binderfs_fs_context_get_tree,
794 .parse_param = binderfs_fs_context_parse_param,
795 .reconfigure = binderfs_fs_context_reconfigure,
798 static int binderfs_init_fs_context(struct fs_context *fc)
800 struct binderfs_mount_opts *ctx;
802 ctx = kzalloc(sizeof(struct binderfs_mount_opts), GFP_KERNEL);
806 ctx->max = BINDERFS_MAX_MINOR;
807 ctx->stats_mode = binderfs_stats_mode_unset;
809 fc->fs_private = ctx;
810 fc->ops = &binderfs_fs_context_ops;
815 static struct file_system_type binder_fs_type = {
817 .init_fs_context = binderfs_init_fs_context,
818 .parameters = binderfs_fs_parameters,
819 .kill_sb = kill_litter_super,
820 .fs_flags = FS_USERNS_MOUNT,
823 int __init init_binderfs(void)
829 /* Verify that the default binderfs device names are valid. */
830 name = binder_devices_param;
831 for (len = strcspn(name, ","); len > 0; len = strcspn(name, ",")) {
832 if (len > BINDERFS_MAX_NAME)
839 /* Allocate new major number for binderfs. */
840 ret = alloc_chrdev_region(&binderfs_dev, 0, BINDERFS_MAX_MINOR,
845 ret = register_filesystem(&binder_fs_type);
847 unregister_chrdev_region(binderfs_dev, BINDERFS_MAX_MINOR);