nfs.h File Reference

Network File System protocol. More...

#include <stdint.h>
#include <ipxe/oncrpc.h>

Go to the source code of this file.

Data Structures
struct	nfs_fh
	A NFS file handle. More...
struct	nfs_lookup_reply
	A NFS LOOKUP reply. More...
struct	nfs_readlink_reply
	A NFS READLINK reply. More...
struct	nfs_read_reply
	A NFS READ reply. More...

Macros
#define	ONCRPC_NFS   100003
	NFS protocol number. More...
#define	NFS_VERS   3
	NFS protocol version. More...
#define	NFS3_OK   0
	No error. More...
#define	NFS3ERR_PERM   1
	Not owner. More...
#define	NFS3ERR_NOENT   2
	No such file or directory. More...
#define	NFS3ERR_IO   5
	I/O error. More...
#define	NFS3ERR_NXIO   6
	No such device or address. More...
#define	NFS3ERR_ACCES   13
	Permission denied. More...
#define	NFS3ERR_EXIST   17
	The file specified already exists. More...
#define	NFS3ERR_XDEV   18
	Attempt to do a cross-device hard link. More...
#define	NFS3ERR_NODEV   19
	No such device. More...
#define	NFS3ERR_NOTDIR   20
	Not a directory. More...
#define	NFS3ERR_ISDIR   21
	Is a directory. More...
#define	NFS3ERR_INVAL   22
	Invalid argument. More...
#define	NFS3ERR_NAMETOOLONG   63
	Filename too long. More...
#define	NFS3ERR_STALE   70
	Invalid file handle. More...
#define	NFS3ERR_REMOTE   71
	Too many levels of remote in path. More...
#define	NFS3ERR_BADHANDLE   10001
	Illegal NFS file handle. More...
#define	NFS3ERR_BAD_COOKIE   10003
	READDIR or READDIRPLUS cookie is stale. More...
#define	NFS3ERR_NOTSUPP   10004
	Operation not supported. More...
#define	NFS3ERR_TOOSMALL   10005
	Buffer or request is too small. More...
#define	NFS3ERR_SERVERFAULT   10006
	An error occurred on the server which does not map to any of the legal NFS version 3 protocol error values. More...
#define	NFS3ERR_JUKEBOX   10008
	The server initiated the request, but was not able to complete it in a timely fashion. More...

Enumerations
enum	nfs_attr_type { NFS_ATTR_SYMLINK = 5 }

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
size_t	nfs_iob_get_fh (struct io_buffer *io_buf, struct nfs_fh *fh)
	Extract a file handle from the beginning of an I/O buffer. More...
size_t	nfs_iob_add_fh (struct io_buffer *io_buf, const struct nfs_fh *fh)
	Add a file handle to the end of an I/O buffer. More...
static void	nfs_init_session (struct oncrpc_session *session, struct oncrpc_cred *credential)
	Prepare an ONC RPC session to be used as a NFS session. More...
int	nfs_lookup (struct interface *intf, struct oncrpc_session *session, const struct nfs_fh *fh, const char *filename)
	Send a LOOKUP request. More...
int	nfs_readlink (struct interface *intf, struct oncrpc_session *session, const struct nfs_fh *fh)
	Send a READLINK request. More...
int	nfs_read (struct interface *intf, struct oncrpc_session *session, const struct nfs_fh *fh, uint64_t offset, uint32_t count)
	Send a READ request. More...
int	nfs_get_lookup_reply (struct nfs_lookup_reply *lookup_reply, struct oncrpc_reply *reply)
	Parse a LOOKUP reply. More...
int	nfs_get_readlink_reply (struct nfs_readlink_reply *readlink_reply, struct oncrpc_reply *reply)
	Parse a READLINK reply. More...
int	nfs_get_read_reply (struct nfs_read_reply *read_reply, struct oncrpc_reply *reply)
	Parse a READ reply. More...

Detailed Description

Network File System protocol.

Definition in file nfs.h.

