/*!\file rpc/clnt.h
 * RPC client-side interface.
 */

/*
 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
 * unrestricted use provided that this legend is included on all tape
 * media and as a part of the software program in whole or part.  Users
 * may copy or modify Sun RPC without charge, but are not authorized
 * to license or distribute it to anyone else except as part of a product or
 * program developed by the user.
 *
 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
 * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
 *
 * Sun RPC is provided with no support and without any obligation on the
 * part of Sun Microsystems, Inc. to assist in its use, correction,
 * modification or enhancement.
 *
 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
 * OR ANY PART THEREOF.
 *
 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
 * or profits or other special, indirect and consequential damages, even if
 * Sun has been advised of the possibility of such damages.
 *
 * Sun Microsystems, Inc.
 * 2550 Garcia Avenue
 * Mountain View, California  94043
 *
 *	from: @(#)clnt.h 1.31 88/02/08 SMI
 *	from: @(#)clnt.h	2.1 88/07/29 4.0 RPCSRC
 *	$Id: clnt.h,v 1.4 1996/01/30 23:31:48 mpp Exp $
 */

/*
 * clnt.h - Client side remote procedure call interface.
 *
 * Copyright (C) 1984, Sun Microsystems, Inc.
 */

#ifndef __RPC_CLIENT_H
#define __RPC_CLIENT_H

#include <sys/cdefs.h>
#include <rpc/types.h>
#include <rpc/xdr.h>

/*
 * Rpc calls return an enum clnt_stat.  This should be looked at more,
 * since each implementation is required to live with this (implementation
 * independent) list of errors.
 */
enum clnt_stat {
     RPC_SUCCESS=0,                  /* call succeeded */
     /*
      * local errors
      */
     RPC_CANTENCODEARGS=1,           /* can't encode arguments */
     RPC_CANTDECODERES=2,            /* can't decode results */
     RPC_CANTSEND=3,                 /* failure in sending call */
     RPC_CANTRECV=4,                 /* failure in receiving result */
     RPC_TIMEDOUT=5,                 /* call timed out */
     /*
      * remote errors
      */
     RPC_VERSMISMATCH=6,             /* rpc versions not compatible */
     RPC_AUTHERROR=7,                /* authentication error */
     RPC_PROGUNAVAIL=8,              /* program not available */
     RPC_PROGVERSMISMATCH=9,         /* program version mismatched */
     RPC_PROCUNAVAIL=10,             /* procedure unavailable */
     RPC_CANTDECODEARGS=11,          /* decode arguments error */
     RPC_SYSTEMERROR=12,             /* generic "other problem" */

     /*
      * callrpc & clnt_create errors
      */
     RPC_UNKNOWNHOST=13,             /* unknown host name */
     RPC_UNKNOWNPROTO=17,            /* unkown protocol */

     /*
      * _ create errors
      */
     RPC_PMAPFAILURE=14,             /* the pmapper failed in its call */
     RPC_PROGNOTREGISTERED=15,       /* remote program is not registered */
     /*
      * unspecified error
      */
     RPC_FAILED=16
   };


/*
 * Error info.
 */
struct rpc_err {
       enum clnt_stat re_status;
       union {
         int            RE_errno;  /* related system error */
         enum auth_stat RE_why;    /* why the auth error occurred */
         struct {
           u_long low;             /* lowest verion supported */
           u_long high;            /* highest verion supported */
         } RE_vers;
         struct {                  /* maybe meaningful if RPC_FAILED */
           long s1;
           long s2;
         } RE_lb;                  /* life boot & debugging only */
       } ru;
#define re_errno  ru.RE_errno
#define re_why    ru.RE_why
#define re_vers   ru.RE_vers
#define re_lb     ru.RE_lb
};


/*
 * Client rpc handle.
 * Created by individual implementations, see e.g. rpc_udp.c.
 * Client is responsible for initializing auth, see e.g. auth_none.c.
 */
