fsal_internal.h File Reference

#include <sys/types.h>
#include <sys/stat.h>
#include <sys/statvfs.h>
#include <cephfs/libcephfs.h>
#include <string.h>
#include "fsal.h"
#include "fsal_pnfs.h"

Go to the source code of this file.

Defines
#define	ReturnStatus(_st_, _f_)   Return( (_st_).major, (_st_).minor, _f_ )
Functions
fsal_status_t	fsal_internal_init_global (fsal_init_info_t *fsal_info, fs_common_initinfo_t *fs_common_info, fs_specific_initinfo_t *fs_specific_info)
void	fsal_increment_nbcall (int function_index, fsal_status_t status)
void	fsal_internal_getstats (fsal_statistics_t *output_stats)
void	TakeTokenFSCall ()
void	ReleaseTokenFSCall ()
fsal_status_t	CEPHFSAL_access (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, fsal_accessflags_t access_type, fsal_attrib_list_t *object_attributes)
fsal_status_t	CEPHFSAL_getattrs (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, fsal_attrib_list_t *object_attributes)
fsal_status_t	CEPHFSAL_setattrs (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, fsal_attrib_list_t *attrib_set, fsal_attrib_list_t *object_attributes)
fsal_status_t	CEPHFSAL_getextattrs (fsal_handle_t *p_filehandle, fsal_op_context_t *p_context, fsal_extattrib_list_t *p_object_attributes)
fsal_status_t	CEPHFSAL_BuildExportContext (fsal_export_context_t *extexport_context, fsal_path_t *export_path, char *fs_specific_options)
fsal_status_t	CEPHFSAL_CleanUpExportContext (fsal_export_context_t *export_context)
fsal_status_t	CEPHFSAL_InitClientContext (fsal_op_context_t *extcontext)
fsal_status_t	CEPHFSAL_GetClientContext (fsal_op_context_t *extcontext, fsal_export_context_t *extexport_context, fsal_uid_t uid, fsal_gid_t gid, fsal_gid_t *alt_groups, fsal_count_t nb_alt_groups)
fsal_status_t	CEPHFSAL_create (fsal_handle_t *extparent, fsal_name_t *filename, fsal_op_context_t *extcontext, fsal_accessmode_t accessmode, fsal_handle_t *object_handle, fsal_attrib_list_t *object_attributes)
fsal_status_t	CEPHFSAL_mkdir (fsal_handle_t *extparent, fsal_name_t *dirname, fsal_op_context_t *extcontext, fsal_accessmode_t accessmode, fsal_handle_t *object_handle, fsal_attrib_list_t *object_attributes)
fsal_status_t	CEPHFSAL_link (fsal_handle_t *exttarget, fsal_handle_t *extdir, fsal_name_t *link_name, fsal_op_context_t *extcontext, fsal_attrib_list_t *attributes)
fsal_status_t	CEPHFSAL_mknode (fsal_handle_t *parent, fsal_name_t *node_name, fsal_op_context_t *p_context, fsal_accessmode_t accessmode, fsal_nodetype_t nodetype, fsal_dev_t *dev, fsal_handle_t *p_object_handle, fsal_attrib_list_t *node_attributes)
fsal_status_t	CEPHFSAL_opendir (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, fsal_dir_t *extdescriptor, fsal_attrib_list_t *dir_attributes)
fsal_status_t	CEPHFSAL_readdir (fsal_dir_t *extdescriptor, fsal_cookie_t extstart, fsal_attrib_mask_t attrmask, fsal_mdsize_t buffersize, fsal_dirent_t *dirents, fsal_cookie_t *extend, fsal_count_t *count, fsal_boolean_t *end_of_dir)
fsal_status_t	CEPHFSAL_closedir (fsal_dir_t *extdescriptor)
fsal_boolean_t	fsal_is_retryable (fsal_status_t status)
fsal_status_t	CEPHFSAL_open (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, fsal_openflags_t openflags, fsal_file_t *extdescriptor, fsal_attrib_list_t *file_attributes)
fsal_status_t	CEPHFSAL_open_by_name (fsal_handle_t *exthandle, fsal_name_t *filename, fsal_op_context_t *extcontext, fsal_openflags_t openflags, fsal_file_t *extdescriptor, fsal_attrib_list_t *file_attributes)
fsal_status_t	CEPHFSAL_read (fsal_file_t *extdescriptor, fsal_seek_t *seek_descriptor, fsal_size_t buffer_size, caddr_t buffer, fsal_size_t *read_amount, fsal_boolean_t *end_of_file)
fsal_status_t	CEPHFSAL_write (fsal_file_t *extdescriptor, fsal_op_context_t *p_context, fsal_seek_t *seek_descriptor, fsal_size_t buffer_size, caddr_t buffer, fsal_size_t *write_amount)
fsal_status_t	CEPHFSAL_close (fsal_file_t *extdescriptor)
fsal_status_t	CEPHFSAL_open_by_fileid (fsal_handle_t *filehandle, fsal_u64_t fileid, fsal_op_context_t *p_context, fsal_openflags_t openflags, fsal_file_t *file_descriptor, fsal_attrib_list_t *file_attributes)
fsal_status_t	CEPHFSAL_close_by_fileid (fsal_file_t *file_descriptor, fsal_u64_t fileid)
unsigned int	CEPHFSAL_GetFileno (fsal_file_t *pfile)
fsal_status_t	CEPHFSAL_commit (fsal_file_t *extdescriptor, fsal_off_t offset, fsal_size_t size)
fsal_status_t	CEPHFSAL_static_fsinfo (fsal_handle_t *exthandle, fsal_op_context_t *context, fsal_staticfsinfo_t *staticinfo)
fsal_status_t	CEPHFSAL_dynamic_fsinfo (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, fsal_dynamicfsinfo_t *dynamicinfo)
fsal_status_t	CEPHFSAL_Init (fsal_parameter_t *init_info)
fsal_status_t	CEPHFSAL_terminate ()
fsal_status_t	CEPHFSAL_test_access (fsal_op_context_t *extcontext, fsal_accessflags_t access_type, fsal_attrib_list_t *object_attributes)
fsal_status_t	CEPHFSAL_lookup (fsal_handle_t *extparent, fsal_name_t *filename, fsal_op_context_t *extcontext, fsal_handle_t *exthandle, fsal_attrib_list_t *object_attributes)
fsal_status_t	CEPHFSAL_lookupJunction (fsal_handle_t *extjunction, fsal_op_context_t *extcontext, fsal_handle_t *extfsroot, fsal_attrib_list_t *fsroot_attributes)
fsal_status_t	CEPHFSAL_lookupPath (fsal_path_t *path, fsal_op_context_t *extcontext, fsal_handle_t *exthandle, fsal_attrib_list_t *object_attributes)
fsal_status_t	CEPHFSAL_rcp (fsal_handle_t *filehandle, fsal_op_context_t *p_context, fsal_path_t *p_local_path, fsal_rcpflag_t transfer_opt)
fsal_status_t	CEPHFSAL_rename (fsal_handle_t *extold_parent, fsal_name_t *old_name, fsal_handle_t *extnew_parent, fsal_name_t *new_name, fsal_op_context_t *extcontext, fsal_attrib_list_t *src_dir_attributes, fsal_attrib_list_t *tgt_dir_attributes)
void	CEPHFSAL_get_stats (fsal_statistics_t *stats, fsal_boolean_t reset)
fsal_status_t	CEPHFSAL_readlink (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, fsal_path_t *link_content, fsal_attrib_list_t *link_attributes)
fsal_status_t	CEPHFSAL_symlink (fsal_handle_t *extparent, fsal_name_t *linkname, fsal_path_t *linkcontent, fsal_op_context_t *extcontext, fsal_accessmode_t accessmode, fsal_handle_t *extlink, fsal_attrib_list_t *link_attributes)
int	CEPHFSAL_handlecmp (fsal_handle_t *exthandle1, fsal_handle_t *exthandle2, fsal_status_t *status)
	Compare 2 handles.