Macro Definition Documentation

ONCRPC_NFS

#define ONCRPC_NFS   100003

NFS protocol number.

Definition at line 16 of file nfs.h.

NFS_VERS

#define NFS_VERS   3

NFS protocol version.

Definition at line 19 of file nfs.h.

NFS3_OK

#define NFS3_OK   0

No error.

Definition at line 22 of file nfs.h.

NFS3ERR_PERM

#define NFS3ERR_PERM   1

Not owner.

Definition at line 24 of file nfs.h.

NFS3ERR_NOENT

#define NFS3ERR_NOENT   2

No such file or directory.

Definition at line 26 of file nfs.h.

NFS3ERR_IO

#define NFS3ERR_IO   5

I/O error.

Definition at line 28 of file nfs.h.

NFS3ERR_NXIO

#define NFS3ERR_NXIO   6

No such device or address.

Definition at line 30 of file nfs.h.

NFS3ERR_ACCES

#define NFS3ERR_ACCES   13

Permission denied.

Definition at line 32 of file nfs.h.

NFS3ERR_EXIST

#define NFS3ERR_EXIST   17

The file specified already exists.

Definition at line 34 of file nfs.h.

NFS3ERR_XDEV

#define NFS3ERR_XDEV   18

Attempt to do a cross-device hard link.

Definition at line 36 of file nfs.h.

NFS3ERR_NODEV

#define NFS3ERR_NODEV   19

No such device.

Definition at line 38 of file nfs.h.

NFS3ERR_NOTDIR

#define NFS3ERR_NOTDIR   20

Not a directory.

Definition at line 40 of file nfs.h.

NFS3ERR_ISDIR

#define NFS3ERR_ISDIR   21

Is a directory.

Definition at line 42 of file nfs.h.

NFS3ERR_INVAL

#define NFS3ERR_INVAL   22

Invalid argument.

Definition at line 44 of file nfs.h.

NFS3ERR_NAMETOOLONG

#define NFS3ERR_NAMETOOLONG   63

Filename too long.

Definition at line 46 of file nfs.h.

NFS3ERR_STALE

#define NFS3ERR_STALE   70

Invalid file handle.

Definition at line 48 of file nfs.h.

NFS3ERR_REMOTE

#define NFS3ERR_REMOTE   71

Too many levels of remote in path.

Definition at line 50 of file nfs.h.

NFS3ERR_BADHANDLE

#define NFS3ERR_BADHANDLE   10001

Illegal NFS file handle.

Definition at line 52 of file nfs.h.

NFS3ERR_BAD_COOKIE

#define NFS3ERR_BAD_COOKIE   10003

READDIR or READDIRPLUS cookie is stale.

Definition at line 54 of file nfs.h.

NFS3ERR_NOTSUPP

#define NFS3ERR_NOTSUPP   10004

Operation not supported.

Definition at line 56 of file nfs.h.

NFS3ERR_TOOSMALL

#define NFS3ERR_TOOSMALL   10005

Buffer or request is too small.

Definition at line 58 of file nfs.h.

NFS3ERR_SERVERFAULT

#define NFS3ERR_SERVERFAULT   10006

An error occurred on the server which does not map to any of the legal NFS version 3 protocol error values.

Definition at line 61 of file nfs.h.

NFS3ERR_JUKEBOX

#define NFS3ERR_JUKEBOX   10008

The server initiated the request, but was not able to complete it in a timely fashion.

Definition at line 64 of file nfs.h.

Enumeration Type Documentation

nfs_attr_type

enum nfs_attr_type

Enumerator
NFS_ATTR_SYMLINK

Definition at line 66 of file nfs.h.

                   {
        NFS_ATTR_SYMLINK = 5,
};

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

nfs_iob_get_fh()

size_t nfs_iob_get_fh	(	struct io_buffer *	io_buf,
		struct nfs_fh *	fh
	)

Extract a file handle from the beginning of an I/O buffer.

Parameters

