RFIO_STAT

Section: Rfio Library Functions (3)
Updated: $Date: 2005/03/31 13:13:03 $
Index Return to Main Contents
 

NAME

rfio_stat - get information about a file or directory  

SYNOPSIS

#include <sys/types.h>
#include "rfio_api.h"

int rfio_stat (const char *path, struct stat *statbuf);
int rfio_fstat (int s, struct stat *statbuf);
int rfio_lstat (const char *path, struct stat *statbuf);
int rfio_mstat (const char *path, struct stat *statbuf);
int rfio_mstat_reset ();
int rfio_end ();

Under Linux, for large files:
#define _LARGEFILE64_SOURCE
#include <sys/types.h>
#include "rfio_api.h"

int rfio_stat64 (const char *path, struct stat64 *statbuf);
int rfio_fstat64 (int s, struct stat64 *statbuf);
int rfio_lstat64 (const char *path, struct stat64 *statbuf);
int rfio_mstat64 (const char *path, struct stat64 *statbuf);

For large files, under other systems:
#include <sys/types.h>
#include "rfio_api.h"

int rfio_stat64 (const char *path, struct stat64 *statbuf);
int rfio_fstat64 (int s, struct stat64 *statbuf);
int rfio_lstat64 (const char *path, struct stat64 *statbuf);
int rfio_mstat64 (const char *path, struct stat64 *statbuf);  

DESCRIPTION

rfio_stat gets information about a file or directory.

rfio_lstat is identical to rfio_stat except for symbolic links. In this case, the link itself is statted and not followed.

rfio_fstat is identical to rfio_stat but works on the file descriptor s returned by rfio_open.

rfio_mstat is identical to rfio_stat but keeps the connection open to the server unless there are more than MAXMCON connections already opened. This is useful when issuing a series of stat calls. The last rfio_mstat call should be followed by a call to rfio_end.

rfio_mstat_reset is to be used when your program is forking. In such a case the permanent connections opened with rfio_mstat become shared between the parent and the child. Use rfio_mstat_reset to perform the necessary reset and close of the socket file descriptor in the parent or the child in order to be sure that only of them will receice an answer from the RFIO daemon.

See NOTES section below.

path
specifies the logical pathname relative to the current directory or the full pathname.
statbuf
is a pointer to a stat structure, receiving result of your query. The 64 bits functions must be used for large files. They have the same syntax as the normal stat functions except that they use a stat64 structure.
 

RETURN VALUE

This routine returns 0 if the operation was successful or -1 if the operation failed. In the latter case, serrno is set appropriately.  

NOTES

Multiple connections using rfio_mstat are thread-safe but not process-wide, therefore a forked child can share file descriptors opened with rfio_mstat by its parent. Use rfio_mstat_reset in such case. Multiple connections behaviour is undefined if you work in a multi-threaded environment and with threads not created using the LCG's Cthread interface.  

ERRORS

ENOENT
The named file/directory does not exist or is a null pathname.
EBADF
s is not a valid file descriptor.
EACCES
Search permission is denied on a component of the path prefix.
EFAULT
path or statbuf is a NULL pointer.
ENOTDIR
A component of path prefix is not a directory.
ENAMETOOLONG
The length of path exceeds CA_MAXPATHLEN or the length of a path component exceeds CA_MAXNAMELEN.
SENOSHOST
Host unknown.
SENOSSERV
Service unknown.
SECOMERR
Communication error.
 

SEE ALSO

Castor_limits(4), rfio_chmod(3), rfio_chown(3), Cthread(3)  

AUTHOR

LCG Grid Deployment Team