unsigned int	CEPHFSAL_Handle_to_HashIndex (fsal_handle_t *exthandle, unsigned int cookie, unsigned int alphabet_len, unsigned int index_size)
	Generate an index in the handle table.
unsigned int	CEPHFSAL_Handle_to_RBTIndex (fsal_handle_t *exthandle, unsigned int cookie)
	Generate a hash to locate the handle within a tree.
fsal_status_t	CEPHFSAL_DigestHandle (fsal_export_context_t *extexport, fsal_digesttype_t output_type, fsal_handle_t *exthandle, struct fsal_handle_desc *fh_desc)
	Create a wire level representation of an FSAL handle.
fsal_status_t	CEPHFSAL_ExpandHandle (fsal_export_context_t *extexport, fsal_digesttype_t in_type, struct fsal_handle_desc *fh_desc)
	Bring in a wire handle.
fsal_status_t	CEPHFSAL_SetDefault_FSAL_parameter (fsal_parameter_t *out_parameter)
fsal_status_t	CEPHFSAL_SetDefault_FS_common_parameter (fsal_parameter_t *out_parameter)
fsal_status_t	CEPHFSAL_SetDefault_FS_specific_parameter (fsal_parameter_t *out_parameter)
fsal_status_t	CEPHFSAL_load_FSAL_parameter_from_conf (config_file_t in_config, fsal_parameter_t *out_parameter)
fsal_status_t	CEPHFSAL_load_FS_common_parameter_from_conf (config_file_t in_config, fsal_parameter_t *out_parameter)
fsal_status_t	CEPHFSAL_load_FS_specific_parameter_from_conf (config_file_t in_config, fsal_parameter_t *out_parameter)
fsal_status_t	CEPHFSAL_truncate (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, fsal_size_t length, fsal_file_t *file_descriptor, fsal_attrib_list_t *object_attributes)
fsal_status_t	CEPHFSAL_unlink (fsal_handle_t *extparent, fsal_name_t *name, fsal_op_context_t *extcontext, fsal_attrib_list_t *parentdir_attributes)
fsal_status_t	CEPHFSAL_GetXAttrAttrs (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, unsigned int xattr_id, fsal_attrib_list_t *attrs)
fsal_status_t	CEPHFSAL_ListXAttrs (fsal_handle_t *exthandle, unsigned int cookie, fsal_op_context_t *extcontext, fsal_xattrent_t *xattrs_tab, unsigned int xattrs_tabsize, unsigned int *p_nb_returned, int *end_of_list)
fsal_status_t	CEPHFSAL_GetXAttrValueById (fsal_handle_t *exthandle, unsigned int xattr_id, fsal_op_context_t *extcontext, caddr_t buffer_addr, size_t buffer_size, size_t *p_output_size)
fsal_status_t	CEPHFSAL_GetXAttrIdByName (fsal_handle_t *exthandle, const fsal_name_t *xattr_name, fsal_op_context_t *extcontext, unsigned int *pxattr_id)
fsal_status_t	CEPHFSAL_GetXAttrValueByName (fsal_handle_t *exthandle, const fsal_name_t *xattr_name, fsal_op_context_t *extcontext, caddr_t buffer_addr, size_t buffer_size, size_t *p_output_size)
fsal_status_t	CEPHFSAL_SetXAttrValue (fsal_handle_t *exthandle, const fsal_name_t *xattr_name, fsal_op_context_t *extcontext, caddr_t buffer_addr, size_t buffer_size, int create)
fsal_status_t	CEPHFSAL_SetXAttrValueById (fsal_handle_t *exthandle, unsigned int xattr_id, fsal_op_context_t *extcontext, caddr_t buffer_addr, size_t buffer_size)
fsal_status_t	CEPHFSAL_RemoveXAttrById (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, unsigned int xattr_id)
fsal_status_t	CEPHFSAL_RemoveXAttrByName (fsal_handle_t *exthandle, fsal_op_context_t *extcontext, const fsal_name_t *xattr_name)
char *	CEPHFSAL_GetFSName ()
fsal_status_t	fsal_internal_testAccess (cephfsal_op_context_t *context, fsal_accessflags_t access_type, struct stat *st, fsal_attrib_list_t *object_attributes)
Variables
fsal_staticfsinfo_t	global_fs_info
cephfs_specific_initinfo_t	global_spec_info

---

Define Documentation

#define ReturnStatus	(		_st_,
			_f_
	)		Return( (_st_).major, (_st_).minor, _f_ )

Definition at line 46 of file FSAL_CEPH/fsal_internal.h.

---

Function Documentation

fsal_status_t CEPHFSAL_access	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		fsal_accessflags_t	access_type,
		fsal_attrib_list_t *	object_attributes
	)

FSAL_access : Tests whether the user or entity identified by the context structure can access the object identified by filehandle as indicated by the access_type parameter.

Parameters:

filehandle	(input): The handle of the object to test permissions on.
context	(input): Authentication context for the operation (export entry, user,...).
access_type	(input): Indicates the permissions to be tested. This is an inclusive OR of the permissions to be checked for the user specified by context. Permissions constants are : FSAL_R_OK : test for read permission FSAL_W_OK : test for write permission FSAL_X_OK : test for exec permission FSAL_F_OK : test for file existence
object_attributes	(optional input/output): The post operation attributes for the object. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). Can be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error, asked permission is granted)
• ERR_FSAL_ACCESS (object permissions doesn't fit asked access type)
• ERR_FSAL_STALE (object_handle does not address an existing object)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes when something anormal occurs.

Definition at line 77 of file FSAL_CEPH/fsal_access.c.

fsal_status_t CEPHFSAL_close

(

fsal_file_t *

extdescriptor

)

FSAL_close: Free the resources allocated by the FSAL_open call.

Parameters:

file_descriptor

(input): The file descriptor returned by FSAL_open.

Returns:

Major error codes:

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ...

Definition at line 365 of file FSAL_CEPH/fsal_fileop.c.

fsal_status_t CEPHFSAL_close_by_fileid	(	fsal_file_t *	file_descriptor,
		fsal_u64_t	fileid
	)

fsal_status_t CEPHFSAL_closedir

(

fsal_dir_t *

extdescriptor

)

FSAL_closedir : Free the resources allocated for reading directory entries.

Parameters:

dir_descriptor

(input): Pointer to a directory descriptor filled by FSAL_opendir.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ...

Definition at line 254 of file FSAL_CEPH/fsal_dirs.c.

fsal_status_t CEPHFSAL_commit	(	fsal_file_t *	extdescriptor,
		fsal_off_t	offset,
		fsal_size_t	length
	)

FSAL_commit: This function is used for processing stable writes and COMMIT requests. Calling this function makes sure the changes to a specific file are written to disk rather than kept in memory.

Parameters:

file_descriptor	(input): The file descriptor returned by FSAL_open.
offset,:	The starting offset for the portion of file to be synced
length,:	The length for the portion of file to be synced.

Returns:

Major error codes:

• ERR_FSAL_NO_ERROR: no error.
• Another error code if an error occured during this call.

Definition at line 419 of file FSAL_CEPH/fsal_fileop.c.

fsal_status_t CEPHFSAL_create	(	fsal_handle_t *	extparent,
		fsal_name_t *	filename,
		fsal_op_context_t *	extcontext,
		fsal_accessmode_t	accessmode,
		fsal_handle_t *	object_handle,
		fsal_attrib_list_t *	object_attributes
	)

FSAL_create: Create a regular file.

Parameters:

extparent	(input): Handle of the parent directory where the file is to be created.
filename	(input): Pointer to the name of the file to be created.
context	(input): Authentication context for the operation (user, export...).
accessmode	(input): Mode for the file to be created. (the umask defined into the FSAL configuration file will be applied on it).
object_handle	(output): Pointer to the handle of the created file.
object_attributes	(optionnal input/output): The postop attributes of the created file. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). Can be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (parent_directory_handle does not address an existing object)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_EXIST, ERR_FSAL_IO, ...

NB: if getting postop attributes failed, the function does not return an error but the FSAL_ATTR_RDATTR_ERR bit is set in the object_attributes->asked_attributes field.

Definition at line 79 of file FSAL_CEPH/fsal_create.c.

fsal_status_t CEPHFSAL_DigestHandle	(	fsal_export_context_t *	extexport,
		fsal_digesttype_t	output_type,
		fsal_handle_t *	exthandle,
		struct fsal_handle_desc *	fh_desc
	)

Create a wire level representation of an FSAL handle.

Convert an fsal_handle_t to a buffer to be included into NFS handles, or another digest.

Parameters:

extexport	[in] The export context
output_type	[in] The type of digest requested
exthandle	[in] The handle to be digested
fh_desc	[out] Counted buffer to hold the handle

Returns:

Errors as appropriate

Definition at line 154 of file FSAL_CEPH/fsal_tools.c.

fsal_status_t CEPHFSAL_dynamic_fsinfo	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		fsal_dynamicfsinfo_t *	dynamicinfo
	)

FSAL_dynamic_fsinfo: Return dynamic filesystem info such as used size, free size, number of objects...

Parameters:

filehandle	(input): Handle of an object in the filesystem whom info is to be retrieved.
p_context	(input): Authentication context for the operation (user,...).
dynamicinfo	(output): Pointer to the static info of the filesystem.

Returns:

Major error codes:

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ...

Definition at line 60 of file FSAL_CEPH/fsal_fsinfo.c.

fsal_status_t CEPHFSAL_ExpandHandle	(	fsal_export_context_t *	extexport,
		fsal_digesttype_t	in_type,
		struct fsal_handle_desc *	fh_desc
	)

Bring in a wire handle.

All we do here is adjust the descriptor length based on knowing the internals of struct file_handle and let the upper level handle memcpy, hash lookup and/or compare. No copies anymore.

Parameters:

extexport	[in] The export handle
in_type	[in] The type of digest to be expanded
fh_desc	[in,out] Descriptor for buffer

Returns:

The major code is ERR_FSAL_NO_ERROR is no error occured. Else, it is a non null value.

Definition at line 223 of file FSAL_CEPH/fsal_tools.c.

void CEPHFSAL_get_stats	(	fsal_statistics_t *	stats,
		fsal_boolean_t	reset
	)

FSAL_get_stats: Retrieve call statistics for current thread.

Parameters:

stats	(output): Pointer to the call statistics structure.
reset	(input): Boolean that indicates if the stats must be reset.

Returns:

Nothing.

Definition at line 54 of file FSAL_CEPH/fsal_stats.c.

fsal_status_t CEPHFSAL_getattrs	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		fsal_attrib_list_t *	object_attributes
	)

FSAL_getattrs: Get attributes for the object specified by its filehandle.

Parameters:

filehandle	(input): The handle of the object to get parameters.
context	(input): Authentication context for the operation (user, export...).
object_attributes	(mandatory input/output): The retrieved attributes for the object. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains).

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (object_handle does not address an existing object)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Another error code if an error occured.

Definition at line 64 of file FSAL_CEPH/fsal_attrs.c.

fsal_status_t CEPHFSAL_GetClientContext	(	fsal_op_context_t *	extcontext,
		fsal_export_context_t *	extexport_context,
		fsal_uid_t	uid,
		fsal_gid_t	gid,
		fsal_gid_t *	alt_groups,
		fsal_count_t	nb_alt_groups
	)

fsal_status_t CEPHFSAL_getextattrs	(	fsal_handle_t *	p_filehandle,
		fsal_op_context_t *	p_context,
		fsal_extattrib_list_t *	p_object_attributes
	)

FSAL_getetxattrs: Get attributes for the object specified by its filehandle.

Parameters:

filehandle	(input): The handle of the object to get parameters.
cred	(input): Authentication context for the operation (user,...).
object_attributes	(mandatory input/output): The retrieved attributes for the object. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains).

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• Another error code if an error occured.

Definition at line 265 of file FSAL_CEPH/fsal_attrs.c.

unsigned int CEPHFSAL_GetFileno

(

fsal_file_t *

pfile

)

Definition at line 396 of file FSAL_CEPH/fsal_fileop.c.

char* CEPHFSAL_GetFSName

(

)

Definition at line 48 of file FSAL_CEPH/fsal_tools.c.

fsal_status_t CEPHFSAL_GetXAttrAttrs	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		unsigned int	xattr_id,
		fsal_attrib_list_t *	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.

Definition at line 53 of file FSAL_CEPH/fsal_xattrs.c.

fsal_status_t CEPHFSAL_GetXAttrIdByName	(	fsal_handle_t *	exthandle,
		const fsal_name_t *	xattr_name,
		fsal_op_context_t *	extcontext,
		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 263 of file FSAL_CEPH/fsal_xattrs.c.

fsal_status_t CEPHFSAL_GetXAttrValueById	(	fsal_handle_t *	exthandle,
		unsigned int	xattr_id,
		fsal_op_context_t *	extcontext,
		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 225 of file FSAL_CEPH/fsal_xattrs.c.

fsal_status_t CEPHFSAL_GetXAttrValueByName	(	fsal_handle_t *	exthandle,
		const fsal_name_t *	xattr_name,
		fsal_op_context_t *	extcontext,
		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 303 of file FSAL_CEPH/fsal_xattrs.c.

unsigned int CEPHFSAL_Handle_to_HashIndex	(	fsal_handle_t *	exthandle,
		unsigned int	cookie,
		unsigned int	alphabet_len,
		unsigned int	index_size
	)

Generate an index in the handle table.

This function is used for hashing a FSAL handle in order to distribute entries into the hash table array.

Parameters:

exthandle	[in] The handle to be hashed
cookie	[in] Makes it possible to have different hash value for the same handle, when cookie changes.
alphabet_len	[in] Parameter for polynomial hashing algorithm
index_size	[in] The range of hash value will be [0..index_size-1]

Returns:

The hash value

Definition at line 105 of file FSAL_CEPH/fsal_tools.c.

unsigned int CEPHFSAL_Handle_to_RBTIndex	(	fsal_handle_t *	exthandle,
		unsigned int	cookie
	)

Generate a hash to locate the handle within a tree.

This function is used for generating a RBT node ID in order to identify entries into the RBT.

Parameters:

exthandle	[in] The handle to be hashed
cookie	[in] Makes it possible to have different hash value for the same handle, when cookie changes.

Returns:

The hash value

Definition at line 131 of file FSAL_CEPH/fsal_tools.c.

int CEPHFSAL_handlecmp	(	fsal_handle_t *	exthandle1,
		fsal_handle_t *	exthandle2,
		fsal_status_t *	status
	)

Compare 2 handles.

This function compares two FSAL handles, returning 0 if they are to be considered identical.

Parameters:

handle1	[in] The first handle to be compared
handle2	[in] The second handle to be compared
status	[out] Status of the compare operation

Return values:

0	if handles are the same
Something	else if they're not

Definition at line 68 of file FSAL_CEPH/fsal_tools.c.

fsal_status_t CEPHFSAL_Init

(

fsal_parameter_t *

init_info

)

FSAL_Init : Initializes the FileSystem Abstraction Layer.

Parameters:

init_info

(input, fsal_parameter_t *) : Pointer to a structure that contains all initialization parameters for the FSAL. Specifically, it contains settings about the filesystem on which the FSAL is based, security settings, logging policy and outputs, and other general FSAL options.

Returns:

Major error codes : ERR_FSAL_NO_ERROR (initialisation OK) ERR_FSAL_FAULT (init_info pointer is null) ERR_FSAL_SERVERFAULT (misc FSAL error) ERR_FSAL_ALREADY_INIT (The FS is already initialized) ERR_FSAL_BAD_INIT (FS specific init error, minor error code gives the reason for this error.) ERR_FSAL_SEC_INIT (Security context init error).

Definition at line 61 of file FSAL_CEPH/fsal_init.c.

fsal_status_t CEPHFSAL_InitClientContext

(

fsal_op_context_t *

extcontext

)

fsal_status_t CEPHFSAL_link	(	fsal_handle_t *	exttarget,
		fsal_handle_t *	extdir,
		fsal_name_t *	link_name,
		fsal_op_context_t *	extcontext,
		fsal_attrib_list_t *	attributes
	)

FSAL_link: Create a hardlink.

Parameters:

exttarget	(input): Handle of the target object.
extdir	(input): Pointer to the directory handle where the hardlink is to be created.
link_name	(input): Pointer to the name of the hardlink to be created.
extcontext	(input): Authentication context for the operation (user,...).
accessmode	(input): Mode for the directory to be created. (the umask defined into the FSAL configuration file will be applied on it).
attributes	(optionnal input/output): The post_operation attributes of the linked object. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). May be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (target or dir does not address an existing object)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_EXIST, ERR_FSAL_IO, ...

NB: if getting postop attributes failed, the function does not return an error but the FSAL_ATTR_RDATTR_ERR bit is set in the attributes->asked_attributes field.

Definition at line 281 of file FSAL_CEPH/fsal_create.c.

fsal_status_t CEPHFSAL_ListXAttrs	(	fsal_handle_t *	exthandle,
		unsigned int	cookie,
		fsal_op_context_t *	extcontext,
		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 138 of file FSAL_CEPH/fsal_xattrs.c.

fsal_status_t CEPHFSAL_load_FS_common_parameter_from_conf	(	config_file_t	in_config,
		fsal_parameter_t *	out_parameter
	)

Definition at line 428 of file FSAL_CEPH/fsal_tools.c.

fsal_status_t CEPHFSAL_load_FS_specific_parameter_from_conf	(	config_file_t	in_config,
		fsal_parameter_t *	out_parameter
	)

Definition at line 653 of file FSAL_CEPH/fsal_tools.c.

fsal_status_t CEPHFSAL_load_FSAL_parameter_from_conf	(	config_file_t	in_config,
		fsal_parameter_t *	out_parameter
	)

FSAL_load_FSAL_parameter_from_conf, FSAL_load_FS_common_parameter_from_conf, FSAL_load_FS_specific_parameter_from_conf:

Those functions initialize the FSAL init parameter structure from a configuration structure.

Parameters:

in_config	(input): Structure that represents the parsed configuration file.
out_parameter	(ouput) FSAL initialization structure filled according to the configuration file given as parameter.

Returns:

ERR_FSAL_NO_ERROR (no error) , ERR_FSAL_NOENT (missing a mandatory stanza in config file), ERR_FSAL_INVAL (invalid parameter), ERR_FSAL_SERVERFAULT (unexpected error) ERR_FSAL_FAULT (null pointer given as parameter),

Definition at line 355 of file FSAL_CEPH/fsal_tools.c.

fsal_status_t CEPHFSAL_lookup	(	fsal_handle_t *	extparent,
		fsal_name_t *	filename,
		fsal_op_context_t *	extcontext,
		fsal_handle_t *	exthandle,
		fsal_attrib_list_t *	object_attributes
	)

FSAL_lookup : Looks up for an object into a directory.

Note : if parent handle and filename are NULL, this retrieves root's handle.

Parameters:

parent_directory_handle	(input) Handle of the parent directory to search the object in.
filename	(input) The name of the object to find.
p_context	(input) Authentication context for the operation (user,...).
object_handle	(output) The handle of the object corresponding to filename.
object_attributes	(optional input/output) Pointer to the attributes of the object we found. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). It can be NULL (increases performances).

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (parent_directory_handle does not address an existing object)
• ERR_FSAL_NOTDIR (parent_directory_handle does not address a directory)
• ERR_FSAL_NOENT (the object designated by p_filename does not exist)
• ERR_FSAL_XDEV (tried to operate a lookup on a filesystem junction. Use FSAL_lookupJunction instead)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_IO, ...

Definition at line 77 of file FSAL_CEPH/fsal_lookup.c.

fsal_status_t CEPHFSAL_lookupJunction	(	fsal_handle_t *	extjunction,
		fsal_op_context_t *	extcontext,
		fsal_handle_t *	extfsroot,
		fsal_attrib_list_t *	fsroot_attributes
	)

FSAL_lookupJunction : Get the fileset root for a junction.

Parameters:

p_junction_handle	(input) Handle of the junction to be looked up.
cred	(input) Authentication context for the operation (user,...).
p_fsroot_handle	(output) The handle of root directory of the fileset.
p_fsroot_attributes	(optional input/output) Pointer to the attributes of the root directory for the fileset. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). It can be NULL (increases performances).

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (p_junction_handle does not address an existing object)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_IO, ...

Definition at line 201 of file FSAL_CEPH/fsal_lookup.c.

fsal_status_t CEPHFSAL_lookupPath	(	fsal_path_t *	path,
		fsal_op_context_t *	extcontext,
		fsal_handle_t *	exthandle,
		fsal_attrib_list_t *	object_attributes
	)

FSAL_lookupPath : Looks up for an object into the namespace.

Note : if path equals "/", this retrieves root's handle.

Parameters:

path	(input) The path of the object to find.
p_context	(input) Authentication context for the operation (user,...).
object_handle	(output) The handle of the object corresponding to filename.
object_attributes	(optional input/output) Pointer to the attributes of the object we found. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). It can be NULL (increases performances).

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• ERR_FSAL_INVAL (the path argument is not absolute)
• ERR_FSAL_NOENT (an element in the path does not exist)
• ERR_FSAL_NOTDIR (an element in the path is not a directory)
• ERR_FSAL_XDEV (tried to cross a filesystem junction, whereas is has not been authorized in the server configuration - FSAL::auth_xdev_export parameter)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_IO, ...

