fsal_xattrs.c File Reference

#include "fsal.h"
#include "fsal_internal.h"
#include "fsal_convert.h"
#include <string.h>

Go to the source code of this file.

Classes
struct	fsal_xattr_def__
Defines
#define	XATTR_FOR_FILE   0x00000001
#define	XATTR_FOR_DIR   0x00000002
#define	XATTR_FOR_SYMLINK   0x00000004
#define	XATTR_FOR_ALL   0x0000000F
#define	XATTR_RO   0x00000100
#define	XATTR_RW   0x00000200
#define	XATTR_COUNT   1
Typedefs
typedef int(*	xattr_getfunc_t )(fsal_handle_t *, fsal_op_context_t *, caddr_t, size_t, size_t *)
typedef int(*	xattr_setfunc_t )(fsal_handle_t *, fsal_op_context_t *, caddr_t, size_t, int)
typedef int(*	xattr_printfunc_t )(caddr_t, size_t, caddr_t, size_t *)
typedef struct fsal_xattr_def__	fsal_xattr_def_t
Functions
int	get_void_attr (fsal_handle_t *p_objecthandle, fsal_op_context_t *p_context, caddr_t buffer_addr, size_t buffer_size, size_t *p_output_size)
int	do_match_type (int xattr_flag, fsal_nodetype_t obj_type)
fsal_status_t	FSAL_GetXAttrAttrs (fsal_handle_t *p_objecthandle, fsal_op_context_t *p_context, unsigned int xattr_id, fsal_attrib_list_t *p_attrs)
fsal_status_t	FSAL_ListXAttrs (fsal_handle_t *p_objecthandle, unsigned int argcookie, fsal_op_context_t *p_context, fsal_xattrent_t *xattrs_tab, unsigned int xattrs_tabsize, unsigned int *p_nb_returned, int *end_of_list)
fsal_status_t	FSAL_GetXAttrValueById (fsal_handle_t *p_objecthandle, unsigned int xattr_id, fsal_op_context_t *p_context, caddr_t buffer_addr, size_t buffer_size, size_t *p_output_size)
fsal_status_t	FSAL_GetXAttrIdByName (fsal_handle_t *p_objecthandle, const fsal_name_t *xattr_name, fsal_op_context_t *p_context, unsigned int *pxattr_id)
fsal_status_t	FSAL_GetXAttrValueByName (fsal_handle_t *p_objecthandle, const fsal_name_t *xattr_name, fsal_op_context_t *p_context, caddr_t buffer_addr, size_t buffer_size, size_t *p_output_size)
fsal_status_t	FSAL_SetXAttrValue (fsal_handle_t *p_objecthandle, const fsal_name_t *xattr_name, fsal_op_context_t *p_context, caddr_t buffer_addr, size_t buffer_size, int create)
fsal_status_t	FSAL_SetXAttrValueById (fsal_handle_t *p_objecthandle, unsigned int xattr_id, fsal_op_context_t *p_context, caddr_t buffer_addr, size_t buffer_size)
fsal_status_t	FSAL_RemoveXAttrById (fsal_handle_t *p_objecthandle, fsal_op_context_t *p_context, unsigned int xattr_id)
fsal_status_t	FSAL_RemoveXAttrByName (fsal_handle_t *p_objecthandle, fsal_op_context_t *p_context, const fsal_name_t *xattr_name)
int	FSAL_GetXattrOffsetSetable (void)

---

Define Documentation

#define XATTR_COUNT   1

Definition at line 83 of file FSAL_TEMPLATE/fsal_xattrs.c.

#define XATTR_FOR_ALL   0x0000000F

Definition at line 24 of file FSAL_TEMPLATE/fsal_xattrs.c.

#define XATTR_FOR_DIR   0x00000002

Definition at line 22 of file FSAL_TEMPLATE/fsal_xattrs.c.

#define XATTR_FOR_FILE   0x00000001

Definition at line 21 of file FSAL_TEMPLATE/fsal_xattrs.c.