io_buf	I/O buffer
fh	File handle

Return values

size	Size of the data read

Definition at line 59 of file nfs.c.

                                                                      {
        fh->size = oncrpc_iob_get_int ( io_buf );

        if ( fh->size > 64 )
                return sizeof ( uint32_t );

        memcpy (fh->fh, io_buf->data, fh->size );
        iob_pull ( io_buf, fh->size );

        return fh->size + sizeof ( uint32_t );
}

References io_buffer::data, nfs_fh::fh, iob_pull, memcpy(), oncrpc_iob_get_int, and nfs_fh::size.

Referenced by mount_get_mnt_reply(), and nfs_get_lookup_reply().

nfs_iob_add_fh()

size_t nfs_iob_add_fh	(	struct io_buffer *	io_buf,
		const struct nfs_fh *	fh
	)

Add a file handle to the end of an I/O buffer.

Parameters

io_buf	I/O buffer
fh	File handle

Return values

size	Size of the data written

Definition at line 78 of file nfs.c.

                                                                            {
        size_t s;

        s = oncrpc_iob_add_int ( io_buf, fh->size );
        memcpy ( iob_put ( io_buf, fh->size ), &fh->fh, fh->size );

        return s + fh->size;
}

References nfs_fh::fh, iob_put, memcpy(), oncrpc_iob_add_int(), and nfs_fh::size.

nfs_init_session()

static void nfs_init_session ( struct oncrpc_session *  session, struct oncrpc_cred *  credential  )

inlinestatic

Prepare an ONC RPC session to be used as a NFS session.

Parameters

session	ONC RPC session
credential	ONC RPC credential

The credential parameter must not be NULL, use 'oncrpc_auth_none' if you don't want a particular scheme to be used.

Definition at line 137 of file nfs.h.

                                                                       {
        oncrpc_init_session ( session, credential, &oncrpc_auth_none,
                              ONCRPC_NFS, NFS_VERS );
}

References NFS_VERS, oncrpc_auth_none, oncrpc_init_session(), and ONCRPC_NFS.

Referenced by nfs_open().

nfs_lookup()

int nfs_lookup	(	struct interface *	intf,
		struct oncrpc_session *	session,
		const struct nfs_fh *	fh,
		const char *	filename
	)

Send a LOOKUP request.

Parameters

intf	Interface to send the request on
session	ONC RPC session
fh	The file handle of the the directory
filename	The file name

Return values

rc	Return status code

Definition at line 96 of file nfs.c.

                                                                 {
        struct oncrpc_field fields[] = {
                ONCRPC_SUBFIELD ( array, fh->size, &fh->fh ),
                ONCRPC_FIELD ( str, filename ),
                ONCRPC_FIELD_END,
        };

        return oncrpc_call ( intf, session, NFS_LOOKUP, fields );
}

References array, nfs_fh::fh, NFS_LOOKUP, oncrpc_call(), ONCRPC_FIELD, ONCRPC_FIELD_END, ONCRPC_SUBFIELD, and nfs_fh::size.

Referenced by nfs_step().

nfs_readlink()

int nfs_readlink	(	struct interface *	intf,
		struct oncrpc_session *	session,
		const struct nfs_fh *	fh
	)

Send a READLINK request.

Parameters

intf	Interface to send the request on
session	ONC RPC session
fh	The symlink file handle

Return values

rc	Return status code

Definition at line 115 of file nfs.c.

                                             {
        struct oncrpc_field fields[] = {
                ONCRPC_SUBFIELD ( array, fh->size, &fh->fh ),
                ONCRPC_FIELD_END,
        };

        return oncrpc_call ( intf, session, NFS_READLINK, fields );
}

References array, nfs_fh::fh, NFS_READLINK, oncrpc_call(), ONCRPC_FIELD_END, ONCRPC_SUBFIELD, and nfs_fh::size.

Referenced by nfs_step().

nfs_read()

