nfslib.c

vxworks的完整的源代码

/* nfsLib.c - Network File System (NFS) library */

/* Copyright 1984-2001 Wind River Systems, Inc. */
#include "copyright_wrs.h"

/*
modification history
--------------------
03k,10may02,kbw  making man page edits
03j,06nov01,vvv  made max path length configurable (SPR #63551)
03i,15oct01,rae  merge from truestack ver 03m, base 03h (cleanup)
03h,15mar99,c_c  Doc: updated nfsAuthUnixSet manual (SPR #20867).
03g,14mar99,jdi  doc: removed refs to config.h and/or configAll.h (SPR 25663).
03f,20nov97,gnn  fix for spr#5436, need to support FIOFSTATFSGET
03e,30may97,sgv  fix for spr#8653, Check for NULL parameter in nfsExportShow
03d,06aug96,sgv  fix for spr#6468
03c,06aug96,sgv  fix for spr #4278. Eliminated the nfsLib closing
		 of the UDP socket(multiple close).
03b,06aug96,sgv  fix for spr#5895
03a,23feb95,caf  cleaned up pointer reference in nfsExportShow().
02g,09oct94,jag  nfsDirReadOne() was changed to handle EOF correctly.
02f,08sep94,jmm  Changed to use the new rpc genned versions of the xdr rtns
02e,11aug93,jmm  Changed ioctl.h and socket.h to sys/ioctl.h and sys/socket.h
02d,28jul93,jmm  moved AUTH_UNIX_FIELD_LEN and MAX_GRPS definitions to nfsLib.h
02c,03feb93,jdi  documentation cleanup for 5.1.
02b,16sep92,jcf  change typedef path to nfsPath.
02a,07sep92,smb  added blksize and blocks to the stat structure initialisation.
01z,19aug92,smb  Changed systime.h to sys/times.h.
01y,18jul92,smb  Changed errno.h to errnoLib.h.
01x,26may92,rrr  the tree shuffle
		  -changed includes to have absolute path from h/
01w,20jan92,jmm  changed nfsDirReadOne to also set errno to OK
01w,20jan92,jmm  changed nfsThingCreate to recognize symlinks (spr 1059)
02n,19dec91,rrr  put dirent.h before nfsLib.h so it would compile
02m,13dec91,gae  ANSI fixes.
02l,19nov91,rrr  shut up some ansi warnings.
02k,04oct91,rrr  passed through the ansification filter
                  -changed functions to ansi style
		  -changed includes to have absolute path from h/
		  -changed VOID to void
		  -changed copyright notice
02j,26apr91,shl  removed NULL entry in help_msg of nfsHelp() (spr 987).
02i,05apr91,jdi	 documentation -- removed header parens and x-ref numbers;
		 switched nfsHelp() to first position; doc review by dnw.
02h,08mar91,elh  added nfsReXmit{Sec,USec} so re-xmit time not hardcoded.
02g,22feb91,lpf  made 'ls' command work on files mounted from HP. (SPR #0935)
02f,21feb91,jaa	 documentation.
02e,02oct90,hjb  added a call to htons() where needed.
02d,19jul90,dnw  mangen fix
02c,26jun90,jcf  changed semaphores to be mutex.
02b,29may90,dnw  fixed bug in nfsInit, introduced in 01x, of testing
		    taskRpcStatics->nfsClientCache before rpcTaskInit is called
		 made nfsInit be NOMANUAL
02a,10may90,dnw  fixed nfsDeleteHook to delete the owner task's nfs stuff rather
		   than the exception task's (del hooks are called by exception
		   task).
		 fixed nfsDeleteHook to free nfsClientCache
		 fixed nfsInit to add nfsDeleteHook only once
		 fixed bug in authorization usage: added authCount field to
		   verify that cached client authorization matches current
		   global setting
		 changed name of nfsAllUnmount() to nfsMntUnmountAll()
		 optimized by removing some unnecessary "freeres" calls
		 optimized by supplying buffers in xdr calls instead of having
		   them malloc'd, in readres (nfsFileRead) result msgs.
		 optimized by adding xdr_readdirresOne hack to nfsDirReadOne
		   which just decodes first entry and discards the rest.
		 changed references to taskModuleList to taskRpcStatics
		 added nfsExportRead and nfsExportFree for use by nfsMountAll
		   in nfsDrv
		 extracted client cache stuff from nfsClientCall() to new
		   function nfsClientCacheSetUp()
		 added forward declarations to fix lint about void
		 changed MAX_FILENAME_LENGTH to POSIX definitions PATH_MAX
		   and NAME_MAX where appropriate
		 cosmetic changes to print out of nfsExportShow and
		   nfsMountListPrint
		 removed nfsDirListPrint() (no longer used)
		 removed some unnecessary error printing
		 changed documentation about nfs's large stack requirements
		   (no longer a pig!)
01w,01may90,llk  deleted nfsLs().
		 added nfsDirReadOne() and nfsFileAttrGet().
		 changed to check return value of taskDeleteHookAdd().
		 changed calls to pathBuild() and pathCat() to examine return
		   values.
01v,14apr90,jcf  removed tcb extension dependencies.
01u,01apr90,llk  turned the `oldhost' field of moduleStatics into an array.
		 substituted smaller constants MAX_FILENAME_LENGTH for the
		   SUN specified NFS_MAXNAMLEN and NFS_MAXPATHLEN.
		 added safety checks for filename lengths.
		 deleted calls to pathArrayFree().
		 changed call to pathParse().
		 changed to clean out the CLIENT cache if authorization
		   parameters are changed by calling nfsClientCacheCleanUp().
		 changed rpcAuthUnix to nfsAuthUnix.  Made it LOCAL.
01t,07mar90,jdi  documentation cleanup.
01s,03dec89,llk  changed nfsClientClose() to check for non-null taskModuleList
		   before cleaning up the nfs cache.
01r,20oct89,hjb  changed "struct timeval" to nfsTimeval to avoid conflicts
		 with the definition of "struct timeval" in "utime.h".
01q,28aug89,dab  modified nfsFileRemove() to delete symbolic links.
01p,23jul89,gae  added taskDeleteHook for nfsCleanup.
01o,06jul89,llk  deleted nfsNameArrayFree().  Added call to pathArrayFree().
		 reworked calls to pathLib.  added panic() calls.  delinted.
01n,09jun89,llk  fixed bug in nfsLookUpByName() which showed up via rmdir().
01m,23may89,dnw  lint.
01l,26mar89,llk  added nfsClientCacheCleanUp and nfsNameArrayFree to get rid
		   of memory eaters.
01k,09nov88,llk  rearranged error checking of nfs structures returned by server.
01j,28sep88,llk  added nfsSockBufSize, nfsTimeoutSec, nfsTimeoutUSec.
		 added nfsIdSet().
01i,25aug88,gae  documentation.
01h,07jul88,jcf  lint.
01g,30jun88,llk  changed to handle links.
		 added nfsHelp().
		 more name changes.
01f,16jun88,llk  changed to more v4 names.
		 added LOCAL and NOMANUAL where appropriate.
		 moved pathSplit() to pathLib.c.
01e,04jun88,llk  rewrote nfsLs and nfsDirRead so they clean up after themselves.
		 incorporated pathLib.
		 added nfsAuthUnix{Set Get Prompt Show} for unix authentication.
01d,30may88,dnw  changed to v4 names.
01c,28may88,dnw  copied promptParam...() stuff here from bootLib so that
		   this lib doesn't depend on bootLib.
01b,26apr88,llk  bug fix.  Internet address returned from remGetHostByName
		   was compared to <= NULL.  Some large addresses can be
		   mistaken for negative numbers.
01a,19apr88,llk  written.
*/

