rcu: Suppress sparse warnings for rcu_dereference_raw()
[linux-2.6-block.git] / net / rxrpc / ar-internal.h
CommitLineData
17926a79
DH
1/* AF_RXRPC internal definitions
2 *
3 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
be6e6707 12#include <linux/atomic.h>
e0e4d82f 13#include <net/sock.h>
be6e6707 14#include <net/af_rxrpc.h>
17926a79
DH
15#include <rxrpc/packet.h>
16
17#if 0
18#define CHECK_SLAB_OKAY(X) \
19 BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
20 (POISON_FREE << 8 | POISON_FREE))
21#else
b4f1342f 22#define CHECK_SLAB_OKAY(X) do {} while (0)
17926a79
DH
23#endif
24
17926a79
DH
25#define FCRYPT_BSIZE 8
26struct rxrpc_crypt {
27 union {
28 u8 x[FCRYPT_BSIZE];
91e916cf 29 __be32 n[2];
17926a79
DH
30 };
31} __attribute__((aligned(8)));
32
651350d1
DH
33#define rxrpc_queue_work(WS) queue_work(rxrpc_workqueue, (WS))
34#define rxrpc_queue_delayed_work(WS,D) \
35 queue_delayed_work(rxrpc_workqueue, (WS), (D))
36
37#define rxrpc_queue_call(CALL) rxrpc_queue_work(&(CALL)->processor)
17926a79 38
cc8feb8e
DH
39struct rxrpc_connection;
40
17926a79
DH
41/*
42 * sk_state for RxRPC sockets
43 */
44enum {
2341e077
DH
45 RXRPC_UNBOUND = 0,
46 RXRPC_CLIENT_UNBOUND, /* Unbound socket used as client */
17926a79 47 RXRPC_CLIENT_BOUND, /* client local address bound */
17926a79
DH
48 RXRPC_SERVER_BOUND, /* server local address bound */
49 RXRPC_SERVER_LISTENING, /* server listening for connections */
50 RXRPC_CLOSE, /* socket is being closed */
51};
52
53/*
54 * RxRPC socket definition
55 */
56struct rxrpc_sock {
57 /* WARNING: sk has to be the first member */
58 struct sock sk;
651350d1 59 rxrpc_interceptor_t interceptor; /* kernel service Rx interceptor function */
17926a79 60 struct rxrpc_local *local; /* local endpoint */
17926a79
DH
61 struct list_head listen_link; /* link in the local endpoint's listen list */
62 struct list_head secureq; /* calls awaiting connection security clearance */
63 struct list_head acceptq; /* calls awaiting acceptance */
64 struct key *key; /* security for this socket */
65 struct key *securities; /* list of server security descriptors */
66 struct rb_root calls; /* outstanding calls on this socket */
67 unsigned long flags;
2341e077 68#define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
17926a79
DH
69 rwlock_t call_lock; /* lock for calls */
70 u32 min_sec_level; /* minimum security level */
71#define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
cc8feb8e
DH
72 bool exclusive; /* Exclusive connection for a client socket */
73 sa_family_t family; /* Protocol family created with */
17926a79 74 struct sockaddr_rxrpc srx; /* local address */
2341e077 75 struct sockaddr_rxrpc connect_srx; /* Default client address from connect() */
17926a79
DH
76};
77
78#define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
79
0d12f8a4
DH
80/*
81 * CPU-byteorder normalised Rx packet header.
82 */
83struct rxrpc_host_header {
84 u32 epoch; /* client boot timestamp */
85 u32 cid; /* connection and channel ID */
86 u32 callNumber; /* call ID (0 for connection-level packets) */
87 u32 seq; /* sequence number of pkt in call stream */
88 u32 serial; /* serial number of pkt sent to network */
89 u8 type; /* packet type */
90 u8 flags; /* packet flags */
91 u8 userStatus; /* app-layer defined status */
92 u8 securityIndex; /* security protocol ID */
93 union {
94 u16 _rsvd; /* reserved */
95 u16 cksum; /* kerberos security checksum */
96 };
97 u16 serviceId; /* service ID */
98} __packed;
99
17926a79
DH
100/*
101 * RxRPC socket buffer private variables
102 * - max 48 bytes (struct sk_buff::cb)
103 */
104struct rxrpc_skb_priv {
105 struct rxrpc_call *call; /* call with which associated */
106 unsigned long resend_at; /* time in jiffies at which to resend */
107 union {
95c96174 108 unsigned int offset; /* offset into buffer of next read */
17926a79
DH
109 int remain; /* amount of space remaining for next write */
110 u32 error; /* network error code */
111 bool need_resend; /* T if needs resending */
112 };
113
0d12f8a4 114 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
17926a79
DH
115};
116
117#define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
118
17926a79
DH
119enum rxrpc_command {
120 RXRPC_CMD_SEND_DATA, /* send data message */
121 RXRPC_CMD_SEND_ABORT, /* request abort generation */
122 RXRPC_CMD_ACCEPT, /* [server] accept incoming call */
123 RXRPC_CMD_REJECT_BUSY, /* [server] reject a call as busy */
124};
125
126/*
127 * RxRPC security module interface
128 */
129struct rxrpc_security {
17926a79
DH
130 const char *name; /* name of this service */
131 u8 security_index; /* security type provided */
132
648af7fc
DH
133 /* Initialise a security service */
134 int (*init)(void);
135
136 /* Clean up a security service */
137 void (*exit)(void);
138
17926a79
DH
139 /* initialise a connection's security */
140 int (*init_connection_security)(struct rxrpc_connection *);
141
142 /* prime a connection's packet security */
a263629d 143 int (*prime_packet_security)(struct rxrpc_connection *);
17926a79
DH
144
145 /* impose security on a packet */
a263629d 146 int (*secure_packet)(struct rxrpc_call *,
17926a79
DH
147 struct sk_buff *,
148 size_t,
149 void *);
150
151 /* verify the security on a received packet */
a263629d 152 int (*verify_packet)(struct rxrpc_call *, struct sk_buff *, u32 *);
17926a79
DH
153
154 /* issue a challenge */
155 int (*issue_challenge)(struct rxrpc_connection *);
156
157 /* respond to a challenge */
158 int (*respond_to_challenge)(struct rxrpc_connection *,
159 struct sk_buff *,
160 u32 *);
161
162 /* verify a response */
163 int (*verify_response)(struct rxrpc_connection *,
164 struct sk_buff *,
165 u32 *);
166
167 /* clear connection security */
168 void (*clear)(struct rxrpc_connection *);
169};
170
171/*
4f95dd78
DH
172 * RxRPC local transport endpoint description
173 * - owned by a single AF_RXRPC socket
174 * - pointed to by transport socket struct sk_user_data
17926a79
DH
175 */
176struct rxrpc_local {
4f95dd78
DH
177 struct rcu_head rcu;
178 atomic_t usage;
179 struct list_head link;
17926a79 180 struct socket *socket; /* my UDP socket */
4f95dd78 181 struct work_struct processor;
17926a79 182 struct list_head services; /* services listening on this endpoint */
17926a79
DH
183 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
184 struct sk_buff_head accept_queue; /* incoming calls awaiting acceptance */
185 struct sk_buff_head reject_queue; /* packets awaiting rejection */
44ba0698 186 struct sk_buff_head event_queue; /* endpoint event packets awaiting processing */
999b69f8
DH
187 struct rb_root client_conns; /* Client connections by socket params */
188 spinlock_t client_conns_lock; /* Lock for client_conns */
17926a79
DH
189 spinlock_t lock; /* access lock */
190 rwlock_t services_lock; /* lock for services list */
17926a79 191 int debug_id; /* debug ID for printks */
4f95dd78 192 bool dead;
17926a79
DH
193 struct sockaddr_rxrpc srx; /* local address */
194};
195
196/*
197 * RxRPC remote transport endpoint definition
be6e6707 198 * - matched by local endpoint, remote port, address and protocol type
17926a79
DH
199 */
200struct rxrpc_peer {
be6e6707
DH
201 struct rcu_head rcu; /* This must be first */
202 atomic_t usage;
203 unsigned long hash_key;
204 struct hlist_node hash_link;
205 struct rxrpc_local *local;
f66d7490
DH
206 struct hlist_head error_targets; /* targets for net error distribution */
207 struct work_struct error_distributor;
aa390bbe
DH
208 struct rb_root service_conns; /* Service connections */
209 rwlock_t conn_lock;
17926a79 210 spinlock_t lock; /* access lock */
95c96174
ED
211 unsigned int if_mtu; /* interface MTU for this peer */
212 unsigned int mtu; /* network MTU for this peer */
213 unsigned int maxdata; /* data size (MTU - hdrsize) */
17926a79
DH
214 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
215 int debug_id; /* debug ID for printks */
f66d7490
DH
216 int error_report; /* Net (+0) or local (+1000000) to distribute */
217#define RXRPC_LOCAL_ERROR_OFFSET 1000000
17926a79
DH
218 struct sockaddr_rxrpc srx; /* remote address */
219
220 /* calculated RTT cache */
221#define RXRPC_RTT_CACHE_SIZE 32
222 suseconds_t rtt; /* current RTT estimate (in uS) */
95c96174
ED
223 unsigned int rtt_point; /* next entry at which to insert */
224 unsigned int rtt_usage; /* amount of cache actually used */
17926a79
DH
225 suseconds_t rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* calculated RTT cache */
226};
227
19ffa01c
DH
228/*
229 * Keys for matching a connection.
230 */
231struct rxrpc_conn_proto {
e8d70ce1
DH
232 union {
233 struct {
234 u32 epoch; /* epoch of this connection */
235 u32 cid; /* connection ID */
236 };
237 u64 index_key;
19ffa01c
DH
238 };
239};
240
241struct rxrpc_conn_parameters {
242 struct rxrpc_local *local; /* Representation of local endpoint */
243 struct rxrpc_peer *peer; /* Remote endpoint */
244 struct key *key; /* Security details */
245 bool exclusive; /* T if conn is exclusive */
246 u16 service_id; /* Service ID for this connection */
247 u32 security_level; /* Security level selected */
248};
249
bba304db
DH
250/*
251 * Bits in the connection flags.
252 */
253enum rxrpc_conn_flag {
254 RXRPC_CONN_HAS_IDR, /* Has a client conn ID assigned */
001c1122
DH
255 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
256 RXRPC_CONN_IN_CLIENT_CONNS, /* Conn is in local->client_conns */
bba304db
DH
257};
258
259/*
260 * Events that can be raised upon a connection.
261 */
262enum rxrpc_conn_event {
263 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
264};
265
266/*
267 * The connection protocol state.
268 */
269enum rxrpc_conn_proto_state {
270 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
271 RXRPC_CONN_CLIENT, /* Client connection */
272 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
273 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
274 RXRPC_CONN_SERVICE, /* Service secured connection */
275 RXRPC_CONN_REMOTELY_ABORTED, /* Conn aborted by peer */
276 RXRPC_CONN_LOCALLY_ABORTED, /* Conn aborted locally */
277 RXRPC_CONN_NETWORK_ERROR, /* Conn terminated by network error */
278 RXRPC_CONN__NR_STATES
279};
280
17926a79
DH
281/*
282 * RxRPC connection definition
aa390bbe 283 * - matched by { local, peer, epoch, conn_id, direction }
17926a79
DH
284 * - each connection can only handle four simultaneous calls
285 */
286struct rxrpc_connection {
19ffa01c
DH
287 struct rxrpc_conn_proto proto;
288 struct rxrpc_conn_parameters params;
289
999b69f8 290 spinlock_t channel_lock;
a1399f8b
DH
291
292 struct rxrpc_channel {
293 struct rxrpc_call __rcu *call; /* Active call */
294 u32 call_id; /* ID of current call */
295 u32 call_counter; /* Call ID counter */
296 u32 last_call; /* ID of last call */
297 u32 last_result; /* Result of last call (0/abort) */
298 } channels[RXRPC_MAXCALLS];
999b69f8
DH
299 wait_queue_head_t channel_wq; /* queue to wait for channel to become available */
300
dee46364 301 struct rcu_head rcu;
17926a79 302 struct work_struct processor; /* connection event processor */
999b69f8
DH
303 union {
304 struct rb_node client_node; /* Node in local->client_conns */
aa390bbe 305 struct rb_node service_node; /* Node in peer->service_conns */
999b69f8 306 };
17926a79 307 struct list_head link; /* link in master connection list */
17926a79 308 struct sk_buff_head rx_queue; /* received conn-level packets */
648af7fc 309 const struct rxrpc_security *security; /* applied security module */
17926a79 310 struct key *server_key; /* security for this service */
1afe593b 311 struct crypto_skcipher *cipher; /* encryption handle */
17926a79 312 struct rxrpc_crypt csum_iv; /* packet checksum base */
4a3388c8 313 unsigned long flags;
17926a79 314 unsigned long events;
999b69f8 315 unsigned long put_time; /* Time at which last put */
17926a79
DH
316 spinlock_t state_lock; /* state-change lock */
317 atomic_t usage;
bba304db 318 enum rxrpc_conn_proto_state state : 8; /* current state of connection */
dc44b3a0
DH
319 u32 local_abort; /* local abort code */
320 u32 remote_abort; /* remote abort code */
321 int error; /* local error incurred */
17926a79 322 int debug_id; /* debug ID for printks */
17926a79
DH
323 atomic_t serial; /* packet serial number counter */
324 atomic_t hi_serial; /* highest serial number received */
999b69f8 325 atomic_t avail_chans; /* number of channels available */
17926a79
DH
326 u8 size_align; /* data size alignment (for security) */
327 u8 header_size; /* rxrpc + security header size */
328 u8 security_size; /* security header size */
17926a79 329 u32 security_nonce; /* response re-use preventer */
17926a79 330 u8 security_ix; /* security type */
17926a79
DH
331 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
332};
333
5b8848d1
DH
334/*
335 * Flags in call->flags.
336 */
337enum rxrpc_call_flag {
338 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
339 RXRPC_CALL_TERMINAL_MSG, /* call has given the socket its final message */
340 RXRPC_CALL_RCVD_LAST, /* all packets received */
341 RXRPC_CALL_RUN_RTIMER, /* Tx resend timer started */
342 RXRPC_CALL_TX_SOFT_ACK, /* sent some soft ACKs */
343 RXRPC_CALL_PROC_BUSY, /* the processor is busy */
344 RXRPC_CALL_INIT_ACCEPT, /* acceptance was initiated */
345 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
346 RXRPC_CALL_EXPECT_OOS, /* expect out of sequence packets */
347};
348
349/*
350 * Events that can be raised on a call.
351 */
352enum rxrpc_call_event {
4c198ad1
DH
353 RXRPC_CALL_EV_RCVD_ACKALL, /* ACKALL or reply received */
354 RXRPC_CALL_EV_RCVD_BUSY, /* busy packet received */
355 RXRPC_CALL_EV_RCVD_ABORT, /* abort packet received */
356 RXRPC_CALL_EV_RCVD_ERROR, /* network error received */
357 RXRPC_CALL_EV_ACK_FINAL, /* need to generate final ACK (and release call) */
358 RXRPC_CALL_EV_ACK, /* need to generate ACK */
359 RXRPC_CALL_EV_REJECT_BUSY, /* need to generate busy message */
360 RXRPC_CALL_EV_ABORT, /* need to generate abort */
361 RXRPC_CALL_EV_CONN_ABORT, /* local connection abort generated */
362 RXRPC_CALL_EV_RESEND_TIMER, /* Tx resend timer expired */
363 RXRPC_CALL_EV_RESEND, /* Tx resend required */
364 RXRPC_CALL_EV_DRAIN_RX_OOS, /* drain the Rx out of sequence queue */
365 RXRPC_CALL_EV_LIFE_TIMER, /* call's lifetimer ran out */
366 RXRPC_CALL_EV_ACCEPTED, /* incoming call accepted by userspace app */
367 RXRPC_CALL_EV_SECURED, /* incoming call's connection is now secure */
368 RXRPC_CALL_EV_POST_ACCEPT, /* need to post an "accept?" message to the app */
369 RXRPC_CALL_EV_RELEASE, /* need to release the call's resources */
5b8848d1
DH
370};
371
372/*
373 * The states that a call can be in.
374 */
375enum rxrpc_call_state {
999b69f8
DH
376 RXRPC_CALL_UNINITIALISED,
377 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
5b8848d1
DH
378 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
379 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
380 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
381 RXRPC_CALL_CLIENT_FINAL_ACK, /* - client sending final ACK phase */
382 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
383 RXRPC_CALL_SERVER_ACCEPTING, /* - server accepting request */
384 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
385 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
386 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
387 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
388 RXRPC_CALL_COMPLETE, /* - call completed */
389 RXRPC_CALL_SERVER_BUSY, /* - call rejected by busy server */
390 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
391 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
392 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
393 RXRPC_CALL_DEAD, /* - call is dead */
394 NR__RXRPC_CALL_STATES
395};
396
17926a79
DH
397/*
398 * RxRPC call definition
399 * - matched by { connection, call_id }
400 */
401struct rxrpc_call {
dee46364 402 struct rcu_head rcu;
17926a79
DH
403 struct rxrpc_connection *conn; /* connection carrying call */
404 struct rxrpc_sock *socket; /* socket responsible */
405 struct timer_list lifetimer; /* lifetime remaining on call */
406 struct timer_list deadspan; /* reap timer for re-ACK'ing, etc */
407 struct timer_list ack_timer; /* ACK generation timer */
408 struct timer_list resend_timer; /* Tx resend timer */
409 struct work_struct destroyer; /* call destroyer */
410 struct work_struct processor; /* packet processor and ACK generator */
411 struct list_head link; /* link in master call list */
f66d7490 412 struct hlist_node error_link; /* link in error distribution list */
17926a79
DH
413 struct list_head accept_link; /* calls awaiting acceptance */
414 struct rb_node sock_node; /* node in socket call tree */
17926a79
DH
415 struct sk_buff_head rx_queue; /* received packets */
416 struct sk_buff_head rx_oos_queue; /* packets received out of sequence */
417 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
418 wait_queue_head_t tx_waitq; /* wait for Tx window space to become available */
a263629d 419 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
17926a79
DH
420 unsigned long user_call_ID; /* user-defined call ID */
421 unsigned long creation_jif; /* time of call creation */
422 unsigned long flags;
17926a79 423 unsigned long events;
17926a79
DH
424 spinlock_t lock;
425 rwlock_t state_lock; /* lock for state transition */
426 atomic_t usage;
427 atomic_t sequence; /* Tx data packet sequence counter */
dc44b3a0
DH
428 u32 local_abort; /* local abort code */
429 u32 remote_abort; /* remote abort code */
f66d7490
DH
430 int error_report; /* Network error (ICMP/local transport) */
431 int error; /* Local error incurred */
5b8848d1 432 enum rxrpc_call_state state : 8; /* current state of call */
17926a79
DH
433 int debug_id; /* debug ID for printks */
434 u8 channel; /* connection channel occupied by this call */
435
436 /* transmission-phase ACK management */
4e36a95e
DH
437 u8 acks_head; /* offset into window of first entry */
438 u8 acks_tail; /* offset into window of last entry */
439 u8 acks_winsz; /* size of un-ACK'd window */
440 u8 acks_unacked; /* lowest unacked packet in last ACK received */
17926a79
DH
441 int acks_latest; /* serial number of latest ACK received */
442 rxrpc_seq_t acks_hard; /* highest definitively ACK'd msg seq */
443 unsigned long *acks_window; /* sent packet window
444 * - elements are pointers with LSB set if ACK'd
445 */
446
447 /* receive-phase ACK management */
448 rxrpc_seq_t rx_data_expect; /* next data seq ID expected to be received */
449 rxrpc_seq_t rx_data_post; /* next data seq ID expected to be posted */
450 rxrpc_seq_t rx_data_recv; /* last data seq ID encountered by recvmsg */
451 rxrpc_seq_t rx_data_eaten; /* last data seq ID consumed by recvmsg */
452 rxrpc_seq_t rx_first_oos; /* first packet in rx_oos_queue (or 0) */
453 rxrpc_seq_t ackr_win_top; /* top of ACK window (rx_data_eaten is bottom) */
0d12f8a4 454 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
4e36a95e 455 u8 ackr_reason; /* reason to ACK */
0d12f8a4 456 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
17926a79
DH
457 atomic_t ackr_not_idle; /* number of packets in Rx queue */
458
459 /* received packet records, 1 bit per record */
460#define RXRPC_ACKR_WINDOW_ASZ DIV_ROUND_UP(RXRPC_MAXACKS, BITS_PER_LONG)
461 unsigned long ackr_window[RXRPC_ACKR_WINDOW_ASZ + 1];
462
7727640c
TS
463 struct hlist_node hash_node;
464 unsigned long hash_key; /* Full hash key */
465 u8 in_clientflag; /* Copy of conn->in_clientflag for hashing */
466 struct rxrpc_local *local; /* Local endpoint. Used for hashing. */
19ffa01c 467 sa_family_t family; /* Frame protocol */
0d12f8a4
DH
468 u32 call_id; /* call ID on connection */
469 u32 cid; /* connection ID plus channel index */
470 u32 epoch; /* epoch of this connection */
471 u16 service_id; /* service ID */
7727640c
TS
472 union { /* Peer IP address for hashing */
473 __be32 ipv4_addr;
474 __u8 ipv6_addr[16]; /* Anticipates eventual IPv6 support */
475 } peer_ip;
17926a79
DH
476};
477
17926a79
DH
478/*
479 * locally abort an RxRPC call
480 */
481static inline void rxrpc_abort_call(struct rxrpc_call *call, u32 abort_code)
482{
483 write_lock_bh(&call->state_lock);
484 if (call->state < RXRPC_CALL_COMPLETE) {
dc44b3a0 485 call->local_abort = abort_code;
17926a79 486 call->state = RXRPC_CALL_LOCALLY_ABORTED;
4c198ad1 487 set_bit(RXRPC_CALL_EV_ABORT, &call->events);
17926a79
DH
488 }
489 write_unlock_bh(&call->state_lock);
490}
491
492/*
651350d1 493 * af_rxrpc.c
17926a79 494 */
651350d1 495extern atomic_t rxrpc_n_skbs;
0d12f8a4 496extern u32 rxrpc_epoch;
651350d1
DH
497extern atomic_t rxrpc_debug_id;
498extern struct workqueue_struct *rxrpc_workqueue;
17926a79
DH
499
500/*
0d81a51a 501 * call_accept.c
17926a79 502 */
4f95dd78 503void rxrpc_accept_incoming_calls(struct rxrpc_local *);
c1b1203d
JP
504struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long);
505int rxrpc_reject_call(struct rxrpc_sock *);
17926a79
DH
506
507/*
0d81a51a 508 * call_event.c
17926a79 509 */
0d12f8a4
DH
510void __rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool);
511void rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool);
c1b1203d 512void rxrpc_process_call(struct work_struct *);
17926a79
DH
513
514/*
0d81a51a 515 * call_object.c
17926a79 516 */
dad8aff7
DH
517extern unsigned int rxrpc_max_call_lifetime;
518extern unsigned int rxrpc_dead_call_expiry;
17926a79
DH
519extern struct kmem_cache *rxrpc_call_jar;
520extern struct list_head rxrpc_calls;
521extern rwlock_t rxrpc_call_lock;
522
0d12f8a4
DH
523struct rxrpc_call *rxrpc_find_call_hash(struct rxrpc_host_header *,
524 void *, sa_family_t, const void *);
2341e077
DH
525struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
526struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
19ffa01c 527 struct rxrpc_conn_parameters *,
999b69f8 528 struct sockaddr_rxrpc *,
2341e077 529 unsigned long, gfp_t);
c1b1203d
JP
530struct rxrpc_call *rxrpc_incoming_call(struct rxrpc_sock *,
531 struct rxrpc_connection *,
42886ffe 532 struct sk_buff *);
c1b1203d
JP
533void rxrpc_release_call(struct rxrpc_call *);
534void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
535void __rxrpc_put_call(struct rxrpc_call *);
536void __exit rxrpc_destroy_all_calls(void);
17926a79 537
4a3388c8
DH
538/*
539 * conn_client.c
540 */
541extern struct idr rxrpc_client_conn_ids;
542
eb9b9d22 543void rxrpc_destroy_client_conn_ids(void);
c6d2b8d7
DH
544int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
545 struct sockaddr_rxrpc *, gfp_t);
001c1122 546void rxrpc_unpublish_client_conn(struct rxrpc_connection *);
4a3388c8 547
17926a79 548/*
0d81a51a
DH
549 * conn_event.c
550 */
551void rxrpc_process_connection(struct work_struct *);
552void rxrpc_reject_packet(struct rxrpc_local *, struct sk_buff *);
4f95dd78 553void rxrpc_reject_packets(struct rxrpc_local *);
0d81a51a
DH
554
555/*
556 * conn_object.c
17926a79 557 */
dad8aff7 558extern unsigned int rxrpc_connection_expiry;
17926a79
DH
559extern struct list_head rxrpc_connections;
560extern rwlock_t rxrpc_connection_lock;
561
7877a4a4
DH
562void rxrpc_conn_hash_proto_key(struct rxrpc_conn_proto *);
563void rxrpc_extract_conn_params(struct rxrpc_conn_proto *,
564 struct rxrpc_local *, struct sk_buff *);
c6d2b8d7 565struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
aa390bbe 566struct rxrpc_connection *rxrpc_find_connection(struct rxrpc_local *,
aa390bbe 567 struct sk_buff *);
a1399f8b 568void __rxrpc_disconnect_call(struct rxrpc_call *);
999b69f8 569void rxrpc_disconnect_call(struct rxrpc_call *);
c1b1203d
JP
570void rxrpc_put_connection(struct rxrpc_connection *);
571void __exit rxrpc_destroy_all_connections(void);
17926a79 572
19ffa01c
DH
573static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
574{
575 return conn->out_clientflag;
576}
577
578static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
579{
e8d70ce1 580 return !rxrpc_conn_is_client(conn);
19ffa01c
DH
581}
582
5627cc8b
DH
583static inline void rxrpc_get_connection(struct rxrpc_connection *conn)
584{
585 atomic_inc(&conn->usage);
586}
587
2c4579e4
DH
588static inline
589struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *conn)
590{
591 return atomic_inc_not_zero(&conn->usage) ? conn : NULL;
592}
5acbee46
DH
593
594static inline void rxrpc_queue_conn(struct rxrpc_connection *conn)
595{
2c4579e4
DH
596 if (rxrpc_get_connection_maybe(conn) &&
597 !rxrpc_queue_work(&conn->processor))
598 rxrpc_put_connection(conn);
5acbee46
DH
599}
600
7877a4a4
DH
601/*
602 * conn_service.c
603 */
604struct rxrpc_connection *rxrpc_incoming_connection(struct rxrpc_local *,
d991b4a3 605 struct sockaddr_rxrpc *,
7877a4a4 606 struct sk_buff *);
001c1122 607void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
7877a4a4 608
17926a79 609/*
0d81a51a 610 * input.c
17926a79 611 */
0d81a51a
DH
612void rxrpc_data_ready(struct sock *);
613int rxrpc_queue_rcv_skb(struct rxrpc_call *, struct sk_buff *, bool, bool);
614void rxrpc_fast_process_packet(struct rxrpc_call *, struct sk_buff *);
17926a79
DH
615
616/*
0d81a51a 617 * insecure.c
17926a79 618 */
0d81a51a 619extern const struct rxrpc_security rxrpc_no_security;
17926a79
DH
620
621/*
0d81a51a 622 * key.c
17926a79 623 */
0d81a51a
DH
624extern struct key_type key_type_rxrpc;
625extern struct key_type key_type_rxrpc_s;
626
627int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
628int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
629int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
630 u32);
17926a79 631
87563616
DH
632/*
633 * local_event.c
634 */
4f95dd78 635extern void rxrpc_process_local_events(struct rxrpc_local *);
87563616 636
17926a79 637/*
0d81a51a 638 * local_object.c
17926a79 639 */
4f95dd78
DH
640struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
641void __rxrpc_put_local(struct rxrpc_local *);
c1b1203d 642void __exit rxrpc_destroy_all_locals(void);
17926a79 643
4f95dd78
DH
644static inline void rxrpc_get_local(struct rxrpc_local *local)
645{
646 atomic_inc(&local->usage);
647}
648
649static inline
650struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
651{
652 return atomic_inc_not_zero(&local->usage) ? local : NULL;
653}
654
655static inline void rxrpc_put_local(struct rxrpc_local *local)
656{
5627cc8b 657 if (local && atomic_dec_and_test(&local->usage))
4f95dd78
DH
658 __rxrpc_put_local(local);
659}
660
5acbee46
DH
661static inline void rxrpc_queue_local(struct rxrpc_local *local)
662{
663 rxrpc_queue_work(&local->processor);
664}
665
17926a79 666/*
0d81a51a 667 * misc.c
17926a79 668 */
0d81a51a
DH
669extern unsigned int rxrpc_max_backlog __read_mostly;
670extern unsigned int rxrpc_requested_ack_delay;
671extern unsigned int rxrpc_soft_ack_delay;
672extern unsigned int rxrpc_idle_ack_delay;
673extern unsigned int rxrpc_rx_window_size;
674extern unsigned int rxrpc_rx_mtu;
675extern unsigned int rxrpc_rx_jumbo_max;
17926a79 676
0d81a51a
DH
677extern const char *const rxrpc_pkts[];
678extern const s8 rxrpc_ack_priority[];
679
680extern const char *rxrpc_acks(u8 reason);
17926a79
DH
681
682/*
0d81a51a 683 * output.c
17926a79 684 */
dad8aff7 685extern unsigned int rxrpc_resend_timeout;
17926a79 686
985a5c82 687int rxrpc_send_data_packet(struct rxrpc_connection *, struct sk_buff *);
2341e077 688int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
17926a79
DH
689
690/*
abe89ef0 691 * peer_event.c
0d81a51a 692 */
abe89ef0 693void rxrpc_error_report(struct sock *);
f66d7490 694void rxrpc_peer_error_distributor(struct work_struct *);
0d81a51a
DH
695
696/*
697 * peer_object.c
17926a79 698 */
be6e6707
DH
699struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
700 const struct sockaddr_rxrpc *);
701struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
702 struct sockaddr_rxrpc *, gfp_t);
703struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
704
705static inline void rxrpc_get_peer(struct rxrpc_peer *peer)
706{
707 atomic_inc(&peer->usage);
708}
709
710static inline
711struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
712{
713 return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
714}
715
716extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
717static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
718{
5627cc8b 719 if (peer && atomic_dec_and_test(&peer->usage))
be6e6707
DH
720 __rxrpc_put_peer(peer);
721}
17926a79
DH
722
723/*
0d81a51a 724 * proc.c
17926a79 725 */
036c2e27
JE
726extern const char *const rxrpc_call_states[];
727extern const struct file_operations rxrpc_call_seq_fops;
728extern const struct file_operations rxrpc_connection_seq_fops;
17926a79
DH
729
730/*
0d81a51a 731 * recvmsg.c
17926a79 732 */
c1b1203d 733void rxrpc_remove_user_ID(struct rxrpc_sock *, struct rxrpc_call *);
1b784140 734int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
17926a79
DH
735
736/*
0d81a51a
DH
737 * rxkad.c
738 */
739#ifdef CONFIG_RXKAD
740extern const struct rxrpc_security rxkad;
741#endif
742
743/*
744 * security.c
17926a79 745 */
648af7fc
DH
746int __init rxrpc_init_security(void);
747void rxrpc_exit_security(void);
c1b1203d
JP
748int rxrpc_init_client_conn_security(struct rxrpc_connection *);
749int rxrpc_init_server_conn_security(struct rxrpc_connection *);
17926a79
DH
750
751/*
0d81a51a 752 * skbuff.c
17926a79 753 */
c1b1203d 754void rxrpc_packet_destructor(struct sk_buff *);
17926a79 755
5873c083
DH
756/*
757 * sysctl.c
758 */
759#ifdef CONFIG_SYSCTL
760extern int __init rxrpc_sysctl_init(void);
761extern void rxrpc_sysctl_exit(void);
762#else
763static inline int __init rxrpc_sysctl_init(void) { return 0; }
764static inline void rxrpc_sysctl_exit(void) {}
765#endif
766
be6e6707
DH
767/*
768 * utils.c
769 */
d991b4a3 770int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
be6e6707 771
17926a79
DH
772/*
773 * debug tracing
774 */
95c96174 775extern unsigned int rxrpc_debug;
17926a79
DH
776
777#define dbgprintk(FMT,...) \
9f389f4b 778 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
17926a79 779
0dc47877
HH
780#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
781#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
17926a79
DH
782#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
783#define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
784#define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
785
786
787#if defined(__KDEBUG)
788#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
789#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
790#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
791#define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
792#define _net(FMT,...) knet(FMT,##__VA_ARGS__)
793
794#elif defined(CONFIG_AF_RXRPC_DEBUG)
795#define RXRPC_DEBUG_KENTER 0x01
796#define RXRPC_DEBUG_KLEAVE 0x02
797#define RXRPC_DEBUG_KDEBUG 0x04
798#define RXRPC_DEBUG_KPROTO 0x08
799#define RXRPC_DEBUG_KNET 0x10
800
801#define _enter(FMT,...) \
802do { \
803 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
804 kenter(FMT,##__VA_ARGS__); \
805} while (0)
806
807#define _leave(FMT,...) \
808do { \
809 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
810 kleave(FMT,##__VA_ARGS__); \
811} while (0)
812
813#define _debug(FMT,...) \
814do { \
815 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
816 kdebug(FMT,##__VA_ARGS__); \
817} while (0)
818
819#define _proto(FMT,...) \
820do { \
821 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
822 kproto(FMT,##__VA_ARGS__); \
823} while (0)
824
825#define _net(FMT,...) \
826do { \
827 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
828 knet(FMT,##__VA_ARGS__); \
829} while (0)
830
831#else
12fdff3f
DH
832#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
833#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
834#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
835#define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
836#define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
17926a79
DH
837#endif
838
839/*
840 * debug assertion checking
841 */
842#if 1 // defined(__KDEBUGALL)
843
844#define ASSERT(X) \
845do { \
846 if (unlikely(!(X))) { \
9b6d5398 847 pr_err("Assertion failed\n"); \
17926a79
DH
848 BUG(); \
849 } \
b4f1342f 850} while (0)
17926a79
DH
851
852#define ASSERTCMP(X, OP, Y) \
853do { \
9b6d5398
JP
854 unsigned long _x = (unsigned long)(X); \
855 unsigned long _y = (unsigned long)(Y); \
856 if (unlikely(!(_x OP _y))) { \
857 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
858 _x, _x, #OP, _y, _y); \
17926a79
DH
859 BUG(); \
860 } \
b4f1342f 861} while (0)
17926a79
DH
862
863#define ASSERTIF(C, X) \
864do { \
865 if (unlikely((C) && !(X))) { \
9b6d5398 866 pr_err("Assertion failed\n"); \
17926a79
DH
867 BUG(); \
868 } \
b4f1342f 869} while (0)
17926a79
DH
870
871#define ASSERTIFCMP(C, X, OP, Y) \
872do { \
9b6d5398
JP
873 unsigned long _x = (unsigned long)(X); \
874 unsigned long _y = (unsigned long)(Y); \
875 if (unlikely((C) && !(_x OP _y))) { \
876 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
877 _x, _x, #OP, _y, _y); \
17926a79
DH
878 BUG(); \
879 } \
b4f1342f 880} while (0)
17926a79
DH
881
882#else
883
884#define ASSERT(X) \
885do { \
b4f1342f 886} while (0)
17926a79
DH
887
888#define ASSERTCMP(X, OP, Y) \
889do { \
b4f1342f 890} while (0)
17926a79
DH
891
892#define ASSERTIF(C, X) \
893do { \
b4f1342f 894} while (0)
17926a79
DH
895
896#define ASSERTIFCMP(C, X, OP, Y) \
897do { \
b4f1342f 898} while (0)
17926a79
DH
899
900#endif /* __KDEBUGALL */
901
902/*
903 * socket buffer accounting / leak finding
904 */
905static inline void __rxrpc_new_skb(struct sk_buff *skb, const char *fn)
906{
907 //_net("new skb %p %s [%d]", skb, fn, atomic_read(&rxrpc_n_skbs));
908 //atomic_inc(&rxrpc_n_skbs);
909}
910
911#define rxrpc_new_skb(skb) __rxrpc_new_skb((skb), __func__)
912
913static inline void __rxrpc_kill_skb(struct sk_buff *skb, const char *fn)
914{
915 //_net("kill skb %p %s [%d]", skb, fn, atomic_read(&rxrpc_n_skbs));
916 //atomic_dec(&rxrpc_n_skbs);
917}
918
919#define rxrpc_kill_skb(skb) __rxrpc_kill_skb((skb), __func__)
920
921static inline void __rxrpc_free_skb(struct sk_buff *skb, const char *fn)
922{
923 if (skb) {
924 CHECK_SLAB_OKAY(&skb->users);
925 //_net("free skb %p %s [%d]",
926 // skb, fn, atomic_read(&rxrpc_n_skbs));
927 //atomic_dec(&rxrpc_n_skbs);
928 kfree_skb(skb);
929 }
930}
931
932#define rxrpc_free_skb(skb) __rxrpc_free_skb((skb), __func__)
933
934static inline void rxrpc_purge_queue(struct sk_buff_head *list)
935{
936 struct sk_buff *skb;
937 while ((skb = skb_dequeue((list))) != NULL)
938 rxrpc_free_skb(skb);
939}
940
17926a79
DH
941#define rxrpc_get_call(CALL) \
942do { \
943 CHECK_SLAB_OKAY(&(CALL)->usage); \
944 if (atomic_inc_return(&(CALL)->usage) == 1) \
945 BUG(); \
b4f1342f 946} while (0)
17926a79
DH
947
948#define rxrpc_put_call(CALL) \
949do { \
950 __rxrpc_put_call(CALL); \
b4f1342f 951} while (0)