int nfs_read	(	struct interface *	intf,
		struct oncrpc_session *	session,
		const struct nfs_fh *	fh,
		uint64_t	offset,
		uint32_t	count
	)

Send a READ request.

Parameters

intf	Interface to send the request on
session	ONC RPC session
fh	The file handle
offset	Offset
count	Byte count

Return values

rc	Return status code

Definition at line 135 of file nfs.c.

                                                                          {
        struct oncrpc_field fields[] = {
                ONCRPC_SUBFIELD ( array, fh->size, &fh->fh ),
                ONCRPC_FIELD ( int64, offset ),
                ONCRPC_FIELD ( int32, count ),
                ONCRPC_FIELD_END,
        };

        return oncrpc_call ( intf, session, NFS_READ, fields );
}

References array, count, nfs_fh::fh, NFS_READ, offset, oncrpc_call(), ONCRPC_FIELD, ONCRPC_FIELD_END, ONCRPC_SUBFIELD, and nfs_fh::size.

Referenced by nfs_step().

nfs_get_lookup_reply()

int nfs_get_lookup_reply	(	struct nfs_lookup_reply *	lookup_reply,
		struct oncrpc_reply *	reply
	)

Parse a LOOKUP reply.

Parameters

lookup_reply	A structure where the data will be saved
reply	The ONC RPC reply to get data from

Return values

rc	Return status code

Definition at line 154 of file nfs.c.

                                                        {
        if ( ! lookup_reply || ! reply )
                return -EINVAL;

        lookup_reply->status = oncrpc_iob_get_int ( reply->data );
        switch ( lookup_reply->status )
        {
        case NFS3_OK:
                break;
        case NFS3ERR_PERM:
                return -EPERM;
        case NFS3ERR_NOENT:
                return -ENOENT;
        case NFS3ERR_IO:
                return -EIO;
        case NFS3ERR_ACCES:
                return -EACCES;
        case NFS3ERR_NOTDIR:
                return -ENOTDIR;
        case NFS3ERR_NAMETOOLONG:
                return -ENAMETOOLONG;
        case NFS3ERR_STALE:
                return -ESTALE;
        case NFS3ERR_BADHANDLE:
        case NFS3ERR_SERVERFAULT:
        default:
                return -EPROTO;
        }

        nfs_iob_get_fh ( reply->data, &lookup_reply->fh );

        if ( oncrpc_iob_get_int ( reply->data ) == 1 )
                lookup_reply->ent_type = oncrpc_iob_get_int ( reply->data );

        return 0;
}

References oncrpc_reply::data, EACCES, EINVAL, EIO, ENAMETOOLONG, ENOENT, ENOTDIR, nfs_lookup_reply::ent_type, EPERM, EPROTO, ESTALE, nfs_lookup_reply::fh, NFS3_OK, NFS3ERR_ACCES, NFS3ERR_BADHANDLE, NFS3ERR_IO, NFS3ERR_NAMETOOLONG, NFS3ERR_NOENT, NFS3ERR_NOTDIR, NFS3ERR_PERM, NFS3ERR_SERVERFAULT, NFS3ERR_STALE, nfs_iob_get_fh(), oncrpc_iob_get_int, and nfs_lookup_reply::status.

Referenced by nfs_deliver().

nfs_get_readlink_reply()

int nfs_get_readlink_reply	(	struct nfs_readlink_reply *	readlink_reply,
		struct oncrpc_reply *	reply
	)

Parse a READLINK reply.

Parameters

readlink_reply	A structure where the data will be saved
reply	The ONC RPC reply to get data from

Return values

rc	Return status code