/*
DESCRIPTION
This library provides the client side of services for NFS (Network File
System) devices.  Most routines in this library should not be called by
users, but rather by device drivers.  The driver is responsible for
keeping track of file pointers, mounted disks, and cached buffers.  This
library uses Remote Procedure Calls (RPC) to make the NFS calls.

VxWorks is delivered with NFS disabled.
To use this feature, include the following component:
INCLUDE_NFS

In the same file, NFS_USER_ID and NFS_GROUP_ID should be
defined to set the default user ID and group ID at system start-up.
For information about creating NFS devices, see the 
* .I "WindNet TCP/IP Network Programmer's Guide"

Normal use of NFS requires no more than 2000 bytes of stack. This 
requirement may change depending on how the maximum file name path length 
parameter, NFS_MAXPATH, is configured. As many as 4 character arrays of
length NFS_MAXPATH may be allocated off the stack during client operation.
Therefore any increase in the parameter can increase stack usage by a
factor of four times the deviation from default NFS_MAXPATH. For example,
a change from 255 to 1024 will increase peak stack usage by (1024 -255) * 4
which is 3076 bytes.


NFS USER IDENTIFICATION
NFS is built on top of RPC and uses a type of RPC authentication known as
AUTH_UNIX, which is passed on to the NFS server with every NFS request.
AUTH_UNIX is a structure that contains necessary information for NFS,
including the user ID number and a list of group IDs to which the user 
belongs.  On UNIX systems, a user ID is specified in the file 
\f3/etc/passwd\fP.  The list of groups to which a user belongs is 
specified in the file \f3/etc/group\fP.

To change the default authentication parameters, use nfsAuthUnixPrompt().
To change just the AUTH_UNIX ID, use nfsIdSet().  Usually, only the user
ID needs to be changed to indicate a new NFS user.

INCLUDE FILES: nfsLib.h

SEE ALSO
rpcLib, ioLib, nfsDrv

INTERNAL
Every routine starts with a call to nfsInit.  nfsInit initializes RPC
and sets up the appropriate RPC task variables used for NFS.  It
may be called more than once with the only ill effect being wasted time.

The constant nfsMaxPath is used instead of NFS_MAXPATHLEN (1024) or
PATH_MAX (255). nfsMaxPath is derived from the configuration parameter
NFS_MAXPATH. A short length like 255 helps conserve memory but restricts 
use of longer paths. The introduction of NFS_MAXPATH allows the user to
decide which is more important. The constant (NAME_MAX + 1) is used instead
of NFS_MAXNAMELEN (255) in order to conserve memory. All file/path names 
which have come to nfsLib via the I/O system, such as filenames being passed 
to nfsLookUpByName(), have already been screened for their path and name 
lengths being less than PATH_MAX and NAME_MAX.

xdr_nfs has been changed to use the shorter lengths as well.
*/

