]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - net/rxrpc/ar-internal.h
rxrpc: Preallocate peers, conns and calls for incoming service requests
[mirror_ubuntu-bionic-kernel.git] / net / rxrpc / ar-internal.h
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
12 #include <linux/atomic.h>
13 #include <linux/seqlock.h>
14 #include <net/sock.h>
15 #include <net/af_rxrpc.h>
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
23 #define CHECK_SLAB_OKAY(X) do {} while (0)
24 #endif
25
26 #define FCRYPT_BSIZE 8
27 struct rxrpc_crypt {
28 union {
29 u8 x[FCRYPT_BSIZE];
30 __be32 n[2];
31 };
32 } __attribute__((aligned(8)));
33
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 struct rxrpc_connection;
39
40 /*
41 * Mark applied to socket buffers.
42 */
43 enum rxrpc_skb_mark {
44 RXRPC_SKB_MARK_DATA, /* data message */
45 RXRPC_SKB_MARK_FINAL_ACK, /* final ACK received message */
46 RXRPC_SKB_MARK_BUSY, /* server busy message */
47 RXRPC_SKB_MARK_REMOTE_ABORT, /* remote abort message */
48 RXRPC_SKB_MARK_LOCAL_ABORT, /* local abort message */
49 RXRPC_SKB_MARK_NET_ERROR, /* network error message */
50 RXRPC_SKB_MARK_LOCAL_ERROR, /* local error message */
51 RXRPC_SKB_MARK_NEW_CALL, /* local error message */
52 };
53
54 /*
55 * sk_state for RxRPC sockets
56 */
57 enum {
58 RXRPC_UNBOUND = 0,
59 RXRPC_CLIENT_UNBOUND, /* Unbound socket used as client */
60 RXRPC_CLIENT_BOUND, /* client local address bound */
61 RXRPC_SERVER_BOUND, /* server local address bound */
62 RXRPC_SERVER_LISTENING, /* server listening for connections */
63 RXRPC_CLOSE, /* socket is being closed */
64 };
65
66 /*
67 * Service backlog preallocation.
68 *
69 * This contains circular buffers of preallocated peers, connections and calls
70 * for incoming service calls and their head and tail pointers. This allows
71 * calls to be set up in the data_ready handler, thereby avoiding the need to
72 * shuffle packets around so much.
73 */
74 struct rxrpc_backlog {
75 unsigned short peer_backlog_head;
76 unsigned short peer_backlog_tail;
77 unsigned short conn_backlog_head;
78 unsigned short conn_backlog_tail;
79 unsigned short call_backlog_head;
80 unsigned short call_backlog_tail;
81 #define RXRPC_BACKLOG_MAX 32
82 struct rxrpc_peer *peer_backlog[RXRPC_BACKLOG_MAX];
83 struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
84 struct rxrpc_call *call_backlog[RXRPC_BACKLOG_MAX];
85 };
86
87 /*
88 * RxRPC socket definition
89 */
90 struct rxrpc_sock {
91 /* WARNING: sk has to be the first member */
92 struct sock sk;
93 rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
94 rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
95 struct rxrpc_local *local; /* local endpoint */
96 struct hlist_node listen_link; /* link in the local endpoint's listen list */
97 struct list_head secureq; /* calls awaiting connection security clearance */
98 struct list_head acceptq; /* calls awaiting acceptance */
99 struct rxrpc_backlog *backlog; /* Preallocation for services */
100 struct key *key; /* security for this socket */
101 struct key *securities; /* list of server security descriptors */
102 struct rb_root calls; /* User ID -> call mapping */
103 unsigned long flags;
104 #define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
105 rwlock_t call_lock; /* lock for calls */
106 u32 min_sec_level; /* minimum security level */
107 #define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
108 bool exclusive; /* Exclusive connection for a client socket */
109 sa_family_t family; /* Protocol family created with */
110 struct sockaddr_rxrpc srx; /* local address */
111 struct sockaddr_rxrpc connect_srx; /* Default client address from connect() */
112 };
113
114 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
115
116 /*
117 * CPU-byteorder normalised Rx packet header.
118 */
119 struct rxrpc_host_header {
120 u32 epoch; /* client boot timestamp */
121 u32 cid; /* connection and channel ID */
122 u32 callNumber; /* call ID (0 for connection-level packets) */
123 u32 seq; /* sequence number of pkt in call stream */
124 u32 serial; /* serial number of pkt sent to network */
125 u8 type; /* packet type */
126 u8 flags; /* packet flags */
127 u8 userStatus; /* app-layer defined status */
128 u8 securityIndex; /* security protocol ID */
129 union {
130 u16 _rsvd; /* reserved */
131 u16 cksum; /* kerberos security checksum */
132 };
133 u16 serviceId; /* service ID */
134 } __packed;
135
136 /*
137 * RxRPC socket buffer private variables
138 * - max 48 bytes (struct sk_buff::cb)
139 */
140 struct rxrpc_skb_priv {
141 struct rxrpc_call *call; /* call with which associated */
142 unsigned long resend_at; /* time in jiffies at which to resend */
143 union {
144 unsigned int offset; /* offset into buffer of next read */
145 int remain; /* amount of space remaining for next write */
146 u32 error; /* network error code */
147 bool need_resend; /* T if needs resending */
148 };
149
150 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
151 };
152
153 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
154
155 /*
156 * RxRPC security module interface
157 */
158 struct rxrpc_security {
159 const char *name; /* name of this service */
160 u8 security_index; /* security type provided */
161
162 /* Initialise a security service */
163 int (*init)(void);
164
165 /* Clean up a security service */
166 void (*exit)(void);
167
168 /* initialise a connection's security */
169 int (*init_connection_security)(struct rxrpc_connection *);
170
171 /* prime a connection's packet security */
172 int (*prime_packet_security)(struct rxrpc_connection *);
173
174 /* impose security on a packet */
175 int (*secure_packet)(struct rxrpc_call *,
176 struct sk_buff *,
177 size_t,
178 void *);
179
180 /* verify the security on a received packet */
181 int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
182 rxrpc_seq_t, u16);
183
184 /* issue a challenge */
185 int (*issue_challenge)(struct rxrpc_connection *);
186
187 /* respond to a challenge */
188 int (*respond_to_challenge)(struct rxrpc_connection *,
189 struct sk_buff *,
190 u32 *);
191
192 /* verify a response */
193 int (*verify_response)(struct rxrpc_connection *,
194 struct sk_buff *,
195 u32 *);
196
197 /* clear connection security */
198 void (*clear)(struct rxrpc_connection *);
199 };
200
201 /*
202 * RxRPC local transport endpoint description
203 * - owned by a single AF_RXRPC socket
204 * - pointed to by transport socket struct sk_user_data
205 */
206 struct rxrpc_local {
207 struct rcu_head rcu;
208 atomic_t usage;
209 struct list_head link;
210 struct socket *socket; /* my UDP socket */
211 struct work_struct processor;
212 struct hlist_head services; /* services listening on this endpoint */
213 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
214 struct sk_buff_head accept_queue; /* incoming calls awaiting acceptance */
215 struct sk_buff_head reject_queue; /* packets awaiting rejection */
216 struct sk_buff_head event_queue; /* endpoint event packets awaiting processing */
217 struct rb_root client_conns; /* Client connections by socket params */
218 spinlock_t client_conns_lock; /* Lock for client_conns */
219 spinlock_t lock; /* access lock */
220 rwlock_t services_lock; /* lock for services list */
221 int debug_id; /* debug ID for printks */
222 bool dead;
223 struct sockaddr_rxrpc srx; /* local address */
224 };
225
226 /*
227 * RxRPC remote transport endpoint definition
228 * - matched by local endpoint, remote port, address and protocol type
229 */
230 struct rxrpc_peer {
231 struct rcu_head rcu; /* This must be first */
232 atomic_t usage;
233 unsigned long hash_key;
234 struct hlist_node hash_link;
235 struct rxrpc_local *local;
236 struct hlist_head error_targets; /* targets for net error distribution */
237 struct work_struct error_distributor;
238 struct rb_root service_conns; /* Service connections */
239 seqlock_t service_conn_lock;
240 spinlock_t lock; /* access lock */
241 unsigned int if_mtu; /* interface MTU for this peer */
242 unsigned int mtu; /* network MTU for this peer */
243 unsigned int maxdata; /* data size (MTU - hdrsize) */
244 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
245 int debug_id; /* debug ID for printks */
246 int error_report; /* Net (+0) or local (+1000000) to distribute */
247 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
248 struct sockaddr_rxrpc srx; /* remote address */
249
250 /* calculated RTT cache */
251 #define RXRPC_RTT_CACHE_SIZE 32
252 suseconds_t rtt; /* current RTT estimate (in uS) */
253 unsigned int rtt_point; /* next entry at which to insert */
254 unsigned int rtt_usage; /* amount of cache actually used */
255 suseconds_t rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* calculated RTT cache */
256 };
257
258 /*
259 * Keys for matching a connection.
260 */
261 struct rxrpc_conn_proto {
262 union {
263 struct {
264 u32 epoch; /* epoch of this connection */
265 u32 cid; /* connection ID */
266 };
267 u64 index_key;
268 };
269 };
270
271 struct rxrpc_conn_parameters {
272 struct rxrpc_local *local; /* Representation of local endpoint */
273 struct rxrpc_peer *peer; /* Remote endpoint */
274 struct key *key; /* Security details */
275 bool exclusive; /* T if conn is exclusive */
276 u16 service_id; /* Service ID for this connection */
277 u32 security_level; /* Security level selected */
278 };
279
280 /*
281 * Bits in the connection flags.
282 */
283 enum rxrpc_conn_flag {
284 RXRPC_CONN_HAS_IDR, /* Has a client conn ID assigned */
285 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
286 RXRPC_CONN_IN_CLIENT_CONNS, /* Conn is in local->client_conns */
287 RXRPC_CONN_EXPOSED, /* Conn has extra ref for exposure */
288 RXRPC_CONN_DONT_REUSE, /* Don't reuse this connection */
289 RXRPC_CONN_COUNTED, /* Counted by rxrpc_nr_client_conns */
290 };
291
292 /*
293 * Events that can be raised upon a connection.
294 */
295 enum rxrpc_conn_event {
296 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
297 };
298
299 /*
300 * The connection cache state.
301 */
302 enum rxrpc_conn_cache_state {
303 RXRPC_CONN_CLIENT_INACTIVE, /* Conn is not yet listed */
304 RXRPC_CONN_CLIENT_WAITING, /* Conn is on wait list, waiting for capacity */
305 RXRPC_CONN_CLIENT_ACTIVE, /* Conn is on active list, doing calls */
306 RXRPC_CONN_CLIENT_CULLED, /* Conn is culled and delisted, doing calls */
307 RXRPC_CONN_CLIENT_IDLE, /* Conn is on idle list, doing mostly nothing */
308 };
309
310 /*
311 * The connection protocol state.
312 */
313 enum rxrpc_conn_proto_state {
314 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
315 RXRPC_CONN_CLIENT, /* Client connection */
316 RXRPC_CONN_SERVICE_PREALLOC, /* Service connection preallocation */
317 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
318 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
319 RXRPC_CONN_SERVICE, /* Service secured connection */
320 RXRPC_CONN_REMOTELY_ABORTED, /* Conn aborted by peer */
321 RXRPC_CONN_LOCALLY_ABORTED, /* Conn aborted locally */
322 RXRPC_CONN__NR_STATES
323 };
324
325 /*
326 * RxRPC connection definition
327 * - matched by { local, peer, epoch, conn_id, direction }
328 * - each connection can only handle four simultaneous calls
329 */
330 struct rxrpc_connection {
331 struct rxrpc_conn_proto proto;
332 struct rxrpc_conn_parameters params;
333
334 atomic_t usage;
335 struct rcu_head rcu;
336 struct list_head cache_link;
337
338 spinlock_t channel_lock;
339 unsigned char active_chans; /* Mask of active channels */
340 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
341 struct list_head waiting_calls; /* Calls waiting for channels */
342 struct rxrpc_channel {
343 struct rxrpc_call __rcu *call; /* Active call */
344 u32 call_id; /* ID of current call */
345 u32 call_counter; /* Call ID counter */
346 u32 last_call; /* ID of last call */
347 u8 last_type; /* Type of last packet */
348 u16 last_service_id;
349 union {
350 u32 last_seq;
351 u32 last_abort;
352 };
353 } channels[RXRPC_MAXCALLS];
354
355 struct work_struct processor; /* connection event processor */
356 union {
357 struct rb_node client_node; /* Node in local->client_conns */
358 struct rb_node service_node; /* Node in peer->service_conns */
359 };
360 struct list_head proc_link; /* link in procfs list */
361 struct list_head link; /* link in master connection list */
362 struct sk_buff_head rx_queue; /* received conn-level packets */
363 const struct rxrpc_security *security; /* applied security module */
364 struct key *server_key; /* security for this service */
365 struct crypto_skcipher *cipher; /* encryption handle */
366 struct rxrpc_crypt csum_iv; /* packet checksum base */
367 unsigned long flags;
368 unsigned long events;
369 unsigned long idle_timestamp; /* Time at which last became idle */
370 spinlock_t state_lock; /* state-change lock */
371 enum rxrpc_conn_cache_state cache_state;
372 enum rxrpc_conn_proto_state state; /* current state of connection */
373 u32 local_abort; /* local abort code */
374 u32 remote_abort; /* remote abort code */
375 int debug_id; /* debug ID for printks */
376 atomic_t serial; /* packet serial number counter */
377 unsigned int hi_serial; /* highest serial number received */
378 u8 size_align; /* data size alignment (for security) */
379 u8 header_size; /* rxrpc + security header size */
380 u8 security_size; /* security header size */
381 u32 security_nonce; /* response re-use preventer */
382 u8 security_ix; /* security type */
383 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
384 };
385
386 /*
387 * Flags in call->flags.
388 */
389 enum rxrpc_call_flag {
390 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
391 RXRPC_CALL_TERMINAL_MSG, /* call has given the socket its final message */
392 RXRPC_CALL_RCVD_LAST, /* all packets received */
393 RXRPC_CALL_RUN_RTIMER, /* Tx resend timer started */
394 RXRPC_CALL_TX_SOFT_ACK, /* sent some soft ACKs */
395 RXRPC_CALL_INIT_ACCEPT, /* acceptance was initiated */
396 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
397 RXRPC_CALL_EXPECT_OOS, /* expect out of sequence packets */
398 RXRPC_CALL_IS_SERVICE, /* Call is service call */
399 RXRPC_CALL_EXPOSED, /* The call was exposed to the world */
400 RXRPC_CALL_RX_NO_MORE, /* Don't indicate MSG_MORE from recvmsg() */
401 };
402
403 /*
404 * Events that can be raised on a call.
405 */
406 enum rxrpc_call_event {
407 RXRPC_CALL_EV_RCVD_ACKALL, /* ACKALL or reply received */
408 RXRPC_CALL_EV_RCVD_BUSY, /* busy packet received */
409 RXRPC_CALL_EV_RCVD_ABORT, /* abort packet received */
410 RXRPC_CALL_EV_RCVD_ERROR, /* network error received */
411 RXRPC_CALL_EV_ACK_FINAL, /* need to generate final ACK (and release call) */
412 RXRPC_CALL_EV_ACK, /* need to generate ACK */
413 RXRPC_CALL_EV_REJECT_BUSY, /* need to generate busy message */
414 RXRPC_CALL_EV_ABORT, /* need to generate abort */
415 RXRPC_CALL_EV_CONN_ABORT, /* local connection abort generated */
416 RXRPC_CALL_EV_RESEND_TIMER, /* Tx resend timer expired */
417 RXRPC_CALL_EV_RESEND, /* Tx resend required */
418 RXRPC_CALL_EV_DRAIN_RX_OOS, /* drain the Rx out of sequence queue */
419 RXRPC_CALL_EV_LIFE_TIMER, /* call's lifetimer ran out */
420 RXRPC_CALL_EV_ACCEPTED, /* incoming call accepted by userspace app */
421 RXRPC_CALL_EV_SECURED, /* incoming call's connection is now secure */
422 RXRPC_CALL_EV_POST_ACCEPT, /* need to post an "accept?" message to the app */
423 };
424
425 /*
426 * The states that a call can be in.
427 */
428 enum rxrpc_call_state {
429 RXRPC_CALL_UNINITIALISED,
430 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
431 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
432 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
433 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
434 RXRPC_CALL_CLIENT_FINAL_ACK, /* - client sending final ACK phase */
435 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
436 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
437 RXRPC_CALL_SERVER_ACCEPTING, /* - server accepting request */
438 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
439 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
440 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
441 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
442 RXRPC_CALL_COMPLETE, /* - call complete */
443 NR__RXRPC_CALL_STATES
444 };
445
446 /*
447 * Call completion condition (state == RXRPC_CALL_COMPLETE).
448 */
449 enum rxrpc_call_completion {
450 RXRPC_CALL_SUCCEEDED, /* - Normal termination */
451 RXRPC_CALL_SERVER_BUSY, /* - call rejected by busy server */
452 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
453 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
454 RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
455 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
456 NR__RXRPC_CALL_COMPLETIONS
457 };
458
459 /*
460 * RxRPC call definition
461 * - matched by { connection, call_id }
462 */
463 struct rxrpc_call {
464 struct rcu_head rcu;
465 struct rxrpc_connection *conn; /* connection carrying call */
466 struct rxrpc_peer *peer; /* Peer record for remote address */
467 struct rxrpc_sock __rcu *socket; /* socket responsible */
468 struct timer_list lifetimer; /* lifetime remaining on call */
469 struct timer_list ack_timer; /* ACK generation timer */
470 struct timer_list resend_timer; /* Tx resend timer */
471 struct work_struct processor; /* packet processor and ACK generator */
472 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
473 struct list_head link; /* link in master call list */
474 struct list_head chan_wait_link; /* Link in conn->waiting_calls */
475 struct hlist_node error_link; /* link in error distribution list */
476 struct list_head accept_link; /* calls awaiting acceptance */
477 struct rb_node sock_node; /* node in socket call tree */
478 struct sk_buff_head rx_queue; /* received packets */
479 struct sk_buff_head rx_oos_queue; /* packets received out of sequence */
480 struct sk_buff_head knlrecv_queue; /* Queue for kernel_recv [TODO: replace this] */
481 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
482 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
483 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
484 unsigned long user_call_ID; /* user-defined call ID */
485 unsigned long creation_jif; /* time of call creation */
486 unsigned long flags;
487 unsigned long events;
488 spinlock_t lock;
489 rwlock_t state_lock; /* lock for state transition */
490 u32 abort_code; /* Local/remote abort code */
491 int error; /* Local error incurred */
492 enum rxrpc_call_state state; /* current state of call */
493 enum rxrpc_call_completion completion; /* Call completion condition */
494 atomic_t usage;
495 atomic_t sequence; /* Tx data packet sequence counter */
496 u16 service_id; /* service ID */
497 u8 security_ix; /* Security type */
498 u32 call_id; /* call ID on connection */
499 u32 cid; /* connection ID plus channel index */
500 int debug_id; /* debug ID for printks */
501
502 /* transmission-phase ACK management */
503 u8 acks_head; /* offset into window of first entry */
504 u8 acks_tail; /* offset into window of last entry */
505 u8 acks_winsz; /* size of un-ACK'd window */
506 u8 acks_unacked; /* lowest unacked packet in last ACK received */
507 int acks_latest; /* serial number of latest ACK received */
508 rxrpc_seq_t acks_hard; /* highest definitively ACK'd msg seq */
509 unsigned long *acks_window; /* sent packet window
510 * - elements are pointers with LSB set if ACK'd
511 */
512
513 /* receive-phase ACK management */
514 rxrpc_seq_t rx_data_expect; /* next data seq ID expected to be received */
515 rxrpc_seq_t rx_data_post; /* next data seq ID expected to be posted */
516 rxrpc_seq_t rx_data_recv; /* last data seq ID encountered by recvmsg */
517 rxrpc_seq_t rx_data_eaten; /* last data seq ID consumed by recvmsg */
518 rxrpc_seq_t rx_first_oos; /* first packet in rx_oos_queue (or 0) */
519 rxrpc_seq_t ackr_win_top; /* top of ACK window (rx_data_eaten is bottom) */
520 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
521 u8 ackr_reason; /* reason to ACK */
522 u16 ackr_skew; /* skew on packet being ACK'd */
523 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
524 atomic_t ackr_not_idle; /* number of packets in Rx queue */
525
526 /* received packet records, 1 bit per record */
527 #define RXRPC_ACKR_WINDOW_ASZ DIV_ROUND_UP(RXRPC_MAXACKS, BITS_PER_LONG)
528 unsigned long ackr_window[RXRPC_ACKR_WINDOW_ASZ + 1];
529 };
530
531 enum rxrpc_call_trace {
532 rxrpc_call_new_client,
533 rxrpc_call_new_service,
534 rxrpc_call_queued,
535 rxrpc_call_queued_ref,
536 rxrpc_call_seen,
537 rxrpc_call_got,
538 rxrpc_call_got_skb,
539 rxrpc_call_got_userid,
540 rxrpc_call_put,
541 rxrpc_call_put_skb,
542 rxrpc_call_put_userid,
543 rxrpc_call_put_noqueue,
544 rxrpc_call__nr_trace
545 };
546
547 extern const char rxrpc_call_traces[rxrpc_call__nr_trace][4];
548
549 #include <trace/events/rxrpc.h>
550
551 /*
552 * af_rxrpc.c
553 */
554 extern atomic_t rxrpc_n_skbs;
555 extern u32 rxrpc_epoch;
556 extern atomic_t rxrpc_debug_id;
557 extern struct workqueue_struct *rxrpc_workqueue;
558
559 /*
560 * call_accept.c
561 */
562 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
563 void rxrpc_discard_prealloc(struct rxrpc_sock *);
564 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
565 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
566 rxrpc_notify_rx_t);
567 int rxrpc_reject_call(struct rxrpc_sock *);
568
569 /*
570 * call_event.c
571 */
572 void __rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool);
573 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool);
574 void rxrpc_process_call(struct work_struct *);
575
576 /*
577 * call_object.c
578 */
579 extern const char *const rxrpc_call_states[];
580 extern const char *const rxrpc_call_completions[];
581 extern unsigned int rxrpc_max_call_lifetime;
582 extern struct kmem_cache *rxrpc_call_jar;
583 extern struct list_head rxrpc_calls;
584 extern rwlock_t rxrpc_call_lock;
585
586 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
587 struct rxrpc_call *rxrpc_alloc_call(gfp_t);
588 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
589 struct rxrpc_conn_parameters *,
590 struct sockaddr_rxrpc *,
591 unsigned long, gfp_t);
592 struct rxrpc_call *rxrpc_incoming_call(struct rxrpc_sock *,
593 struct rxrpc_connection *,
594 struct sk_buff *);
595 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
596 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
597 bool __rxrpc_queue_call(struct rxrpc_call *);
598 bool rxrpc_queue_call(struct rxrpc_call *);
599 void rxrpc_see_call(struct rxrpc_call *);
600 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
601 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
602 void rxrpc_get_call_for_skb(struct rxrpc_call *, struct sk_buff *);
603 void rxrpc_put_call_for_skb(struct rxrpc_call *, struct sk_buff *);
604 void rxrpc_cleanup_call(struct rxrpc_call *);
605 void __exit rxrpc_destroy_all_calls(void);
606
607 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
608 {
609 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
610 }
611
612 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
613 {
614 return !rxrpc_is_service_call(call);
615 }
616
617 /*
618 * Transition a call to the complete state.
619 */
620 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
621 enum rxrpc_call_completion compl,
622 u32 abort_code,
623 int error)
624 {
625 if (call->state < RXRPC_CALL_COMPLETE) {
626 call->abort_code = abort_code;
627 call->error = error;
628 call->completion = compl,
629 call->state = RXRPC_CALL_COMPLETE;
630 return true;
631 }
632 return false;
633 }
634
635 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
636 enum rxrpc_call_completion compl,
637 u32 abort_code,
638 int error)
639 {
640 bool ret;
641
642 write_lock_bh(&call->state_lock);
643 ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
644 write_unlock_bh(&call->state_lock);
645 return ret;
646 }
647
648 /*
649 * Record that a call successfully completed.
650 */
651 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
652 {
653 return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
654 }
655
656 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
657 {
658 bool ret;
659
660 write_lock_bh(&call->state_lock);
661 ret = __rxrpc_call_completed(call);
662 write_unlock_bh(&call->state_lock);
663 return ret;
664 }
665
666 /*
667 * Record that a call is locally aborted.
668 */
669 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
670 rxrpc_seq_t seq,
671 u32 abort_code, int error)
672 {
673 trace_rxrpc_abort(why, call->cid, call->call_id, seq,
674 abort_code, error);
675 if (__rxrpc_set_call_completion(call,
676 RXRPC_CALL_LOCALLY_ABORTED,
677 abort_code, error)) {
678 set_bit(RXRPC_CALL_EV_ABORT, &call->events);
679 return true;
680 }
681 return false;
682 }
683
684 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
685 rxrpc_seq_t seq, u32 abort_code, int error)
686 {
687 bool ret;
688
689 write_lock_bh(&call->state_lock);
690 ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
691 write_unlock_bh(&call->state_lock);
692 return ret;
693 }
694
695 /*
696 * conn_client.c
697 */
698 extern unsigned int rxrpc_max_client_connections;
699 extern unsigned int rxrpc_reap_client_connections;
700 extern unsigned int rxrpc_conn_idle_client_expiry;
701 extern unsigned int rxrpc_conn_idle_client_fast_expiry;
702 extern struct idr rxrpc_client_conn_ids;
703
704 void rxrpc_destroy_client_conn_ids(void);
705 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
706 struct sockaddr_rxrpc *, gfp_t);
707 void rxrpc_expose_client_call(struct rxrpc_call *);
708 void rxrpc_disconnect_client_call(struct rxrpc_call *);
709 void rxrpc_put_client_conn(struct rxrpc_connection *);
710 void __exit rxrpc_destroy_all_client_connections(void);
711
712 /*
713 * conn_event.c
714 */
715 void rxrpc_process_connection(struct work_struct *);
716 void rxrpc_reject_packet(struct rxrpc_local *, struct sk_buff *);
717 void rxrpc_reject_packets(struct rxrpc_local *);
718
719 /*
720 * conn_object.c
721 */
722 extern unsigned int rxrpc_connection_expiry;
723 extern struct list_head rxrpc_connections;
724 extern struct list_head rxrpc_connection_proc_list;
725 extern rwlock_t rxrpc_connection_lock;
726
727 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
728 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
729 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
730 struct sk_buff *);
731 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
732 void rxrpc_disconnect_call(struct rxrpc_call *);
733 void rxrpc_kill_connection(struct rxrpc_connection *);
734 void __rxrpc_put_connection(struct rxrpc_connection *);
735 void __exit rxrpc_destroy_all_connections(void);
736
737 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
738 {
739 return conn->out_clientflag;
740 }
741
742 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
743 {
744 return !rxrpc_conn_is_client(conn);
745 }
746
747 static inline void rxrpc_get_connection(struct rxrpc_connection *conn)
748 {
749 atomic_inc(&conn->usage);
750 }
751
752 static inline
753 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *conn)
754 {
755 return atomic_inc_not_zero(&conn->usage) ? conn : NULL;
756 }
757
758 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
759 {
760 if (!conn)
761 return;
762
763 if (rxrpc_conn_is_client(conn)) {
764 if (atomic_dec_and_test(&conn->usage))
765 rxrpc_put_client_conn(conn);
766 } else {
767 if (atomic_dec_return(&conn->usage) == 1)
768 __rxrpc_put_connection(conn);
769 }
770 }
771
772 static inline bool rxrpc_queue_conn(struct rxrpc_connection *conn)
773 {
774 if (!rxrpc_get_connection_maybe(conn))
775 return false;
776 if (!rxrpc_queue_work(&conn->processor))
777 rxrpc_put_connection(conn);
778 return true;
779 }
780
781 /*
782 * conn_service.c
783 */
784 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
785 struct sk_buff *);
786 struct rxrpc_connection *rxrpc_incoming_connection(struct rxrpc_local *,
787 struct sockaddr_rxrpc *,
788 struct sk_buff *);
789 struct rxrpc_connection *rxrpc_prealloc_service_connection(gfp_t);
790 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
791
792 /*
793 * input.c
794 */
795 void rxrpc_data_ready(struct sock *);
796 int rxrpc_queue_rcv_skb(struct rxrpc_call *, struct sk_buff *, bool, bool);
797 void rxrpc_fast_process_packet(struct rxrpc_call *, struct sk_buff *);
798
799 /*
800 * insecure.c
801 */
802 extern const struct rxrpc_security rxrpc_no_security;
803
804 /*
805 * key.c
806 */
807 extern struct key_type key_type_rxrpc;
808 extern struct key_type key_type_rxrpc_s;
809
810 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
811 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
812 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
813 u32);
814
815 /*
816 * local_event.c
817 */
818 extern void rxrpc_process_local_events(struct rxrpc_local *);
819
820 /*
821 * local_object.c
822 */
823 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
824 void __rxrpc_put_local(struct rxrpc_local *);
825 void __exit rxrpc_destroy_all_locals(void);
826
827 static inline void rxrpc_get_local(struct rxrpc_local *local)
828 {
829 atomic_inc(&local->usage);
830 }
831
832 static inline
833 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
834 {
835 return atomic_inc_not_zero(&local->usage) ? local : NULL;
836 }
837
838 static inline void rxrpc_put_local(struct rxrpc_local *local)
839 {
840 if (local && atomic_dec_and_test(&local->usage))
841 __rxrpc_put_local(local);
842 }
843
844 static inline void rxrpc_queue_local(struct rxrpc_local *local)
845 {
846 rxrpc_queue_work(&local->processor);
847 }
848
849 /*
850 * misc.c
851 */
852 extern unsigned int rxrpc_max_backlog __read_mostly;
853 extern unsigned int rxrpc_requested_ack_delay;
854 extern unsigned int rxrpc_soft_ack_delay;
855 extern unsigned int rxrpc_idle_ack_delay;
856 extern unsigned int rxrpc_rx_window_size;
857 extern unsigned int rxrpc_rx_mtu;
858 extern unsigned int rxrpc_rx_jumbo_max;
859 extern unsigned int rxrpc_resend_timeout;
860
861 extern const char *const rxrpc_pkts[];
862 extern const s8 rxrpc_ack_priority[];
863
864 extern const char *rxrpc_acks(u8 reason);
865
866 /*
867 * output.c
868 */
869 int rxrpc_send_call_packet(struct rxrpc_call *, u8);
870 int rxrpc_send_data_packet(struct rxrpc_connection *, struct sk_buff *);
871
872 /*
873 * peer_event.c
874 */
875 void rxrpc_error_report(struct sock *);
876 void rxrpc_peer_error_distributor(struct work_struct *);
877
878 /*
879 * peer_object.c
880 */
881 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
882 const struct sockaddr_rxrpc *);
883 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
884 struct sockaddr_rxrpc *, gfp_t);
885 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
886
887 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
888 {
889 atomic_inc(&peer->usage);
890 return peer;
891 }
892
893 static inline
894 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
895 {
896 return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
897 }
898
899 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
900 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
901 {
902 if (peer && atomic_dec_and_test(&peer->usage))
903 __rxrpc_put_peer(peer);
904 }
905
906 /*
907 * proc.c
908 */
909 extern const struct file_operations rxrpc_call_seq_fops;
910 extern const struct file_operations rxrpc_connection_seq_fops;
911
912 /*
913 * recvmsg.c
914 */
915 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
916
917 /*
918 * rxkad.c
919 */
920 #ifdef CONFIG_RXKAD
921 extern const struct rxrpc_security rxkad;
922 #endif
923
924 /*
925 * security.c
926 */
927 int __init rxrpc_init_security(void);
928 void rxrpc_exit_security(void);
929 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
930 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
931
932 /*
933 * sendmsg.c
934 */
935 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
936
937 /*
938 * skbuff.c
939 */
940 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
941 void rxrpc_packet_destructor(struct sk_buff *);
942 void rxrpc_new_skb(struct sk_buff *);
943 void rxrpc_see_skb(struct sk_buff *);
944 void rxrpc_get_skb(struct sk_buff *);
945 void rxrpc_free_skb(struct sk_buff *);
946 void rxrpc_purge_queue(struct sk_buff_head *);
947
948 /*
949 * sysctl.c
950 */
951 #ifdef CONFIG_SYSCTL
952 extern int __init rxrpc_sysctl_init(void);
953 extern void rxrpc_sysctl_exit(void);
954 #else
955 static inline int __init rxrpc_sysctl_init(void) { return 0; }
956 static inline void rxrpc_sysctl_exit(void) {}
957 #endif
958
959 /*
960 * utils.c
961 */
962 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
963
964 /*
965 * debug tracing
966 */
967 extern unsigned int rxrpc_debug;
968
969 #define dbgprintk(FMT,...) \
970 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
971
972 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
973 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
974 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
975 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
976 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
977
978
979 #if defined(__KDEBUG)
980 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
981 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
982 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
983 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
984 #define _net(FMT,...) knet(FMT,##__VA_ARGS__)
985
986 #elif defined(CONFIG_AF_RXRPC_DEBUG)
987 #define RXRPC_DEBUG_KENTER 0x01
988 #define RXRPC_DEBUG_KLEAVE 0x02
989 #define RXRPC_DEBUG_KDEBUG 0x04
990 #define RXRPC_DEBUG_KPROTO 0x08
991 #define RXRPC_DEBUG_KNET 0x10
992
993 #define _enter(FMT,...) \
994 do { \
995 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
996 kenter(FMT,##__VA_ARGS__); \
997 } while (0)
998
999 #define _leave(FMT,...) \
1000 do { \
1001 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1002 kleave(FMT,##__VA_ARGS__); \
1003 } while (0)
1004
1005 #define _debug(FMT,...) \
1006 do { \
1007 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1008 kdebug(FMT,##__VA_ARGS__); \
1009 } while (0)
1010
1011 #define _proto(FMT,...) \
1012 do { \
1013 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1014 kproto(FMT,##__VA_ARGS__); \
1015 } while (0)
1016
1017 #define _net(FMT,...) \
1018 do { \
1019 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1020 knet(FMT,##__VA_ARGS__); \
1021 } while (0)
1022
1023 #else
1024 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1025 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1026 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1027 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1028 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1029 #endif
1030
1031 /*
1032 * debug assertion checking
1033 */
1034 #if 1 // defined(__KDEBUGALL)
1035
1036 #define ASSERT(X) \
1037 do { \
1038 if (unlikely(!(X))) { \
1039 pr_err("Assertion failed\n"); \
1040 BUG(); \
1041 } \
1042 } while (0)
1043
1044 #define ASSERTCMP(X, OP, Y) \
1045 do { \
1046 __typeof__(X) _x = (X); \
1047 __typeof__(Y) _y = (__typeof__(X))(Y); \
1048 if (unlikely(!(_x OP _y))) { \
1049 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1050 (unsigned long)_x, (unsigned long)_x, #OP, \
1051 (unsigned long)_y, (unsigned long)_y); \
1052 BUG(); \
1053 } \
1054 } while (0)
1055
1056 #define ASSERTIF(C, X) \
1057 do { \
1058 if (unlikely((C) && !(X))) { \
1059 pr_err("Assertion failed\n"); \
1060 BUG(); \
1061 } \
1062 } while (0)
1063
1064 #define ASSERTIFCMP(C, X, OP, Y) \
1065 do { \
1066 __typeof__(X) _x = (X); \
1067 __typeof__(Y) _y = (__typeof__(X))(Y); \
1068 if (unlikely((C) && !(_x OP _y))) { \
1069 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1070 (unsigned long)_x, (unsigned long)_x, #OP, \
1071 (unsigned long)_y, (unsigned long)_y); \
1072 BUG(); \
1073 } \
1074 } while (0)
1075
1076 #else
1077
1078 #define ASSERT(X) \
1079 do { \
1080 } while (0)
1081
1082 #define ASSERTCMP(X, OP, Y) \
1083 do { \
1084 } while (0)
1085
1086 #define ASSERTIF(C, X) \
1087 do { \
1088 } while (0)
1089
1090 #define ASSERTIFCMP(C, X, OP, Y) \
1091 do { \
1092 } while (0)
1093
1094 #endif /* __KDEBUGALL */