Definition at line 198 of file nfs.c.

                                                          {
        if ( ! readlink_reply || ! reply )
                return -EINVAL;

        readlink_reply->status = oncrpc_iob_get_int ( reply->data );
        switch ( readlink_reply->status )
        {
        case NFS3_OK:
                 break;
        case NFS3ERR_IO:
                return -EIO;
        case NFS3ERR_ACCES:
                return -EACCES;
        case NFS3ERR_INVAL:
                return -EINVAL;
        case NFS3ERR_NOTSUPP:
                return -ENOTSUP;
        case NFS3ERR_STALE:
                return -ESTALE;
        case NFS3ERR_BADHANDLE:
        case NFS3ERR_SERVERFAULT:
        default:
                return -EPROTO;
        }

        if ( oncrpc_iob_get_int ( reply->data ) == 1 )
                iob_pull ( reply->data, 5 * sizeof ( uint32_t ) +
                                        8 * sizeof ( uint64_t ) );

        readlink_reply->path_len = oncrpc_iob_get_int ( reply->data );
        readlink_reply->path     = reply->data->data;

        return 0;
}

References io_buffer::data, oncrpc_reply::data, EACCES, EINVAL, EIO, ENOTSUP, EPROTO, ESTALE, iob_pull, NFS3_OK, NFS3ERR_ACCES, NFS3ERR_BADHANDLE, NFS3ERR_INVAL, NFS3ERR_IO, NFS3ERR_NOTSUPP, NFS3ERR_SERVERFAULT, NFS3ERR_STALE, oncrpc_iob_get_int, nfs_readlink_reply::path, nfs_readlink_reply::path_len, and nfs_readlink_reply::status.

Referenced by nfs_deliver().

nfs_get_read_reply()

int nfs_get_read_reply	(	struct nfs_read_reply *	read_reply,
		struct oncrpc_reply *	reply
	)

Parse a READ reply.

Parameters

read_reply	A structure where the data will be saved
reply	The ONC RPC reply to get data from

Return values

rc	Return status code

Definition at line 241 of file nfs.c.

                                                      {
        if ( ! read_reply || ! reply )
                return -EINVAL;

        read_reply->status = oncrpc_iob_get_int ( reply->data );
        switch ( read_reply->status )
        {
        case NFS3_OK:
                 break;
        case NFS3ERR_PERM:
                return -EPERM;
        case NFS3ERR_NOENT:
                return -ENOENT;
        case NFS3ERR_IO:
                return -EIO;
        case NFS3ERR_NXIO:
                return -ENXIO;
        case NFS3ERR_ACCES:
                return -EACCES;
        case NFS3ERR_INVAL:
                return -EINVAL;
        case NFS3ERR_STALE:
                return -ESTALE;
        case NFS3ERR_BADHANDLE:
        case NFS3ERR_SERVERFAULT:
        default:
                return -EPROTO;
        }

        if ( oncrpc_iob_get_int ( reply->data ) == 1 )
        {
                iob_pull ( reply->data, 5 * sizeof ( uint32_t ) );
                read_reply->filesize = oncrpc_iob_get_int64 ( reply->data );
                iob_pull ( reply->data, 7 * sizeof ( uint64_t ) );
        }

        read_reply->count    = oncrpc_iob_get_int ( reply->data );
        read_reply->eof      = oncrpc_iob_get_int ( reply->data );
        read_reply->data_len = oncrpc_iob_get_int ( reply->data );
        read_reply->data     = reply->data->data;

        if ( read_reply->count != read_reply->data_len )
                return -EPROTO;

        return 0;
}

References nfs_read_reply::count, io_buffer::data, oncrpc_reply::data, nfs_read_reply::data, nfs_read_reply::data_len, EACCES, EINVAL, EIO, ENOENT, ENXIO, nfs_read_reply::eof, EPERM, EPROTO, ESTALE, nfs_read_reply::filesize, iob_pull, NFS3_OK, NFS3ERR_ACCES, NFS3ERR_BADHANDLE, NFS3ERR_INVAL, NFS3ERR_IO, NFS3ERR_NOENT, NFS3ERR_NXIO, NFS3ERR_PERM, NFS3ERR_SERVERFAULT, NFS3ERR_STALE, oncrpc_iob_get_int, oncrpc_iob_get_int64, and nfs_read_reply::status.

Referenced by nfs_deliver().