tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
2 * linux/include/linux/sunrpc/svc_xprt.h
3 *
4 * RPC server transport I/O
5 */
6
7#ifndef SUNRPC_SVC_XPRT_H
8#define SUNRPC_SVC_XPRT_H
9
10#include <linux/sunrpc/svc.h>
11#include <linux/module.h>
12
13struct svc_xprt_ops {
14 struct svc_xprt *(*xpo_create)(struct svc_serv *,
15 struct sockaddr *, int,
16 int);
17 struct svc_xprt *(*xpo_accept)(struct svc_xprt *);
18 int (*xpo_has_wspace)(struct svc_xprt *);
19 int (*xpo_recvfrom)(struct svc_rqst *);
20 void (*xpo_prep_reply_hdr)(struct svc_rqst *);
21 int (*xpo_sendto)(struct svc_rqst *);
22 void (*xpo_release_rqst)(struct svc_rqst *);
23 void (*xpo_detach)(struct svc_xprt *);
24 void (*xpo_free)(struct svc_xprt *);
25};
26
27struct svc_xprt_class {
28 const char *xcl_name;
29 struct module *xcl_owner;
30 struct svc_xprt_ops *xcl_ops;
31 struct list_head xcl_list;
32 u32 xcl_max_payload;
33};
34
35struct svc_xprt {
36 struct svc_xprt_class *xpt_class;
37 struct svc_xprt_ops *xpt_ops;
38 struct kref xpt_ref;
39 struct list_head xpt_list;
40 struct list_head xpt_ready;
41 unsigned long xpt_flags;
42#define XPT_BUSY 0 /* enqueued/receiving */
43#define XPT_CONN 1 /* conn pending */
44#define XPT_CLOSE 2 /* dead or dying */
45#define XPT_DATA 3 /* data pending */
46#define XPT_TEMP 4 /* connected transport */
47#define XPT_DEAD 6 /* transport closed */
48#define XPT_CHNGBUF 7 /* need to change snd/rcv buf sizes */
49#define XPT_DEFERRED 8 /* deferred request pending */
50#define XPT_OLD 9 /* used for xprt aging mark+sweep */
51#define XPT_DETACHED 10 /* detached from tempsocks list */
52#define XPT_LISTENER 11 /* listening endpoint */
53#define XPT_CACHE_AUTH 12 /* cache auth info */
54
55 struct svc_pool *xpt_pool; /* current pool iff queued */
56 struct svc_serv *xpt_server; /* service for transport */
57 atomic_t xpt_reserved; /* space on outq that is rsvd */
58 struct mutex xpt_mutex; /* to serialize sending data */
59 spinlock_t xpt_lock; /* protects sk_deferred
60 * and xpt_auth_cache */
61 void *xpt_auth_cache;/* auth cache */
62 struct list_head xpt_deferred; /* deferred requests that need
63 * to be revisted */
64 struct sockaddr_storage xpt_local; /* local address */
65 size_t xpt_locallen; /* length of address */
66 struct sockaddr_storage xpt_remote; /* remote peer's address */
67 size_t xpt_remotelen; /* length of address */
68};
69
70int svc_reg_xprt_class(struct svc_xprt_class *);
71void svc_unreg_xprt_class(struct svc_xprt_class *);
72void svc_xprt_init(struct svc_xprt_class *, struct svc_xprt *,
73 struct svc_serv *);
74int svc_create_xprt(struct svc_serv *, const char *, const int,
75 const unsigned short, int);
76void svc_xprt_enqueue(struct svc_xprt *xprt);
77void svc_xprt_received(struct svc_xprt *);
78void svc_xprt_put(struct svc_xprt *xprt);
79void svc_xprt_copy_addrs(struct svc_rqst *rqstp, struct svc_xprt *xprt);
80void svc_close_xprt(struct svc_xprt *xprt);
81void svc_delete_xprt(struct svc_xprt *xprt);
82int svc_port_is_privileged(struct sockaddr *sin);
83int svc_print_xprts(char *buf, int maxlen);
84struct svc_xprt *svc_find_xprt(struct svc_serv *serv, const char *xcl_name,
85 const sa_family_t af, const unsigned short port);
86int svc_xprt_names(struct svc_serv *serv, char *buf, const int buflen);
87
88static inline void svc_xprt_get(struct svc_xprt *xprt)
89{
90 kref_get(&xprt->xpt_ref);
91}
92static inline void svc_xprt_set_local(struct svc_xprt *xprt,
93 const struct sockaddr *sa,
94 const size_t salen)
95{
96 memcpy(&xprt->xpt_local, sa, salen);
97 xprt->xpt_locallen = salen;
98}
99static inline void svc_xprt_set_remote(struct svc_xprt *xprt,
100 const struct sockaddr *sa,
101 const size_t salen)
102{
103 memcpy(&xprt->xpt_remote, sa, salen);
104 xprt->xpt_remotelen = salen;
105}
106static inline unsigned short svc_addr_port(const struct sockaddr *sa)
107{
108 const struct sockaddr_in *sin = (const struct sockaddr_in *)sa;
109 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sa;
110
111 switch (sa->sa_family) {
112 case AF_INET:
113 return ntohs(sin->sin_port);
114 case AF_INET6:
115 return ntohs(sin6->sin6_port);
116 }
117
118 return 0;
119}
120
121static inline size_t svc_addr_len(const struct sockaddr *sa)
122{
123 switch (sa->sa_family) {
124 case AF_INET:
125 return sizeof(struct sockaddr_in);
126 case AF_INET6:
127 return sizeof(struct sockaddr_in6);
128 }
129
130 return 0;
131}
132
133static inline unsigned short svc_xprt_local_port(const struct svc_xprt *xprt)
134{
135 return svc_addr_port((const struct sockaddr *)&xprt->xpt_local);
136}
137
138static inline unsigned short svc_xprt_remote_port(const struct svc_xprt *xprt)
139{
140 return svc_addr_port((const struct sockaddr *)&xprt->xpt_remote);
141}
142
143static inline char *__svc_print_addr(const struct sockaddr *addr,
144 char *buf, const size_t len)
145{
146 const struct sockaddr_in *sin = (const struct sockaddr_in *)addr;
147 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr;
148
149 switch (addr->sa_family) {
150 case AF_INET:
151 snprintf(buf, len, "%pI4, port=%u", &sin->sin_addr,
152 ntohs(sin->sin_port));
153 break;
154
155 case AF_INET6:
156 snprintf(buf, len, "%pI6, port=%u",
157 &sin6->sin6_addr,
158 ntohs(sin6->sin6_port));
159 break;
160
161 default:
162 snprintf(buf, len, "unknown address type: %d", addr->sa_family);
163 break;
164 }
165
166 return buf;
167}
168#endif /* SUNRPC_SVC_XPRT_H */