#define XATTR_FOR_SYMLINK   0x00000004

Definition at line 23 of file FSAL_TEMPLATE/fsal_xattrs.c.

#define XATTR_RO   0x00000100

Definition at line 25 of file FSAL_TEMPLATE/fsal_xattrs.c.

#define XATTR_RW   0x00000200

Definition at line 26 of file FSAL_TEMPLATE/fsal_xattrs.c.

---

Typedef Documentation

typedef struct fsal_xattr_def__ fsal_xattr_def_t

typedef int(* xattr_getfunc_t)(fsal_handle_t *,fsal_op_context_t *,caddr_t,size_t,size_t *)

Definition at line 30 of file FSAL_TEMPLATE/fsal_xattrs.c.

typedef int(* xattr_printfunc_t)(caddr_t,size_t,caddr_t,size_t *)

Definition at line 42 of file FSAL_TEMPLATE/fsal_xattrs.c.

typedef int(* xattr_setfunc_t)(fsal_handle_t *,fsal_op_context_t *,caddr_t,size_t,int)

Definition at line 36 of file FSAL_TEMPLATE/fsal_xattrs.c.

---

Function Documentation

int do_match_type	(	int	xattr_flag,
		fsal_nodetype_t	obj_type
	)

Definition at line 88 of file FSAL_TEMPLATE/fsal_xattrs.c.

fsal_status_t FSAL_GetXAttrAttrs	(	fsal_handle_t *	p_objecthandle,
		fsal_op_context_t *	p_context,
		unsigned int	xattr_id,
		fsal_attrib_list_t *	p_attrs
	)

Get the attributes of an extended attribute from its index.

Parameters:

p_objecthandle	Handle of the object you want to get attribute for.
p_context	pointer to the current security context.
xattr_cookie	xattr's cookie (as returned by listxattrs).
p_attrs	xattr's attributes.

Parameters:

p_attrs

IN/OUT xattr attributes (if supported)

Definition at line 244 of file FSAL_TEMPLATE/fsal_xattrs.c.

fsal_status_t FSAL_GetXAttrIdByName	(	fsal_handle_t *	p_objecthandle,
		const fsal_name_t *	xattr_name,
		fsal_op_context_t *	p_context,
		unsigned int *	pxattr_id
	)

Get the index of an xattr based on its name

Parameters:

p_objecthandle	Handle of the object you want to get attribute for.
xattr_name	the name of the attribute to be read.
pxattr_id	found xattr_id

Returns:

ERR_FSAL_NO_ERROR if xattr_name exists, ERR_FSAL_NOENT otherwise

Definition at line 412 of file FSAL_TEMPLATE/fsal_xattrs.c.

int FSAL_GetXattrOffsetSetable

(

void

)

Definition at line 536 of file FSAL_TEMPLATE/fsal_xattrs.c.

fsal_status_t FSAL_GetXAttrValueById	(	fsal_handle_t *	p_objecthandle,
		unsigned int	xattr_id,
		fsal_op_context_t *	p_context,
		caddr_t	buffer_addr,
		size_t	buffer_size,
		size_t *	p_output_size
	)

Get the value of an extended attribute from its index.

Parameters:

p_objecthandle	Handle of the object you want to get attribute for.
xattr_name	the name of the attribute to be read.
p_context	pointer to the current security context.
buffer_addr	address of the buffer where the xattr value is to be stored.
buffer_size	size of the buffer where the xattr value is to be stored.
p_output_size	size of the data actually stored into the buffer.

Definition at line 374 of file FSAL_TEMPLATE/fsal_xattrs.c.

fsal_status_t FSAL_GetXAttrValueByName	(	fsal_handle_t *	p_objecthandle,
		const fsal_name_t *	xattr_name,
		fsal_op_context_t *	p_context,
		caddr_t	buffer_addr,
		size_t	buffer_size,
		size_t *	p_output_size
	)

Get the value of an extended attribute from its name.

Parameters:

