[linux-block.git] / include / linux / posix_acl.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
  File: linux/posix_acl.h

  (C) 2002 Andreas Gruenbacher, <a.gruenbacher@computer.org>
*/


#ifndef __LINUX_POSIX_ACL_H
#define __LINUX_POSIX_ACL_H

#include <linux/bug.h>
#include <linux/slab.h>
#include <linux/rcupdate.h>
#include <linux/refcount.h>
#include <uapi/linux/posix_acl.h>

struct user_namespace;

struct posix_acl_entry {
	short			e_tag;
	unsigned short		e_perm;
	union {
		kuid_t		e_uid;
		kgid_t		e_gid;
	};
};

struct posix_acl {
	refcount_t		a_refcount;
	struct rcu_head		a_rcu;
	unsigned int		a_count;
	struct posix_acl_entry	a_entries[];
};

#define FOREACH_ACL_ENTRY(pa, acl, pe) \
	for(pa=(acl)->a_entries, pe=pa+(acl)->a_count; pa<pe; pa++)


/*
 * Duplicate an ACL handle.
 */
static inline struct posix_acl *
posix_acl_dup(struct posix_acl *acl)
{
	if (acl)
		refcount_inc(&acl->a_refcount);
	return acl;
}

/*
 * Free an ACL handle.
 */
static inline void
posix_acl_release(struct posix_acl *acl)
{
	if (acl && refcount_dec_and_test(&acl->a_refcount))
		kfree_rcu(acl, a_rcu);
}


/* posix_acl.c */

extern void posix_acl_init(struct posix_acl *, int);
extern struct posix_acl *posix_acl_alloc(int, gfp_t);
extern struct posix_acl *posix_acl_from_mode(umode_t, gfp_t);
extern int posix_acl_equiv_mode(const struct posix_acl *, umode_t *);
extern int __posix_acl_create(struct posix_acl **, gfp_t, umode_t *);
extern int __posix_acl_chmod(struct posix_acl **, gfp_t, umode_t);

extern struct posix_acl *get_posix_acl(struct inode *, int);
int set_posix_acl(struct mnt_idmap *, struct dentry *, int,
		  struct posix_acl *);

struct posix_acl *get_cached_acl_rcu(struct inode *inode, int type);
struct posix_acl *posix_acl_clone(const struct posix_acl *acl, gfp_t flags);

#ifdef CONFIG_FS_POSIX_ACL
int posix_acl_chmod(struct mnt_idmap *, struct dentry *, umode_t);
extern int posix_acl_create(struct inode *, umode_t *, struct posix_acl **,
		struct posix_acl **);
int posix_acl_update_mode(struct mnt_idmap *, struct inode *, umode_t *,
			  struct posix_acl **);

int simple_set_acl(struct mnt_idmap *, struct dentry *,
		   struct posix_acl *, int);
extern int simple_acl_create(struct inode *, struct inode *);

struct posix_acl *get_cached_acl(struct inode *inode, int type);
void set_cached_acl(struct inode *inode, int type, struct posix_acl *acl);
void forget_cached_acl(struct inode *inode, int type);
void forget_all_cached_acls(struct inode *inode);
int posix_acl_valid(struct user_namespace *, const struct posix_acl *);
int posix_acl_permission(struct mnt_idmap *, struct inode *,
			 const struct posix_acl *, int);

static inline void cache_no_acl(struct inode *inode)
{
	inode->i_acl = NULL;
	inode->i_default_acl = NULL;
}

int vfs_set_acl(struct mnt_idmap *idmap, struct dentry *dentry,
		const char *acl_name, struct posix_acl *kacl);
struct posix_acl *vfs_get_acl(struct mnt_idmap *idmap,
			      struct dentry *dentry, const char *acl_name);
int vfs_remove_acl(struct mnt_idmap *idmap, struct dentry *dentry,
		   const char *acl_name);
int posix_acl_listxattr(struct inode *inode, char **buffer,
			ssize_t *remaining_size);
#else
static inline int posix_acl_chmod(struct mnt_idmap *idmap,
				  struct dentry *dentry, umode_t mode)
{
	return 0;
}

#define simple_set_acl		NULL

static inline int simple_acl_create(struct inode *dir, struct inode *inode)
{
	return 0;
}
static inline void cache_no_acl(struct inode *inode)
{
}