typedef struct {
        AUTH  *cl_auth;                        /* authenticator */
	struct clnt_ops {
                enum clnt_stat(*cl_call)();    /* call remote procedure */
                void          (*cl_abort)();   /* abort a call */
                void          (*cl_geterr)();  /* get specific error code */
                bool_t        (*cl_freeres)(); /* frees results */
                void          (*cl_destroy)(); /* destroy this structure */
                bool_t        (*cl_control)(); /* the ioctl() of rpc */
	} *cl_ops;
        caddr_t               cl_private;      /* private stuff */
} CLIENT;


/*
 * client side rpc interface ops
 *
 * Parameter types are:
 *
 */

/*
 * enum clnt_stat
 * CLNT_CALL(rh, proc, xargs, argsp, xres, resp, timeout)
 * 	CLIENT *rh;
 *	u_long proc;
 *	xdrproc_t xargs;
 *	caddr_t argsp;
 *	xdrproc_t xres;
 *	caddr_t resp;
 *	struct timeval timeout;
 */
#define	CLNT_CALL(rh, proc, xargs, argsp, xres, resp, secs)	\
	((*(rh)->cl_ops->cl_call)(rh, proc, xargs, argsp, xres, resp, secs))
#define	clnt_call(rh, proc, xargs, argsp, xres, resp, secs)	\
	((*(rh)->cl_ops->cl_call)(rh, proc, xargs, argsp, xres, resp, secs))

/*
 * void
 * CLNT_ABORT(rh);
 * 	CLIENT *rh;
 */
#define	CLNT_ABORT(rh)	((*(rh)->cl_ops->cl_abort)(rh))
#define	clnt_abort(rh)	((*(rh)->cl_ops->cl_abort)(rh))

/*
 * struct rpc_err
 * CLNT_GETERR(rh);
 * 	CLIENT *rh;
 */
#define CLNT_GETERR(rh,errp)  ((*(rh)->cl_ops->cl_geterr)(rh, errp))
#define clnt_geterr(rh,errp)  ((*(rh)->cl_ops->cl_geterr)(rh, errp))


/*
 * bool_t
 * CLNT_FREERES(rh, xres, resp);
 * 	CLIENT *rh;
 *	xdrproc_t xres;
 *	caddr_t resp;
 */
#define	CLNT_FREERES(rh,xres,resp) ((*(rh)->cl_ops->cl_freeres)(rh,xres,resp))
#define	clnt_freeres(rh,xres,resp) ((*(rh)->cl_ops->cl_freeres)(rh,xres,resp))

/*
 * bool_t
 * CLNT_CONTROL(cl, request, info)
 *      CLIENT *cl;
 *      u_int request;
 *      char *info;
 */
#define	CLNT_CONTROL(cl,rq,in) ((*(cl)->cl_ops->cl_control)(cl,rq,in))
#define	clnt_control(cl,rq,in) ((*(cl)->cl_ops->cl_control)(cl,rq,in))

/*
 * control operations that apply to both udp and tcp transports
 */
#define CLSET_TIMEOUT       1   /* set timeout (timeval) */
#define CLGET_TIMEOUT       2   /* get timeout (timeval) */
#define CLGET_SERVER_ADDR   3   /* get server's address (sockaddr) */
/*
 * udp only control operations
 */
#define CLSET_RETRY_TIMEOUT 4   /* set retry timeout (timeval) */
#define CLGET_RETRY_TIMEOUT 5   /* get retry timeout (timeval) */

/*
 * void
 * CLNT_DESTROY(rh);
 * 	CLIENT *rh;
 */
#define	CLNT_DESTROY(rh)	((*(rh)->cl_ops->cl_destroy)(rh))
#define	clnt_destroy(rh)	((*(rh)->cl_ops->cl_destroy)(rh))


/*
 * RPCTEST is a test program which is accessible on every rpc
 * transport/port.  It is used for testing, performance evaluation,
 * and network administration.
 */

