blob: 16eb59adf5aab96b1d38bd9ba0a399df8eac9698 [file] [log] [blame]
Joel Becker7063fbf2005-12-15 14:29:43 -08001/* -*- mode: c; c-basic-offset:8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
3 *
4 * configfs_internal.h - Internal stuff for configfs
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 021110-1307, USA.
20 *
21 * Based on sysfs:
22 * sysfs is Copyright (C) 2001, 2002, 2003 Patrick Mochel
23 *
24 * configfs Copyright (C) 2005 Oracle. All rights reserved.
25 */
26
Fabian Frederick1d88aa42014-06-04 16:05:59 -070027#ifdef pr_fmt
28#undef pr_fmt
29#endif
30
31#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32
Joel Becker7063fbf2005-12-15 14:29:43 -080033#include <linux/slab.h>
34#include <linux/list.h>
Louis Rilling6f610762008-06-16 19:00:58 +020035#include <linux/spinlock.h>
Joel Becker7063fbf2005-12-15 14:29:43 -080036
Al Viro77590eb2019-08-25 19:56:13 -040037struct configfs_fragment {
38 atomic_t frag_count;
39 struct rw_semaphore frag_sem;
40 bool frag_dead;
41};
42
43void put_fragment(struct configfs_fragment *);
44struct configfs_fragment *get_fragment(struct configfs_fragment *);
45
Joel Becker7063fbf2005-12-15 14:29:43 -080046struct configfs_dirent {
47 atomic_t s_count;
Joel Becker631d1fe2007-06-18 18:06:09 -070048 int s_dependent_count;
Joel Becker7063fbf2005-12-15 14:29:43 -080049 struct list_head s_sibling;
50 struct list_head s_children;
51 struct list_head s_links;
Joel Becker631d1fe2007-06-18 18:06:09 -070052 void * s_element;
Joel Becker7063fbf2005-12-15 14:29:43 -080053 int s_type;
54 umode_t s_mode;
55 struct dentry * s_dentry;
Joel Becker3d0f89b2006-01-25 13:31:07 -080056 struct iattr * s_iattr;
Louis Rillinge74cc062009-01-28 19:18:32 +010057#ifdef CONFIG_LOCKDEP
58 int s_depth;
59#endif
Al Viro77590eb2019-08-25 19:56:13 -040060 struct configfs_fragment *s_frag;
Joel Becker7063fbf2005-12-15 14:29:43 -080061};
62
63#define CONFIGFS_ROOT 0x0001
64#define CONFIGFS_DIR 0x0002
Joel Becker631d1fe2007-06-18 18:06:09 -070065#define CONFIGFS_ITEM_ATTR 0x0004
Pantelis Antoniou03607ac2015-10-22 23:30:04 +030066#define CONFIGFS_ITEM_BIN_ATTR 0x0008
Joel Becker631d1fe2007-06-18 18:06:09 -070067#define CONFIGFS_ITEM_LINK 0x0020
Joel Becker7063fbf2005-12-15 14:29:43 -080068#define CONFIGFS_USET_DIR 0x0040
69#define CONFIGFS_USET_DEFAULT 0x0080
70#define CONFIGFS_USET_DROPPING 0x0100
Louis Rilling6d8344b2008-06-16 19:01:02 +020071#define CONFIGFS_USET_IN_MKDIR 0x0200
Louis Rilling2a109f22008-07-04 16:56:05 +020072#define CONFIGFS_USET_CREATING 0x0400
Pantelis Antoniou03607ac2015-10-22 23:30:04 +030073#define CONFIGFS_NOT_PINNED (CONFIGFS_ITEM_ATTR | CONFIGFS_ITEM_BIN_ATTR)
Joel Becker7063fbf2005-12-15 14:29:43 -080074
Louis Rilling9a73d782008-06-20 14:09:22 +020075extern struct mutex configfs_symlink_mutex;
Louis Rilling6f610762008-06-16 19:00:58 +020076extern spinlock_t configfs_dirent_lock;
77
Christoph Lametere18b8902006-12-06 20:33:20 -080078extern struct kmem_cache *configfs_dir_cachep;
Joel Becker7063fbf2005-12-15 14:29:43 -080079
80extern int configfs_is_root(struct config_item *item);
81
Al Virob7c177f2012-03-17 16:24:54 -040082extern struct inode * configfs_new_inode(umode_t mode, struct configfs_dirent *, struct super_block *);
Al Viroc88b1e72015-01-29 00:17:57 -050083extern int configfs_create(struct dentry *, umode_t mode, void (*init)(struct inode *));
Joel Becker7063fbf2005-12-15 14:29:43 -080084
85extern int configfs_create_file(struct config_item *, const struct configfs_attribute *);
Pantelis Antoniou03607ac2015-10-22 23:30:04 +030086extern int configfs_create_bin_file(struct config_item *,
87 const struct configfs_bin_attribute *);
Al Viro77590eb2019-08-25 19:56:13 -040088extern int configfs_make_dirent(struct configfs_dirent *, struct dentry *,
89 void *, umode_t, int, struct configfs_fragment *);
Louis Rilling2a109f22008-07-04 16:56:05 +020090extern int configfs_dirent_is_ready(struct configfs_dirent *);
Joel Becker7063fbf2005-12-15 14:29:43 -080091
Joel Becker7063fbf2005-12-15 14:29:43 -080092extern void configfs_hash_and_remove(struct dentry * dir, const char * name);
93
94extern const unsigned char * configfs_get_name(struct configfs_dirent *sd);
95extern void configfs_drop_dentry(struct configfs_dirent *sd, struct dentry *parent);
Joel Becker3d0f89b2006-01-25 13:31:07 -080096extern int configfs_setattr(struct dentry *dentry, struct iattr *iattr);
Joel Becker7063fbf2005-12-15 14:29:43 -080097
Al Viro2a152ad2012-03-17 16:53:29 -040098extern struct dentry *configfs_pin_fs(void);
Joel Becker7063fbf2005-12-15 14:29:43 -080099extern void configfs_release_fs(void);
100
101extern struct rw_semaphore configfs_rename_sem;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800102extern const struct file_operations configfs_dir_operations;
103extern const struct file_operations configfs_file_operations;
Pantelis Antoniou03607ac2015-10-22 23:30:04 +0300104extern const struct file_operations configfs_bin_file_operations;
Arjan van de Ven754661f2007-02-12 00:55:38 -0800105extern const struct inode_operations configfs_dir_inode_operations;
Al Viro81d44ed12012-03-17 16:13:25 -0400106extern const struct inode_operations configfs_root_inode_operations;
Arjan van de Ven754661f2007-02-12 00:55:38 -0800107extern const struct inode_operations configfs_symlink_inode_operations;
Al Virod463a0c2011-01-12 16:41:05 -0500108extern const struct dentry_operations configfs_dentry_ops;
Joel Becker7063fbf2005-12-15 14:29:43 -0800109
110extern int configfs_symlink(struct inode *dir, struct dentry *dentry,
111 const char *symname);
112extern int configfs_unlink(struct inode *dir, struct dentry *dentry);
113
114struct configfs_symlink {
115 struct list_head sl_list;
116 struct config_item *sl_target;
117};
118
119extern int configfs_create_link(struct configfs_symlink *sl,
120 struct dentry *parent,
121 struct dentry *dentry);
122
123static inline struct config_item * to_item(struct dentry * dentry)
124{
125 struct configfs_dirent * sd = dentry->d_fsdata;
126 return ((struct config_item *) sd->s_element);
127}
128
129static inline struct configfs_attribute * to_attr(struct dentry * dentry)
130{
131 struct configfs_dirent * sd = dentry->d_fsdata;
132 return ((struct configfs_attribute *) sd->s_element);
133}
134
Pantelis Antoniou03607ac2015-10-22 23:30:04 +0300135static inline struct configfs_bin_attribute *to_bin_attr(struct dentry *dentry)
136{
137 struct configfs_attribute *attr = to_attr(dentry);
138
139 return container_of(attr, struct configfs_bin_attribute, cb_attr);
140}
141
Joel Becker7063fbf2005-12-15 14:29:43 -0800142static inline struct config_item *configfs_get_config_item(struct dentry *dentry)
143{
144 struct config_item * item = NULL;
145
Nick Pigginda502952011-01-07 17:49:33 +1100146 spin_lock(&dentry->d_lock);
Joel Becker7063fbf2005-12-15 14:29:43 -0800147 if (!d_unhashed(dentry)) {
148 struct configfs_dirent * sd = dentry->d_fsdata;
149 if (sd->s_type & CONFIGFS_ITEM_LINK) {
150 struct configfs_symlink * sl = sd->s_element;
151 item = config_item_get(sl->sl_target);
152 } else
153 item = config_item_get(sd->s_element);
154 }
Nick Pigginda502952011-01-07 17:49:33 +1100155 spin_unlock(&dentry->d_lock);
Joel Becker7063fbf2005-12-15 14:29:43 -0800156
157 return item;
158}
159
160static inline void release_configfs_dirent(struct configfs_dirent * sd)
161{
Joel Becker3d0f89b2006-01-25 13:31:07 -0800162 if (!(sd->s_type & CONFIGFS_ROOT)) {
163 kfree(sd->s_iattr);
Al Viro77590eb2019-08-25 19:56:13 -0400164 put_fragment(sd->s_frag);
Joel Becker3d0f89b2006-01-25 13:31:07 -0800165 kmem_cache_free(configfs_dir_cachep, sd);
166 }
Joel Becker7063fbf2005-12-15 14:29:43 -0800167}
168
169static inline struct configfs_dirent * configfs_get(struct configfs_dirent * sd)
170{
171 if (sd) {
172 WARN_ON(!atomic_read(&sd->s_count));
173 atomic_inc(&sd->s_count);
174 }
175 return sd;
176}
177
178static inline void configfs_put(struct configfs_dirent * sd)
179{
180 WARN_ON(!atomic_read(&sd->s_count));
181 if (atomic_dec_and_test(&sd->s_count))
182 release_configfs_dirent(sd);
183}
184