2005-12-15 22:29:43 +00:00
|
|
|
/* -*- mode: c; c-basic-offset:8; -*-
|
|
|
|
* vim: noexpandtab sw=8 ts=8 sts=0:
|
|
|
|
*
|
|
|
|
* configfs_internal.h - Internal stuff for configfs
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public
|
|
|
|
* License along with this program; if not, write to the
|
|
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
|
* Boston, MA 021110-1307, USA.
|
|
|
|
*
|
|
|
|
* Based on sysfs:
|
|
|
|
* sysfs is Copyright (C) 2001, 2002, 2003 Patrick Mochel
|
|
|
|
*
|
|
|
|
* configfs Copyright (C) 2005 Oracle. All rights reserved.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <linux/slab.h>
|
|
|
|
#include <linux/list.h>
|
2008-06-16 17:00:58 +00:00
|
|
|
#include <linux/spinlock.h>
|
2005-12-15 22:29:43 +00:00
|
|
|
|
|
|
|
struct configfs_dirent {
|
|
|
|
atomic_t s_count;
|
configfs: config item dependancies.
Sometimes other drivers depend on particular configfs items. For
example, ocfs2 mounts depend on a heartbeat region item. If that
region item is removed with rmdir(2), the ocfs2 mount must BUG or go
readonly. Not happy.
This provides two additional API calls: configfs_depend_item() and
configfs_undepend_item(). A client driver can call
configfs_depend_item() on an existing item to tell configfs that it is
depended on. configfs will then return -EBUSY from rmdir(2) for that
item. When the item is no longer depended on, the client driver calls
configfs_undepend_item() on it.
These API cannot be called underneath any configfs callbacks, as
they will conflict. They can block and allocate. A client driver
probably shouldn't calling them of its own gumption. Rather it should
be providing an API that external subsystems call.
How does this work? Imagine the ocfs2 mount process. When it mounts,
it asks for a heart region item. This is done via a call into the
heartbeat code. Inside the heartbeat code, the region item is looked
up. Here, the heartbeat code calls configfs_depend_item(). If it
succeeds, then heartbeat knows the region is safe to give to ocfs2.
If it fails, it was being torn down anyway, and heartbeat can gracefully
pass up an error.
[ Fixed some bad whitespace in configfs.txt. --Mark ]
Signed-off-by: Joel Becker <joel.becker@oracle.com>
Signed-off-by: Mark Fasheh <mark.fasheh@oracle.com>
2007-06-19 01:06:09 +00:00
|
|
|
int s_dependent_count;
|
2005-12-15 22:29:43 +00:00
|
|
|
struct list_head s_sibling;
|
|
|
|
struct list_head s_children;
|
|
|
|
struct list_head s_links;
|
configfs: config item dependancies.
Sometimes other drivers depend on particular configfs items. For
example, ocfs2 mounts depend on a heartbeat region item. If that
region item is removed with rmdir(2), the ocfs2 mount must BUG or go
readonly. Not happy.
This provides two additional API calls: configfs_depend_item() and
configfs_undepend_item(). A client driver can call
configfs_depend_item() on an existing item to tell configfs that it is
depended on. configfs will then return -EBUSY from rmdir(2) for that
item. When the item is no longer depended on, the client driver calls
configfs_undepend_item() on it.
These API cannot be called underneath any configfs callbacks, as
they will conflict. They can block and allocate. A client driver
probably shouldn't calling them of its own gumption. Rather it should
be providing an API that external subsystems call.
How does this work? Imagine the ocfs2 mount process. When it mounts,
it asks for a heart region item. This is done via a call into the
heartbeat code. Inside the heartbeat code, the region item is looked
up. Here, the heartbeat code calls configfs_depend_item(). If it
succeeds, then heartbeat knows the region is safe to give to ocfs2.
If it fails, it was being torn down anyway, and heartbeat can gracefully
pass up an error.
[ Fixed some bad whitespace in configfs.txt. --Mark ]
Signed-off-by: Joel Becker <joel.becker@oracle.com>
Signed-off-by: Mark Fasheh <mark.fasheh@oracle.com>
2007-06-19 01:06:09 +00:00
|
|
|
void * s_element;
|
2005-12-15 22:29:43 +00:00
|
|
|
int s_type;
|
|
|
|
umode_t s_mode;
|
|
|
|
struct dentry * s_dentry;
|
2006-01-25 21:31:07 +00:00
|
|
|
struct iattr * s_iattr;
|
2005-12-15 22:29:43 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#define CONFIGFS_ROOT 0x0001
|
|
|
|
#define CONFIGFS_DIR 0x0002
|
configfs: config item dependancies.
Sometimes other drivers depend on particular configfs items. For
example, ocfs2 mounts depend on a heartbeat region item. If that
region item is removed with rmdir(2), the ocfs2 mount must BUG or go
readonly. Not happy.
This provides two additional API calls: configfs_depend_item() and
configfs_undepend_item(). A client driver can call
configfs_depend_item() on an existing item to tell configfs that it is
depended on. configfs will then return -EBUSY from rmdir(2) for that
item. When the item is no longer depended on, the client driver calls
configfs_undepend_item() on it.
These API cannot be called underneath any configfs callbacks, as
they will conflict. They can block and allocate. A client driver
probably shouldn't calling them of its own gumption. Rather it should
be providing an API that external subsystems call.
How does this work? Imagine the ocfs2 mount process. When it mounts,
it asks for a heart region item. This is done via a call into the
heartbeat code. Inside the heartbeat code, the region item is looked
up. Here, the heartbeat code calls configfs_depend_item(). If it
succeeds, then heartbeat knows the region is safe to give to ocfs2.
If it fails, it was being torn down anyway, and heartbeat can gracefully
pass up an error.
[ Fixed some bad whitespace in configfs.txt. --Mark ]
Signed-off-by: Joel Becker <joel.becker@oracle.com>
Signed-off-by: Mark Fasheh <mark.fasheh@oracle.com>
2007-06-19 01:06:09 +00:00
|
|
|
#define CONFIGFS_ITEM_ATTR 0x0004
|
|
|
|
#define CONFIGFS_ITEM_LINK 0x0020
|
2005-12-15 22:29:43 +00:00
|
|
|
#define CONFIGFS_USET_DIR 0x0040
|
|
|
|
#define CONFIGFS_USET_DEFAULT 0x0080
|
|
|
|
#define CONFIGFS_USET_DROPPING 0x0100
|
2008-06-16 17:01:02 +00:00
|
|
|
#define CONFIGFS_USET_IN_MKDIR 0x0200
|
2005-12-15 22:29:43 +00:00
|
|
|
#define CONFIGFS_NOT_PINNED (CONFIGFS_ITEM_ATTR)
|
|
|
|
|
2008-06-16 17:00:58 +00:00
|
|
|
extern spinlock_t configfs_dirent_lock;
|
|
|
|
|
2005-12-15 22:29:43 +00:00
|
|
|
extern struct vfsmount * configfs_mount;
|
2006-12-07 04:33:20 +00:00
|
|
|
extern struct kmem_cache *configfs_dir_cachep;
|
2005-12-15 22:29:43 +00:00
|
|
|
|
|
|
|
extern int configfs_is_root(struct config_item *item);
|
|
|
|
|
2006-01-25 21:31:07 +00:00
|
|
|
extern struct inode * configfs_new_inode(mode_t mode, struct configfs_dirent *);
|
2005-12-15 22:29:43 +00:00
|
|
|
extern int configfs_create(struct dentry *, int mode, int (*init)(struct inode *));
|
2007-10-17 06:25:46 +00:00
|
|
|
extern int configfs_inode_init(void);
|
|
|
|
extern void configfs_inode_exit(void);
|
2005-12-15 22:29:43 +00:00
|
|
|
|
|
|
|
extern int configfs_create_file(struct config_item *, const struct configfs_attribute *);
|
|
|
|
extern int configfs_make_dirent(struct configfs_dirent *,
|
|
|
|
struct dentry *, void *, umode_t, int);
|
|
|
|
|
|
|
|
extern int configfs_add_file(struct dentry *, const struct configfs_attribute *, int);
|
|
|
|
extern void configfs_hash_and_remove(struct dentry * dir, const char * name);
|
|
|
|
|
|
|
|
extern const unsigned char * configfs_get_name(struct configfs_dirent *sd);
|
|
|
|
extern void configfs_drop_dentry(struct configfs_dirent *sd, struct dentry *parent);
|
2006-01-25 21:31:07 +00:00
|
|
|
extern int configfs_setattr(struct dentry *dentry, struct iattr *iattr);
|
2005-12-15 22:29:43 +00:00
|
|
|
|
|
|
|
extern int configfs_pin_fs(void);
|
|
|
|
extern void configfs_release_fs(void);
|
|
|
|
|
|
|
|
extern struct rw_semaphore configfs_rename_sem;
|
|
|
|
extern struct super_block * configfs_sb;
|
2006-03-28 09:56:42 +00:00
|
|
|
extern const struct file_operations configfs_dir_operations;
|
|
|
|
extern const struct file_operations configfs_file_operations;
|
|
|
|
extern const struct file_operations bin_fops;
|
2007-02-12 08:55:38 +00:00
|
|
|
extern const struct inode_operations configfs_dir_inode_operations;
|
|
|
|
extern const struct inode_operations configfs_symlink_inode_operations;
|
2005-12-15 22:29:43 +00:00
|
|
|
|
|
|
|
extern int configfs_symlink(struct inode *dir, struct dentry *dentry,
|
|
|
|
const char *symname);
|
|
|
|
extern int configfs_unlink(struct inode *dir, struct dentry *dentry);
|
|
|
|
|
|
|
|
struct configfs_symlink {
|
|
|
|
struct list_head sl_list;
|
|
|
|
struct config_item *sl_target;
|
|
|
|
};
|
|
|
|
|
|
|
|
extern int configfs_create_link(struct configfs_symlink *sl,
|
|
|
|
struct dentry *parent,
|
|
|
|
struct dentry *dentry);
|
|
|
|
|
|
|
|
static inline struct config_item * to_item(struct dentry * dentry)
|
|
|
|
{
|
|
|
|
struct configfs_dirent * sd = dentry->d_fsdata;
|
|
|
|
return ((struct config_item *) sd->s_element);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline struct configfs_attribute * to_attr(struct dentry * dentry)
|
|
|
|
{
|
|
|
|
struct configfs_dirent * sd = dentry->d_fsdata;
|
|
|
|
return ((struct configfs_attribute *) sd->s_element);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline struct config_item *configfs_get_config_item(struct dentry *dentry)
|
|
|
|
{
|
|
|
|
struct config_item * item = NULL;
|
|
|
|
|
|
|
|
spin_lock(&dcache_lock);
|
|
|
|
if (!d_unhashed(dentry)) {
|
|
|
|
struct configfs_dirent * sd = dentry->d_fsdata;
|
|
|
|
if (sd->s_type & CONFIGFS_ITEM_LINK) {
|
|
|
|
struct configfs_symlink * sl = sd->s_element;
|
|
|
|
item = config_item_get(sl->sl_target);
|
|
|
|
} else
|
|
|
|
item = config_item_get(sd->s_element);
|
|
|
|
}
|
|
|
|
spin_unlock(&dcache_lock);
|
|
|
|
|
|
|
|
return item;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void release_configfs_dirent(struct configfs_dirent * sd)
|
|
|
|
{
|
2006-01-25 21:31:07 +00:00
|
|
|
if (!(sd->s_type & CONFIGFS_ROOT)) {
|
|
|
|
kfree(sd->s_iattr);
|
|
|
|
kmem_cache_free(configfs_dir_cachep, sd);
|
|
|
|
}
|
2005-12-15 22:29:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline struct configfs_dirent * configfs_get(struct configfs_dirent * sd)
|
|
|
|
{
|
|
|
|
if (sd) {
|
|
|
|
WARN_ON(!atomic_read(&sd->s_count));
|
|
|
|
atomic_inc(&sd->s_count);
|
|
|
|
}
|
|
|
|
return sd;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void configfs_put(struct configfs_dirent * sd)
|
|
|
|
{
|
|
|
|
WARN_ON(!atomic_read(&sd->s_count));
|
|
|
|
if (atomic_dec_and_test(&sd->s_count))
|
|
|
|
release_configfs_dirent(sd);
|
|
|
|
}
|
|
|
|
|