#define RPCTEST_PROGRAM		((u_long)1)
#define RPCTEST_VERSION		((u_long)1)
#define RPCTEST_NULL_PROC	((u_long)2)
#define RPCTEST_NULL_BATCH_PROC	((u_long)3)

/*
 * By convention, procedure 0 takes null arguments and returns them
 */

#define NULLPROC ((u_long)0)

__BEGIN_DECLS

/*
 * Below are the client handle creation routines for the various
 * implementations of client side rpc.  They can return NULL if a
 * creation failure occurs.
 */

/*
 * Memory based rpc (for speed check and testing)
 * CLIENT *
 * clntraw_create(prog, vers)
 *	u_long prog;
 *	u_long vers;
 */
extern CLIENT *clntraw_create (u_long, u_long);

/*
 * Generic client creation routine. Supported protocols are "udp" and "tcp"
 * CLIENT *
 * clnt_create(host, prog, vers, prot);
 *	char *host; 	-- hostname
 *	u_long prog;	-- program number
 *	u_long vers;	-- version number
 *	char *prot;	-- protocol
 */
extern CLIENT *clnt_create      (char *, u_long, u_long, char *);


/*
 * TCP based rpc
 * CLIENT *
 * clnttcp_create(raddr, prog, vers, sockp, sendsz, recvsz)
 *	struct sockaddr_in *raddr;
 *	u_long prog;
 *	u_long version;
 *	register int *sockp;
 *	u_int sendsz;
 *	u_int recvsz;
 */

extern CLIENT *clnttcp_create   (struct sockaddr_in *, u_long, u_long,
                                 int *, u_int, u_int);

/*
 * UDP based rpc.
 * CLIENT *
 * clntudp_create(raddr, program, version, wait, sockp)
 *	struct sockaddr_in *raddr;
 *	u_long program;
 *	u_long version;
 *	struct timeval wait;
 *	int *sockp;
 *
 * Same as above, but you specify max packet sizes.
 * CLIENT *
 * clntudp_bufcreate(raddr, program, version, wait, sockp, sendsz, recvsz)
 *	struct sockaddr_in *raddr;
 *	u_long program;
 *	u_long version;
 *	struct timeval wait;
 *	int *sockp;
 *	u_int sendsz;
 *	u_int recvsz;
 */

extern CLIENT *clntudp_create   (struct sockaddr_in *, u_long, u_long,
                                 struct timeval, int *);
extern CLIENT *clntudp_bufcreate(struct sockaddr_in *, u_long, u_long,
                                 struct timeval, int *, u_int, u_int);


/*
 * Print why creation failed
 */

extern void  clnt_pcreateerror  (char *);     /* stderr */
extern char *clnt_spcreateerror (char *);     /* string */

/*
 * Like clnt_perror(), but is more verbose in its output
 */

extern void clnt_perrno  (enum clnt_stat);    /* stderr */
extern char *clnt_sperrno(enum clnt_stat);    /* string */

/*
 * Print an English error message, given the client error code
 */

extern void  clnt_perror (CLIENT *, char *);  /* stderr */
extern char *clnt_sperror(CLIENT *, char *);  /* string */

/*
 * Call routine on remote host
 */

extern int callrpc (char *host, u_long prognum, u_long versnum, u_long procnum,
                    xdrproc_t inproc,  char *in,
                    xdrproc_t outproc, char *out);

__END_DECLS


/*
 * If a creation fails, the following allows the user to figure out why.
 */
struct rpc_createerr {
       enum clnt_stat cf_stat;
       struct rpc_err cf_error; /* useful when cf_stat == RPC_PMAPFAILURE */
       const char    *cf_file;  /* failed file + line */
       unsigned       cf_line;
     };

extern struct rpc_createerr rpc_createerr;


#define UDPMSGSIZE	8800	/* rpc imposed limit on udp msg size */
#define RPCSMALLMSGSIZE	400	/* a more reasonable packet size */

#endif
