blob: dc84a3ef9ca20420ff29c691abfa8436395ed993 [file] [log] [blame]
Tejun Heoae6621b2013-11-28 14:54:31 -05001/*
2 * fs/kernfs/kernfs-internal.h - kernfs internal header file
3 *
4 * Copyright (c) 2001-3 Patrick Mochel
5 * Copyright (c) 2007 SUSE Linux Products GmbH
6 * Copyright (c) 2007, 2013 Tejun Heo <teheo@suse.de>
7 *
8 * This file is released under the GPLv2.
9 */
10
11#ifndef __KERNFS_INTERNAL_H
12#define __KERNFS_INTERNAL_H
13
14#include <linux/lockdep.h>
15#include <linux/fs.h>
Tejun Heofd7b9f72013-11-28 14:54:33 -050016#include <linux/mutex.h>
Tejun Heo23223922013-11-23 17:40:02 -050017#include <linux/xattr.h>
Tejun Heoae6621b2013-11-28 14:54:31 -050018
19#include <linux/kernfs.h>
20
Tejun Heoc525aad2013-12-11 14:11:55 -050021struct kernfs_iattrs {
Tejun Heo9a8049a2013-11-23 17:40:01 -050022 struct iattr ia_iattr;
23 void *ia_secdata;
24 u32 ia_secdata_len;
Tejun Heo23223922013-11-23 17:40:02 -050025
26 struct simple_xattrs xattrs;
Tejun Heoae6621b2013-11-28 14:54:31 -050027};
28
Tejun Heo81c173c2014-02-03 14:03:00 -050029/* +1 to avoid triggering overflow warning when negating it */
30#define KN_DEACTIVATED_BIAS (INT_MIN + 1)
Tejun Heoae6621b2013-11-28 14:54:31 -050031
Tejun Heodf23fc32013-12-11 14:11:56 -050032/* KERNFS_TYPE_MASK and types are defined in include/linux/kernfs.h */
Tejun Heoae6621b2013-11-28 14:54:31 -050033
Tejun Heoba7443b2013-11-28 14:54:40 -050034/**
Tejun Heo324a56e2013-12-11 14:11:53 -050035 * kernfs_root - find out the kernfs_root a kernfs_node belongs to
36 * @kn: kernfs_node of interest
Tejun Heoba7443b2013-11-28 14:54:40 -050037 *
Tejun Heo324a56e2013-12-11 14:11:53 -050038 * Return the kernfs_root @kn belongs to.
Tejun Heoba7443b2013-11-28 14:54:40 -050039 */
Tejun Heo324a56e2013-12-11 14:11:53 -050040static inline struct kernfs_root *kernfs_root(struct kernfs_node *kn)
Tejun Heoba7443b2013-11-28 14:54:40 -050041{
42 /* if parent exists, it's always a dir; otherwise, @sd is a dir */
Tejun Heoadc5e8b2013-12-11 14:11:54 -050043 if (kn->parent)
44 kn = kn->parent;
45 return kn->dir.root;
Tejun Heoba7443b2013-11-28 14:54:40 -050046}
47
Tejun Heoae6621b2013-11-28 14:54:31 -050048/*
Tejun Heofa736a92013-11-28 14:54:44 -050049 * mount.c
50 */
Tejun Heoc525aad2013-12-11 14:11:55 -050051struct kernfs_super_info {
Tejun Heo7d568a82014-04-09 11:07:30 -040052 struct super_block *sb;
53
Tejun Heofa736a92013-11-28 14:54:44 -050054 /*
55 * The root associated with this super_block. Each super_block is
56 * identified by the root and ns it's associated with.
57 */
58 struct kernfs_root *root;
59
60 /*
Tejun Heo324a56e2013-12-11 14:11:53 -050061 * Each sb is associated with one namespace tag, currently the
Tejun Heoc525aad2013-12-11 14:11:55 -050062 * network namespace of the task which mounted this kernfs
63 * instance. If multiple tags become necessary, make the following
64 * an array and compare kernfs_node tag against every entry.
Tejun Heofa736a92013-11-28 14:54:44 -050065 */
66 const void *ns;
Tejun Heo7d568a82014-04-09 11:07:30 -040067
68 /* anchored at kernfs_root->supers, protected by kernfs_mutex */
69 struct list_head node;
Tejun Heofa736a92013-11-28 14:54:44 -050070};
Tejun Heoc525aad2013-12-11 14:11:55 -050071#define kernfs_info(SB) ((struct kernfs_super_info *)(SB->s_fs_info))
Tejun Heofa736a92013-11-28 14:54:44 -050072
Li Zefanf41c5932014-02-14 16:57:27 +080073extern const struct super_operations kernfs_sops;
Tejun Heoa797bfc2013-12-11 14:11:57 -050074extern struct kmem_cache *kernfs_node_cache;
Tejun Heofa736a92013-11-28 14:54:44 -050075
76/*
Tejun Heoffed24e2013-11-28 14:54:32 -050077 * inode.c
78 */
Tejun Heoc637b8a2013-12-11 14:11:58 -050079struct inode *kernfs_get_inode(struct super_block *sb, struct kernfs_node *kn);
80void kernfs_evict_inode(struct inode *inode);
81int kernfs_iop_permission(struct inode *inode, int mask);
82int kernfs_iop_setattr(struct dentry *dentry, struct iattr *iattr);
83int kernfs_iop_getattr(struct vfsmount *mnt, struct dentry *dentry,
84 struct kstat *stat);
85int kernfs_iop_setxattr(struct dentry *dentry, const char *name, const void *value,
86 size_t size, int flags);
87int kernfs_iop_removexattr(struct dentry *dentry, const char *name);
88ssize_t kernfs_iop_getxattr(struct dentry *dentry, const char *name, void *buf,
89 size_t size);
90ssize_t kernfs_iop_listxattr(struct dentry *dentry, char *buf, size_t size);
91void kernfs_inode_init(void);
Tejun Heoffed24e2013-11-28 14:54:32 -050092
Tejun Heofd7b9f72013-11-28 14:54:33 -050093/*
94 * dir.c
95 */
Tejun Heoa797bfc2013-12-11 14:11:57 -050096extern struct mutex kernfs_mutex;
97extern const struct dentry_operations kernfs_dops;
98extern const struct file_operations kernfs_dir_fops;
99extern const struct inode_operations kernfs_dir_iops;
Tejun Heofd7b9f72013-11-28 14:54:33 -0500100
Tejun Heoc637b8a2013-12-11 14:11:58 -0500101struct kernfs_node *kernfs_get_active(struct kernfs_node *kn);
102void kernfs_put_active(struct kernfs_node *kn);
Tejun Heo988cd7a2014-02-03 14:02:58 -0500103int kernfs_add_one(struct kernfs_node *kn);
Tejun Heodb4aad22014-01-17 09:58:25 -0500104struct kernfs_node *kernfs_new_node(struct kernfs_node *parent,
105 const char *name, umode_t mode,
106 unsigned flags);
Tejun Heofd7b9f72013-11-28 14:54:33 -0500107
Tejun Heo414985a2013-11-28 14:54:34 -0500108/*
109 * file.c
110 */
Tejun Heoa797bfc2013-12-11 14:11:57 -0500111extern const struct file_operations kernfs_file_fops;
Tejun Heo414985a2013-11-28 14:54:34 -0500112
Greg Kroah-Hartman55f6e302014-01-13 14:27:16 -0800113void kernfs_unmap_bin_file(struct kernfs_node *kn);
Tejun Heo414985a2013-11-28 14:54:34 -0500114
Tejun Heo2072f1a2013-11-28 14:54:35 -0500115/*
116 * symlink.c
117 */
Tejun Heoa797bfc2013-12-11 14:11:57 -0500118extern const struct inode_operations kernfs_symlink_iops;
Tejun Heo2072f1a2013-11-28 14:54:35 -0500119
Tejun Heoae6621b2013-11-28 14:54:31 -0500120#endif /* __KERNFS_INTERNAL_H */