1 /* $NetBSD: svc.h,v 1.17 2000/06/02 22:57:56 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: @(#)svc.h 1.35 88/12/17 SMI 32 * from: @(#)svc.h 1.27 94/04/25 SMI 33 * $FreeBSD$ 34 */ 35 36 /* 37 * svc.h, Server-side remote procedure call interface. 38 * 39 * Copyright (C) 1986-1993 by Sun Microsystems, Inc. 40 */ 41 42 #ifndef _RPC_SVC_H 43 #define _RPC_SVC_H 44 #include <sys/cdefs.h> 45 46 /* 47 * This interface must manage two items concerning remote procedure calling: 48 * 49 * 1) An arbitrary number of transport connections upon which rpc requests 50 * are received. The two most notable transports are TCP and UDP; they are 51 * created and registered by routines in svc_tcp.c and svc_udp.c, respectively; 52 * they in turn call xprt_register and xprt_unregister. 53 * 54 * 2) An arbitrary number of locally registered services. Services are 55 * described by the following four data: program number, version number, 56 * "service dispatch" function, a transport handle, and a boolean that 57 * indicates whether or not the exported program should be registered with a 58 * local binder service; if true the program's number and version and the 59 * port number from the transport handle are registered with the binder. 60 * These data are registered with the rpc svc system via svc_register. 61 * 62 * A service's dispatch function is called whenever an rpc request comes in 63 * on a transport. The request's program and version numbers must match 64 * those of the registered service. The dispatch function is passed two 65 * parameters, struct svc_req * and SVCXPRT *, defined below. 66 */ 67 68 /* 69 * Service control requests 70 */ 71 #define SVCGET_VERSQUIET 1 72 #define SVCSET_VERSQUIET 2 73 #define SVCGET_CONNMAXREC 3 74 #define SVCSET_CONNMAXREC 4 75 76 /* 77 * Operations for rpc_control(). 78 */ 79 #define RPC_SVC_CONNMAXREC_SET 0 /* set max rec size, enable nonblock */ 80 #define RPC_SVC_CONNMAXREC_GET 1 81 82 enum xprt_stat { 83 XPRT_DIED, 84 XPRT_MOREREQS, 85 XPRT_IDLE 86 }; 87 88 /* 89 * Server side transport handle 90 */ 91 typedef struct __rpc_svcxprt { 92 int xp_fd; 93 u_short xp_port; /* associated port number */ 94 const struct xp_ops { 95 /* receive incoming requests */ 96 bool_t (*xp_recv)(struct __rpc_svcxprt *, struct rpc_msg *); 97 /* get transport status */ 98 enum xprt_stat (*xp_stat)(struct __rpc_svcxprt *); 99 /* get arguments */ 100 bool_t (*xp_getargs)(struct __rpc_svcxprt *, xdrproc_t, 101 void *); 102 /* send reply */ 103 bool_t (*xp_reply)(struct __rpc_svcxprt *, struct rpc_msg *); 104 /* free mem allocated for args */ 105 bool_t (*xp_freeargs)(struct __rpc_svcxprt *, xdrproc_t, 106 void *); 107 /* destroy this struct */ 108 void (*xp_destroy)(struct __rpc_svcxprt *); 109 } *xp_ops; 110 int xp_addrlen; /* length of remote address */ 111 struct sockaddr_in xp_raddr; /* remote addr. (backward ABI compat) */ 112 /* XXX - fvdl stick this here for ABI backward compat reasons */ 113 const struct xp_ops2 { 114 /* catch-all function */ 115 bool_t (*xp_control)(struct __rpc_svcxprt *, const u_int, 116 void *); 117 } *xp_ops2; 118 char *xp_tp; /* transport provider device name */ 119 char *xp_netid; /* network token */ 120 struct netbuf xp_ltaddr; /* local transport address */ 121 struct netbuf xp_rtaddr; /* remote transport address */ 122 struct opaque_auth xp_verf; /* raw response verifier */ 123 void *xp_p1; /* private: for use by svc ops */ 124 void *xp_p2; /* private: for use by svc ops */ 125 void *xp_p3; /* private: for use by svc lib */ 126 int xp_type; /* transport type */ 127 } SVCXPRT; 128 129 /* 130 * Interface to server-side authentication flavors. 131 */ 132 typedef struct __rpc_svcauth { 133 struct svc_auth_ops { 134 int (*svc_ah_wrap)(struct __rpc_svcauth *, XDR *, 135 xdrproc_t, caddr_t); 136 int (*svc_ah_unwrap)(struct __rpc_svcauth *, XDR *, 137 xdrproc_t, caddr_t); 138 } *svc_ah_ops; 139 void *svc_ah_private; 140 } SVCAUTH; 141 142 /* 143 * Server transport extensions (accessed via xp_p3). 144 */ 145 typedef struct __rpc_svcxprt_ext { 146 int xp_flags; /* versquiet */ 147 SVCAUTH xp_auth; /* interface to auth methods */ 148 } SVCXPRT_EXT; 149 150 /* 151 * Service request 152 */ 153 struct svc_req { 154 u_int32_t rq_prog; /* service program number */ 155 u_int32_t rq_vers; /* service protocol version */ 156 u_int32_t rq_proc; /* the desired procedure */ 157 struct opaque_auth rq_cred; /* raw creds from the wire */ 158 void *rq_clntcred; /* read only cooked cred */ 159 SVCXPRT *rq_xprt; /* associated transport */ 160 }; 161 162 /* 163 * Approved way of getting address of caller 164 */ 165 #define svc_getrpccaller(x) (&(x)->xp_rtaddr) 166 167 /* 168 * Operations defined on an SVCXPRT handle 169 * 170 * SVCXPRT *xprt; 171 * struct rpc_msg *msg; 172 * xdrproc_t xargs; 173 * void * argsp; 174 */ 175 #define SVC_RECV(xprt, msg) \ 176 (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) 177 #define svc_recv(xprt, msg) \ 178 (*(xprt)->xp_ops->xp_recv)((xprt), (msg)) 179 180 #define SVC_STAT(xprt) \ 181 (*(xprt)->xp_ops->xp_stat)(xprt) 182 #define svc_stat(xprt) \ 183 (*(xprt)->xp_ops->xp_stat)(xprt) 184 185 #define SVC_GETARGS(xprt, xargs, argsp) \ 186 (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp)) 187 #define svc_getargs(xprt, xargs, argsp) \ 188 (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp)) 189 190 #define SVC_REPLY(xprt, msg) \ 191 (*(xprt)->xp_ops->xp_reply) ((xprt), (msg)) 192 #define svc_reply(xprt, msg) \ 193 (*(xprt)->xp_ops->xp_reply) ((xprt), (msg)) 194 195 #define SVC_FREEARGS(xprt, xargs, argsp) \ 196 (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp)) 197 #define svc_freeargs(xprt, xargs, argsp) \ 198 (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp)) 199 200 #define SVC_DESTROY(xprt) \ 201 (*(xprt)->xp_ops->xp_destroy)(xprt) 202 #define svc_destroy(xprt) \ 203 (*(xprt)->xp_ops->xp_destroy)(xprt) 204 205 #define SVC_CONTROL(xprt, rq, in) \ 206 (*(xprt)->xp_ops2->xp_control)((xprt), (rq), (in)) 207 208 #define SVC_EXT(xprt) \ 209 ((SVCXPRT_EXT *) xprt->xp_p3) 210 211 #define SVC_AUTH(xprt) \ 212 (SVC_EXT(xprt)->xp_auth) 213 214 /* 215 * Operations defined on an SVCAUTH handle 216 */ 217 #define SVCAUTH_WRAP(auth, xdrs, xfunc, xwhere) \ 218 ((auth)->svc_ah_ops->svc_ah_wrap(auth, xdrs, xfunc, xwhere)) 219 #define SVCAUTH_UNWRAP(auth, xdrs, xfunc, xwhere) \ 220 ((auth)->svc_ah_ops->svc_ah_unwrap(auth, xdrs, xfunc, xwhere)) 221 222 /* 223 * Service registration 224 * 225 * svc_reg(xprt, prog, vers, dispatch, nconf) 226 * const SVCXPRT *xprt; 227 * const rpcprog_t prog; 228 * const rpcvers_t vers; 229 * const void (*dispatch)(); 230 * const struct netconfig *nconf; 231 */ 232 233 __BEGIN_DECLS 234 extern bool_t svc_reg(SVCXPRT *, const rpcprog_t, const rpcvers_t, 235 void (*)(struct svc_req *, SVCXPRT *), 236 const struct netconfig *); 237 __END_DECLS 238 239 /* 240 * Service un-registration 241 * 242 * svc_unreg(prog, vers) 243 * const rpcprog_t prog; 244 * const rpcvers_t vers; 245 */ 246 247 __BEGIN_DECLS 248 extern void svc_unreg(const rpcprog_t, const rpcvers_t); 249 __END_DECLS 250 251 /* 252 * Transport registration. 253 * 254 * xprt_register(xprt) 255 * SVCXPRT *xprt; 256 */ 257 __BEGIN_DECLS 258 extern void xprt_register(SVCXPRT *); 259 __END_DECLS 260 261 /* 262 * Transport un-register 263 * 264 * xprt_unregister(xprt) 265 * SVCXPRT *xprt; 266 */ 267 __BEGIN_DECLS 268 extern void xprt_unregister(SVCXPRT *); 269 __END_DECLS 270 271 272 /* 273 * When the service routine is called, it must first check to see if it 274 * knows about the procedure; if not, it should call svcerr_noproc 275 * and return. If so, it should deserialize its arguments via 276 * SVC_GETARGS (defined above). If the deserialization does not work, 277 * svcerr_decode should be called followed by a return. Successful 278 * decoding of the arguments should be followed the execution of the 279 * procedure's code and a call to svc_sendreply. 280 * 281 * Also, if the service refuses to execute the procedure due to too- 282 * weak authentication parameters, svcerr_weakauth should be called. 283 * Note: do not confuse access-control failure with weak authentication! 284 * 285 * NB: In pure implementations of rpc, the caller always waits for a reply 286 * msg. This message is sent when svc_sendreply is called. 287 * Therefore pure service implementations should always call 288 * svc_sendreply even if the function logically returns void; use 289 * xdr.h - xdr_void for the xdr routine. HOWEVER, tcp based rpc allows 290 * for the abuse of pure rpc via batched calling or pipelining. In the 291 * case of a batched call, svc_sendreply should NOT be called since 292 * this would send a return message, which is what batching tries to avoid. 293 * It is the service/protocol writer's responsibility to know which calls are 294 * batched and which are not. Warning: responding to batch calls may 295 * deadlock the caller and server processes! 296 */ 297 298 __BEGIN_DECLS 299 extern bool_t svc_sendreply(SVCXPRT *, xdrproc_t, void *); 300 extern void svcerr_decode(SVCXPRT *); 301 extern void svcerr_weakauth(SVCXPRT *); 302 extern void svcerr_noproc(SVCXPRT *); 303 extern void svcerr_progvers(SVCXPRT *, rpcvers_t, rpcvers_t); 304 extern void svcerr_auth(SVCXPRT *, enum auth_stat); 305 extern void svcerr_noprog(SVCXPRT *); 306 extern void svcerr_systemerr(SVCXPRT *); 307 extern int rpc_reg(rpcprog_t, rpcvers_t, rpcproc_t, 308 char *(*)(char *), xdrproc_t, xdrproc_t, 309 char *); 310 __END_DECLS 311 312 /* 313 * Lowest level dispatching -OR- who owns this process anyway. 314 * Somebody has to wait for incoming requests and then call the correct 315 * service routine. The routine svc_run does infinite waiting; i.e., 316 * svc_run never returns. 317 * Since another (co-existant) package may wish to selectively wait for 318 * incoming calls or other events outside of the rpc architecture, the 319 * routine svc_getreq is provided. It must be passed readfds, the 320 * "in-place" results of a select system call (see select, section 2). 321 */ 322 323 /* 324 * Global keeper of rpc service descriptors in use 325 * dynamic; must be inspected before each call to select 326 */ 327 extern int svc_maxfd; 328 #ifdef FD_SETSIZE 329 extern fd_set svc_fdset; 330 #define svc_fds svc_fdset.fds_bits[0] /* compatibility */ 331 #else 332 extern int svc_fds; 333 #endif /* def FD_SETSIZE */ 334 335 /* 336 * A set of null auth methods used by any authentication protocols 337 * that don't need to inspect or modify the message body. 338 */ 339 extern SVCAUTH _svc_auth_null; 340 341 /* 342 * a small program implemented by the svc_rpc implementation itself; 343 * also see clnt.h for protocol numbers. 344 */ 345 __BEGIN_DECLS 346 extern void rpctest_service(void); 347 __END_DECLS 348 349 __BEGIN_DECLS 350 extern SVCXPRT *svc_xprt_alloc(void); 351 extern void svc_xprt_free(SVCXPRT *); 352 extern void svc_getreq(int); 353 extern void svc_getreqset(fd_set *); 354 extern void svc_getreq_common(int); 355 struct pollfd; 356 extern void svc_getreq_poll(struct pollfd *, int); 357 358 extern void svc_run(void); 359 extern void svc_exit(void); 360 __END_DECLS 361 362 /* 363 * Socket to use on svcxxx_create call to get default socket 364 */ 365 #define RPC_ANYSOCK -1 366 #define RPC_ANYFD RPC_ANYSOCK 367 368 /* 369 * These are the existing service side transport implementations 370 */ 371 372 __BEGIN_DECLS 373 /* 374 * Transport independent svc_create routine. 375 */ 376 extern int svc_create(void (*)(struct svc_req *, SVCXPRT *), 377 const rpcprog_t, const rpcvers_t, const char *); 378 /* 379 * void (*dispatch)(); -- dispatch routine 380 * const rpcprog_t prognum; -- program number 381 * const rpcvers_t versnum; -- version number 382 * const char *nettype; -- network type 383 */ 384 385 386 /* 387 * Generic server creation routine. It takes a netconfig structure 388 * instead of a nettype. 389 */ 390 391 extern SVCXPRT *svc_tp_create(void (*)(struct svc_req *, SVCXPRT *), 392 const rpcprog_t, const rpcvers_t, 393 const struct netconfig *); 394 /* 395 * void (*dispatch)(); -- dispatch routine 396 * const rpcprog_t prognum; -- program number 397 * const rpcvers_t versnum; -- version number 398 * const struct netconfig *nconf; -- netconfig structure 399 */ 400 401 402 /* 403 * Generic TLI create routine 404 */ 405 extern SVCXPRT *svc_tli_create(const int, const struct netconfig *, 406 const struct t_bind *, const u_int, 407 const u_int); 408 /* 409 * const int fd; -- connection end point 410 * const struct netconfig *nconf; -- netconfig structure for network 411 * const struct t_bind *bindaddr; -- local bind address 412 * const u_int sendsz; -- max sendsize 413 * const u_int recvsz; -- max recvsize 414 */ 415 416 /* 417 * Connectionless and connectionful create routines 418 */ 419 420 extern SVCXPRT *svc_vc_create(const int, const u_int, const u_int); 421 /* 422 * const int fd; -- open connection end point 423 * const u_int sendsize; -- max send size 424 * const u_int recvsize; -- max recv size 425 */ 426 427 /* 428 * Added for compatibility to old rpc 4.0. Obsoleted by svc_vc_create(). 429 */ 430 extern SVCXPRT *svcunix_create(int, u_int, u_int, char *); 431 432 extern SVCXPRT *svc_dg_create(const int, const u_int, const u_int); 433 /* 434 * const int fd; -- open connection 435 * const u_int sendsize; -- max send size 436 * const u_int recvsize; -- max recv size 437 */ 438 439 440 /* 441 * the routine takes any *open* connection 442 * descriptor as its first input and is used for open connections. 443 */ 444 extern SVCXPRT *svc_fd_create(const int, const u_int, const u_int); 445 /* 446 * const int fd; -- open connection end point 447 * const u_int sendsize; -- max send size 448 * const u_int recvsize; -- max recv size 449 */ 450 451 /* 452 * Added for compatibility to old rpc 4.0. Obsoleted by svc_fd_create(). 453 */ 454 extern SVCXPRT *svcunixfd_create(int, u_int, u_int); 455 456 /* 457 * Memory based rpc (for speed check and testing) 458 */ 459 extern SVCXPRT *svc_raw_create(void); 460 461 /* 462 * svc_dg_enable_cache() enables the cache on dg transports. 463 */ 464 int svc_dg_enablecache(SVCXPRT *, const u_int); 465 466 int __rpc_get_local_uid(SVCXPRT *_transp, uid_t *_uid); 467 468 __END_DECLS 469 470 471 /* for backward compatibility */ 472 #include <rpc/svc_soc.h> 473 474 #endif /* !_RPC_SVC_H */ 475