Definition at line 243 of file FSAL_CEPH/fsal_lookup.c.

fsal_status_t CEPHFSAL_mkdir	(	fsal_handle_t *	extparent,
		fsal_name_t *	dirname,
		fsal_op_context_t *	extcontext,
		fsal_accessmode_t	accessmode,
		fsal_handle_t *	object_handle,
		fsal_attrib_list_t *	object_attributes
	)

FSAL_mkdir: Create a directory.

Parameters:

extparent	(input): Handle of the parent directory where the subdirectory is to be created.
dirname	(input): Pointer to the name of the directory to be created.
context	(input): Authentication context for the operation (user,...).
accessmode	(input): Mode for the directory to be created. (the umask defined into the FSAL configuration file will be applied on it).
object_handle	(output): Pointer to the handle of the created directory.
object_attributes	(optionnal input/output): The attributes of the created directory. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). May be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (parent does not address an existing object)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_EXIST, ERR_FSAL_IO, ...

NB: if getting postop attributes failed, the function does not return an error but the FSAL_ATTR_RDATTR_ERR bit is set in the object_attributes->asked_attributes field.

Definition at line 181 of file FSAL_CEPH/fsal_create.c.

fsal_status_t CEPHFSAL_mknode	(	fsal_handle_t *	parent,
		fsal_name_t *	node_name,
		fsal_op_context_t *	context,
		fsal_accessmode_t	accessmode,
		fsal_nodetype_t	nodetype,
		fsal_dev_t *	dev,
		fsal_handle_t *	object_handle,
		fsal_attrib_list_t *	node_attributes
	)

FSAL_mknode: Create a special object in the filesystem. Not supported in upper layers in this GANESHA's version.

Returns:

ERR_FSAL_NOTSUPP.

Definition at line 343 of file FSAL_CEPH/fsal_create.c.

fsal_status_t CEPHFSAL_open	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		fsal_openflags_t	openflags,
		fsal_file_t *	extdescriptor,
		fsal_attrib_list_t *	file_attributes
	)

FSAL_open: Open a regular file for reading/writing its data content.

Parameters:

filehandle	(input): Handle of the file to be read/modified.
cred	(input): Authentication context for the operation (user,...).
openflags	(input): Flags that indicates behavior for file opening and access. This is an inclusive OR of the following values ( such of them are not compatible) : FSAL_O_RDONLY: opening file for reading only. FSAL_O_RDWR: opening file for reading and writing. FSAL_O_WRONLY: opening file for writting only. FSAL_O_APPEND: always write at the end of the file. FSAL_O_TRUNC: truncate the file to 0 on opening.
file_descriptor	(output): The file descriptor to be used for FSAL_read/write operations.
file_attributes	(optionnal input/output): Post operation attributes. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains).

Returns:

Major error codes:

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_ACCESS (user doesn't have the permissions for opening the file)
• ERR_FSAL_STALE (filehandle does not address an existing object)
• ERR_FSAL_INVAL (filehandle does not address a regular file, or open flags are conflicting)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ...

Definition at line 77 of file FSAL_CEPH/fsal_fileop.c.

fsal_status_t CEPHFSAL_open_by_fileid	(	fsal_handle_t *	filehandle,
		fsal_u64_t	fileid,
		fsal_op_context_t *	p_context,
		fsal_openflags_t	openflags,
		fsal_file_t *	file_descriptor,
		fsal_attrib_list_t *	file_attributes
	)

fsal_status_t CEPHFSAL_open_by_name	(	fsal_handle_t *	exthandle,
		fsal_name_t *	filename,
		fsal_op_context_t *	extcontext,
		fsal_openflags_t	openflags,
		fsal_file_t *	extdescriptor,
		fsal_attrib_list_t *	file_attributes
	)

FSAL_open_byname: Open a regular file for reading/writing its data content.

Parameters:

dirhandle	(input): Handle of the directory that contain the file to be read/modified.
filename	(input): Name of the file to be read/modified
cred	(input): Authentication context for the operation (user,...).
openflags	(input): Flags that indicates behavior for file opening and access. This is an inclusive OR of the following values ( such of them are not compatible) : FSAL_O_RDONLY: opening file for reading only. FSAL_O_RDWR: opening file for reading and writing. FSAL_O_WRONLY: opening file for writting only. FSAL_O_APPEND: always write at the end of the file. FSAL_O_TRUNC: truncate the file to 0 on opening.
file_descriptor	(output): The file descriptor to be used for FSAL_read/write operations.
file_attributes	(optionnal input/output): Post operation attributes. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains).

Returns:

Major error codes:

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_ACCESS (user doesn't have the permissions for opening the file)
• ERR_FSAL_STALE (filehandle does not address an existing object)
• ERR_FSAL_INVAL (filehandle does not address a regular file, or open flags are conflicting)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ...

Definition at line 172 of file FSAL_CEPH/fsal_fileop.c.

fsal_status_t CEPHFSAL_opendir	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		fsal_dir_t *	extdescriptor,
		fsal_attrib_list_t *	dir_attributes
	)

FSAL_opendir : Opens a directory for reading its content.

Parameters:

exthandle	(input) the handle of the directory to be opened.
extcontext	(input) Permission context for the operation (user, export context...).
extdescriptor	(output) pointer to an allocated structure that will receive directory stream informations, on successfull completion.
attributes	(optional output) On successfull completion,the structure pointed by dir_attributes receives the new directory attributes. Can be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_ACCESS (user does not have read permission on directory)
• ERR_FSAL_STALE (exthandle does not address an existing object)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ...

Definition at line 68 of file FSAL_CEPH/fsal_dirs.c.

fsal_status_t CEPHFSAL_rcp	(	fsal_handle_t *	filehandle,
		fsal_op_context_t *	p_context,
		fsal_path_t *	p_local_path,
		fsal_rcpflag_t	transfer_opt
	)

FSAL_rcp: Copy an HPSS file to/from a local filesystem.

Parameters:

filehandle	(input): Handle of the HPSS file to be copied.
p_context	(input): Authentication context for the operation (user,...).
p_local_path	(input): Path of the file in the local filesystem.
transfer_opt	(input): Flags that indicate transfer direction and options. This consists of an inclusive OR between the following values : FSAL_RCP_FS_TO_LOCAL: Copy the file from the filesystem to a local path. FSAL_RCP_LOCAL_TO_FS: Copy the file from local path to the filesystem. FSAL_RCP_LOCAL_CREAT: Create the target local file if it doesn't exist. FSAL_RCP_LOCAL_EXCL: Produce an error if the target local file already exists.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_ACCESS (user doesn't have the permissions for opening the file)
• ERR_FSAL_STALE (filehandle does not address an existing object)
• ERR_FSAL_INVAL (filehandle does not address a regular file, or tranfert options are conflicting)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ERR_FSAL_NOSPC, ERR_FSAL_DQUOT...

Definition at line 80 of file FSAL_CEPH/fsal_rcp.c.

fsal_status_t CEPHFSAL_read	(	fsal_file_t *	extdescriptor,
		fsal_seek_t *	seek_descriptor,
		fsal_size_t	buffer_size,
		caddr_t	buffer,
		fsal_size_t *	read_amount,
		fsal_boolean_t *	end_of_file
	)

FSAL_read: Perform a read operation on an opened file.

Parameters:

file_descriptor	(input): The file descriptor returned by FSAL_open.
seek_descriptor	(optional input): Specifies the position where data is to be read. If not specified, data will be read at the current position.
buffer_size	(input): Amount (in bytes) of data to be read.
buffer	(output): Address where the read data is to be stored in memory.
read_amount	(output): Pointer to the amount of data (in bytes) that have been read during this call.
end_of_file	(output): Pointer to a boolean that indicates whether the end of file has been reached during this call.

Returns:

Major error codes:

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_INVAL (invalid parameter)
• ERR_FSAL_NOT_OPENED (tried to read in a non-opened fsal_file_t)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ...

Definition at line 223 of file FSAL_CEPH/fsal_fileop.c.

fsal_status_t CEPHFSAL_readdir	(	fsal_dir_t *	extdescriptor,
		fsal_cookie_t	extstart,
		fsal_attrib_mask_t	attrmask,
		fsal_mdsize_t	buffersize,
		fsal_dirent_t *	dirents,
		fsal_cookie_t *	extend,
		fsal_count_t *	count,
		fsal_boolean_t *	end_of_dir
	)

FSAL_readdir : Read the entries of an opened directory.

Parameters:

descriptor	(input): Pointer to the directory descriptor filled by FSAL_opendir.
start_position	(input): Cookie that indicates the first object to be read during this readdir operation. This should be : FSAL_READDIR_FROM_BEGINNING for reading the content of the directory from the beginning. The end_position parameter returned by the previous call to FSAL_readdir.
get_attr_mask	(input) Specify the set of attributes to be retrieved for directory entries.
buffersize	(input) The size (in bytes) of the buffer where the direntries are to be stored.
dirents	(output) Adress of the buffer where the direntries are to be stored.
end_position	(output) Cookie that indicates the current position in the directory.
count	(output) Pointer to the number of entries read during the call.
end_of_dir	(output) Pointer to a boolean that indicates if the end of dir has been reached during the call.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ...

Definition at line 151 of file FSAL_CEPH/fsal_dirs.c.

fsal_status_t CEPHFSAL_readlink	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		fsal_path_t *	link_content,
		fsal_attrib_list_t *	link_attributes
	)

FSAL_readlink: Read the content of a symbolic link.

Parameters:

linkhandle	(input): Handle of the link to be read.
cred	(input): Authentication context for the operation (user,...).
p_link_content	(output): Pointer to an fsal path structure where the link content is to be stored..
link_attributes	(optionnal input/output): The post operation attributes of the symlink link. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). May be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (linkhandle does not address an existing object)
• ERR_FSAL_INVAL (linkhandle does not address a symbolic link)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_IO, ...

Definition at line 71 of file FSAL_CEPH/fsal_symlinks.c.

fsal_status_t CEPHFSAL_RemoveXAttrById	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		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 388 of file FSAL_CEPH/fsal_xattrs.c.

fsal_status_t CEPHFSAL_RemoveXAttrByName	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		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 413 of file FSAL_CEPH/fsal_xattrs.c.

fsal_status_t CEPHFSAL_rename	(	fsal_handle_t *	extold_parent,
		fsal_name_t *	old_name,
		fsal_handle_t *	extnew_parent,
		fsal_name_t *	new_name,
		fsal_op_context_t *	extcontext,
		fsal_attrib_list_t *	src_dir_attributes,
		fsal_attrib_list_t *	tgt_dir_attributes
	)

FSAL_rename: Change name and/or parent dir of a filesystem object.

Parameters:

old_parentdir_handle	(input): Source parent directory of the object is to be moved/renamed.
p_old_name	(input): Pointer to the current name of the object to be moved/renamed.
new_parentdir_handle	(input): Target parent directory for the object.
p_new_name	(input): Pointer to the new name for the object.
p_context	(input): Authentication context for the operation (user,...).
src_dir_attributes	(optionnal input/output): Post operation attributes for the source directory. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). May be NULL.
tgt_dir_attributes	(optionnal input/output): Post operation attributes for the target directory. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). May be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (a parent directory handle does not address an existing object)
• ERR_FSAL_NOTDIR (a parent directory handle does not address a directory)
• ERR_FSAL_NOENT (the object designated by p_old_name does not exist)
• ERR_FSAL_NOTEMPTY (the target object is a non empty directory)
• ERR_FSAL_XDEV (tried to move an object across different filesystems)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returnoed : ERR_FSAL_ACCESS, ERR_FSAL_IO, ...

Definition at line 84 of file FSAL_CEPH/fsal_rename.c.

fsal_status_t CEPHFSAL_setattrs	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		fsal_attrib_list_t *	attrib_set,
		fsal_attrib_list_t *	object_attributes
	)

FSAL_setattrs: Set attributes for the object specified by its filehandle.

Parameters:

filehandle	(input): The handle of the object to get parameters.
context	(input): Authentication context for the operation (user,...).
attrib_set	(mandatory input): The attributes to be set for the object. It defines the attributes that the caller wants to set and their values.
object_attributes	(optionnal input/output): The post operation attributes for the object. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). May be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (object_handle does not address an existing object)
• ERR_FSAL_INVAL (tried to modify a read-only attribute)
• ERR_FSAL_ATTRNOTSUPP (tried to modify a non-supported attribute)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Another error code if an error occured. NB: if getting postop attributes failed, the function does not return an error but the FSAL_ATTR_RDATTR_ERR bit is set in the object_attributes->asked_attributes field.

Definition at line 137 of file FSAL_CEPH/fsal_attrs.c.

fsal_status_t CEPHFSAL_SetDefault_FS_common_parameter

(

fsal_parameter_t *

out_parameter

)

Definition at line 284 of file FSAL_CEPH/fsal_tools.c.

fsal_status_t CEPHFSAL_SetDefault_FS_specific_parameter

(

fsal_parameter_t *

out_parameter

)

Definition at line 320 of file FSAL_CEPH/fsal_tools.c.

fsal_status_t CEPHFSAL_SetDefault_FSAL_parameter

(

fsal_parameter_t *

out_parameter

)

Those routines set the default parameters for FSAL init structure.

Returns:

ERR_FSAL_NO_ERROR (no error), ERR_FSAL_FAULT (null pointer given as parameter), ERR_FSAL_SERVERFAULT (unexpected error)

Definition at line 272 of file FSAL_CEPH/fsal_tools.c.

fsal_status_t CEPHFSAL_SetXAttrValue	(	fsal_handle_t *	exthandle,
		const fsal_name_t *	xattr_name,
		fsal_op_context_t *	extcontext,
		caddr_t	buffer_addr,
		size_t	buffer_size,
		int	create
	)

Definition at line 334 of file FSAL_CEPH/fsal_xattrs.c.

fsal_status_t CEPHFSAL_SetXAttrValueById	(	fsal_handle_t *	exthandle,
		unsigned int	xattr_id,
		fsal_op_context_t *	extcontext,
		caddr_t	buffer_addr,
		size_t	buffer_size
	)

Definition at line 363 of file FSAL_CEPH/fsal_xattrs.c.

fsal_status_t CEPHFSAL_static_fsinfo	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	context,
		fsal_staticfsinfo_t *	staticinfo
	)

fsal_status_t CEPHFSAL_symlink	(	fsal_handle_t *	extparent,
		fsal_name_t *	linkname,
		fsal_path_t *	linkcontent,
		fsal_op_context_t *	extcontext,
		fsal_accessmode_t	accessmode,
		fsal_handle_t *	extlink,
		fsal_attrib_list_t *	link_attributes
	)

FSAL_symlink: Create a symbolic link.

Parameters:

parent_directory_handle	(input): Handle of the parent directory where the link is to be created.
p_linkname	(input): Name of the link to be created.
p_linkcontent	(input): Content of the link to be created.
cred	(input): Authentication context for the operation (user,...).
accessmode	(ignored input): Mode of the link to be created. It has no sense in HPSS nor UNIX filesystems.
link_handle	(output): Pointer to the handle of the created symlink.
link_attributes	(optionnal input/output): Attributes of the newly created symlink. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). May be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (parent_directory_handle does not address an existing object)
• ERR_FSAL_NOTDIR (parent_directory_handle does not address a directory)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_IO, ...

Definition at line 153 of file FSAL_CEPH/fsal_symlinks.c.

fsal_status_t CEPHFSAL_terminate

(

)

Definition at line 88 of file FSAL_CEPH/fsal_init.c.

fsal_status_t CEPHFSAL_test_access	(	fsal_op_context_t *	extcontext,
		fsal_accessflags_t	access_type,
		fsal_attrib_list_t *	object_attributes
	)

FSAL_test_access : Tests whether the user identified by the p_context structure can access the object as indicated by the access_type parameter. This function tests access rights using cached attributes given as parameter (no calls to filesystem). Thus, it cannot test FSAL_F_OK flag, and asking such a flag will result in a ERR_FSAL_INVAL error.

Parameters:

p_context	(input): Authentication context for the operation (user,...).
access_type	(input): Indicates the permissions to test. This is an inclusive OR of the permissions to be checked for the user identified by cred. Permissions constants are : FSAL_R_OK : test for read permission FSAL_W_OK : test for write permission FSAL_X_OK : test for exec permission FSAL_F_OK : test for file existence
object_attributes	(mandatory input): The cached attributes for the object to test rights on. The following attributes MUST be filled : owner, group, mode, ACLs.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error, permission granted)
• ERR_FSAL_ACCESS (object permissions doesn't fit asked access type)
• ERR_FSAL_INVAL (FSAL_test_access is not able to test such a permission)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Another error code if an error occured.

Definition at line 77 of file FSAL_CEPH/fsal_local_op.c.

fsal_status_t CEPHFSAL_truncate	(	fsal_handle_t *	exthandle,
		fsal_op_context_t *	extcontext,
		fsal_size_t	length,
		fsal_file_t *	file_descriptor,
		fsal_attrib_list_t *	object_attributes
	)

FSAL_truncate: Modify the data length of a regular file.

Parameters:

filehandle	(input): Handle of the file is to be truncated.
cred	(input): Authentication context for the operation (user,...).
length	(input): The new data length for the file.
object_attributes	(optionnal input/output): The post operation attributes of the file. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). May be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (filehandle does not address an existing object)
• ERR_FSAL_INVAL (filehandle does not address a regular file)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_IO, ...

Definition at line 70 of file FSAL_CEPH/fsal_truncate.c.

fsal_status_t CEPHFSAL_unlink	(	fsal_handle_t *	extparent,
		fsal_name_t *	name,
		fsal_op_context_t *	extcontext,
		fsal_attrib_list_t *	parentdir_attributes
	)

FSAL_unlink: Remove a filesystem object .

Parameters:

parentdir_handle	(input): Handle of the parent directory of the object to be deleted.
p_object_name	(input): Name of the object to be removed.
p_context	(input): Authentication context for the operation (user,...).
parentdir_attributes	(optionnal input/output): Post operation attributes of the parent directory. As input, it defines the attributes that the caller wants to retrieve (by positioning flags into this structure) and the output is built considering this input (it fills the structure according to the flags it contains). May be NULL.

Returns:

Major error codes :

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_STALE (parentdir_handle does not address an existing object)
• ERR_FSAL_NOTDIR (parentdir_handle does not address a directory)
• ERR_FSAL_NOENT (the object designated by p_object_name does not exist)
• ERR_FSAL_NOTEMPTY (tried to remove a non empty directory)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_ACCESS, ERR_FSAL_IO, ...

Definition at line 72 of file FSAL_CEPH/fsal_unlink.c.

fsal_status_t CEPHFSAL_write	(	fsal_file_t *	extdescriptor,
		fsal_op_context_t *	p_context,
		fsal_seek_t *	seek_descriptor,
		fsal_size_t	buffer_size,
		caddr_t	buffer,
		fsal_size_t *	write_amount
	)

FSAL_write: Perform a write operation on an opened file.

Parameters:

file_descriptor	(input): The file descriptor returned by FSAL_open.
p_context	(input): Authentication context for the operation (user,...).
seek_descriptor	(optional input): Specifies the position where data is to be written. If not specified, data will be written at the current position.
buffer_size	(input): Amount (in bytes) of data to be written.
buffer	(input): Address in memory of the data to write to file.
write_amount	(output): Pointer to the amount of data (in bytes) that have been written during this call.

Returns:

Major error codes:

• ERR_FSAL_NO_ERROR (no error)
• ERR_FSAL_INVAL (invalid parameter)
• ERR_FSAL_NOT_OPENED (tried to write in a non-opened fsal_file_t)
• ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
• Other error codes can be returned : ERR_FSAL_IO, ERR_FSAL_NOSPC, ERR_FSAL_DQUOT...

Definition at line 303 of file FSAL_CEPH/fsal_fileop.c.

void fsal_increment_nbcall	(	int	function_index,
		fsal_status_t	status
	)

Increments the number of calls for a function.

fsal_increment_nbcall: Updates fonction call statistics.

Parameters:

function_index	(input): Index of the function whom number of call is to be incremented.
status	(input): Status the function returned.

Returns:

Nothing.

Definition at line 135 of file FSAL_CEPH/fsal_internal.c.

void fsal_internal_getstats

(

fsal_statistics_t *

output_stats

)

Retrieves current thread statistics.

fsal_internal_getstats: (For internal use in the FSAL). Retrieve call statistics for current thread.

Parameters:

output_stats

(output): Pointer to the call statistics structure.

Returns:

Nothing.

Definition at line 211 of file FSAL_CEPH/fsal_internal.c.

fsal_status_t fsal_internal_init_global	(	fsal_init_info_t *	fsal_info,
		fs_common_initinfo_t *	fs_common_info,
		fs_specific_initinfo_t *	fs_specific_info
	)

This function initializes shared variables of the FSAL.

Definition at line 490 of file FSAL_CEPH/fsal_internal.c.

fsal_status_t fsal_internal_testAccess	(	cephfsal_op_context_t *	context,
		fsal_accessflags_t	access_type,
		struct stat *	st,
		fsal_attrib_list_t *	object_attributes
	)

Definition at line 345 of file FSAL_CEPH/fsal_internal.c.

fsal_boolean_t fsal_is_retryable

(

fsal_status_t

status

)

fsal_is_retryable: Indicates if an FSAL error is retryable, i.e. if the caller has a chance of succeeding if it tries to call again the function that returned such an error code.

Parameters:

status(input),:

The fsal status whom retryability is to be tested.

Returns:

- TRUE if the error is retryable.

• FALSE if the error is NOT retryable.

Todo:

: ERR_FSAL_DELAY : The only retryable error ?

Todo:

: ERR_FSAL_DELAY : The only retryable error ?

Todo:

: ERR_FSAL_DELAY : The only retryable error ?

Definition at line 33 of file FSAL_CEPH/fsal_errors.c.

void ReleaseTokenFSCall

(

)

Definition at line 269 of file FSAL_CEPH/fsal_internal.c.

void TakeTokenFSCall

(

)

Used to limit the number of simultaneous calls to Filesystem.

Definition at line 258 of file FSAL_CEPH/fsal_internal.c.

---

Variable Documentation

fsal_staticfsinfo_t global_fs_info

Definition at line 52 of file FSAL_CEPH/fsal_internal.c.

cephfs_specific_initinfo_t global_spec_info

Definition at line 53 of file FSAL_CEPH/fsal_internal.c.