/* LINTLIBRARY */

#include "vxWorks.h"
#include "limits.h"
#include "ctype.h"
#include "string.h"
#include "ioLib.h"
#include "taskLib.h"
#include "taskHookLib.h"
#include "rpc/rpc.h"
#include "stdlib.h"
#include "sys/socket.h"
#include "netinet/in.h"
#include "rpc/auth.h"
#include "rpc/rpcGbl.h"
#include "xdr_nfs.h"
#include "sys/stat.h"
#include "dirent.h"
#include "nfsLib.h"
#include "hostLib.h"
#include "sys/times.h"
#include "sockLib.h"
#include "pathLib.h"
#include "stdio.h"
#include "unistd.h"
#include "errnoLib.h"
#include "rpcLib.h"
#include "netLib.h"
#include "fioLib.h"
#include "memPartLib.h"

#define READDIR_MAXLEN		512	/* increased for NFSPROC_READDIR on */
					/* HP server */

#ifdef __GNUC__
# ifndef alloca
#  define alloca __builtin_alloca
# endif
#endif

/* IMPORTS */

IMPORT int   nfsMaxPath;               /* max. length of file path */

/* GLOBALS */

unsigned nfsMaxMsgLen = NFS_MAXDATA;	/* largest read or write buffer that
					 * can be transfered to/from the nfs
					 * server
					 */
u_int nfsTimeoutSec   = NFS_TIMEOUT_SEC;
u_int nfsTimeoutUSec  = NFS_TIMEOUT_USEC;

u_int nfsReXmitSec    = NFS_REXMIT_SEC;
u_int nfsReXmitUSec   = NFS_REXMIT_USEC;

int   nfsSockBufSize  = NFS_SOCKOPTVAL;

/* LOCALS */

/*
Static RPC information.
Set on initial NFS invocation and re-used during
subsequent calls on a per task basis.
*/

typedef struct moduleStatics
    {
    CLIENT *client;     /* pointer to client structure */
    int socket;         /* socket associated with this client */
    int oldprognum;     /* last program number used with this client */
    int oldversnum;     /* last version number used with this client */
    int authCount;	/* auth count this client was built with */
    int valid;          /* if TRUE, then this client information is valid */
    char oldhost [MAXHOSTNAMELEN];
    			/* last host name that was used with this client */
    } NFS_MODULE_STATICS;

typedef struct		/* NFS_AUTH_UNIX_TYPE - UNIX authentication structure */
    {
    char machname [AUTH_UNIX_FIELD_LEN];  /* host name where client is */
    int uid;			/* client's UNIX effective uid */
    int gid;			/* client's current group ID */
    int len;			/* element length of aup_gids */
    int aup_gids [MAX_GRPS];	/* array of groups user is in */
    } NFS_AUTH_UNIX_TYPE;

