[linux.git] / fs / ocfs2 / xattr.h

/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * xattr.h
 *
 * Copyright (C) 2004, 2008 Oracle.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License version 2 as published by the Free Software Foundation.
 *
 * 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.
 */

#ifndef OCFS2_XATTR_H
#define OCFS2_XATTR_H

#include <linux/init.h>
#include <linux/xattr.h>

enum ocfs2_xattr_type {
	OCFS2_XATTR_INDEX_USER = 1,
	OCFS2_XATTR_INDEX_POSIX_ACL_ACCESS,
	OCFS2_XATTR_INDEX_POSIX_ACL_DEFAULT,
	OCFS2_XATTR_INDEX_TRUSTED,
	OCFS2_XATTR_INDEX_SECURITY,
	OCFS2_XATTR_MAX
};

struct ocfs2_security_xattr_info {
	int enable;
	const char *name;
	void *value;
	size_t value_len;
};

extern const struct xattr_handler ocfs2_xattr_user_handler;
extern const struct xattr_handler ocfs2_xattr_trusted_handler;
extern const struct xattr_handler ocfs2_xattr_security_handler;
extern const struct xattr_handler *ocfs2_xattr_handlers[];

ssize_t ocfs2_listxattr(struct dentry *, char *, size_t);
int ocfs2_xattr_get_nolock(struct inode *, struct buffer_head *, int,
			   const char *, void *, size_t);
int ocfs2_xattr_set(struct inode *, int, const char *, const void *,
		    size_t, int);
int ocfs2_xattr_set_handle(handle_t *, struct inode *, struct buffer_head *,
			   int, const char *, const void *, size_t, int,
			   struct ocfs2_alloc_context *,
			   struct ocfs2_alloc_context *);
int ocfs2_has_inline_xattr_value_outside(struct inode *inode,
					 struct ocfs2_dinode *di);
int ocfs2_xattr_remove(struct inode *, struct buffer_head *);
int ocfs2_init_security_get(struct inode *, struct inode *,
			    const struct qstr *,
			    struct ocfs2_security_xattr_info *);
int ocfs2_init_security_set(handle_t *, struct inode *,
			    struct buffer_head *,
			    struct ocfs2_security_xattr_info *,
			    struct ocfs2_alloc_context *,
			    struct ocfs2_alloc_context *);
int ocfs2_calc_security_init(struct inode *,
			     struct ocfs2_security_xattr_info *,
			     int *, int *, struct ocfs2_alloc_context **);
int ocfs2_calc_xattr_init(struct inode *, struct buffer_head *,
			  umode_t, struct ocfs2_security_xattr_info *,
			  int *, int *, int *);

/*
 * xattrs can live inside an inode, as part of an external xattr block,
 * or inside an xattr bucket, which is the leaf of a tree rooted in an
 * xattr block.  Some of the xattr calls, especially the value setting
 * functions, want to treat each of these locations as equal.  Let's wrap
 * them in a structure that we can pass around instead of raw buffer_heads.
 */
struct ocfs2_xattr_value_buf {
	struct buffer_head		*vb_bh;
	ocfs2_journal_access_func	vb_access;
	struct ocfs2_xattr_value_root	*vb_xv;
};

int ocfs2_xattr_attach_refcount_tree(struct inode *inode,
				     struct buffer_head *fe_bh,
				     struct ocfs2_caching_info *ref_ci,
				     struct buffer_head *ref_root_bh,
				     struct ocfs2_cached_dealloc_ctxt *dealloc);
int ocfs2_reflink_xattrs(struct inode *old_inode,
			 struct buffer_head *old_bh,
			 struct inode *new_inode,
			 struct buffer_head *new_bh,
			 bool preserve_security);
int ocfs2_init_security_and_acl(struct inode *dir,
				struct inode *inode,
				const struct qstr *qstr);
#endif /* OCFS2_XATTR_H */
Commit	Line	Data
cf1d6c76 TY	1	/* -- mode: c; c-basic-offset: 8; --
	2	* vim: noexpandtab sw=8 ts=8 sts=0:
	3	*
	4	* xattr.h
	5	*
c3cb6827	6	* Copyright (C) 2004, 2008 Oracle. All rights reserved.
cf1d6c76 TY	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public
c3cb6827	10	* License version 2 as published by the Free Software Foundation.
cf1d6c76 TY	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
cf1d6c76 TY	16	*/
	17
	18	#ifndef OCFS2_XATTR_H
	19	#define OCFS2_XATTR_H
	20
	21	#include <linux/init.h>
	22	#include <linux/xattr.h>
	23
	24	enum ocfs2_xattr_type {
	25	OCFS2_XATTR_INDEX_USER = 1,
	26	OCFS2_XATTR_INDEX_POSIX_ACL_ACCESS,
	27	OCFS2_XATTR_INDEX_POSIX_ACL_DEFAULT,
	28	OCFS2_XATTR_INDEX_TRUSTED,
	29	OCFS2_XATTR_INDEX_SECURITY,
	30	OCFS2_XATTR_MAX
	31	};
	32
