[deliverable/linux.git] / fs / autofs4 / autofs_i.h

/* -*- c -*- ------------------------------------------------------------- *
 *   
 * linux/fs/autofs/autofs_i.h
 *
 *   Copyright 1997-1998 Transmeta Corporation - All Rights Reserved
 *   Copyright 2005-2006 Ian Kent <raven@themaw.net>
 *
 * This file is part of the Linux kernel and is made available under
 * the terms of the GNU General Public License, version 2, or at your
 * option, any later version, incorporated herein by reference.
 *
 * ----------------------------------------------------------------------- */

/* Internal header file for autofs */

#include <linux/auto_fs4.h>
#include <linux/auto_dev-ioctl.h>
#include <linux/mutex.h>
#include <linux/spinlock.h>
#include <linux/list.h>

/* This is the range of ioctl() numbers we claim as ours */
#define AUTOFS_IOC_FIRST     AUTOFS_IOC_READY
#define AUTOFS_IOC_COUNT     32

#define AUTOFS_DEV_IOCTL_IOC_FIRST	(AUTOFS_DEV_IOCTL_VERSION)
#define AUTOFS_DEV_IOCTL_IOC_COUNT	(AUTOFS_IOC_COUNT - 11)

#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/time.h>
#include <linux/string.h>
#include <linux/wait.h>
#include <linux/sched.h>
#include <linux/mount.h>
#include <linux/namei.h>
#include <asm/current.h>
#include <asm/uaccess.h>

/* #define DEBUG */

