include/rpc/svc.h

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