clnt.h revision 78678
1/* $NetBSD: clnt.h,v 1.14 2000/06/02 22:57:55 fvdl Exp $ */ 2 3/* 4 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for 5 * unrestricted use provided that this legend is included on all tape 6 * media and as a part of the software program in whole or part. Users 7 * may copy or modify Sun RPC without charge, but are not authorized 8 * to license or distribute it to anyone else except as part of a product or 9 * program developed by the user. 10 * 11 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE 12 * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR 13 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE. 14 * 15 * Sun RPC is provided with no support and without any obligation on the 16 * part of Sun Microsystems, Inc. to assist in its use, correction, 17 * modification or enhancement. 18 * 19 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE 20 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC 21 * OR ANY PART THEREOF. 22 * 23 * In no event will Sun Microsystems, Inc. be liable for any lost revenue 24 * or profits or other special, indirect and consequential damages, even if 25 * Sun has been advised of the possibility of such damages. 26 * 27 * Sun Microsystems, Inc. 28 * 2550 Garcia Avenue 29 * Mountain View, California 94043 30 * 31 * from: @(#)clnt.h 1.31 94/04/29 SMI 32 * from: @(#)clnt.h 2.1 88/07/29 4.0 RPCSRC 33 * $FreeBSD: head/include/rpc/clnt.h 78678 2001-06-23 19:43:21Z iedowse $ 34 */ 35 36/* 37 * clnt.h - Client side remote procedure call interface. 38 * 39 * Copyright (C) 1984, Sun Microsystems, Inc. 40 */ 41 42#ifndef _RPC_CLNT_H_ 43#define _RPC_CLNT_H_ 44#include <rpc/clnt_stat.h> 45#include <sys/cdefs.h> 46#include <netconfig.h> 47#include <sys/un.h> 48 49/* 50 * Well-known IPV6 RPC broadcast address. 51 */ 52#define RPCB_MULTICAST_ADDR "ff02::202" 53 54/* 55 * the following errors are in general unrecoverable. The caller 56 * should give up rather than retry. 57 */ 58#define IS_UNRECOVERABLE_RPC(s) (((s) == RPC_AUTHERROR) || \ 59 ((s) == RPC_CANTENCODEARGS) || \ 60 ((s) == RPC_CANTDECODERES) || \ 61 ((s) == RPC_VERSMISMATCH) || \ 62 ((s) == RPC_PROCUNAVAIL) || \ 63 ((s) == RPC_PROGUNAVAIL) || \ 64 ((s) == RPC_PROGVERSMISMATCH) || \ 65 ((s) == RPC_CANTDECODEARGS)) 66 67/* 68 * Error info. 69 */ 70struct rpc_err { 71 enum clnt_stat re_status; 72 union { 73 int RE_errno; /* related system error */ 74 enum auth_stat RE_why; /* why the auth error occurred */ 75 struct { 76 rpcvers_t low; /* lowest version supported */ 77 rpcvers_t high; /* highest version supported */ 78 } RE_vers; 79 struct { /* maybe meaningful if RPC_FAILED */ 80 int32_t s1; 81 int32_t s2; 82 } RE_lb; /* life boot & debugging only */ 83 } ru; 84#define re_errno ru.RE_errno 85#define re_why ru.RE_why 86#define re_vers ru.RE_vers 87#define re_lb ru.RE_lb 88}; 89 90 91/* 92 * Client rpc handle. 93 * Created by individual implementations 94 * Client is responsible for initializing auth, see e.g. auth_none.c. 95 */ 96typedef struct __rpc_client { 97 AUTH *cl_auth; /* authenticator */ 98 struct clnt_ops { 99 /* call remote procedure */ 100 enum clnt_stat (*cl_call) __P((struct __rpc_client *, 101 rpcproc_t, xdrproc_t, caddr_t, xdrproc_t, 102 caddr_t, struct timeval)); 103 /* abort a call */ 104 void (*cl_abort) __P((struct __rpc_client *)); 105 /* get specific error code */ 106 void (*cl_geterr) __P((struct __rpc_client *, 107 struct rpc_err *)); 108 /* frees results */ 109 bool_t (*cl_freeres) __P((struct __rpc_client *, 110 xdrproc_t, caddr_t)); 111 /* destroy this structure */ 112 void (*cl_destroy) __P((struct __rpc_client *)); 113 /* the ioctl() of rpc */ 114 bool_t (*cl_control) __P((struct __rpc_client *, u_int, 115 char *)); 116 } *cl_ops; 117 void *cl_private; /* private stuff */ 118 char *cl_netid; /* network token */ 119 char *cl_tp; /* device name */ 120} CLIENT; 121 122 123/* 124 * Timers used for the pseudo-transport protocol when using datagrams 125 */ 126struct rpc_timers { 127 u_short rt_srtt; /* smoothed round-trip time */ 128 u_short rt_deviate; /* estimated deviation */ 129 u_long rt_rtxcur; /* current (backed-off) rto */ 130}; 131 132/* 133 * Feedback values used for possible congestion and rate control 134 */ 135#define FEEDBACK_REXMIT1 1 /* first retransmit */ 136#define FEEDBACK_OK 2 /* no retransmits */ 137 138/* Used to set version of portmapper used in broadcast */ 139 140#define CLCR_SET_LOWVERS 3 141#define CLCR_GET_LOWVERS 4 142 143#define RPCSMALLMSGSIZE 400 /* a more reasonable packet size */ 144 145/* 146 * client side rpc interface ops 147 * 148 * Parameter types are: 149 * 150 */ 151 152/* 153 * enum clnt_stat 154 * CLNT_CALL(rh, proc, xargs, argsp, xres, resp, timeout) 155 * CLIENT *rh; 156 * rpcproc_t proc; 157 * xdrproc_t xargs; 158 * caddr_t argsp; 159 * xdrproc_t xres; 160 * caddr_t resp; 161 * struct timeval timeout; 162 */ 163#define CLNT_CALL(rh, proc, xargs, argsp, xres, resp, secs) \ 164 ((*(rh)->cl_ops->cl_call)(rh, proc, xargs, \ 165 (caddr_t)(void *)argsp, xres, (caddr_t)(void *)resp, secs)) 166#define clnt_call(rh, proc, xargs, argsp, xres, resp, secs) \ 167 ((*(rh)->cl_ops->cl_call)(rh, proc, xargs, \ 168 (caddr_t)(void *)argsp, xres, (caddr_t)(void *)resp, secs)) 169 170/* 171 * void 172 * CLNT_ABORT(rh); 173 * CLIENT *rh; 174 */ 175#define CLNT_ABORT(rh) ((*(rh)->cl_ops->cl_abort)(rh)) 176#define clnt_abort(rh) ((*(rh)->cl_ops->cl_abort)(rh)) 177 178/* 179 * struct rpc_err 180 * CLNT_GETERR(rh); 181 * CLIENT *rh; 182 */ 183#define CLNT_GETERR(rh,errp) ((*(rh)->cl_ops->cl_geterr)(rh, errp)) 184#define clnt_geterr(rh,errp) ((*(rh)->cl_ops->cl_geterr)(rh, errp)) 185 186 187/* 188 * bool_t 189 * CLNT_FREERES(rh, xres, resp); 190 * CLIENT *rh; 191 * xdrproc_t xres; 192 * caddr_t resp; 193 */ 194#define CLNT_FREERES(rh,xres,resp) ((*(rh)->cl_ops->cl_freeres)(rh,xres,resp)) 195#define clnt_freeres(rh,xres,resp) ((*(rh)->cl_ops->cl_freeres)(rh,xres,resp)) 196 197/* 198 * bool_t 199 * CLNT_CONTROL(cl, request, info) 200 * CLIENT *cl; 201 * u_int request; 202 * char *info; 203 */ 204#define CLNT_CONTROL(cl,rq,in) ((*(cl)->cl_ops->cl_control)(cl,rq,in)) 205#define clnt_control(cl,rq,in) ((*(cl)->cl_ops->cl_control)(cl,rq,in)) 206 207/* 208 * control operations that apply to both udp and tcp transports 209 */ 210#define CLSET_TIMEOUT 1 /* set timeout (timeval) */ 211#define CLGET_TIMEOUT 2 /* get timeout (timeval) */ 212#define CLGET_SERVER_ADDR 3 /* get server's address (sockaddr) */ 213#define CLGET_FD 6 /* get connections file descriptor */ 214#define CLGET_SVC_ADDR 7 /* get server's address (netbuf) */ 215#define CLSET_FD_CLOSE 8 /* close fd while clnt_destroy */ 216#define CLSET_FD_NCLOSE 9 /* Do not close fd while clnt_destroy */ 217#define CLGET_XID 10 /* Get xid */ 218#define CLSET_XID 11 /* Set xid */ 219#define CLGET_VERS 12 /* Get version number */ 220#define CLSET_VERS 13 /* Set version number */ 221#define CLGET_PROG 14 /* Get program number */ 222#define CLSET_PROG 15 /* Set program number */ 223#define CLSET_SVC_ADDR 16 /* get server's address (netbuf) */ 224#define CLSET_PUSH_TIMOD 17 /* push timod if not already present */ 225#define CLSET_POP_TIMOD 18 /* pop timod */ 226/* 227 * Connectionless only control operations 228 */ 229#define CLSET_RETRY_TIMEOUT 4 /* set retry timeout (timeval) */ 230#define CLGET_RETRY_TIMEOUT 5 /* get retry timeout (timeval) */ 231#define CLSET_ASYNC 19 232#define CLSET_CONNECT 20 /* Use connect() for UDP. (int) */ 233 234/* 235 * void 236 * CLNT_DESTROY(rh); 237 * CLIENT *rh; 238 */ 239#define CLNT_DESTROY(rh) ((*(rh)->cl_ops->cl_destroy)(rh)) 240#define clnt_destroy(rh) ((*(rh)->cl_ops->cl_destroy)(rh)) 241 242 243/* 244 * RPCTEST is a test program which is accessible on every rpc 245 * transport/port. It is used for testing, performance evaluation, 246 * and network administration. 247 */ 248 249#define RPCTEST_PROGRAM ((rpcprog_t)1) 250#define RPCTEST_VERSION ((rpcvers_t)1) 251#define RPCTEST_NULL_PROC ((rpcproc_t)2) 252#define RPCTEST_NULL_BATCH_PROC ((rpcproc_t)3) 253 254/* 255 * By convention, procedure 0 takes null arguments and returns them 256 */ 257 258#define NULLPROC ((rpcproc_t)0) 259 260/* 261 * Below are the client handle creation routines for the various 262 * implementations of client side rpc. They can return NULL if a 263 * creation failure occurs. 264 */ 265 266/* 267 * Generic client creation routine. Supported protocols are those that 268 * belong to the nettype namespace (/etc/netconfig). 269 * CLIENT * 270 * clnt_create(host, prog, vers, prot); 271 * const char *host; -- hostname 272 * const rpcprog_t prog; -- program number 273 * const rpcvers_t vers; -- version number 274 * const char *prot; -- protocol 275 */ 276__BEGIN_DECLS 277extern CLIENT *clnt_create __P((const char *, const rpcprog_t, const rpcvers_t, 278 const char *)); 279/* 280 * 281 * const char *hostname; -- hostname 282 * const rpcprog_t prog; -- program number 283 * const rpcvers_t vers; -- version number 284 * const char *nettype; -- network type 285 */ 286 287/* 288 * Generic client creation routine. Supported protocols are which belong 289 * to the nettype name space. 290 */ 291extern CLIENT *clnt_create_vers __P((const char *, const rpcprog_t, rpcvers_t *, 292 const rpcvers_t, const rpcvers_t, 293 const char *)); 294/* 295 * const char *host; -- hostname 296 * const rpcprog_t prog; -- program number 297 * rpcvers_t *vers_out; -- servers highest available version 298 * const rpcvers_t vers_low; -- low version number 299 * const rpcvers_t vers_high; -- high version number 300 * const char *nettype; -- network type 301 */ 302 303 304/* 305 * Generic client creation routine. It takes a netconfig structure 306 * instead of nettype 307 */ 308extern CLIENT *clnt_tp_create __P((const char *, const rpcprog_t, 309 const rpcvers_t, const struct netconfig *)); 310/* 311 * const char *hostname; -- hostname 312 * const rpcprog_t prog; -- program number 313 * const rpcvers_t vers; -- version number 314 * const struct netconfig *netconf; -- network config structure 315 */ 316 317/* 318 * Generic TLI create routine. Only provided for compatibility. 319 */ 320 321extern CLIENT *clnt_tli_create __P((const int, const struct netconfig *, 322 const struct netbuf *, const rpcprog_t, 323 const rpcvers_t, const u_int, const u_int)); 324/* 325 * const register int fd; -- fd 326 * const struct netconfig *nconf; -- netconfig structure 327 * const struct netbuf *svcaddr; -- servers address 328 * const u_long prog; -- program number 329 * const u_long vers; -- version number 330 * const u_int sendsz; -- send size 331 * const u_int recvsz; -- recv size 332 */ 333 334/* 335 * Low level clnt create routine for connectionful transports, e.g. tcp. 336 */ 337extern CLIENT *clnt_vc_create __P((const int, const struct netbuf *, 338 const rpcprog_t, const rpcvers_t, 339 const u_int, const u_int)); 340/* 341 * const int fd; -- open file descriptor 342 * const struct netbuf *svcaddr; -- servers address 343 * const rpcprog_t prog; -- program number 344 * const rpcvers_t vers; -- version number 345 * const u_int sendsz; -- buffer recv size 346 * const u_int recvsz; -- buffer send size 347 */ 348 349/* 350 * Low level clnt create routine for connectionless transports, e.g. udp. 351 */ 352extern CLIENT *clnt_dg_create __P((const int, const struct netbuf *, 353 const rpcprog_t, const rpcvers_t, 354 const u_int, const u_int)); 355/* 356 * const int fd; -- open file descriptor 357 * const struct netbuf *svcaddr; -- servers address 358 * const rpcprog_t program; -- program number 359 * const rpcvers_t version; -- version number 360 * const u_int sendsz; -- buffer recv size 361 * const u_int recvsz; -- buffer send size 362 */ 363 364/* 365 * Memory based rpc (for speed check and testing) 366 * CLIENT * 367 * clnt_raw_create(prog, vers) 368 * u_long prog; 369 * u_long vers; 370 */ 371extern CLIENT *clnt_raw_create __P((rpcprog_t, rpcvers_t)); 372 373__END_DECLS 374 375 376/* 377 * Print why creation failed 378 */ 379__BEGIN_DECLS 380extern void clnt_pcreateerror __P((const char *)); /* stderr */ 381extern char *clnt_spcreateerror __P((const char *)); /* string */ 382__END_DECLS 383 384/* 385 * Like clnt_perror(), but is more verbose in its output 386 */ 387__BEGIN_DECLS 388extern void clnt_perrno __P((enum clnt_stat)); /* stderr */ 389extern char *clnt_sperrno __P((enum clnt_stat)); /* string */ 390__END_DECLS 391 392/* 393 * Print an English error message, given the client error code 394 */ 395__BEGIN_DECLS 396extern void clnt_perror __P((CLIENT *, const char *)); /* stderr */ 397extern char *clnt_sperror __P((CLIENT *, const char *)); /* string */ 398__END_DECLS 399 400 401/* 402 * If a creation fails, the following allows the user to figure out why. 403 */ 404struct rpc_createerr { 405 enum clnt_stat cf_stat; 406 struct rpc_err cf_error; /* useful when cf_stat == RPC_PMAPFAILURE */ 407}; 408 409#ifdef _THREAD_SAFE 410__BEGIN_DECLS 411extern struct rpc_createerr *__rpc_createerr __P((void)); 412__END_DECLS 413#define rpc_createerr (*(__rpc_createerr())) 414#else 415extern struct rpc_createerr rpc_createerr; 416#endif /* _THREAD_SAFE */ 417 418/* 419 * The simplified interface: 420 * enum clnt_stat 421 * rpc_call(host, prognum, versnum, procnum, inproc, in, outproc, out, nettype) 422 * const char *host; 423 * const rpcprog_t prognum; 424 * const rpcvers_t versnum; 425 * const rpcproc_t procnum; 426 * const xdrproc_t inproc, outproc; 427 * const char *in; 428 * char *out; 429 * const char *nettype; 430 */ 431__BEGIN_DECLS 432extern enum clnt_stat rpc_call __P((const char *, const rpcprog_t, 433 const rpcvers_t, const rpcproc_t, 434 const xdrproc_t, const char *, 435 const xdrproc_t, char *, const char *)); 436__END_DECLS 437 438/* 439 * RPC broadcast interface 440 * The call is broadcasted to all locally connected nets. 441 * 442 * extern enum clnt_stat 443 * rpc_broadcast(prog, vers, proc, xargs, argsp, xresults, resultsp, 444 * eachresult, nettype) 445 * const rpcprog_t prog; -- program number 446 * const rpcvers_t vers; -- version number 447 * const rpcproc_t proc; -- procedure number 448 * const xdrproc_t xargs; -- xdr routine for args 449 * caddr_t argsp; -- pointer to args 450 * const xdrproc_t xresults; -- xdr routine for results 451 * caddr_t resultsp; -- pointer to results 452 * const resultproc_t eachresult; -- call with each result 453 * const char *nettype; -- Transport type 454 * 455 * For each valid response received, the procedure eachresult is called. 456 * Its form is: 457 * done = eachresult(resp, raddr, nconf) 458 * bool_t done; 459 * caddr_t resp; 460 * struct netbuf *raddr; 461 * struct netconfig *nconf; 462 * where resp points to the results of the call and raddr is the 463 * address if the responder to the broadcast. nconf is the transport 464 * on which the response was received. 465 * 466 * extern enum clnt_stat 467 * rpc_broadcast_exp(prog, vers, proc, xargs, argsp, xresults, resultsp, 468 * eachresult, inittime, waittime, nettype) 469 * const rpcprog_t prog; -- program number 470 * const rpcvers_t vers; -- version number 471 * const rpcproc_t proc; -- procedure number 472 * const xdrproc_t xargs; -- xdr routine for args 473 * caddr_t argsp; -- pointer to args 474 * const xdrproc_t xresults; -- xdr routine for results 475 * caddr_t resultsp; -- pointer to results 476 * const resultproc_t eachresult; -- call with each result 477 * const int inittime; -- how long to wait initially 478 * const int waittime; -- maximum time to wait 479 * const char *nettype; -- Transport type 480 */ 481 482typedef bool_t (*resultproc_t) __P((caddr_t, ...)); 483 484__BEGIN_DECLS 485extern enum clnt_stat rpc_broadcast __P((const rpcprog_t, const rpcvers_t, 486 const rpcproc_t, const xdrproc_t, 487 caddr_t, const xdrproc_t, caddr_t, 488 const resultproc_t, const char *)); 489extern enum clnt_stat rpc_broadcast_exp __P((const rpcprog_t, const rpcvers_t, 490 const rpcproc_t, const xdrproc_t, 491 caddr_t, const xdrproc_t, caddr_t, 492 const resultproc_t, const int, 493 const int, const char *)); 494__END_DECLS 495 496/* For backward compatibility */ 497#include <rpc/clnt_soc.h> 498 499#endif /* !_RPC_CLNT_H_ */ 500