static inline int posix_acl_create(struct inode *inode, umode_t *mode,
		struct posix_acl **default_acl, struct posix_acl **acl)
{
	*default_acl = *acl = NULL;
	return 0;
}

static inline void forget_all_cached_acls(struct inode *inode)
{
}

static inline int vfs_set_acl(struct mnt_idmap *idmap,
			      struct dentry *dentry, const char *name,
			      struct posix_acl *acl)
{
	return -EOPNOTSUPP;
}

static inline struct posix_acl *vfs_get_acl(struct mnt_idmap *idmap,
					    struct dentry *dentry,
					    const char *acl_name)
{
	return ERR_PTR(-EOPNOTSUPP);
}

static inline int vfs_remove_acl(struct mnt_idmap *idmap,
				 struct dentry *dentry, const char *acl_name)
{
	return -EOPNOTSUPP;
}
static inline int posix_acl_listxattr(struct inode *inode, char **buffer,
				      ssize_t *remaining_size)
{
	return 0;
}
#endif /* CONFIG_FS_POSIX_ACL */

struct posix_acl *get_inode_acl(struct inode *inode, int type);

#endif  /* __LINUX_POSIX_ACL_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	File: linux/posix_acl.h
	4
	5	(C) 2002 Andreas Gruenbacher, <a.gruenbacher@computer.org>
	6	*/
	7
	8
	9	#ifndef __LINUX_POSIX_ACL_H
	10	#define __LINUX_POSIX_ACL_H
	11
187f1882	12	#include <linux/bug.h>
1da177e4	13	#include <linux/slab.h>
3567866b	14	#include <linux/rcupdate.h>
66717260	15	#include <linux/refcount.h>
bc8bcf3b	16	#include <uapi/linux/posix_acl.h>
1da177e4	17
47291baa CB	18	struct user_namespace;
47291baa CB	19
1da177e4 LT	20	struct posix_acl_entry {
	21	short e_tag;
	22	unsigned short e_perm;
2f6f0654 EB	23	union {
	24	kuid_t e_uid;
	25	kgid_t e_gid;
2f6f0654	26	};
1da177e4 LT	27	};
	28
	29	struct posix_acl {
66717260	30	refcount_t a_refcount;
6d4e56ce	31	struct rcu_head a_rcu;
1da177e4	32	unsigned int a_count;
70f1451e	33	struct posix_acl_entry a_entries[];
1da177e4 LT	34	};
	35
	36	#define FOREACH_ACL_ENTRY(pa, acl, pe) \
	37	for(pa=(acl)->a_entries, pe=pa+(acl)->a_count; pa<pe; pa++)
	38
	39
	40	/*
	41	* Duplicate an ACL handle.
	42	*/
	43	static inline struct posix_acl *
	44	posix_acl_dup(struct posix_acl *acl)
	45	{
	46	if (acl)
66717260	47	refcount_inc(&acl->a_refcount);
1da177e4 LT	48	return acl;
	49	}
	50
	51	/*
	52	* Free an ACL handle.
	53	*/
	54	static inline void
	55	posix_acl_release(struct posix_acl *acl)
	56	{
66717260	57	if (acl && refcount_dec_and_test(&acl->a_refcount))
3567866b	58	kfree_rcu(acl, a_rcu);
1da177e4 LT	59	}
	60
	61
	62	/* posix_acl.c */
	63
f61f6da0	64	extern void posix_acl_init(struct posix_acl *, int);
dd0fc66f	65	extern struct posix_acl *posix_acl_alloc(int, gfp_t);
3a5fba19	66	extern struct posix_acl *posix_acl_from_mode(umode_t, gfp_t);
d6952123	67	extern int posix_acl_equiv_mode(const struct posix_acl , umode_t );
37bc1539	68	extern int __posix_acl_create(struct posix_acl *, gfp_t, umode_t );
5bf3258f	69	extern int __posix_acl_chmod(struct posix_acl **, gfp_t, umode_t);
1da177e4 LT	70
1da177e4 LT	71	extern struct posix_acl get_posix_acl(struct inode , int);
13e83a49	72	int set_posix_acl(struct mnt_idmap , struct dentry , int,
138060ba	73	struct posix_acl *);
1da177e4	74
332f606b	75	struct posix_acl get_cached_acl_rcu(struct inode inode, int type);
8043bffd	76	struct posix_acl posix_acl_clone(const struct posix_acl acl, gfp_t flags);
332f606b	77
641cf4a6	78	#ifdef CONFIG_FS_POSIX_ACL
13e83a49	79	int posix_acl_chmod(struct mnt_idmap , struct dentry , umode_t);
37bc1539 CH	80	extern int posix_acl_create(struct inode , umode_t , struct posix_acl **,
37bc1539 CH	81	struct posix_acl **);
700b7940	82	int posix_acl_update_mode(struct mnt_idmap , struct inode , umode_t *,
e65ce2a5	83	struct posix_acl **);
5bf3258f	84
13e83a49	85	int simple_set_acl(struct mnt_idmap , struct dentry ,
138060ba	86	struct posix_acl *, int);
feda821e CH	87	extern int simple_acl_create(struct inode , struct inode );
feda821e CH	88
0afaa120	89	struct posix_acl get_cached_acl(struct inode inode, int type);
0afaa120 AM	90	void set_cached_acl(struct inode inode, int type, struct posix_acl acl);
	91	void forget_cached_acl(struct inode *inode, int type);
	92	void forget_all_cached_acls(struct inode *inode);
