nfs-ganesha 1.4
Defines | Functions | Variables

fsal_internal.h File Reference

#include "fsal.h"

Go to the source code of this file.

Defines

#define HPSS_SUPPORTED_ATTRIBUTES

Functions

fsal_status_t fsal_internal_init_global (fsal_init_info_t *fsal_info, fs_common_initinfo_t *fs_common_info)
void fsal_increment_nbcall (int function_index, fsal_status_t status)
void fsal_internal_getstats (fsal_statistics_t *output_stats)
void fsal_internal_SetCredentialLifetime (fsal_uint_t lifetime_in)
void fsal_internal_SetReturnInconsistentDirent (fsal_uint_t bool_in)
void TakeTokenFSCall ()
void ReleaseTokenFSCall ()
fsal_boolean_t fsal_do_log (fsal_status_t status)
fsal_status_t HPSSFSAL_access (hpssfsal_handle_t *p_object_handle, hpssfsal_op_context_t *p_context, fsal_accessflags_t access_type, fsal_attrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_getattrs (hpssfsal_handle_t *p_filehandle, hpssfsal_op_context_t *p_context, fsal_attrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_setattrs (hpssfsal_handle_t *p_filehandle, hpssfsal_op_context_t *p_context, fsal_attrib_list_t *p_attrib_set, fsal_attrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_BuildExportContext (hpssfsal_export_context_t *p_export_context, fsal_path_t *p_export_path, char *fs_specific_options)
fsal_status_t HPSSFSAL_InitClientContext (hpssfsal_op_context_t *p_thr_context)
fsal_status_t HPSSFSAL_CleanUpExportContext (hpssfsal_export_context_t *p_export_context)
fsal_status_t HPSSFSAL_GetClientContext (hpssfsal_op_context_t *p_thr_context, hpssfsal_export_context_t *p_export_context, fsal_uid_t uid, fsal_gid_t gid, fsal_gid_t *alt_groups, fsal_count_t nb_alt_groups)
fsal_status_t HPSSFSAL_create (hpssfsal_handle_t *p_parent_directory_handle, fsal_name_t *p_filename, hpssfsal_op_context_t *p_context, fsal_accessmode_t accessmode, hpssfsal_handle_t *p_object_handle, fsal_attrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_mkdir (hpssfsal_handle_t *p_parent_directory_handle, fsal_name_t *p_dirname, hpssfsal_op_context_t *p_context, fsal_accessmode_t accessmode, hpssfsal_handle_t *p_object_handle, fsal_attrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_link (hpssfsal_handle_t *p_target_handle, hpssfsal_handle_t *p_dir_handle, fsal_name_t *p_link_name, hpssfsal_op_context_t *p_context, fsal_attrib_list_t *p_attributes)
fsal_status_t HPSSFSAL_mknode (hpssfsal_handle_t *parentdir_handle, fsal_name_t *p_node_name, hpssfsal_op_context_t *p_context, fsal_accessmode_t accessmode, fsal_nodetype_t nodetype, fsal_dev_t *dev, hpssfsal_handle_t *p_object_handle, fsal_attrib_list_t *node_attributes)
fsal_status_t HPSSFSAL_opendir (hpssfsal_handle_t *p_dir_handle, hpssfsal_op_context_t *p_context, hpssfsal_dir_t *p_dir_descriptor, fsal_attrib_list_t *p_dir_attributes)
fsal_status_t HPSSFSAL_readdir (hpssfsal_dir_t *p_dir_descriptor, hpssfsal_cookie_t start_position, fsal_attrib_mask_t get_attr_mask, fsal_mdsize_t buffersize, fsal_dirent_t *p_pdirent, hpssfsal_cookie_t *p_end_position, fsal_count_t *p_nb_entries, fsal_boolean_t *p_end_of_dir)
fsal_status_t HPSSFSAL_closedir (hpssfsal_dir_t *p_dir_descriptor)
fsal_status_t HPSSFSAL_open_by_name (hpssfsal_handle_t *dirhandle, fsal_name_t *filename, hpssfsal_op_context_t *p_context, fsal_openflags_t openflags, hpssfsal_file_t *file_descriptor, fsal_attrib_list_t *file_attributes)
fsal_status_t HPSSFSAL_open (hpssfsal_handle_t *p_filehandle, hpssfsal_op_context_t *p_context, fsal_openflags_t openflags, hpssfsal_file_t *p_file_descriptor, fsal_attrib_list_t *p_file_attributes)
fsal_status_t HPSSFSAL_read (hpssfsal_file_t *p_file_descriptor, fsal_seek_t *p_seek_descriptor, fsal_size_t buffer_size, caddr_t buffer, fsal_size_t *p_read_amount, fsal_boolean_t *p_end_of_file)
fsal_status_t HPSSFSAL_write (hpssfsal_file_t *p_file_descriptor, fsal_op_context_t *p_context, fsal_seek_t *p_seek_descriptor, fsal_size_t buffer_size, caddr_t buffer, fsal_size_t *p_write_amount)
fsal_status_t HPSSFSAL_close (hpssfsal_file_t *p_file_descriptor)
fsal_status_t HPSSFSAL_open_by_fileid (hpssfsal_handle_t *filehandle, fsal_u64_t fileid, hpssfsal_op_context_t *p_context, fsal_openflags_t openflags, hpssfsal_file_t *file_descriptor, fsal_attrib_list_t *file_attributes)
fsal_status_t HPSSFSAL_close_by_fileid (hpssfsal_file_t *file_descriptor, fsal_u64_t fileid)
fsal_status_t HPSSFSAL_dynamic_fsinfo (hpssfsal_handle_t *p_filehandle, hpssfsal_op_context_t *p_context, fsal_dynamicfsinfo_t *p_dynamicinfo)
fsal_status_t HPSSFSAL_Init (fsal_parameter_t *init_info)
fsal_status_t HPSSFSAL_terminate ()
fsal_status_t HPSSFSAL_test_access (hpssfsal_op_context_t *p_context, fsal_accessflags_t access_type, fsal_attrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_setattr_access (hpssfsal_op_context_t *p_context, fsal_attrib_list_t *candidate_attributes, fsal_attrib_list_t *object_attributes)
fsal_status_t HPSSFSAL_rename_access (hpssfsal_op_context_t *pcontext, fsal_attrib_list_t *pattrsrc, fsal_attrib_list_t *pattrdest)
fsal_status_t HPSSFSAL_create_access (hpssfsal_op_context_t *pcontext, fsal_attrib_list_t *pattr)
fsal_status_t HPSSFSAL_unlink_access (hpssfsal_op_context_t *pcontext, fsal_attrib_list_t *pattr)
fsal_status_t HPSSFSAL_link_access (hpssfsal_op_context_t *pcontext, fsal_attrib_list_t *pattr)
fsal_status_t HPSSFSAL_merge_attrs (fsal_attrib_list_t *pinit_attr, fsal_attrib_list_t *pnew_attr, fsal_attrib_list_t *presult_attr)
fsal_status_t HPSSFSAL_lookup (hpssfsal_handle_t *p_parent_directory_handle, fsal_name_t *p_filename, hpssfsal_op_context_t *p_context, hpssfsal_handle_t *p_object_handle, fsal_attrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_lookupPath (fsal_path_t *p_path, hpssfsal_op_context_t *p_context, hpssfsal_handle_t *object_handle, fsal_attrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_lookupJunction (hpssfsal_handle_t *p_junction_handle, hpssfsal_op_context_t *p_context, hpssfsal_handle_t *p_fsoot_handle, fsal_attrib_list_t *p_fsroot_attributes)
fsal_status_t HPSSFSAL_CleanObjectResources (hpssfsal_handle_t *in_fsal_handle)
fsal_status_t HPSSFSAL_set_quota (fsal_path_t *pfsal_path, int quota_type, fsal_uid_t fsal_uid, fsal_quota_t *pquota, fsal_quota_t *presquota)
fsal_status_t HPSSFSAL_get_quota (fsal_path_t *pfsal_path, int quota_type, fsal_uid_t fsal_uid, fsal_quota_t *pquota)
fsal_status_t HPSSFSAL_check_quota (char *path, fsal_quota_type_t quota_type, fsal_uid_t fsal_uid)
fsal_status_t HPSSFSAL_rcp (hpssfsal_handle_t *filehandle, hpssfsal_op_context_t *p_context, fsal_path_t *p_local_path, fsal_rcpflag_t transfer_opt)
fsal_status_t HPSSFSAL_rename (hpssfsal_handle_t *p_old_parentdir_handle, fsal_name_t *p_old_name, hpssfsal_handle_t *p_new_parentdir_handle, fsal_name_t *p_new_name, hpssfsal_op_context_t *p_context, fsal_attrib_list_t *p_src_dir_attributes, fsal_attrib_list_t *p_tgt_dir_attributes)
void HPSSFSAL_get_stats (fsal_statistics_t *stats, fsal_boolean_t reset)
fsal_status_t HPSSFSAL_readlink (hpssfsal_handle_t *p_linkhandle, hpssfsal_op_context_t *p_context, fsal_path_t *p_link_content, fsal_attrib_list_t *p_link_attributes)
fsal_status_t HPSSFSAL_symlink (hpssfsal_handle_t *p_parent_directory_handle, fsal_name_t *p_linkname, fsal_path_t *p_linkcontent, hpssfsal_op_context_t *p_context, fsal_accessmode_t accessmode, hpssfsal_handle_t *p_link_handle, fsal_attrib_list_t *p_link_attributes)
int HPSSFSAL_handlecmp (hpssfsal_handle_t *handle1, hpssfsal_handle_t *handle2, fsal_status_t *status)
unsigned int HPSSFSAL_Handle_to_HashIndex (hpssfsal_handle_t *p_handle, unsigned int cookie, unsigned int alphabet_len, unsigned int index_size)
unsigned int HPSSFSAL_Handle_to_RBTIndex (hpssfsal_handle_t *p_handle, unsigned int cookie)
fsal_status_t HPSSFSAL_DigestHandle (hpssfsal_export_context_t *p_expcontext, fsal_digesttype_t output_type, hpssfsal_handle_t *p_in_fsal_handle, caddr_t out_buff)
fsal_status_t HPSSFSAL_ExpandHandle (hpssfsal_export_context_t *p_expcontext, fsal_digesttype_t in_type, caddr_t in_buff, hpssfsal_handle_t *p_out_fsal_handle)
fsal_status_t HPSSFSAL_SetDefault_FSAL_parameter (fsal_parameter_t *out_parameter)
fsal_status_t HPSSFSAL_SetDefault_FS_common_parameter (fsal_parameter_t *out_parameter)
fsal_status_t HPSSFSAL_SetDefault_FS_specific_parameter (fsal_parameter_t *out_parameter)
fsal_status_t HPSSFSAL_load_FSAL_parameter_from_conf (config_file_t in_config, fsal_parameter_t *out_parameter)
fsal_status_t HPSSFSAL_load_FS_common_parameter_from_conf (config_file_t in_config, fsal_parameter_t *out_parameter)
fsal_status_t HPSSFSAL_load_FS_specific_parameter_from_conf (config_file_t in_config, fsal_parameter_t *out_parameter)
fsal_status_t HPSSFSAL_truncate (hpssfsal_handle_t *p_filehandle, hpssfsal_op_context_t *p_context, fsal_size_t length, hpssfsal_file_t *file_descriptor, fsal_attrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_unlink (hpssfsal_handle_t *p_parent_directory_handle, fsal_name_t *p_object_name, hpssfsal_op_context_t *p_context, fsal_attrib_list_t *p_parent_directory_attributes)
char * HPSSFSAL_GetFSName ()
fsal_status_t HPSSFSAL_GetXAttrAttrs (hpssfsal_handle_t *p_objecthandle, hpssfsal_op_context_t *p_context, unsigned int xattr_id, fsal_attrib_list_t *p_attrs)
fsal_status_t HPSSFSAL_ListXAttrs (hpssfsal_handle_t *p_objecthandle, unsigned int cookie, hpssfsal_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 HPSSFSAL_GetXAttrValueById (hpssfsal_handle_t *p_objecthandle, unsigned int xattr_id, hpssfsal_op_context_t *p_context, caddr_t buffer_addr, size_t buffer_size, size_t *p_output_size)
fsal_status_t HPSSFSAL_GetXAttrIdByName (hpssfsal_handle_t *p_objecthandle, const fsal_name_t *xattr_name, hpssfsal_op_context_t *p_context, unsigned int *pxattr_id)
fsal_status_t HPSSFSAL_GetXAttrValueByName (hpssfsal_handle_t *p_objecthandle, const fsal_name_t *xattr_name, hpssfsal_op_context_t *p_context, caddr_t buffer_addr, size_t buffer_size, size_t *p_output_size)
fsal_status_t HPSSFSAL_SetXAttrValue (hpssfsal_handle_t *p_objecthandle, const fsal_name_t *xattr_name, hpssfsal_op_context_t *p_context, caddr_t buffer_addr, size_t buffer_size, int create)
fsal_status_t HPSSFSAL_SetXAttrValueById (hpssfsal_handle_t *p_objecthandle, unsigned int xattr_id, hpssfsal_op_context_t *p_context, caddr_t buffer_addr, size_t buffer_size)
fsal_status_t HPSSFSAL_RemoveXAttrById (hpssfsal_handle_t *p_objecthandle, hpssfsal_op_context_t *p_context, unsigned int xattr_id)
fsal_status_t HPSSFSAL_RemoveXAttrByName (hpssfsal_handle_t *p_objecthandle, hpssfsal_op_context_t *p_context, const fsal_name_t *xattr_name)
int HPSSFSAL_GetXattrOffsetSetable (void)
unsigned int HPSSFSAL_GetFileno (fsal_file_t *pfile)
fsal_status_t HPSSFSAL_getextattrs (fsal_handle_t *p_filehandle, fsal_op_context_t *p_context, fsal_extattrib_list_t *p_object_attributes)
fsal_status_t HPSSFSAL_commit (fsal_file_t *p_file_descriptor, fsal_off_t offset, fsal_size_t size)

Variables

fsal_staticfsinfo_t global_fs_info
fsal_uint_t CredentialLifetime
fsal_uint_t ReturnInconsistentDirent

Define Documentation

#define HPSS_SUPPORTED_ATTRIBUTES

Function Documentation

fsal_boolean_t fsal_do_log ( fsal_status_t  status)

fsal_do_log: Indicates if an FSAL error has to be traced into its log file in the NIV_EVENT level. (in the other cases, return codes are only logged in the NIV_FULL_DEBUG logging lovel).

fsal_do_log: Indicates if an FSAL error has to be traced into its log file in the NIV_EVENT level. (in the other cases, return codes are only logged in the NIV_FULL_DEBUG logging lovel).

Parameters:
status(input),:The fsal status that is to be tested.
Returns:
- TRUE if the error is to be traced.
  • FALSE if the error must not be traced except in NIV_FULL_DEBUG level.

Definition at line 345 of file FSAL_FUSELIKE/fsal_internal.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 
)

This function initializes shared variables of the FSAL.

Definition at line 262 of file FSAL_FUSELIKE/fsal_internal.c.

void fsal_internal_SetCredentialLifetime ( fsal_uint_t  lifetime_in)

Set credential lifetime.

Set credential lifetime. (For internal use in the FSAL). Set the period for thread's credential renewal.

Parameters:
lifetime_in(input): The period for thread's credential renewal.
Returns:
Nothing.

Definition at line 307 of file FSAL_GPFS/fsal_internal.c.

void fsal_internal_SetReturnInconsistentDirent ( fsal_uint_t  bool_in)

Set behavior when detecting a MD inconsistency in readdir.

Set behavior when detecting a MD inconsistency in readdir. (For internal use in the FSAL).

Parameters:
lifetime_in(input): The period for thread's credential renewal.
Returns:
Nothing.

Definition at line 249 of file FSAL_HPSS/fsal_internal.c.

fsal_status_t HPSSFSAL_access ( hpssfsal_handle_t object_handle,
hpssfsal_op_context_t p_context,
fsal_accessflags_t  access_type,
fsal_attrib_list_t object_attributes 
)

FSAL_access : Tests whether the user or entity identified by the p_context structure can access the object identified by object_handle, as indicated by the access_type parameter.

Parameters:
object_handle(input): The handle of the object to test permissions on.
p_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 p_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 58 of file FSAL_HPSS/fsal_access.c.

fsal_status_t HPSSFSAL_check_quota ( char *  path,
fsal_quota_type_t  quota_type,
fsal_uid_t  fsal_uid 
)

FSAL_check_quota : checks if quotas allow a user to do an operation

Parameters:
pfsal_pathpath to the filesystem whose quota are requested
quota_typetype of quota to be checked (inodes or blocks
fsal_uiduid for the user whose quota are requested
Returns:
Major error codes :
  • ERR_FSAL_NO_ERROR (no error)
  • Another error code if an error occured.

Definition at line 101 of file FSAL_HPSS/fsal_quota.c.

fsal_status_t HPSSFSAL_CleanObjectResources ( hpssfsal_handle_t in_fsal_handle)

FSAL_CleanObjectResources: This function cleans remanent internal resources that are kept for a given FSAL handle.

Parameters:
in_fsal_handle(input): The handle whose the resources are to be cleaned.

Definition at line 28 of file FSAL_HPSS/fsal_objectres.c.

fsal_status_t HPSSFSAL_close ( hpssfsal_file_t *  file_descriptor)

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 540 of file FSAL_HPSS/fsal_fileop.c.

fsal_status_t HPSSFSAL_close_by_fileid ( hpssfsal_file_t *  file_descriptor,
fsal_u64_t  fileid 
)

Definition at line 577 of file FSAL_HPSS/fsal_fileop.c.

fsal_status_t HPSSFSAL_closedir ( hpssfsal_dir_t dir_descriptor)

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 310 of file FSAL_HPSS/fsal_dirs.c.

fsal_status_t HPSSFSAL_commit ( fsal_file_t p_file_descriptor,
fsal_off_t  offset,
fsal_size_t  size 
)
fsal_status_t HPSSFSAL_create ( hpssfsal_handle_t parent_directory_handle,
fsal_name_t p_filename,
hpssfsal_op_context_t p_context,
fsal_accessmode_t  accessmode,
hpssfsal_handle_t object_handle,
fsal_attrib_list_t object_attributes 
)

FSAL_create: Create a regular file.

Parameters:
parent_directory_handle(input): Handle of the parent directory where the file is to be created.
p_filename(input): Pointer to the name of the file to be created.
cred(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 62 of file FSAL_HPSS/fsal_create.c.

fsal_status_t HPSSFSAL_create_access ( hpssfsal_op_context_t pcontext,
fsal_attrib_list_t pattr 
)

FSAL_create_access : test if a client identified by cred can create an object within a directory knowing its attributes

Parameters:
pcontext(in hpssfsal_cred_t *) user's context.
pattrsource directory attributes
Returns:
Major error codes :
  • ERR_FSAL_NO_ERROR (no error)
  • ERR_FSAL_ACCESS (Permission denied)
  • ERR_FSAL_FAULT (null pointer parameter)
  • ERR_FSAL_INVAL (missing attributes : mode, group, user,...)
  • ERR_FSAL_SERVERFAULT (unexpected error)

Definition at line 338 of file FSAL_HPSS/fsal_local_op.c.

fsal_status_t HPSSFSAL_DigestHandle ( hpssfsal_export_context_t p_expcontext,
fsal_digesttype_t  output_type,
hpssfsal_handle_t in_fsal_handle,
caddr_t  out_buff 
)

FSAL_DigestHandle : Convert an hpssfsal_handle_t to a buffer to be included into NFS handles, or another digest.

Parameters:
output_type(input): Indicates the type of digest to do.
in_fsal_handle(input): The handle to be converted to digest.
out_buff(output): The buffer where the digest is to be stored.
Returns:
The major code is ERR_FSAL_NO_ERROR is no error occured. Else, it is a non null value.

Definition at line 201 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_dynamic_fsinfo ( hpssfsal_handle_t filehandle,
hpssfsal_op_context_t p_context,
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 46 of file FSAL_HPSS/fsal_fsinfo.c.

fsal_status_t HPSSFSAL_ExpandHandle ( hpssfsal_export_context_t p_expcontext,
fsal_digesttype_t  in_type,
caddr_t  in_buff,
hpssfsal_handle_t out_fsal_handle 
)

FSAL_ExpandHandle : Convert a buffer extracted from NFS handles to an FSAL handle.

Parameters:
in_type(input): Indicates the type of digest to be expanded.
in_buff(input): Pointer to the digest to be expanded.
out_fsal_handle(output): The handle built from digest.
Returns:
The major code is ERR_FSAL_NO_ERROR is no error occured. Else, it is a non null value.

Definition at line 433 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_get_quota ( fsal_path_t pfsal_path,
int  quota_type,
fsal_uid_t  fsal_uid,
fsal_quota_t pquota 
)

FSAL_get_quota : Gets the quota for a given path.

Parameters:
pfsal_pathpath to the filesystem whose quota are requested
fsal_uiduid for the user whose quota are requested
pquota(input): Parameter to the structure containing the requested quotas
Returns:
Major error codes :
  • ERR_FSAL_NO_ERROR (no error)
  • Another error code if an error occured.

Definition at line 53 of file FSAL_HPSS/fsal_quota.c.

void HPSSFSAL_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 33 of file FSAL_HPSS/fsal_stats.c.

fsal_status_t HPSSFSAL_getattrs ( hpssfsal_handle_t filehandle,
hpssfsal_op_context_t p_context,
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.
p_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 46 of file FSAL_HPSS/fsal_attrs.c.

fsal_status_t HPSSFSAL_getextattrs ( fsal_handle_t p_filehandle,
fsal_op_context_t p_context,
fsal_extattrib_list_t p_object_attributes 
)
unsigned int HPSSFSAL_GetFileno ( fsal_file_t pfile)
char* HPSSFSAL_GetFSName ( )

Definition at line 37 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_GetXAttrAttrs ( hpssfsal_handle_t p_objecthandle,
hpssfsal_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_objecthandleHandle of the object you want to get attribute for.
p_contextpointer to the current security context.
xattr_cookiexattr's cookie (as returned by listxattrs).
p_attrsxattr's attributes.
Parameters:
p_attrsIN/OUT xattr attributes (if supported)

Definition at line 508 of file FSAL_HPSS/fsal_xattrs.c.

fsal_status_t HPSSFSAL_GetXAttrIdByName ( hpssfsal_handle_t p_objecthandle,
const fsal_name_t xattr_name,
hpssfsal_op_context_t p_context,
unsigned int *  pxattr_id 
)

Get the index of an xattr based on its name

Parameters:
p_objecthandleHandle of the object you want to get attribute for.
xattr_namethe name of the attribute to be read.
pxattr_idfound xattr_id
Returns:
ERR_FSAL_NO_ERROR if xattr_name exists, ERR_FSAL_NOENT otherwise

Definition at line 880 of file FSAL_HPSS/fsal_xattrs.c.

int HPSSFSAL_GetXattrOffsetSetable ( void  )

Definition at line 1210 of file FSAL_HPSS/fsal_xattrs.c.

fsal_status_t HPSSFSAL_GetXAttrValueById ( hpssfsal_handle_t p_objecthandle,
unsigned int  xattr_id,
hpssfsal_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_objecthandleHandle of the object you want to get attribute for.
xattr_namethe name of the attribute to be read.
p_contextpointer to the current security context.
buffer_addraddress of the buffer where the xattr value is to be stored.
buffer_sizesize of the buffer where the xattr value is to be stored.
p_output_sizesize of the data actually stored into the buffer.

Definition at line 787 of file FSAL_HPSS/fsal_xattrs.c.

fsal_status_t HPSSFSAL_GetXAttrValueByName ( hpssfsal_handle_t p_objecthandle,
const fsal_name_t xattr_name,
hpssfsal_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_objecthandleHandle of the object you want to get attribute for.
xattr_namethe name of the attribute to be read.
p_contextpointer to the current security context.
buffer_addraddress of the buffer where the xattr value is to be stored.
buffer_sizesize of the buffer where the xattr value is to be stored.
p_output_sizesize of the data actually stored into the buffer.

Definition at line 971 of file FSAL_HPSS/fsal_xattrs.c.

unsigned int HPSSFSAL_Handle_to_HashIndex ( hpssfsal_handle_t p_handle,
unsigned int  cookie,
unsigned int  alphabet_len,
unsigned int  index_size 
)

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

Parameters:
p_handleThe handle to be hashed
cookieMakes it possible to have different hash value for the same handle, when cookie changes.
alphabet_lenParameter for polynomial hashing algorithm
index_sizeThe range of hash value will be [0..index_size-1]
Returns:
The hash value

Definition at line 104 of file FSAL_HPSS/fsal_tools.c.

unsigned int HPSSFSAL_Handle_to_RBTIndex ( hpssfsal_handle_t p_handle,
unsigned int  cookie 
)

Definition at line 159 of file FSAL_HPSS/fsal_tools.c.

int HPSSFSAL_handlecmp ( hpssfsal_handle_t handle1,
hpssfsal_handle_t handle2,
fsal_status_t status 
)

FSAL_handlecmp: Compare 2 handles.

Parameters:
handle1(input): The first handle to be compared.
handle2(input): The second handle to be compared.
status(output): The status of the compare operation.
Returns:
- 0 if handles are the same.
  • A non null value else.
  • Segfault if status is a NULL pointer.

Definition at line 59 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_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 254 of file FSAL_HPSS/fsal_init.c.

fsal_status_t HPSSFSAL_link ( hpssfsal_handle_t target_handle,
hpssfsal_handle_t dir_handle,
fsal_name_t p_link_name,
hpssfsal_op_context_t p_context,
fsal_attrib_list_t attributes 
)

FSAL_link: Create a hardlink.

Parameters:
target_handle(input): Handle of the target object.
dir_handle(input): Pointer to the directory handle where the hardlink is to be created.
p_link_name(input): Pointer to the name of the hardlink to be created.
cred(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_handle or dir_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 attributes->asked_attributes field.

Definition at line 335 of file FSAL_HPSS/fsal_create.c.

fsal_status_t HPSSFSAL_link_access ( hpssfsal_op_context_t pcontext,
fsal_attrib_list_t pattr 
)

FSAL_link_access : test if a client identified by cred can link to a directory knowing its attributes

Parameters:
pcontext(in hpssfsal_cred_t *) user's context.
pattrdestination directory attributes
Returns:
Major error codes :
  • ERR_FSAL_NO_ERROR (no error)
  • ERR_FSAL_ACCESS (Permission denied)
  • ERR_FSAL_FAULT (null pointer parameter)
  • ERR_FSAL_INVAL (missing attributes : mode, group, user,...)
  • ERR_FSAL_SERVERFAULT (unexpected error)

Definition at line 394 of file FSAL_HPSS/fsal_local_op.c.

fsal_status_t HPSSFSAL_ListXAttrs ( hpssfsal_handle_t p_objecthandle,
unsigned int  argcookie,
hpssfsal_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_objecthandleHandle of the object we want to get extended attributes.
cookieindex of the next entry to be returned.
p_contextpointer to the current security context.
xattrs_taba table for storing extended attributes list to.
xattrs_tabsizethe maximum number of xattr entries that xattrs_tab can contain.
p_nb_returnedthe number of xattr entries actually stored in xattrs_tab.
end_of_listthis boolean indicates that the end of xattrs list has been reached.

Definition at line 615 of file FSAL_HPSS/fsal_xattrs.c.

fsal_status_t HPSSFSAL_load_FS_common_parameter_from_conf ( config_file_t  in_config,
fsal_parameter_t out_parameter 
)

Definition at line 733 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_load_FS_specific_parameter_from_conf ( config_file_t  in_config,
fsal_parameter_t out_parameter 
)

Definition at line 941 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_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 628 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_lookup ( hpssfsal_handle_t parent_directory_handle,
fsal_name_t p_filename,
hpssfsal_op_context_t p_context,
hpssfsal_handle_t object_handle,
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, ...

/!\ WARNING : When the directory handle is stale, HPSS returns ENOTDIR. Thus, in this case, we must double check by checking the directory handle.

Definition at line 60 of file FSAL_HPSS/fsal_lookup.c.

fsal_status_t HPSSFSAL_lookupJunction ( hpssfsal_handle_t p_junction_handle,
hpssfsal_op_context_t p_context,
hpssfsal_handle_t p_fsoot_handle,
fsal_attrib_list_t p_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 221 of file FSAL_HPSS/fsal_lookup.c.

fsal_status_t HPSSFSAL_lookupPath ( fsal_path_t p_path,
hpssfsal_op_context_t p_context,
hpssfsal_handle_t object_handle,
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, ...

Todo:
: Be carefull about junction crossing, symlinks, hardlinks,...

Definition at line 308 of file FSAL_HPSS/fsal_lookup.c.

fsal_status_t HPSSFSAL_merge_attrs ( fsal_attrib_list_t pinit_attr,
fsal_attrib_list_t pnew_attr,
fsal_attrib_list_t presult_attr 
)

FSAL_merge_attrs: merge to attributes structure.

This functions merge the second attributes list into the first argument. Results in returned in the last argument.

Parameters:
pinit_attr[IN] attributes to be changed
pnew_attr[IN] attributes to be added
presult_attr[IN] resulting attributes
Returns:
Major error codes :
  • ERR_FSAL_NO_ERROR (no error)
  • ERR_FSAL_INVAL Invalid argument(s)

Definition at line 422 of file FSAL_HPSS/fsal_local_op.c.

fsal_status_t HPSSFSAL_mkdir ( hpssfsal_handle_t parent_directory_handle,
fsal_name_t p_dirname,
hpssfsal_op_context_t p_context,
fsal_accessmode_t  accessmode,
hpssfsal_handle_t object_handle,
fsal_attrib_list_t object_attributes 
)

FSAL_mkdir: Create a directory.

Parameters:
parent_directory_handle(input): Handle of the parent directory where the subdirectory is to be created.
p_dirname(input): Pointer to the name of the directory to be created.
cred(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_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 217 of file FSAL_HPSS/fsal_create.c.

fsal_status_t HPSSFSAL_mknode ( hpssfsal_handle_t parentdir_handle,
fsal_name_t p_node_name,
hpssfsal_op_context_t p_context,
fsal_accessmode_t  accessmode,
fsal_nodetype_t  nodetype,
fsal_dev_t dev,
hpssfsal_handle_t p_object_handle,
fsal_attrib_list_t node_attributes 
)

FSAL_mknode: Create a special object in the filesystem. Not supported upon HPSS.

Returns:
ERR_FSAL_NOTSUPP.

Definition at line 418 of file FSAL_HPSS/fsal_create.c.

fsal_status_t HPSSFSAL_open ( hpssfsal_handle_t filehandle,
hpssfsal_op_context_t p_context,
fsal_openflags_t  openflags,
hpssfsal_file_t *  file_descriptor,
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 121 of file FSAL_HPSS/fsal_fileop.c.

fsal_status_t HPSSFSAL_open_by_fileid ( hpssfsal_handle_t filehandle,
fsal_u64_t  fileid,
hpssfsal_op_context_t p_context,
fsal_openflags_t  openflags,
hpssfsal_file_t *  file_descriptor,
fsal_attrib_list_t file_attributes 
)

Definition at line 566 of file FSAL_HPSS/fsal_fileop.c.

fsal_status_t HPSSFSAL_open_by_name ( hpssfsal_handle_t dirhandle,
fsal_name_t filename,
hpssfsal_op_context_t p_context,
fsal_openflags_t  openflags,
hpssfsal_file_t *  file_descriptor,
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 62 of file FSAL_HPSS/fsal_fileop.c.

fsal_status_t HPSSFSAL_opendir ( hpssfsal_handle_t dir_handle,
hpssfsal_op_context_t p_context,
hpssfsal_dir_t dir_descriptor,
fsal_attrib_list_t dir_attributes 
)

FSAL_opendir : Opens a directory for reading its content.

Parameters:
dir_handle(input) the handle of the directory to be opened.
p_context(input) Permission context for the operation (user, export context...).
dir_descriptor(output) pointer to an allocated structure that will receive directory stream informations, on successfull completion.
dir_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 (dir_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_IO, ...

Definition at line 48 of file FSAL_HPSS/fsal_dirs.c.

fsal_status_t HPSSFSAL_rcp ( hpssfsal_handle_t filehandle,
hpssfsal_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 57 of file FSAL_HPSS/fsal_rcp.c.

fsal_status_t HPSSFSAL_read ( hpssfsal_file_t *  file_descriptor,
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 hpssfsal_file_t)
  • ERR_FSAL_FAULT (a NULL pointer was passed as mandatory argument)
  • Other error codes can be returned : ERR_FSAL_IO, ...

Todo:
: manage fsal_size_t to size_t convertion
Todo:
: manage ssize_t to fsal_size_t convertion

Definition at line 240 of file FSAL_HPSS/fsal_fileop.c.

fsal_status_t HPSSFSAL_readdir ( hpssfsal_dir_t dir_descriptor,
hpssfsal_cookie_t  start_position,
fsal_attrib_mask_t  get_attr_mask,
fsal_mdsize_t  buffersize,
fsal_dirent_t pdirent,
hpssfsal_cookie_t end_position,
fsal_count_t nb_entries,
fsal_boolean_t end_of_dir 
)

FSAL_readdir : Read the entries of an opened directory.

Parameters:
dir_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.
pdirent(output) Adresse of the buffer where the direntries are to be stored.
end_position(output) Cookie that indicates the current position in the directory.
nb_entries(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, ...

Todo:
: does handle provide mounted_on_fileid ?
Todo:
: test returned status

Definition at line 115 of file FSAL_HPSS/fsal_dirs.c.

fsal_status_t HPSSFSAL_readlink ( hpssfsal_handle_t linkhandle,
hpssfsal_op_context_t p_context,
fsal_path_t p_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 54 of file FSAL_HPSS/fsal_symlinks.c.

fsal_status_t HPSSFSAL_RemoveXAttrById ( hpssfsal_handle_t p_objecthandle,
hpssfsal_op_context_t p_context,
unsigned int  xattr_id 
)

Removes a xattr by Id

Parameters:
p_objecthandleHandle of the object you want to get attribute for.
p_contextpointer to the current security context.
xattr_idxattr's id

Definition at line 1189 of file FSAL_HPSS/fsal_xattrs.c.

fsal_status_t HPSSFSAL_RemoveXAttrByName ( hpssfsal_handle_t p_objecthandle,
hpssfsal_op_context_t p_context,
const fsal_name_t xattr_name 
)

Removes a xattr by Name

Parameters:
p_objecthandleHandle of the object you want to get attribute for.
p_contextpointer to the current security context.
xattr_namexattr's name

Definition at line 1203 of file FSAL_HPSS/fsal_xattrs.c.

fsal_status_t HPSSFSAL_rename ( hpssfsal_handle_t old_parentdir_handle,
fsal_name_t p_old_name,
hpssfsal_handle_t new_parentdir_handle,
fsal_name_t p_new_name,
hpssfsal_op_context_t p_context,
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 returned : ERR_FSAL_ACCESS, ERR_FSAL_IO, ...

Definition at line 66 of file FSAL_HPSS/fsal_rename.c.

fsal_status_t HPSSFSAL_rename_access ( hpssfsal_op_context_t pcontext,
fsal_attrib_list_t pattrsrc,
fsal_attrib_list_t pattrdest 
)

FSAL_rename_access : test if a client identified by cred can be renamed on the object knowing the parents attributes

Parameters:
pcontext(in hpssfsal_cred_t *) user's context.
pattrsrcsource directory attributes
pattrdestdestination directory attributes
Returns:
Major error codes :
  • ERR_FSAL_NO_ERROR (no error)
  • ERR_FSAL_ACCESS (Permission denied)
  • ERR_FSAL_FAULT (null pointer parameter)
  • ERR_FSAL_INVAL (missing attributes : mode, group, user,...)
  • ERR_FSAL_SERVERFAULT (unexpected error)

Definition at line 306 of file FSAL_HPSS/fsal_local_op.c.

fsal_status_t HPSSFSAL_set_quota ( fsal_path_t pfsal_path,
int  quota_type,
fsal_uid_t  fsal_uid,
fsal_quota_t pquot,
fsal_quota_t presquot 
)

FSAL_get_quota : Gets the quota for a given path.

Parameters:
pfsal_pathpath to the filesystem whose quota are requested
fsal_uiduid for the user whose quota are requested
pquota(input): pointer to the structure containing the wanted quotas
presquot(output) pointer to the structure containing the resulting quotas
Returns:
Major error codes :
  • ERR_FSAL_NO_ERROR (no error)
  • Another error code if an error occured.

Definition at line 77 of file FSAL_HPSS/fsal_quota.c.

fsal_status_t HPSSFSAL_setattr_access ( hpssfsal_op_context_t p_context,
fsal_attrib_list_t pcandidate_attributes,
fsal_attrib_list_t pobject_attributes 
)

FSAL_test_setattr_access : test if a client identified by cred can access setattr on the object knowing its attributes and parent's attributes. The following fields of the object_attributes structures MUST be filled : acls (if supported), mode, owner, group. This doesn't make any call to the filesystem, as a result, this doesn't ensure that the file exists, nor that the permissions given as parameters are the actual file permissions : this must be ensured by the cache_inode layer, using FSAL_getattrs, for example.

Parameters:
cred(in hpssfsal_cred_t *) user's identifier.
candidate_attrbutesthe attributes we want to set on the object
parent_attributes(in fsal_attrib_list_t *) the cached attributes for the object.
Returns:
Major error codes :
  • ERR_FSAL_NO_ERROR (no error)
  • ERR_FSAL_ACCESS (Permission denied)
  • ERR_FSAL_FAULT (null pointer parameter)
  • ERR_FSAL_INVAL (missing attributes : mode, group, user,...)
  • ERR_FSAL_SERVERFAULT (unexpected error)

Definition at line 250 of file FSAL_HPSS/fsal_local_op.c.

fsal_status_t HPSSFSAL_setattrs ( hpssfsal_handle_t filehandle,
hpssfsal_op_context_t p_context,
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.
p_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.

Todo:
: chown restricted seems to be OK.
Todo:
voir pourquoi hpss_fattr_out ne contient pas ce qu'il devrait contenir

Definition at line 125 of file FSAL_HPSS/fsal_attrs.c.

fsal_status_t HPSSFSAL_SetDefault_FS_common_parameter ( fsal_parameter_t out_parameter)

Definition at line 534 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_SetDefault_FS_specific_parameter ( fsal_parameter_t out_parameter)

Definition at line 570 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_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 519 of file FSAL_HPSS/fsal_tools.c.

fsal_status_t HPSSFSAL_SetXAttrValue ( hpssfsal_handle_t p_objecthandle,
const fsal_name_t xattr_name,
hpssfsal_op_context_t p_context,
caddr_t  buffer_addr,
size_t  buffer_size,
int  create 
)

Definition at line 1076 of file FSAL_HPSS/fsal_xattrs.c.

fsal_status_t HPSSFSAL_SetXAttrValueById ( hpssfsal_handle_t p_objecthandle,
unsigned int  xattr_id,
hpssfsal_op_context_t p_context,
caddr_t  buffer_addr,
size_t  buffer_size 
)

Definition at line 1119 of file FSAL_HPSS/fsal_xattrs.c.

fsal_status_t HPSSFSAL_symlink ( hpssfsal_handle_t parent_directory_handle,
fsal_name_t p_linkname,
fsal_path_t p_linkcontent,
hpssfsal_op_context_t p_context,
fsal_accessmode_t  accessmode,
hpssfsal_handle_t link_handle,
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 155 of file FSAL_HPSS/fsal_symlinks.c.

fsal_status_t HPSSFSAL_terminate ( )

Definition at line 370 of file FSAL_HPSS/fsal_init.c.

fsal_status_t HPSSFSAL_test_access ( hpssfsal_op_context_t p_context,
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.

Todo:
: test that needed attributes are in the structure
Todo:
: ACLs.

Definition at line 78 of file FSAL_HPSS/fsal_local_op.c.

fsal_status_t HPSSFSAL_truncate ( hpssfsal_handle_t filehandle,
hpssfsal_op_context_t p_context,
fsal_size_t  length,
hpssfsal_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 51 of file FSAL_HPSS/fsal_truncate.c.

fsal_status_t HPSSFSAL_unlink ( hpssfsal_handle_t parentdir_handle,
fsal_name_t p_object_name,
hpssfsal_op_context_t p_context,
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 51 of file FSAL_HPSS/fsal_unlink.c.

fsal_status_t HPSSFSAL_unlink_access ( hpssfsal_op_context_t pcontext,
fsal_attrib_list_t pattr 
)

FSAL_unlink_access : test if a client identified by cred can unlink on a directory knowing its attributes

Parameters:
pcontext(in hpssfsal_cred_t *) user's context.
pattrsource directory attributes
Returns:
Major error codes :
  • ERR_FSAL_NO_ERROR (no error)
  • ERR_FSAL_ACCESS (Permission denied)
  • ERR_FSAL_FAULT (null pointer parameter)
  • ERR_FSAL_INVAL (missing attributes : mode, group, user,...)
  • ERR_FSAL_SERVERFAULT (unexpected error)

Definition at line 366 of file FSAL_HPSS/fsal_local_op.c.

fsal_status_t HPSSFSAL_write ( hpssfsal_file_t *  file_descriptor,
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 hpssfsal_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...

Todo:
: manage fsal_size_t to size_t convertion
Todo:
: manage ssize_t to fsal_size_t convertion

Definition at line 376 of file FSAL_HPSS/fsal_fileop.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

Definition at line 61 of file FSAL_GPFS/fsal_internal.c.

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

Definition at line 31 of file FSAL_HPSS/fsal_internal.c.