/usr/include/ntirpc/rpc/svc.h is in libntirpc-dev 1.3.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 | /* $netbsd: svc.h,v 1.17 2000/06/02 22:57:56 fvdl Exp $ */
/*
* Copyright (c) 2009, Sun Microsystems, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - 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.
* - Neither the name of Sun Microsystems, Inc. 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 COPYRIGHT HOLDERS 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 COPYRIGHT HOLDER 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.
*
* from: @(#)svc.h 1.35 88/12/17 SMI
* from: @(#)svc.h 1.27 94/04/25 SMI
* $FreeBSD: src/include/rpc/svc.h,v 1.24 2003/06/15 10:32:01 mbr Exp $
*/
/*
* svc.h, Server-side remote procedure call interface.
*
* Copyright (C) 1986-1993 by Sun Microsystems, Inc.
*/
#ifndef _TIRPC_SVC_H
#define _TIRPC_SVC_H
#include <sys/cdefs.h>
#include <rpc/types.h>
#include <rpc/work_pool.h>
#include <misc/portable.h>
#include <misc/queue.h>
#include <misc/rbtree.h>
#include "reentrant.h"
#if defined(HAVE_BLKIN)
#include <blkin/zipkin_c.h>
#endif
/*
* This interface must manage two items concerning remote procedure calling:
*
* 1) An arbitrary number of transport connections upon which rpc requests
* are received. The two most notable transports are TCP and UDP; they are
* created and registered by routines in svc_tcp.c and svc_udp.c, respectively;
* they in turn call xprt_register and xprt_unregister.
*
* 2) An arbitrary number of locally registered services. Services are
* described by the following four data: program number, version number,
* "service dispatch" function, a transport handle, and a boolean that
* indicates whether or not the exported program should be registered with a
* local binder service; if true the program's number and version and the
* port number from the transport handle are registered with the binder.
* These data are registered with the rpc svc system via svc_register.
*
* A service's dispatch function is called whenever an rpc request comes in
* on a transport. The request's program and version numbers must match
* those of the registered service. The dispatch function is passed two
* parameters, struct svc_req * and SVCXPRT *, defined below.
*/
/* Package init flags */
#define SVC_INIT_DEFAULT 0x0000
#define SVC_INIT_XPRTS 0x0001
#define SVC_INIT_EPOLL 0x0002
#define SVC_INIT_WARNX 0x0004
#define SVC_INIT_NOREG_XPRTS 0x0008
#define SVC_INIT_BLKIN 0x0010
#define SVC_SHUTDOWN_FLAG_NONE 0x0000
/*
* Service control requests
*/
#define SVCGET_VERSQUIET 1
#define SVCSET_VERSQUIET 2
#define SVCGET_CONNMAXREC 3
#define SVCSET_CONNMAXREC 4
#define SVCGET_XP_RECV 5
#define SVCSET_XP_RECV 6
#define SVCGET_XP_FLAGS 7
#define SVCSET_XP_FLAGS 8
#define SVCGET_XP_GETREQ 9
#define SVCSET_XP_GETREQ 10
#define SVCGET_XP_DISPATCH 11
#define SVCSET_XP_DISPATCH 12
#define SVCGET_XP_RECV_USER_DATA 13
#define SVCSET_XP_RECV_USER_DATA 14
#define SVCGET_XP_FREE_USER_DATA 15
#define SVCSET_XP_FREE_USER_DATA 16
/*
* Operations for rpc_control().
*/
#define RPC_SVC_CONNMAXREC_SET 0 /* set max rec size, enable nonblock */
#define RPC_SVC_CONNMAXREC_GET 1
#define RPC_SVC_XPRTS_GET 2
#define RPC_SVC_XPRTS_SET 3
#define RPC_SVC_FDSET_GET 4
#define RPC_SVC_FDSET_SET 5
/*
* Flags for svc_fd_ncreate2
*/
#define SVC_VCCR_NONE 0x0000
/* Svc event strategy */
enum svc_event_type {
SVC_EVENT_FDSET /* trad. using select and poll (currently unhooked) */ ,
SVC_EVENT_EPOLL /* Linux epoll interface */
};
typedef struct svc_init_params {
u_long flags;
warnx_t warnx;
u_int max_connections; /* xprts */
u_int max_events; /* evchan events */
u_int svc_ioq_maxbuf;
int32_t idle_timeout;
u_int gss_ctx_hash_partitions;
u_int gss_max_ctx;
u_int gss_max_idle_gen;
u_int gss_max_gc;
u_int ioq_thrd_max;
} svc_init_params;
/* Svc param flags */
#define SVC_FLAG_NONE 0x0000
#define SVC_FLAG_NOREG_XPRTS 0x0001
/*
* SVCXPRT xp_flags
*/
#define SVC_XPRT_FLAG_NONE 0x0000
/* uint16_t actually used */
#define SVC_XPRT_FLAG_ADDED 0x0001
#define SVC_XPRT_FLAG_BLOCKED 0x0002
#define SVC_XPRT_FLAG_DESTROYED 0x0020 /* SVC_DESTROY() was called */
#define SVC_XPRT_FLAG_DESTROYING 0x0040 /* (*xp_destroy) was called */
/* uint32_t instructions */
#define SVC_XPRT_FLAG_LOCK SVC_XPRT_FLAG_NONE
#define SVC_XPRT_FLAG_LOCKED 0x00010000
#define SVC_XPRT_FLAG_UNLOCK 0x00020000
/*
* SVC_REF flags
*/
#define SVC_REF_FLAG_NONE SVC_XPRT_FLAG_NONE
#define SVC_REF_FLAG_LOCKED SVC_XPRT_FLAG_LOCKED
/*
* SVC_RELEASE flags
*/
#define SVC_RELEASE_FLAG_NONE SVC_XPRT_FLAG_NONE
#define SVC_RELEASE_FLAG_LOCKED SVC_XPRT_FLAG_LOCKED
/* XXX Ganesha
* Don't confuse with (currently incomplete) transport type, nee
* socktype. */
typedef enum xprt_type {
XPRT_UNKNOWN = 0,
XPRT_UDP,
XPRT_TCP,
XPRT_TCP_RENDEZVOUS,
XPRT_SCTP,
XPRT_RDMA
} xprt_type_t;
enum xprt_stat {
XPRT_DIED,
XPRT_MOREREQS,
XPRT_IDLE,
XPRT_DESTROYED
};
struct cf_rendezvous { /* kept in xprt->xp_p1 for rendezvouser */
u_int sendsize;
u_int recvsize;
int maxrec;
};
struct SVCAUTH; /* forward decl. */
/*
* Server side transport handle
*/
typedef struct rpc_svcxprt {
struct xp_ops {
/* receive incoming requests */
bool (*xp_recv) (struct rpc_svcxprt *, struct svc_req *);
/* get transport status */
enum xprt_stat (*xp_stat) (struct rpc_svcxprt *);
/* get arguments, thread u_data in arg4 */
bool (*xp_getargs) (struct rpc_svcxprt *, struct svc_req *,
xdrproc_t, void *, void *);
/* send reply */
bool (*xp_reply) (struct rpc_svcxprt *, struct svc_req *,
struct rpc_msg *);
/* free mem allocated for args */
bool (*xp_freeargs) (struct rpc_svcxprt *, struct svc_req *,
xdrproc_t, void *);
/* actually destroy after xp_destroy_it and xp_release_it */
void (*xp_destroy) (struct rpc_svcxprt *, u_int,
const char *, const int);
/* catch-all function */
bool (*xp_control) (struct rpc_svcxprt *, const u_int, void *);
/* transport locking (may be duplex-aware, etc) */
void (*xp_lock) (struct rpc_svcxprt *, uint32_t,
const char *, int);
void (*xp_unlock) (struct rpc_svcxprt *, uint32_t,
const char *, int);
/* handle incoming requests (calls xp_recv) */
bool (*xp_getreq) (struct rpc_svcxprt *);
/* call dispatch strategy function */
void (*xp_dispatch) (struct rpc_svcxprt *, struct rpc_msg **);
/* rendezvous (epilogue) */
u_int (*xp_recv_user_data) (struct rpc_svcxprt *,
struct rpc_svcxprt *,
const u_int, void *);
/* free client user data */
bool (*xp_free_user_data) (struct rpc_svcxprt *);
} *xp_ops;
char *xp_tp; /* transport provider device name */
char *xp_netid; /* network token */
void *xp_ev; /* event handle */
void *xp_p1; /* private: for use by svc ops */
void *xp_p2; /* private: for use by svc ops */
void *xp_p3; /* private: for use by svc lib */
void *xp_p4; /* private: for use by svc lib */
void *xp_p5; /* private: for use by svc lib */
void *xp_u1; /* client user data */
void *xp_u2; /* client user data */
struct rpc_address xp_local; /* local address, length, port */
struct rpc_address xp_remote; /* remote address, length, port */
#if defined(HAVE_BLKIN)
/* blkin tracing */
struct {
char *svc_name;
struct blkin_endpoint endp;
} blkin;
#endif
/* auth */
mutex_t xp_auth_lock; /* lock owned by installed authenticator */
/* serialize private data */
mutex_t xp_lock;
/* event vector list */
TAILQ_ENTRY(rpc_svcxprt) xp_evq;
/* indexed by fd */
struct opr_rbtree_node xp_fd_node;
uint32_t xp_refs; /* handle reference count */
uint32_t xp_requests; /* related requests count */
int xp_fd;
int xp_si_type; /* si type */
int xp_type; /* xprt type */
uint16_t xp_flags; /* flags */
u_short xp_port; /* associated port number */
/*
* union of event processor types
*/
enum svc_event_type ev_type;
union {
#if defined(TIRPC_EPOLL)
struct {
struct epoll_event event;
} epoll;
#endif
} ev_u;
} SVCXPRT;
/* Service record used by exported search routines */
typedef struct svc_record {
rpcprog_t sc_prog;
rpcvers_t sc_vers;
char *sc_netid;
void (*sc_dispatch) (struct svc_req *, SVCXPRT *);
} svc_rec_t;
typedef struct svc_vers_range {
rpcvers_t lowvers;
rpcvers_t highvers;
} svc_vers_range_t;
typedef enum svc_lookup_result {
SVC_LKP_SUCCESS = 0,
SVC_LKP_PROG_NOTFOUND = 1,
SVC_LKP_VERS_NOTFOUND = 2,
SVC_LKP_NETID_NOTFOUND = 3,
SVC_LKP_ERR = 667,
} svc_lookup_result_t;
/* functions which can be installed using a control function, e.g.,
* xp_ops->xp_control */
typedef bool(*xp_recv_t) (struct rpc_svcxprt *, struct svc_req *);
typedef bool(*xp_getreq_t) (struct rpc_svcxprt *);
typedef void (*xp_dispatch_t) (struct rpc_svcxprt *, struct rpc_msg **);
typedef u_int(*xp_recv_user_data_t) (struct rpc_svcxprt *, struct rpc_svcxprt *,
const u_int, void *);
typedef bool(*xp_free_user_data_t) (struct rpc_svcxprt *);
/*
* Service request
*/
struct svc_req {
u_int32_t rq_prog; /* service program number */
u_int32_t rq_vers; /* service protocol version */
u_int32_t rq_proc; /* the desired procedure */
struct opaque_auth rq_cred; /* raw creds from the wire */
void *rq_clntcred; /* read only cooked cred */
SVCXPRT *rq_xprt; /* associated transport */
/* New with TI-RPC */
caddr_t rq_clntname; /* read only client name */
caddr_t rq_svcname; /* read only cooked service cred */
/* New with N TI-RPC */
struct rpc_msg *rq_msg; /* decoded rpc_msg */
void *rq_context; /* private context */
void *rq_u1; /* user data */
void *rq_u2; /* user data */
uint64_t rq_cksum;
u_int32_t rq_xid; /* xid */
/* Moved in N TI-RPC */
struct opaque_auth rq_verf; /* raw response verifier */
struct SVCAUTH *rq_auth; /* auth handle */
void *rq_ap1; /* auth private */
void *rq_ap2; /* auth private */
/* copy of remote transport address */
struct sockaddr_storage rq_raddr;
/* Store dest addr for UDP to send replys from */
struct sockaddr_storage rq_daddr;
size_t rq_raddr_len;
size_t rq_daddr_len;
#if defined(HAVE_BLKIN)
/* blkin tracing */
struct blkin_trace bl_trace;
#endif
};
/*
* Approved way of getting addresses
*/
#define svc_getrpccaller(x) (&(x)->xp_remote.ss)
#define svc_getrpclocal(x) (&(x)->xp_local.ss)
/*
* Ganesha. Get connected transport type.
*/
#define svc_get_xprt_type(x) ((x)->xp_type)
/*
* Ganesha. Original TI-RPC si type.
*/
#define svc_get_xprt_si_type(x) ((x)->xp_si_type)
/*
* Trace transport (de-)references, with remote address
*/
__BEGIN_DECLS
extern void svc_xprt_trace(SVCXPRT *, const char *, const char *, const int);
__END_DECLS
#define XPRT_TRACE(xprt, func, tag, line) \
if (__ntirpc_pkg_params.debug_flags & TIRPC_DEBUG_FLAG_REFCNT) { \
svc_xprt_trace((xprt), (func), (tag), (line)); \
}
/*
* Operations defined on an SVCXPRT handle
*
* SVCXPRT *xprt;
* struct svc_req *req;
* xdrproc_t xargs;
* void * argsp;
*/
#define SVC_RECV(xprt, req) \
(*(xprt)->xp_ops->xp_recv)((xprt), (req))
#define svc_recv(xprt, req) \
(*(xprt)->xp_ops->xp_recv)((xprt), (req))
#define SVC_STAT(xprt) \
(*(xprt)->xp_ops->xp_stat)(xprt)
#define svc_stat(xprt) \
(*(xprt)->xp_ops->xp_stat)(xprt)
#define SVC_GETARGS(xprt, req, xargs, argsp, u_data) \
(*(xprt)->xp_ops->xp_getargs)((xprt), (req), (xargs), (argsp), \
(u_data))
#define svc_getargs(xprt, req, xargs, argsp, u_data) \
(*(xprt)->xp_ops->xp_getargs)((xprt), (req), (xargs), (argsp), \
(u_data))
#define SVC_REPLY(xprt, req, msg) \
(*(xprt)->xp_ops->xp_reply) ((xprt), (req), (msg))
#define svc_reply(xprt, req, msg) \
(*(xprt)->xp_ops->xp_reply) ((xprt), (req), (msg))
#define SVC_FREEARGS(xprt, req, xargs, argsp) \
(*(xprt)->xp_ops->xp_freeargs)((xprt), (req), (xargs), (argsp))
#define svc_freeargs(xprt, req, xargs, argsp) \
(*(xprt)->xp_ops->xp_freeargs)((xprt), (req), (xargs), (argsp))
/* Protect a SVCXPRT with a SVC_REF for each call or request.
*/
static inline void svc_ref_it(struct rpc_svcxprt *xprt, u_int flags,
const char *tag, const int line)
{
atomic_inc_uint32_t(&xprt->xp_refs);
if (flags & SVC_REF_FLAG_LOCKED) {
/* unlock before warning trace */
mutex_unlock(&xprt->xp_lock);
}
XPRT_TRACE(xprt, __func__, tag, line);
}
#define SVC_REF2(xprt, flags, tag, line) \
svc_ref_it(xprt, flags, tag, line)
#define svc_ref2(xprt, flags, tag, line) \
svc_ref_it(xprt, flags, tag, line)
#define SVC_REF(xprt, flags) \
svc_ref_it(xprt, flags, __func__, __LINE__)
#define svc_ref(xprt, flags) \
svc_ref_it(xprt, flags, __func__, __LINE__)
static inline void svc_release_it(struct rpc_svcxprt *xprt, u_int flags,
const char *tag, const int line)
{
uint32_t refs = atomic_dec_uint32_t(&xprt->xp_refs);
uint16_t xp_flags;
if (flags & SVC_RELEASE_FLAG_LOCKED) {
/* unlock before warning trace */
mutex_unlock(&xprt->xp_lock);
}
XPRT_TRACE(xprt, __func__, tag, line);
if (likely(refs > 0)) {
/* normal case */
return;
}
/* enforce once-only semantic, trace others */
xp_flags = atomic_postset_uint16_t_bits(&xprt->xp_flags,
SVC_XPRT_FLAG_DESTROYING);
if (xp_flags & SVC_XPRT_FLAG_DESTROYING) {
XPRT_TRACE(xprt, "ERROR! already destroying!", tag, line);
return;
}
/* Releasing last reference */
(*(xprt)->xp_ops->xp_destroy)(xprt, flags, tag, line);
}
#define SVC_RELEASE2(xprt, flags, tag, line) \
svc_release_it(xprt, flags, __func__, __LINE__)
#define svc_release2(xprt, flags, tag, line) \
svc_release_it(xprt, flags, __func__, __LINE__)
#define SVC_RELEASE(xprt, flags) \
svc_release_it(xprt, flags, __func__, __LINE__)
#define svc_release(xprt, flags) \
svc_release_it(xprt, flags, __func__, __LINE__)
/* SVC_DESTROY is SVC_RELEASE with once-only semantics. Also, idempotent
* SVC_XPRT_FLAG_DESTROYED indicates that more references should not be taken.
*/
static inline void svc_destroy_it(struct rpc_svcxprt *xprt,
const char *tag, const int line)
{
uint16_t flags = atomic_postset_uint16_t_bits(&xprt->xp_flags,
SVC_XPRT_FLAG_DESTROYED);
XPRT_TRACE(xprt, __func__, tag, line);
if (flags & SVC_XPRT_FLAG_DESTROYED) {
/* previously set, do nothing */
return;
}
svc_release_it(xprt, SVC_RELEASE_FLAG_NONE, tag, line);
}
#define SVC_DESTROY(xprt) \
svc_destroy_it(xprt, __func__, __LINE__)
#define svc_destroy(xprt) \
svc_destroy_it(xprt, __func__, __LINE__)
#define SVC_CONTROL(xprt, rq, in) \
(*(xprt)->xp_ops->xp_control)((xprt), (rq), (in))
#define XP_LOCK_NONE 0x0000
#define XP_LOCK_SEND 0x0001
#define XP_LOCK_RECV 0x0002
#define SVC_LOCK(xprt, flags, func, line) \
(*(xprt)->xp_ops->xp_lock)((xprt), (flags), (func), (line))
#define svc_lock(xprt, flags, func, line) \
(*(xprt)->xp_ops->xp_lock)((xprt), (flags), (func), (line))
#define SVC_UNLOCK(xprt, flags, func, line) \
(*(xprt)->xp_ops->xp_unlock)((xprt), (flags), (func), (line))
#define svc_unlock(xprt, flags, func, line) \
(*(xprt)->xp_ops->xp_unlock)((xprt), (flags), (func), (line))
/*
* Service init (optional).
*/
__BEGIN_DECLS
extern struct work_pool svc_work_pool;
bool svc_init(struct svc_init_params *);
__END_DECLS
/*
* Service shutdown (optional).
*/
__BEGIN_DECLS
int svc_shutdown(u_long flags);
__END_DECLS
/*
* Service registration
*
* svc_reg(xprt, prog, vers, dispatch, nconf)
* const SVCXPRT *xprt;
* const rpcprog_t prog;
* const rpcvers_t vers;
* const void (*dispatch)();
* const struct netconfig *nconf;
*/
__BEGIN_DECLS
extern bool svc_reg(SVCXPRT *, const rpcprog_t, const rpcvers_t,
void (*)(struct svc_req *, SVCXPRT *),
const struct netconfig *);
__END_DECLS
/*
* Service un-registration
*
* svc_unreg(prog, vers)
* const rpcprog_t prog;
* const rpcvers_t vers;
*/
__BEGIN_DECLS
extern void svc_unreg(const rpcprog_t, const rpcvers_t);
__END_DECLS
/*
* Transport registration.
*
* xprt_register(xprt)
* SVCXPRT *xprt;
*/
__BEGIN_DECLS
extern void xprt_register(SVCXPRT *);
__END_DECLS
/*
* Transport un-register
*
* xprt_unregister(xprt)
* SVCXPRT *xprt;
*/
__BEGIN_DECLS
extern void xprt_unregister(SVCXPRT *);
__END_DECLS
/*
* This is used to set local and remote addresses in a way legacy
* apps can deal with, at the same time setting up a corresponding
* netbuf -- with no alloc/free needed.
*/
__BEGIN_DECLS
extern void __rpc_set_address(struct rpc_address *,
const struct sockaddr_storage *, socklen_t);
__END_DECLS
/*
* When the service routine is called, it must first check to see if it
* knows about the procedure; if not, it should call svcerr_noproc
* and return. If so, it should deserialize its arguments via
* SVC_GETARGS (defined above). If the deserialization does not work,
* svcerr_decode should be called followed by a return. Successful
* decoding of the arguments should be followed the execution of the
* procedure's code and a call to svc_sendreply.
*
* Also, if the service refuses to execute the procedure due to too-
* weak authentication parameters, svcerr_weakauth should be called.
* Note: do not confuse access-control failure with weak authentication!
*
* NB: In pure implementations of rpc, the caller always waits for a reply
* msg. This message is sent when svc_sendreply is called.
* Therefore pure service implementations should always call
* svc_sendreply even if the function logically returns void; use
* xdr.h - xdr_void for the xdr routine. HOWEVER, tcp based rpc allows
* for the abuse of pure rpc via batched calling or pipelining. In the
* case of a batched call, svc_sendreply should NOT be called since
* this would send a return message, which is what batching tries to avoid.
* It is the service/protocol writer's responsibility to know which calls are
* batched and which are not. Warning: responding to batch calls may
* deadlock the caller and server processes!
*/
__BEGIN_DECLS
extern bool svc_sendreply(SVCXPRT *, struct svc_req *, xdrproc_t,
void *);
extern void svcerr_decode(SVCXPRT *, struct svc_req *);
extern void svcerr_weakauth(SVCXPRT *, struct svc_req *);
extern void svcerr_noproc(SVCXPRT *, struct svc_req *);
extern void svcerr_progvers(SVCXPRT *, struct svc_req *, rpcvers_t, rpcvers_t);
extern void svcerr_auth(SVCXPRT *, struct svc_req *, enum auth_stat);
extern void svcerr_noprog(SVCXPRT *, struct svc_req *);
extern void svcerr_systemerr(SVCXPRT *, struct svc_req *);
extern int rpc_reg(rpcprog_t, rpcvers_t, rpcproc_t, char *(*)(char *),
xdrproc_t, xdrproc_t, char *);
__END_DECLS
/*
* a small program implemented by the svc_rpc implementation itself;
* also see clnt.h for protocol numbers.
*/
__BEGIN_DECLS
extern void rpctest_service(void);
__END_DECLS
__BEGIN_DECLS
extern void svc_getreq(int);
extern void svc_getreqset(fd_set *);
extern void svc_getreq_common(int);
struct pollfd;
extern void svc_getreq_poll(struct pollfd *, int);
extern void svc_run(void);
extern void svc_exit(void);
__END_DECLS
/*
* Socket to use on svcxxx_ncreate call to get default socket
*/
#define RPC_ANYSOCK -1
#define RPC_ANYFD RPC_ANYSOCK
/*
* These are the existing service side transport implementations
*/
__BEGIN_DECLS
/*
* Transport independent svc_create routine.
*/
extern int svc_ncreate(void (*)(struct svc_req *, SVCXPRT *), const rpcprog_t,
const rpcvers_t, const char *);
/*
* void (*dispatch)(); -- dispatch routine
* const rpcprog_t prognum; -- program number
* const rpcvers_t versnum; -- version number
* const char *nettype; -- network type
*/
/*
* Generic server creation routine. It takes a netconfig structure
* instead of a nettype.
*/
extern SVCXPRT *svc_tp_ncreate(void (*)(struct svc_req *, SVCXPRT *),
const rpcprog_t, const rpcvers_t,
const struct netconfig *);
/*
* void (*dispatch)(); -- dispatch routine
* const rpcprog_t prognum; -- program number
* const rpcvers_t versnum; -- version number
* const struct netconfig *nconf; -- netconfig structure
*/
/*
* Generic TLI create routine
*/
extern SVCXPRT *svc_tli_ncreate(const int, const struct netconfig *,
const struct t_bind *, const u_int,
const u_int);
/*
* const int fd; -- connection end point
* const struct netconfig *nconf; -- netconfig structure for network
* const struct t_bind *bindaddr; -- local bind address
* const u_int sendsz; -- max sendsize
* const u_int recvsz; -- max recvsize
*/
/*
* Connectionless and connectionful create routines
*/
extern SVCXPRT *svc_vc_ncreate(const int, const u_int, const u_int);
/*
* const int fd; -- open connection end point
* const u_int sendsize; -- max send size
* const u_int recvsize; -- max recv size
*/
extern SVCXPRT *svc_vc_ncreate2(const int, const u_int, const u_int,
const u_int);
/*
* const int fd; -- open connection end point
* const u_int sendsize; -- max send size
* const u_int recvsize; -- max recv size
* const u_int flags; -- flags
*/
__END_DECLS
#define SVC_VC_CREATE_NONE 0x0000
#define SVC_VC_CREATE_BOTHWAYS 0x0001
#define SVC_VC_CREATE_ONEWAY 0x0002 /* !bothways */
#define SVC_VC_CREATE_DISPOSE 0x0004 /* !bothways */
#define SVC_VC_CREATE_XPRT_NOREG 0x0008
#define SVC_VC_CREATE_LISTEN 0x0010
__BEGIN_DECLS
/*
* Create a client handle from an active service transport handle.
*/
extern CLIENT *clnt_vc_ncreate_svc(SVCXPRT *, const rpcprog_t, const rpcvers_t,
const uint32_t);
/*
* SVCXPRT *xprt; -- active service xprt
* const rpcprog_t prog; -- RPC program number
* const rpcvers_t vers; -- RPC program version
*/
__END_DECLS
__BEGIN_DECLS
/*
* Create an RPC SVCXPRT handle from an active client transport
* handle, i.e., to service RPC requests
*/
extern SVCXPRT *svc_vc_ncreate_clnt(CLIENT *, u_int, u_int, const uint32_t);
/*
*
* CLIENT *cl; -- connected client
* const u_int sendsize; -- max send size
* const u_int recvsize; -- max recv size
* const uint32_t flags; -- flags
*/
/*
* Added for compatibility to old rpc 4.0. Obsoleted by svc_vc_create().
*/
extern SVCXPRT *svcunix_ncreate(int, u_int, u_int, char *);
extern SVCXPRT *svc_dg_ncreate(const int, const u_int, const u_int);
/*
* const int fd; -- open connection
* const u_int sendsize; -- max send size
* const u_int recvsize; -- max recv size
*/
/*
* the routine takes any *open* connection
* descriptor as its first input and is used for open connections.
*/
extern SVCXPRT *svc_fd_ncreate(const int, const u_int, const u_int);
/*
* const int fd; -- open connection end point
* const u_int sendsize; -- max send size
* const u_int recvsize; -- max recv size
*/
/*
* Added for compatibility to old rpc 4.0. Obsoleted by svc_fd_create().
*/
extern SVCXPRT *svcunixfd_ncreate(int, u_int, u_int);
/*
* Memory based rpc (for speed check and testing)
*/
extern SVCXPRT *svc_raw_ncreate(void);
/*
* RDMA based rpc
*/
extern SVCXPRT *svc_rdma_ncreate(void *arg, const u_int sendsize,
const u_int recvsize, const u_int flags);
struct rpc_rdma_attr {
char *statistics_prefix;
/* silly char * to pass to rdma_getaddrinfo() */
char *node; /**< remote peer's hostname */
char *port; /**< service port (or name) */
void (*disconnect_cb)(SVCXPRT *);
enum xprt_stat (*request_cb)(void *, SVCXPRT *);
u_long timeout; /**< ms wait for events */
u_int sq_depth; /**< depth of Send Queue */
u_int max_send_sge; /**< s/g elements per send */
u_int rq_depth; /**< depth of Receive Queue. */
u_int max_recv_sge; /**< s/g elements per recv */
u_int backlog; /**< connection backlog */
u_int credits; /**< parallel messages */
u_int worker_count; /**< worker threads */
u_int worker_queue_size; /**< worker data queue */
bool destroy_on_disconnect; /**< should perform cleanup */
bool use_srq; /**< server use srq? */
};
extern SVCXPRT *rpc_rdma_create(struct rpc_rdma_attr *arg);
/*
* Getreq plug-out prototype
*/
extern bool svc_getreq_default(SVCXPRT *);
/*
* Dispatch plug-out prototype
*/
extern void svc_dispatch_default(SVCXPRT *, struct rpc_msg **);
/*
* Convenience functions for implementing these
*/
extern bool svc_validate_xprt_list(SVCXPRT *);
extern struct rpc_msg *alloc_rpc_msg(void);
extern void free_rpc_msg(struct rpc_msg *);
/*
* svc_dg_enable_cache() enables the cache on dg transports.
*/
int svc_dg_enablecache(SVCXPRT *, const u_int);
int __rpc_get_local_uid(SVCXPRT *, uid_t *);
__END_DECLS
/* for backward compatibility */
#include <rpc/svc_soc.h>
#include <rpc/tirpc_compat.h>
#endif /* !_TIRPC_SVC_H */
|