47291baa	93	int posix_acl_valid(struct user_namespace , const struct posix_acl );
700b7940	94	int posix_acl_permission(struct mnt_idmap , struct inode ,
47291baa	95	const struct posix_acl *, int);
72c04902 AV	96
	97	static inline void cache_no_acl(struct inode *inode)
	98	{
72c04902 AV	99	inode->i_acl = NULL;
72c04902 AV	100	inode->i_default_acl = NULL;
72c04902	101	}
e4cc9163	102
13e83a49	103	int vfs_set_acl(struct mnt_idmap idmap, struct dentry dentry,
e4cc9163	104	const char acl_name, struct posix_acl kacl);
77435322	105	struct posix_acl vfs_get_acl(struct mnt_idmap idmap,
4f353ba4	106	struct dentry dentry, const char acl_name);
13e83a49	107	int vfs_remove_acl(struct mnt_idmap idmap, struct dentry dentry,
aeb7f005	108	const char *acl_name);
f2620f16 CB	109	int posix_acl_listxattr(struct inode inode, char *buffer,
f2620f16 CB	110	ssize_t *remaining_size);
5bf3258f	111	#else
13e83a49	112	static inline int posix_acl_chmod(struct mnt_idmap *idmap,
138060ba	113	struct dentry *dentry, umode_t mode)
5bf3258f CH	114	{
	115	return 0;
	116	}
	117
feda821e CH	118	#define simple_set_acl NULL
	119
	120	static inline int simple_acl_create(struct inode dir, struct inode inode)
	121	{
	122	return 0;
	123	}
5bf3258f CH	124	static inline void cache_no_acl(struct inode *inode)
	125	{
	126	}
37bc1539 CH	127
	128	static inline int posix_acl_create(struct inode inode, umode_t mode,
	129	struct posix_acl default_acl, struct posix_acl acl)
	130	{
	131	default_acl = acl = NULL;
	132	return 0;
	133	}
013cdf10 CH	134
	135	static inline void forget_all_cached_acls(struct inode *inode)
	136	{
	137	}
e4cc9163	138
13e83a49	139	static inline int vfs_set_acl(struct mnt_idmap *idmap,
e4cc9163 CB	140	struct dentry dentry, const char name,
	141	struct posix_acl *acl)
	142	{
	143	return -EOPNOTSUPP;
	144	}
4f353ba4	145
77435322	146	static inline struct posix_acl vfs_get_acl(struct mnt_idmap idmap,
4f353ba4 CB	147	struct dentry *dentry,
	148	const char *acl_name)
	149	{
	150	return ERR_PTR(-EOPNOTSUPP);
	151	}
aeb7f005	152
13e83a49	153	static inline int vfs_remove_acl(struct mnt_idmap *idmap,
aeb7f005 CB	154	struct dentry dentry, const char acl_name)
	155	{
	156	return -EOPNOTSUPP;
	157	}
f2620f16 CB	158	static inline int posix_acl_listxattr(struct inode inode, char *buffer,
	159	ssize_t *remaining_size)
	160	{
	161	return 0;
	162	}
5bf3258f	163	#endif /* CONFIG_FS_POSIX_ACL */
72c04902	164
cac2f8b8	165	struct posix_acl get_inode_acl(struct inode inode, int type);
72c04902	166
1da177e4	167	#endif /* __LINUX_POSIX_ACL_H */