/**************************************************************************** * 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 * Gregory Nutt * * 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 #include #include #include "nfs_proto.h" #ifdef __cplusplus #if __cplusplus extern "C" { #endif /* __cplusplus */ #endif /* __cplusplus */ /**************************************************************************** * 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 #define NFS_IPPROTO_TCP 6 #define NFS_IPPROTO_UDP 17 #define NFS_PROTO_TYPE NFS_IPPROTO_TCP #if (NFS_PROTO_TYPE == NFS_IPPROTO_TCP) #define NFS_PROTOTYPE IPPROTO_TCP /* Default protocol to provide */ #elif (NFS_PROTO_TYPE == NFS_IPPROTO_UDP) #define NFS_PROTOTYPE IPPROTO_UDP #endif /* There is an argument we can set in nfs server influences the port number we can use. * When it is "secure", nfs use port number under 1024. * When it is "insecure", nfs use port number over 1024. * And "secure" is default. */ #define RPCCONN_MAXPORT 1023 #define RPCCONN_MINPORT 256 /* 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 #define RPC_RPATH_MAXSIZE NFS_MOUNT_PATH_MAX_SIZE #if (NFS_PROTO_TYPE == NFS_IPPROTO_TCP) #define RPC_RMSIZE 4 #define RPC_RM_FLAGMENT_LAST_FLAG 0x80000000 #define RPC_RM_FLAGMENT_LEN_MASK 0x7FFFFFFF #elif (NFS_PROTO_TYPE == NFS_IPPROTO_UDP) #define RPC_RMSIZE 0 #endif /* 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 PMAPPORT 111 #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 ****************************************************************************/ /* Global RPC statistics */ #ifdef CONFIG_NFS_STATISTICS struct rpcstats { int rpcretries; int rpcrequests; int rpctimeouts; int rpcinvalid; }; #endif /* PMAP headers */ struct call_args_pmap { uint32_t prog; uint32_t vers; uint32_t proc; uint32_t port; }; struct call_result_pmap { uint32_t port; }; /* MOUNTD headers */ struct call_args_mount { uint32_t len; char rpath[RPC_RPATH_MAXSIZE]; }; struct call_args_umount { uint32_t len; char rpath[RPC_RPATH_MAXSIZE]; }; /* Generic RPC call headers */ 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 autolist[AUTH_MAX]; }; /* Generic RPC call headers */ struct rpc_auth_info { uint32_t authtype; /* auth type */ uint32_t authlen; /* auth length */ }; struct auth_unix { uint32_t stamp; uint32_t hostname_len; /* use n uint32_t(s) to store CONFIG_NFS_MACHINE_NAME_SIZE bytes */ uint32_t hostname[(CONFIG_NFS_MACHINE_NAME_SIZE + sizeof(uint32_t) - 1) / sizeof(uint32_t)]; uint32_t uid; uint32_t gid; uint32_t gidlist; uint32_t gidlist_value; }; struct rpc_call_header { #if (NFS_PROTO_TYPE == NFS_IPPROTO_TCP) uint32_t rp_recmark; /* fragment header */ #endif 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 auth_unix rpc_auth_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 { #if (NFS_PROTO_TYPE == NFS_IPPROTO_TCP) uint32_t rp_recmark; /* fragment header */ #endif 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 { #if (NFS_PROTO_TYPE == NFS_IPPROTO_TCP) uint32_t rp_recmark; /* fragment header */ #endif 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; 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 rpc_reply_header rh; uint32_t status; struct CREATE3resok create; }; struct rpc_reply_lookup { struct rpc_reply_header rh; uint32_t status; struct LOOKUP3resok lookup; }; struct rpc_reply_write { struct rpc_reply_header rh; uint32_t status; struct WRITE3resok write; /* Variable length */ }; struct rpc_reply_read { struct rpc_reply_header rh; uint32_t status; struct READ3resok read; /* Variable length */ }; #define SIZEOF_rpc_reply_read(n) \ (sizeof(struct rpc_reply_header) + sizeof(uint32_t) + \ SIZEOF_READ3resok(n)) struct rpc_reply_remove { struct rpc_reply_header rh; uint32_t status; struct REMOVE3resok remove; }; struct rpc_reply_rename { struct rpc_reply_header rh; uint32_t status; struct RENAME3resok rename; }; struct rpc_reply_mkdir { struct rpc_reply_header rh; uint32_t status; struct MKDIR3resok mkdir; }; struct rpc_reply_rmdir { struct rpc_reply_header rh; uint32_t status; struct RMDIR3resok rmdir; }; struct rpc_reply_readdir { struct rpc_reply_header rh; uint32_t status; struct READDIR3resok readdir; }; #define SIZEOF_rpc_reply_readdir(n) \ (sizeof(struct rpc_reply_header) + sizeof(uint32_t) + \ SIZEOF_READDIR3resok(n)) struct rpc_reply_fsinfo { struct rpc_reply_header rh; uint32_t status; struct nfsv3_fsinfo fsinfo; }; struct rpc_reply_fsstat { struct rpc_reply_header rh; uint32_t status; struct nfs_statfs fsstat; }; struct rpc_reply_getattr { struct rpc_reply_header rh; uint32_t status; struct nfs_fattr attr; }; struct rpc_reply_setattr { struct rpc_reply_header rh; uint32_t status; struct SETATTR3resok setattr; }; struct rpcclnt { nfsfh_t rc_fh; /* File handle of the root directory */ unsigned int rc_fhsize; /* File size of the root directory */ char *rc_path; /* Server's path of the mounted directory */ uint32_t xid; struct sockaddr *rc_name; int rc_so; /* RPC socket */ bool rc_timeout; /* Receipt of reply timed out */ uint8_t rc_sotype; /* Type of socket */ uint8_t rc_retry; /* Max retries */ }; /**************************************************************************** * Public Function Prototypes ****************************************************************************/ void rpcclnt_init(void); int rpcclnt_connect(struct rpcclnt *rpc); void rpcclnt_disconnect(struct rpcclnt *rpc); int rpcclnt_umount(struct rpcclnt *rpc); void rpcclnt_safedisconnect(struct rpcclnt *rpc); int rpcclnt_request(struct rpcclnt *rpc, int procnum, int prog, int version, void *request, size_t reqlen, void *response, size_t resplen); void rpcclnt_setuidgid(uint32_t uid, uint32_t gid); #ifdef __cplusplus #if __cplusplus } #endif /* __cplusplus */ #endif /* __cplusplus */ #endif /* __FS_NFS_RPC_H */