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