p_objecthandle	Handle of the object you want to get attribute for.
xattr_name	the name of the attribute to be read.
p_context	pointer to the current security context.
buffer_addr	address of the buffer where the xattr value is to be stored.
buffer_size	size of the buffer where the xattr value is to be stored.
p_output_size	size of the data actually stored into the buffer.

Definition at line 454 of file FSAL_TEMPLATE/fsal_xattrs.c.

fsal_status_t FSAL_ListXAttrs	(	fsal_handle_t *	p_objecthandle,
		unsigned int	argcookie,
		fsal_op_context_t *	p_context,
		fsal_xattrent_t *	xattrs_tab,
		unsigned int	xattrs_tabsize,
		unsigned int *	p_nb_returned,
		int *	end_of_list
	)

Retrieves the list of extended attributes for an object in the filesystem.

Parameters:

p_objecthandle	Handle of the object we want to get extended attributes.
cookie	index of the next entry to be returned.
p_context	pointer to the current security context.
xattrs_tab	a table for storing extended attributes list to.
xattrs_tabsize	the maximum number of xattr entries that xattrs_tab can contain.
p_nb_returned	the number of xattr entries actually stored in xattrs_tab.
end_of_list	this boolean indicates that the end of xattrs list has been reached.

Definition at line 295 of file FSAL_TEMPLATE/fsal_xattrs.c.

fsal_status_t FSAL_RemoveXAttrById	(	fsal_handle_t *	p_objecthandle,
		fsal_op_context_t *	p_context,
		unsigned int	xattr_id
	)

Removes a xattr by Id

Parameters:

p_objecthandle	Handle of the object you want to get attribute for.
p_context	pointer to the current security context.
xattr_id	xattr's id

Definition at line 515 of file FSAL_TEMPLATE/fsal_xattrs.c.

fsal_status_t FSAL_RemoveXAttrByName	(	fsal_handle_t *	p_objecthandle,
		fsal_op_context_t *	p_context,
		const fsal_name_t *	xattr_name
	)

Removes a xattr by Name

Parameters:

p_objecthandle	Handle of the object you want to get attribute for.
p_context	pointer to the current security context.
xattr_name	xattr's name

Definition at line 529 of file FSAL_TEMPLATE/fsal_xattrs.c.

fsal_status_t FSAL_SetXAttrValue	(	fsal_handle_t *	p_objecthandle,
		const fsal_name_t *	xattr_name,
		fsal_op_context_t *	p_context,
		caddr_t	buffer_addr,
		size_t	buffer_size,
		int	create
	)

Set the value of an extended attribute.

Parameters:

p_objecthandle	Handle of the object you want to set attribute for.
xattr_name	the name of the attribute to be written.
p_context	pointer to the current security context.
buffer_addr	address of the buffer where the xattr value is stored.
buffer_size	size of the buffer where the xattr value is stored.
create	this boolean specifies if the attribute is created if it does not exist.

Definition at line 487 of file FSAL_TEMPLATE/fsal_xattrs.c.

fsal_status_t FSAL_SetXAttrValueById	(	fsal_handle_t *	p_objecthandle,
		unsigned int	xattr_id,
		fsal_op_context_t *	p_context,
		caddr_t	buffer_addr,
		size_t	buffer_size
	)

Set the value of an extended attribute by its Id.

Parameters:

p_objecthandle	Handle of the object you want to set attribute for.
xattr_id	index of the attribute to be written.
p_context	pointer to the current security context.
buffer_addr	address of the buffer where the xattr value is stored.
buffer_size	size of the buffer where the xattr value is stored.

Definition at line 498 of file FSAL_TEMPLATE/fsal_xattrs.c.

int get_void_attr	(	fsal_handle_t *	p_objecthandle,
		fsal_op_context_t *	p_context,
		caddr_t	buffer_addr,
		size_t	buffer_size,
		size_t *	p_output_size
	)

Definition at line 60 of file FSAL_TEMPLATE/fsal_xattrs.c.