123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473 |
- /****************************************************************************
- * fs/nfs/rpc.h
- *
- * Copyright (C) 2012 Gregory Nutt. All rights reserved.
- * Copyright (C) 2012 Jose Pablo Rojas Vargas. All rights reserved.
- * Author: Jose Pablo Rojas Vargas <jrojas@nx-engineering.com>
- * Gregory Nutt <gnutt@nuttx.org>
- *
- * Leveraged from OpenBSD:
- *
- * copyright (c) 2003
- * the regents of the university of michigan
- * all rights reserved
- *
- * permission is granted to use, copy, create derivative works and redistribute
- * this software and such derivative works for any purpose, so long as the name
- * of the university of michigan is not used in any advertising or publicity
- * pertaining to the use or distribution of this software without specific,
- * written prior authorization. if the above copyright notice or any other
- * identification of the university of michigan is included in any copy of any
- * portion of this software, then the disclaimer below must also be included.
- *
- * this software is provided as is, without representation from the university
- * of michigan as to its fitness for any purpose, and without warranty by the
- * university of michigan of any kind, either express or implied, including
- * without limitation the implied warranties of merchantability and fitness for
- * a particular purpose. the regents of the university of michigan shall not be
- * liable for any damages, including special, indirect, incidental, or
- * consequential damages, with respect to any claim arising out of or in
- * connection with the use of the software, even if it has been or is hereafter
- * advised of the possibility of such damages.
- *
- * Copyright (c) 1989, 1993
- * The Regents of the University of California. All rights reserved.
- *
- * This code is derived from software contributed to Berkeley by
- * Rick Macklem at The University of Guelph.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * 3. All advertising materials mentioning features or use of this software
- * must display the following acknowledgement:
- * This product includes software developed by the University of
- * California, Berkeley and its contributors.
- * 4. Neither the name of the University nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- *
- ****************************************************************************/
- #ifndef __FS_NFS_RPC_H
- #define __FS_NFS_RPC_H
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <sys/types.h>
- #include <nuttx/net/net.h>
- #include "nfs_proto.h"
- /****************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
- /* Version # */
- #define RPC_VER2 2
- /* Authentication */
- #define RPCAUTH_NULL 0
- #define RPCAUTH_UNIX 1
- #define RPCAUTH_SHORT 2
- #define RPCAUTH_KERB4 4
- #define RPCAUTH_MAXSIZ 400
- #define RPCVERF_MAXSIZ 12
- /* For Kerb, can actually be 400 */
- #define RPCAUTH_UNIXGIDS 16
- /* Constants associated with authentication flavours. */
- #define RPCAKN_FULLNAME 0
- #define RPCAKN_NICKNAME 1
- /* RPC Constants */
- #define RPC_CALL 0
- #define RPC_REPLY 1
- #define RPC_MSGACCEPTED 0
- #define RPC_MSGDENIED 1
- #define RPC_PROGUNAVAIL 1
- #define RPC_PROGMISMATCH 2
- #define RPC_PROCUNAVAIL 3
- #define RPC_GARBAGE 4
- #define RPC_MISMATCH 0
- #define RPC_AUTHERR 1
- /* Authentication failures */
- #define AUTH_BADCRED 1
- #define AUTH_REJECTCRED 2
- #define AUTH_BADVERF 3
- #define AUTH_REJECTVERF 4
- #define AUTH_TOOWEAK 5
- /* Sizes of RPC header parts */
- #define RPC_SIZ 24
- #define RPC_REPLYSIZ 28
- /* RPC Prog definitions */
- #define RPCPROG_MNT 100005
- #define RPCMNT_VER1 1
- #define RPCMNT_VER3 3
- #define RPCMNT_MOUNT 1
- #define RPCMNT_DUMP 2
- #define RPCMNT_UMOUNT 3
- #define RPCMNT_UMNTALL 4
- #define RPCMNT_EXPORT 5
- #define RPCMNT_NAMELEN 255
- #define RPCMNT_PATHLEN 1024
- #define RPCPROG_NFS 100003
- /* RPC definitions for the portmapper. */
- #define PMAPPROG 100000
- #define PMAPVERS 2
- #define PMAPPROC_NULL 0
- #define PMAPPROC_SET 1
- #define PMAPPROC_UNSET 2
- #define PMAPPROC_GETPORT 3
- #define PMAPPROC_DUMP 4
- #define PMAPPROC_CALLIT 5
- #define RPC_SUCCESS 0
- /****************************************************************************
- * Public Types
- ****************************************************************************/
- /* PMAP headers */
- struct call_args_pmap
- {
- uint32_t prog;
- uint32_t vers;
- uint32_t prot;
- uint32_t port;
- };
- struct call_result_pmap
- {
- uint32_t port;
- };
- /* MOUNTD headers */
- struct call_args_mount
- {
- uint32_t len;
- char rpath[90];
- };
- struct call_args_umount
- {
- uint32_t len;
- char rpath[90];
- };
- enum auth_flavor
- {
- AUTH_NONE = 0,
- AUTH_SYS = 1,
- AUTH_SHORT = 2,
- AUTH_DES = 3,
- AUTH_MAX
- /* and more to be defined */
- };
- struct call_result_mount
- {
- uint32_t status;
- struct file_handle fhandle;
- uint32_t authlen;
- uint32_t authlist[AUTH_MAX];
- };
- /* Generic RPC call headers */
- struct rpc_auth_info
- {
- uint32_t authtype; /* auth type */
- uint32_t authlen; /* auth length */
- };
- struct rpc_auth_unix
- {
- uint32_t stamp;
- uint32_t hostname; /* null */
- uint32_t uid;
- uint32_t gid;
- uint32_t gidlist; /* null */
- };
- struct rpc_call_header
- {
- uint32_t rp_xid; /* request transaction id */
- int32_t rp_direction; /* call direction (0) */
- uint32_t rp_rpcvers; /* RPC version (2) */
- uint32_t rp_prog; /* program */
- uint32_t rp_vers; /* version */
- uint32_t rp_proc; /* procedure */
- struct rpc_auth_info rpc_auth;
- struct rpc_auth_unix rpc_unix;
- struct rpc_auth_info rpc_verf;
- };
- struct rpc_call_pmap
- {
- struct rpc_call_header ch;
- struct call_args_pmap pmap;
- };
- struct rpc_call_mount
- {
- struct rpc_call_header ch;
- struct call_args_mount mount;
- };
- struct rpc_call_umount
- {
- struct rpc_call_header ch;
- struct call_args_umount umount;
- };
- struct rpc_call_create
- {
- struct rpc_call_header ch;
- struct CREATE3args create;
- };
- struct rpc_call_lookup
- {
- struct rpc_call_header ch;
- struct LOOKUP3args lookup;
- };
- #define SIZEOF_rpc_call_lookup(n) (sizeof(struct rpc_call_header) + SIZEOF_LOOKUP3args(n))
- struct rpc_call_read
- {
- struct rpc_call_header ch;
- struct READ3args read;
- };
- struct rpc_call_write
- {
- struct rpc_call_header ch;
- struct WRITE3args write; /* Variable length */
- };
- #define SIZEOF_rpc_call_write(n) (sizeof(struct rpc_call_header) + SIZEOF_WRITE3args(n))
- struct rpc_call_remove
- {
- struct rpc_call_header ch;
- struct REMOVE3args remove;
- };
- struct rpc_call_rename
- {
- struct rpc_call_header ch;
- struct RENAME3args rename;
- };
- struct rpc_call_mkdir
- {
- struct rpc_call_header ch;
- struct MKDIR3args mkdir;
- };
- struct rpc_call_rmdir
- {
- struct rpc_call_header ch;
- struct RMDIR3args rmdir;
- };
- struct rpc_call_readdir
- {
- struct rpc_call_header ch;
- struct READDIR3args readdir;
- };
- struct rpc_call_setattr
- {
- struct rpc_call_header ch;
- struct SETATTR3args setattr;
- };
- struct rpc_call_fs
- {
- struct rpc_call_header ch;
- struct FS3args fs;
- };
- /* Generic RPC reply headers */
- struct rpc_reply_header
- {
- uint32_t rp_xid; /* Request transaction id */
- uint32_t rp_direction; /* Call direction (1) */
- uint32_t type;
- struct rpc_auth_info rpc_verfi;
- uint32_t status;
- };
- struct nfs_reply_header
- {
- struct rpc_reply_header rh;
- uint32_t nfs_status;
- };
- struct rpc_reply_pmap
- {
- struct rpc_reply_header rh;
- struct call_result_pmap pmap;
- };
- struct rpc_reply_mount
- {
- struct rpc_reply_header rh;
- struct call_result_mount mount;
- };
- struct rpc_reply_umount
- {
- struct rpc_reply_header rh;
- };
- struct rpc_reply_create
- {
- struct nfs_reply_header rh;
- struct CREATE3resok create;
- };
- struct rpc_reply_lookup
- {
- struct nfs_reply_header rh;
- struct LOOKUP3resok lookup;
- };
- struct rpc_reply_write
- {
- struct nfs_reply_header rh;
- struct WRITE3resok write; /* Variable length */
- };
- struct rpc_reply_read
- {
- struct nfs_reply_header rh;
- struct READ3resok read; /* Variable length */
- };
- #define SIZEOF_rpc_reply_read(n) \
- (sizeof(struct nfs_reply_header) + SIZEOF_READ3resok(n))
- struct rpc_reply_remove
- {
- struct nfs_reply_header rh;
- struct REMOVE3resok remove;
- };
- struct rpc_reply_rename
- {
- struct nfs_reply_header rh;
- struct RENAME3resok rename;
- };
- struct rpc_reply_mkdir
- {
- struct nfs_reply_header rh;
- struct MKDIR3resok mkdir;
- };
- struct rpc_reply_rmdir
- {
- struct nfs_reply_header rh;
- struct RMDIR3resok rmdir;
- };
- struct rpc_reply_readdir
- {
- struct nfs_reply_header rh;
- struct READDIR3resok readdir;
- };
- #define SIZEOF_rpc_reply_readdir(n) \
- (sizeof(struct nfs_reply_header) + SIZEOF_READDIR3resok(n))
- struct rpc_reply_fsinfo
- {
- struct nfs_reply_header rh;
- struct nfsv3_fsinfo fsinfo;
- };
- struct rpc_reply_fsstat
- {
- struct nfs_reply_header rh;
- struct nfs_statfs fsstat;
- };
- struct rpc_reply_getattr
- {
- struct nfs_reply_header rh;
- struct nfs_fattr attr;
- };
- struct rpc_reply_setattr
- {
- struct nfs_reply_header rh;
- struct SETATTR3resok setattr;
- };
- struct rpcclnt
- {
- nfsfh_t rc_fh; /* File handle of the root directory */
- uint8_t rc_fhsize; /* File size of the root directory */
- FAR char *rc_path; /* Server's path of the mounted directory */
- FAR struct sockaddr_storage *rc_name;
- struct socket rc_so; /* RPC socket */
- uint8_t rc_sotype; /* Type of socket */
- uint8_t rc_timeo; /* Timeout value (in deciseconds) */
- uint8_t rc_retry; /* Max retries */
- uint32_t rc_xid; /* Transaction id */
- };
- /****************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
- void rpcclnt_init(void);
- int rpcclnt_connect(FAR struct rpcclnt *rpc);
- void rpcclnt_disconnect(FAR struct rpcclnt *rpc);
- int rpcclnt_request(FAR struct rpcclnt *rpc, int procnum, int prog,
- int version, FAR void *request, size_t reqlen,
- FAR void *response, size_t resplen);
- #endif /* __FS_NFS_RPC_H */
|