/* There is a single global nfs authorization, nfsAuthUnix.
 * Any time it is changed, nfsAuthCount is bumped.  This count is kept
 * in the nfsClientCache to make sure that the client was built with the
 * current authorization parameters.  In the future, it might be desirable
 * to let different tasks have different authorizations.
 */

LOCAL NFS_AUTH_UNIX_TYPE nfsAuthUnix;
LOCAL int  nfsAuthCount;

LOCAL BOOL nfsInstalled;

/* forward declarations */

LOCAL STATUS nfsClientCall (char *host, u_int prognum, u_int versnum, u_int procnum, xdrproc_t inproc, char *in, xdrproc_t outproc, char *out);
LOCAL STATUS nfsLinkGet (char * hostName, nfs_fh * pHandle, nfspath realPath);
LOCAL STATUS nfsInit (void);
LOCAL void nfsDeleteHook ();
LOCAL void nfsClientCacheCleanUp ();
LOCAL void nfsMountListPrint ();
LOCAL void nfsGroupsPrint ();
LOCAL void nfsExportPrint ();
LOCAL void nfsErrnoSet ();
LOCAL void printClear ();
LOCAL void promptParamString ();
LOCAL void promptParamNum ();

/*******************************************************************************
*
* nfsDirMount - mount an NFS directory
*
* RETURNS: OK or ERROR
*
* NOMANUAL
*/

STATUS nfsDirMount
    (
    char *hostName,
    dirpath dirname,
    nfs_fh *pFileHandle         /* the directory's file handle */
    )
    {
    fhstatus fileHandleStatus;

    bzero ((char *) &fileHandleStatus, sizeof (fileHandleStatus));

    if (nfsClientCall (hostName, MOUNTPROG, MOUNTVERS, MOUNTPROC_MNT,
			xdr_dirpath, (char *) &dirname,
			xdr_fhstatus, (char *) &fileHandleStatus) == ERROR)
	{
	return (ERROR);
	}

    if (fileHandleStatus.fhs_status != 0)
	{
	netErrnoSet ((int) fileHandleStatus.fhs_status);	/* UNIX error */
	return (ERROR);
	}

    bcopy ((char *) &fileHandleStatus.fhstatus_u.fhs_fhandle,
	   (char *) pFileHandle, sizeof (nfs_fh));

    return (OK);
    }
/*******************************************************************************
*
* nfsDirUnmount - unmount an NFS directory
*
* RETURNS: OK or ERROR
*
* NOMANUAL
*/

STATUS nfsDirUnmount
    (
    char *hostName,
    dirpath dirname
    )
    {
    return (nfsClientCall (hostName, MOUNTPROG, MOUNTVERS, MOUNTPROC_UMNT,
				xdr_dirpath, (char *) &dirname,
				xdr_void, (char *) NULL));
    }
/*******************************************************************************
*
* nfsMntUnmountAll - unmount all file systems on a particular host
*
* This routine removes all NFS file systems mounted on <hostName> from that
* host's client list.  It does NOT actually "unmount" the file systems.
*
* RETURNS: OK or ERROR.
*
* SEE ALSO: nfsMntDump()
*
* NOMANUAL
*/

STATUS nfsMntUnmountAll
    (
    char *hostName              /* host machine to unmount from */
    )
    {
    return (nfsClientCall (hostName, MOUNTPROG, MOUNTVERS, MOUNTPROC_UMNTALL,
				xdr_void, (char *) NULL,
				xdr_void, (char *) NULL));
    }
/*******************************************************************************
*
* nfsMntDump - display all NFS file systems mounted on a particular host
*
* This routine displays all the NFS file systems mounted on a specified host
* machine.
*
* RETURNS: OK or ERROR.
*
* NOMANUAL
*/

STATUS nfsMntDump
    (
    char *hostName              /* host machine */
    )
    {
    mountlist mEntries;

    bzero ((char *) &mEntries, sizeof (mEntries));

    if (nfsClientCall (hostName, MOUNTPROG, MOUNTVERS, MOUNTPROC_DUMP,
				xdr_void, (char *) NULL,
				xdr_mountlist, (char *) &mEntries) == ERROR)
	{
	return (ERROR);
	}

    if (mEntries)
	nfsMountListPrint (mEntries);

    clntudp_freeres (taskRpcStatics->nfsClientCache->client, xdr_mountlist,
		     (caddr_t) &mEntries);
    return (OK);
    }
/*******************************************************************************