NFS Client Library

Files
file	mount_prot.h
	Nfsclient Mount Prot.
file	librtemsNfs.h
	Public Interface to the NFS Client Library for RTEMS.
file	rpcio.h
	A Multithreaded RPC/UDP Multiplexor.

Macros
#define	RPCIOD_DEFAULT_ID   0xdef10000

Typedefs
typedef struct RpcUdpServerRec_ *	RpcUdpServer
typedef struct RpcUdpXactRec_ *	RpcUdpXact
typedef RpcUdpXact	RpcUdpClnt
typedef void *	XdrProcT
	Mute compiler warnings.
typedef void *	CaddrT
typedef struct RpcUdpXactPoolRec_ *	RpcUdpXactPool

Enumerations
enum	XactPoolGetMode { XactGetFail, XactGetWait, XactGetCreate }

Functions
void	rpcSetXIDs (uint32_t xid)
	Sets the XIDs of the RPC transaction hash table. More...
int	rpcUdpInit (void)
	Initialize the driver. More...
int	rpcUdpCleanup (void)
	RPC cleanup and stop. More...
int	nfsInit (int smallPoolDepth, int bigPoolDepth)
	NFS driver interface. More...
int	nfsCleanup (void)
	Driver cleanup code. More...
int	nfsMountsShow (FILE *f)
	Dump a list of the currently mounted NFS to a file. More...
int	rtems_nfs_initialize (rtems_filesystem_mount_table_entry_t *mt_entry, const void *data)
	Filesystem mount table mount handler. More...
rtems_status_code	rtems_filesystem_resolve_location (char *buf, int len, rtems_filesystem_location_info_t *loc)
	A utility routine to find the path leading to a rtems_filesystem_location_info_t node. More...
int	nfsSetTimeout (uint32_t timeout_ms)
	Set the timeout (initial default: 10s) for NFS and mount calls. More...
uint32_t	nfsGetTimeout (void)
	Read current timeout (in milliseconds)
enum clnt_stat	rpcUdpServerCreate (struct sockaddr_in *paddr, rpcprog_t prog, rpcvers_t vers, u_long uid, u_long gid, RpcUdpServer *pclnt)
void	rpcUdpServerDestroy (RpcUdpServer s)
int	rpcUdpStats (FILE *f)
	Dump statistics to a file (stdout if NULL);. More...
enum clnt_stat	rpcUdpClntCreate (struct sockaddr_in *psaddr, rpcprog_t prog, rpcvers_t vers, u_long uid, u_long gid, RpcUdpClnt *pclnt)
void	RpcUdpClntDestroy (RpcUdpClnt clnt)
enum clnt_stat	rpcUdpClntCall (RpcUdpClnt clnt, u_long proc, XdrProcT xargs, CaddrT pargs, XdrProcT xres, CaddrT pres, struct timeval *timeout)
RpcUdpXact	rpcUdpXactCreate (u_long program, u_long version, u_long size)
void	rpcUdpXactDestroy (RpcUdpXact xact)
enum clnt_stat	rpcUdpSend (RpcUdpXact xact, RpcUdpServer srvr, struct timeval *timeout, u_long proc, xdrproc_t xres, caddr_t pres, xdrproc_t xargs, caddr_t pargs,...)
	Send a transaction.
enum clnt_stat	rpcUdpRcv (RpcUdpXact xact)
	Wait for a transaction to complete.
enum clnt_stat	rpcUdpCallRp (struct sockaddr_in *pserver_addr, u_long prog, u_long vers, u_long proc, XdrProcT xargs, CaddrT pargs, XdrProcT xres, CaddrT pres, u_long uid, u_long gid, struct timeval *timeout)
RpcUdpXactPool	rpcUdpXactPoolCreate (rpcprog_t prog, rpcvers_t version, int xactsize, int poolsize)
void	rpcUdpXactPoolDestroy (RpcUdpXactPool pool)
RpcUdpXact	rpcUdpXactPoolGet (RpcUdpXactPool pool, XactPoolGetMode mode)
void	rpcUdpXactPoolPut (RpcUdpXact xact)

Variables
rtems_task_priority	rpciodPriority
	RPCIO driver interface. More...

Detailed Description

Function Documentation

nfsCleanup()

int nfsCleanup

(

void

)

Driver cleanup code.

Return values

0	on success, nonzero if still in use

nfsInit()

int nfsInit	(	int	smallPoolDepth,
		int	bigPoolDepth
	)

NFS driver interface.

Initialize the NFS driver.

The RPCIO driver must have been initialized prior to calling this.

Note, called in nfsfs initialise when mount is called with defaults.

ARGS: depth of the small and big transaction pools, i.e. how many transactions (buffers) should always be kept around.

(If more transactions are needed, they are created and destroyed on the fly).

Supply zero values to have the driver chose reasonable defaults.

Return values

0	Successful operation.
-1	An error occurred. The errno is set to indicate the error.

nfsMountsShow()

int nfsMountsShow

(

FILE *

f

)

Dump a list of the currently mounted NFS to a file.

Dump a list of the currently mounted NFS to a file (stdout is used in case f==NULL)

nfsSetTimeout()

int nfsSetTimeout

(

uint32_t

timeout_ms

)

Set the timeout (initial default: 10s) for NFS and mount calls.

Set the timeout (initial default: 10s) for NFS and mount calls.

Return values

0	on success, nonzero if the requested timeout is less than a clock tick or if the system clock rate cannot be determined.

rpcSetXIDs()

void rpcSetXIDs

(

uint32_t

xid

)

Sets the XIDs of the RPC transaction hash table.

The active RPC transactions are stored in a hash table. Each table entry contains the XID of its corresponding transaction. The XID consists of two parts. The lower part is determined by the hash table index. The upper part is incremented in each send operation.

This function sets the upper part of the XID in all hash table entries. This can be used to ensure that the XIDs are not reused in a short interval for example during a boot process or after resets.

Parameters

[in]

xid

The upper part is used to set the upper XID part of the hash table entries.

rpcUdpCleanup()

int rpcUdpCleanup

(

void

)

RPC cleanup and stop.

Return values

0	on success, nonzero if still in use

References rtems_build_name, RTEMS_DEFAULT_ATTRIBUTES, and rtems_semaphore_create().

rpcUdpInit()

int rpcUdpInit

(

void

)

Initialize the driver.

Note, called in nfsfs initialise when mount is called.

Return values

0	on success, -1 on failure

rpcUdpStats()

int rpcUdpStats

(

FILE *

f

)

Dump statistics to a file (stdout if NULL);.

Return values

0	for convenience

rtems_filesystem_resolve_location()

rtems_status_code rtems_filesystem_resolve_location	(	char *	buf,
		int	len,
		rtems_filesystem_location_info_t *	loc
	)

A utility routine to find the path leading to a rtems_filesystem_location_info_t node.

This should really be present in libcsupport...

Parameters

[in]	'loc'	and a buffer 'buf' (length 'len') to hold the path.
[out]	path	copied into 'buf'

Return values

0	on success, RTEMS error code on error.

rtems_nfs_initialize()

int rtems_nfs_initialize	(	rtems_filesystem_mount_table_entry_t *	mt_entry,
		const void *	data
	)

Filesystem mount table mount handler.

Filesystem mount table mount handler. Do not call, use the mount call.

Variable Documentation

rpciodPriority

rtems_task_priority rpciodPriority

RPCIO driver interface.

If you need RPCIO for other purposes than NFS you may want to include <rpcio.h> #include "rpcio.h" Priority of daemon; may be setup prior to calling rpcUdpInit(); otherwise the network task priority from the rtems_bsdnet_config is used...