534eaddd TY	33	struct ocfs2_security_xattr_info {
534eaddd TY	34	int enable;
9548906b	35	const char *name;
534eaddd TY	36	void *value;
	37	size_t value_len;
	38	};
	39
537d81ca SH	40	extern const struct xattr_handler ocfs2_xattr_user_handler;
	41	extern const struct xattr_handler ocfs2_xattr_trusted_handler;
	42	extern const struct xattr_handler ocfs2_xattr_security_handler;
537d81ca	43	extern const struct xattr_handler *ocfs2_xattr_handlers[];
cf1d6c76	44
0030e001	45	ssize_t ocfs2_listxattr(struct dentry , char , size_t);
4e3e9d02 TY	46	int ocfs2_xattr_get_nolock(struct inode , struct buffer_head , int,
4e3e9d02 TY	47	const char , void , size_t);
0030e001 TY	48	int ocfs2_xattr_set(struct inode , int, const char , const void *,
0030e001 TY	49	size_t, int);
6c3faba4 TY	50	int ocfs2_xattr_set_handle(handle_t , struct inode , struct buffer_head *,
	51	int, const char , const void , size_t, int,
	52	struct ocfs2_alloc_context *,
	53	struct ocfs2_alloc_context *);
8b2c0dba TM	54	int ocfs2_has_inline_xattr_value_outside(struct inode *inode,
8b2c0dba TM	55	struct ocfs2_dinode *di);
0030e001	56	int ocfs2_xattr_remove(struct inode , struct buffer_head );
534eaddd	57	int ocfs2_init_security_get(struct inode , struct inode ,
2a7dba39	58	const struct qstr *,
534eaddd TY	59	struct ocfs2_security_xattr_info *);
	60	int ocfs2_init_security_set(handle_t , struct inode ,
	61	struct buffer_head *,
	62	struct ocfs2_security_xattr_info *,
	63	struct ocfs2_alloc_context *,
	64	struct ocfs2_alloc_context *);
	65	int ocfs2_calc_security_init(struct inode *,
	66	struct ocfs2_security_xattr_info *,
	67	int , int , struct ocfs2_alloc_context **);
89c38bd0	68	int ocfs2_calc_xattr_init(struct inode , struct buffer_head ,
67697cbd	69	umode_t, struct ocfs2_security_xattr_info *,
9b7895ef	70	int , int , int *);
01225596	71
2a50a743 JB	72	/*
	73	* xattrs can live inside an inode, as part of an external xattr block,
	74	* or inside an xattr bucket, which is the leaf of a tree rooted in an
	75	* xattr block. Some of the xattr calls, especially the value setting
	76	* functions, want to treat each of these locations as equal. Let's wrap
	77	* them in a structure that we can pass around instead of raw buffer_heads.
	78	*/
	79	struct ocfs2_xattr_value_buf {
	80	struct buffer_head *vb_bh;
	81	ocfs2_journal_access_func vb_access;
	82	struct ocfs2_xattr_value_root *vb_xv;
	83	};
	84
0129241e TM	85	int ocfs2_xattr_attach_refcount_tree(struct inode *inode,
	86	struct buffer_head *fe_bh,
	87	struct ocfs2_caching_info *ref_ci,
	88	struct buffer_head *ref_root_bh,
	89	struct ocfs2_cached_dealloc_ctxt *dealloc);
2999d12f TM	90	int ocfs2_reflink_xattrs(struct inode *old_inode,
	91	struct buffer_head *old_bh,
	92	struct inode *new_inode,
0fe9b66c TM	93	struct buffer_head *new_bh,
	94	bool preserve_security);
	95	int ocfs2_init_security_and_acl(struct inode *dir,
2a7dba39	96	struct inode *inode,
c25a1e06	97	const struct qstr *qstr);
cf1d6c76	98	#endif /* OCFS2_XATTR_H */