#ifdef DEBUG
#define DPRINTK(fmt, args...)				\
do {							\
	printk(KERN_DEBUG "pid %d: %s: " fmt "\n",	\
		current->pid, __func__, ##args);	\
} while (0)
#else
#define DPRINTK(fmt, args...) do {} while (0)
#endif

#define AUTOFS_WARN(fmt, args...)			\
do {							\
	printk(KERN_WARNING "pid %d: %s: " fmt "\n",	\
		current->pid, __func__, ##args);	\
} while (0)

#define AUTOFS_ERROR(fmt, args...)			\
do {							\
	printk(KERN_ERR "pid %d: %s: " fmt "\n",	\
		current->pid, __func__, ##args);	\
} while (0)

extern spinlock_t autofs4_lock;

/* Unified info structure.  This is pointed to by both the dentry and
   inode structures.  Each file in the filesystem has an instance of this
   structure.  It holds a reference to the dentry, so dentries are never
   flushed while the file exists.  All name lookups are dealt with at the
   dentry level, although the filesystem can interfere in the validation
   process.  Readdir is implemented by traversing the dentry lists. */
struct autofs_info {
	struct dentry	*dentry;
	struct inode	*inode;

	int		flags;

	struct completion expire_complete;

	struct list_head active;
	int active_count;

	struct list_head expiring;

	struct autofs_sb_info *sbi;
	unsigned long last_used;
	atomic_t count;

	uid_t uid;
	gid_t gid;

	mode_t	mode;
	size_t	size;

	void (*free)(struct autofs_info *);
	union {
		const char *symlink;
	} u;
};

#define AUTOFS_INF_EXPIRING	(1<<0) /* dentry is in the process of expiring */
#define AUTOFS_INF_MOUNTPOINT	(1<<1) /* mountpoint status for direct expire */
#define AUTOFS_INF_PENDING	(1<<2) /* dentry pending mount */

struct autofs_wait_queue {
	wait_queue_head_t queue;
	struct autofs_wait_queue *next;
	autofs_wqt_t wait_queue_token;
	/* We use the following to see what we are waiting for */
	struct qstr name;
	u32 dev;
	u64 ino;
	uid_t uid;
	gid_t gid;
	pid_t pid;
	pid_t tgid;
	/* This is for status reporting upon return */
	int status;
	unsigned int wait_ctr;
};

#define AUTOFS_SBI_MAGIC 0x6d4a556d

struct autofs_sb_info {
	u32 magic;
	int pipefd;
	struct file *pipe;
	pid_t oz_pgrp;
	int catatonic;
	int version;
	int sub_version;
	int min_proto;
	int max_proto;
	unsigned long exp_timeout;
	unsigned int type;
	int reghost_enabled;
	int needs_reghost;
	struct super_block *sb;
	struct mutex wq_mutex;
	spinlock_t fs_lock;
	struct autofs_wait_queue *queues; /* Wait queue pointer */
	spinlock_t lookup_lock;
	struct list_head active_list;
	struct list_head expiring_list;
};

static inline struct autofs_sb_info *autofs4_sbi(struct super_block *sb)
{
	return (struct autofs_sb_info *)(sb->s_fs_info);
}

static inline struct autofs_info *autofs4_dentry_ino(struct dentry *dentry)
{
	return (struct autofs_info *)(dentry->d_fsdata);
}

/* autofs4_oz_mode(): do we see the man behind the curtain?  (The
   processes which do manipulations for us in user space sees the raw
   filesystem without "magic".) */

static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
	return sbi->catatonic || task_pgrp_nr(current) == sbi->oz_pgrp;
}

/* Does a dentry have some pending activity? */
static inline int autofs4_ispending(struct dentry *dentry)
{
	struct autofs_info *inf = autofs4_dentry_ino(dentry);

	if (inf->flags & AUTOFS_INF_PENDING)
		return 1;

	if (inf->flags & AUTOFS_INF_EXPIRING)
		return 1;

	return 0;
}

static inline void autofs4_copy_atime(struct file *src, struct file *dst)
{
	dst->f_path.dentry->d_inode->i_atime =
		src->f_path.dentry->d_inode->i_atime;
	return;
}

struct inode *autofs4_get_inode(struct super_block *, struct autofs_info *);
void autofs4_free_ino(struct autofs_info *);

/* Expiration */
int is_autofs4_dentry(struct dentry *);
int autofs4_expire_wait(struct dentry *dentry);
int autofs4_expire_run(struct super_block *, struct vfsmount *,
			struct autofs_sb_info *,
			struct autofs_packet_expire __user *);
int autofs4_do_expire_multi(struct super_block *sb, struct vfsmount *mnt,
			    struct autofs_sb_info *sbi, int when);
int autofs4_expire_multi(struct super_block *, struct vfsmount *,
			struct autofs_sb_info *, int __user *);
struct dentry *autofs4_expire_direct(struct super_block *sb,
				     struct vfsmount *mnt,
				     struct autofs_sb_info *sbi, int how);
struct dentry *autofs4_expire_indirect(struct super_block *sb,
				       struct vfsmount *mnt,
				       struct autofs_sb_info *sbi, int how);

/* Device node initialization */

int autofs_dev_ioctl_init(void);
void autofs_dev_ioctl_exit(void);

/* Operations structures */

extern const struct inode_operations autofs4_symlink_inode_operations;
extern const struct inode_operations autofs4_dir_inode_operations;
extern const struct inode_operations autofs4_root_inode_operations;
extern const struct inode_operations autofs4_indirect_root_inode_operations;
extern const struct inode_operations autofs4_direct_root_inode_operations;
extern const struct file_operations autofs4_dir_operations;
extern const struct file_operations autofs4_root_operations;

/* Initializing function */

int autofs4_fill_super(struct super_block *, void *, int);
struct autofs_info *autofs4_init_ino(struct autofs_info *, struct autofs_sb_info *sbi, mode_t mode);

/* Queue management functions */

int autofs4_wait(struct autofs_sb_info *,struct dentry *, enum autofs_notify);
int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
void autofs4_catatonic_mode(struct autofs_sb_info *);

static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
{
	return new_encode_dev(sbi->sb->s_dev);
}

static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
{
	return sbi->sb->s_root->d_inode->i_ino;
}

static inline int simple_positive(struct dentry *dentry)
{
	return dentry->d_inode && !d_unhashed(dentry);
}

static inline void __autofs4_add_expiring(struct dentry *dentry)
{
	struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
	struct autofs_info *ino = autofs4_dentry_ino(dentry);
	if (ino) {
		if (list_empty(&ino->expiring))
			list_add(&ino->expiring, &sbi->expiring_list);
	}
	return;
}

static inline void autofs4_add_expiring(struct dentry *dentry)
{
	struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
	struct autofs_info *ino = autofs4_dentry_ino(dentry);
	if (ino) {
		spin_lock(&sbi->lookup_lock);
		if (list_empty(&ino->expiring))
			list_add(&ino->expiring, &sbi->expiring_list);
		spin_unlock(&sbi->lookup_lock);
	}
	return;
}

static inline void autofs4_del_expiring(struct dentry *dentry)
{
	struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
	struct autofs_info *ino = autofs4_dentry_ino(dentry);
	if (ino) {
		spin_lock(&sbi->lookup_lock);
		if (!list_empty(&ino->expiring))
			list_del_init(&ino->expiring);
		spin_unlock(&sbi->lookup_lock);
	}
	return;
}

void autofs4_dentry_release(struct dentry *);
extern void autofs4_kill_sb(struct super_block *);
Commit	Line	Data
1da177e4 LT	1	/* -- c -- ------------------------------------------------------------- *
	2	*
	3	* linux/fs/autofs/autofs_i.h
	4	*
	5	* Copyright 1997-1998 Transmeta Corporation - All Rights Reserved
34ca959c	6	* Copyright 2005-2006 Ian Kent <raven@themaw.net>
1da177e4 LT	7	*
	8	* This file is part of the Linux kernel and is made available under
	9	* the terms of the GNU General Public License, version 2, or at your
	10	* option, any later version, incorporated herein by reference.
	11	*
	12	* ----------------------------------------------------------------------- */
	13
	14	/* Internal header file for autofs */
	15
	16	#include <linux/auto_fs4.h>
8d7b48e0	17	#include <linux/auto_dev-ioctl.h>
1d5599e3	18	#include <linux/mutex.h>
b5c84bf6	19	#include <linux/spinlock.h>
1da177e4 LT	20	#include <linux/list.h>
	21
	22	/* This is the range of ioctl() numbers we claim as ours */
	23	#define AUTOFS_IOC_FIRST AUTOFS_IOC_READY
	24	#define AUTOFS_IOC_COUNT 32
	25
8d7b48e0 IK	26	#define AUTOFS_DEV_IOCTL_IOC_FIRST (AUTOFS_DEV_IOCTL_VERSION)
	27	#define AUTOFS_DEV_IOCTL_IOC_COUNT (AUTOFS_IOC_COUNT - 11)
	28
1da177e4 LT	29	#include <linux/kernel.h>
	30	#include <linux/slab.h>
	31	#include <linux/time.h>
	32	#include <linux/string.h>
	33	#include <linux/wait.h>
	34	#include <linux/sched.h>
	35	#include <linux/mount.h>
	36	#include <linux/namei.h>
	37	#include <asm/current.h>
	38	#include <asm/uaccess.h>
	39
	40	/* #define DEBUG */
	41
	42	#ifdef DEBUG
8d7b48e0 IK	43	#define DPRINTK(fmt, args...) \
	44	do { \
	45	printk(KERN_DEBUG "pid %d: %s: " fmt "\n", \
	46	current->pid, __func__, ##args); \
	47	} while (0)
1da177e4	48	#else
8d7b48e0	49	#define DPRINTK(fmt, args...) do {} while (0)
1da177e4 LT	50	#endif
1da177e4 LT	51
8d7b48e0 IK	52	#define AUTOFS_WARN(fmt, args...) \
	53	do { \
	54	printk(KERN_WARNING "pid %d: %s: " fmt "\n", \
	55	current->pid, __func__, ##args); \
	56	} while (0)
	57
	58	#define AUTOFS_ERROR(fmt, args...) \
	59	do { \
	60	printk(KERN_ERR "pid %d: %s: " fmt "\n", \
	61	current->pid, __func__, ##args); \
	62	} while (0)
	63
b5c84bf6 NP	64	extern spinlock_t autofs4_lock;
b5c84bf6 NP	65
1da177e4 LT	66	/* Unified info structure. This is pointed to by both the dentry and
	67	inode structures. Each file in the filesystem has an instance of this
	68	structure. It holds a reference to the dentry, so dentries are never
	69	flushed while the file exists. All name lookups are dealt with at the
	70	dentry level, although the filesystem can interfere in the validation
	71	process. Readdir is implemented by traversing the dentry lists. */
	72	struct autofs_info {
	73	struct dentry *dentry;
	74	struct inode *inode;
	75
	76	int flags;
	77
6e60a9ab IK	78	struct completion expire_complete;
6e60a9ab IK	79
25767378	80	struct list_head active;
4f8427d1 IK	81	int active_count;
4f8427d1 IK	82
5f6f4f28	83	struct list_head expiring;
f50b6f86	84
1da177e4 LT	85	struct autofs_sb_info *sbi;
1da177e4 LT	86	unsigned long last_used;
1aff3c8b	87	atomic_t count;
1da177e4	88
c0f54d3e IK	89	uid_t uid;
	90	gid_t gid;
	91
1da177e4 LT	92	mode_t mode;
	93	size_t size;
	94
	95	void (free)(struct autofs_info );
	96	union {
	97	const char *symlink;
	98	} u;
	99	};
	100
	101	#define AUTOFS_INF_EXPIRING (1<<0) /* dentry is in the process of expiring */
6e60a9ab	102	#define AUTOFS_INF_MOUNTPOINT (1<<1) /* mountpoint status for direct expire */
aa952eb2	103	#define AUTOFS_INF_PENDING (1<<2) /* dentry pending mount */
1da177e4 LT	104
	105	struct autofs_wait_queue {
	106	wait_queue_head_t queue;
	107	struct autofs_wait_queue *next;
	108	autofs_wqt_t wait_queue_token;
	109	/* We use the following to see what we are waiting for */
70b52a0a	110	struct qstr name;
5c0a32fc IK	111	u32 dev;
	112	u64 ino;
	113	uid_t uid;
	114	gid_t gid;
	115	pid_t pid;
	116	pid_t tgid;
1da177e4 LT	117	/* This is for status reporting upon return */
1da177e4 LT	118	int status;
296f7bf7	119	unsigned int wait_ctr;
1da177e4 LT	120	};
	121
	122	#define AUTOFS_SBI_MAGIC 0x6d4a556d
	123
	124	struct autofs_sb_info {
	125	u32 magic;
d7c4a5f1	126	int pipefd;
1da177e4 LT	127	struct file *pipe;
	128	pid_t oz_pgrp;
	129	int catatonic;
	130	int version;
	131	int sub_version;
d7c4a5f1 IK	132	int min_proto;
d7c4a5f1 IK	133	int max_proto;
1da177e4	134	unsigned long exp_timeout;
34ca959c	135	unsigned int type;
1da177e4 LT	136	int reghost_enabled;
	137	int needs_reghost;
	138	struct super_block *sb;
1d5599e3	139	struct mutex wq_mutex;
3a9720ce	140	spinlock_t fs_lock;
1da177e4	141	struct autofs_wait_queue queues; / Wait queue pointer */
5f6f4f28	142	spinlock_t lookup_lock;
25767378	143	struct list_head active_list;
5f6f4f28	144	struct list_head expiring_list;
1da177e4 LT	145	};
	146
	147	static inline struct autofs_sb_info autofs4_sbi(struct super_block sb)
	148	{
	149	return (struct autofs_sb_info *)(sb->s_fs_info);
	150	}
	151
	152	static inline struct autofs_info autofs4_dentry_ino(struct dentry dentry)
	153	{
	154	return (struct autofs_info *)(dentry->d_fsdata);
	155	}
	156
	157	/* autofs4_oz_mode(): do we see the man behind the curtain? (The
	158	processes which do manipulations for us in user space sees the raw
	159	filesystem without "magic".) */
	160
	161	static inline int autofs4_oz_mode(struct autofs_sb_info *sbi) {
a47afb0f	162	return sbi->catatonic \|\| task_pgrp_nr(current) == sbi->oz_pgrp;
1da177e4 LT	163	}
	164
	165	/* Does a dentry have some pending activity? */
	166	static inline int autofs4_ispending(struct dentry *dentry)
	167	{
	168	struct autofs_info *inf = autofs4_dentry_ino(dentry);
	169
aa952eb2	170	if (inf->flags & AUTOFS_INF_PENDING)
3a9720ce IK	171	return 1;
3a9720ce IK	172
97e7449a IK	173	if (inf->flags & AUTOFS_INF_EXPIRING)
97e7449a IK	174	return 1;
3a9720ce	175
97e7449a	176	return 0;
1da177e4 LT	177	}
	178
	179	static inline void autofs4_copy_atime(struct file src, struct file dst)
	180	{
a4669ed8 JJS	181	dst->f_path.dentry->d_inode->i_atime =
a4669ed8 JJS	182	src->f_path.dentry->d_inode->i_atime;
1da177e4 LT	183	return;
	184	}
	185
	186	struct inode autofs4_get_inode(struct super_block , struct autofs_info *);
	187	void autofs4_free_ino(struct autofs_info *);
	188
	189	/* Expiration */
	190	int is_autofs4_dentry(struct dentry *);
06a35985	191	int autofs4_expire_wait(struct dentry *dentry);
1da177e4 LT	192	int autofs4_expire_run(struct super_block , struct vfsmount ,
	193	struct autofs_sb_info *,
	194	struct autofs_packet_expire __user *);
56fcef75 IK	195	int autofs4_do_expire_multi(struct super_block sb, struct vfsmount mnt,
56fcef75 IK	196	struct autofs_sb_info *sbi, int when);
1da177e4 LT	197	int autofs4_expire_multi(struct super_block , struct vfsmount ,
1da177e4 LT	198	struct autofs_sb_info , int __user );
8d7b48e0 IK	199	struct dentry autofs4_expire_direct(struct super_block sb,
	200	struct vfsmount *mnt,
	201	struct autofs_sb_info *sbi, int how);
	202	struct dentry autofs4_expire_indirect(struct super_block sb,
	203	struct vfsmount *mnt,
	204	struct autofs_sb_info *sbi, int how);
	205
	206	/* Device node initialization */
	207
	208	int autofs_dev_ioctl_init(void);
	209	void autofs_dev_ioctl_exit(void);
1da177e4 LT	210
	211	/* Operations structures */
	212
754661f1 AV	213	extern const struct inode_operations autofs4_symlink_inode_operations;
	214	extern const struct inode_operations autofs4_dir_inode_operations;
	215	extern const struct inode_operations autofs4_root_inode_operations;
	216	extern const struct inode_operations autofs4_indirect_root_inode_operations;
	217	extern const struct inode_operations autofs4_direct_root_inode_operations;
4b6f5d20 AV	218	extern const struct file_operations autofs4_dir_operations;
4b6f5d20 AV	219	extern const struct file_operations autofs4_root_operations;
1da177e4 LT	220
	221	/* Initializing function */
	222
	223	int autofs4_fill_super(struct super_block , void , int);
	224	struct autofs_info autofs4_init_ino(struct autofs_info , struct autofs_sb_info *sbi, mode_t mode);
	225
	226	/* Queue management functions */
	227
1da177e4 LT	228	int autofs4_wait(struct autofs_sb_info ,struct dentry , enum autofs_notify);
	229	int autofs4_wait_release(struct autofs_sb_info *,autofs_wqt_t,int);
	230	void autofs4_catatonic_mode(struct autofs_sb_info *);
	231
5c0a32fc IK	232	static inline u32 autofs4_get_dev(struct autofs_sb_info *sbi)
	233	{
	234	return new_encode_dev(sbi->sb->s_dev);
	235	}
	236
	237	static inline u64 autofs4_get_ino(struct autofs_sb_info *sbi)
	238	{
	239	return sbi->sb->s_root->d_inode->i_ino;
	240	}
	241
1da177e4 LT	242	static inline int simple_positive(struct dentry *dentry)
	243	{
	244	return dentry->d_inode && !d_unhashed(dentry);
	245	}
	246
2fd6b7f5 NP	247	static inline void __autofs4_add_expiring(struct dentry *dentry)
	248	{
	249	struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
	250	struct autofs_info *ino = autofs4_dentry_ino(dentry);
	251	if (ino) {
	252	if (list_empty(&ino->expiring))
	253	list_add(&ino->expiring, &sbi->expiring_list);
	254	}
	255	return;
	256	}
	257
c4cd70b3 IK	258	static inline void autofs4_add_expiring(struct dentry *dentry)
	259	{
	260	struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
	261	struct autofs_info *ino = autofs4_dentry_ino(dentry);
	262	if (ino) {
	263	spin_lock(&sbi->lookup_lock);
	264	if (list_empty(&ino->expiring))
	265	list_add(&ino->expiring, &sbi->expiring_list);
	266	spin_unlock(&sbi->lookup_lock);
	267	}
	268	return;
	269	}
	270
	271	static inline void autofs4_del_expiring(struct dentry *dentry)
	272	{
	273	struct autofs_sb_info *sbi = autofs4_sbi(dentry->d_sb);
	274	struct autofs_info *ino = autofs4_dentry_ino(dentry);
	275	if (ino) {
	276	spin_lock(&sbi->lookup_lock);
	277	if (!list_empty(&ino->expiring))
	278	list_del_init(&ino->expiring);
	279	spin_unlock(&sbi->lookup_lock);
	280	}
	281	return;
	282	}
	283
f5b95ff0	284	void autofs4_dentry_release(struct dentry *);
6ce31523	285	extern void autofs4_kill_sb(struct super_block *);