Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/* AF_RXRPC internal definitions
3 *
4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
6 */
7
8#include <linux/atomic.h>
9#include <linux/seqlock.h>
10#include <linux/win_minmax.h>
11#include <net/net_namespace.h>
12#include <net/netns/generic.h>
13#include <net/sock.h>
14#include <net/af_rxrpc.h>
15#include "protocol.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
22#define CHECK_SLAB_OKAY(X) do {} while (0)
23#endif
24
25#define FCRYPT_BSIZE 8
26struct rxrpc_crypt {
27 union {
28 u8 x[FCRYPT_BSIZE];
29 __be32 n[2];
30 };
31} __attribute__((aligned(8)));
32
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
37struct rxrpc_connection;
38
39/*
40 * Mark applied to socket buffers in skb->mark. skb->priority is used
41 * to pass supplementary information.
42 */
43enum rxrpc_skb_mark {
44 RXRPC_SKB_MARK_REJECT_BUSY, /* Reject with BUSY */
45 RXRPC_SKB_MARK_REJECT_ABORT, /* Reject with ABORT (code in skb->priority) */
46};
47
48/*
49 * sk_state for RxRPC sockets
50 */
51enum {
52 RXRPC_UNBOUND = 0,
53 RXRPC_CLIENT_UNBOUND, /* Unbound socket used as client */
54 RXRPC_CLIENT_BOUND, /* client local address bound */
55 RXRPC_SERVER_BOUND, /* server local address bound */
56 RXRPC_SERVER_BOUND2, /* second server local address bound */
57 RXRPC_SERVER_LISTENING, /* server listening for connections */
58 RXRPC_SERVER_LISTEN_DISABLED, /* server listening disabled */
59 RXRPC_CLOSE, /* socket is being closed */
60};
61
62/*
63 * Per-network namespace data.
64 */
65struct rxrpc_net {
66 struct proc_dir_entry *proc_net; /* Subdir in /proc/net */
67 u32 epoch; /* Local epoch for detecting local-end reset */
68 struct list_head calls; /* List of calls active in this namespace */
69 rwlock_t call_lock; /* Lock for ->calls */
70 atomic_t nr_calls; /* Count of allocated calls */
71
72 atomic_t nr_conns;
73 struct list_head conn_proc_list; /* List of conns in this namespace for proc */
74 struct list_head service_conns; /* Service conns in this namespace */
75 rwlock_t conn_lock; /* Lock for ->conn_proc_list, ->service_conns */
76 struct work_struct service_conn_reaper;
77 struct timer_list service_conn_reap_timer;
78
79 unsigned int nr_client_conns;
80 unsigned int nr_active_client_conns;
81 bool kill_all_client_conns;
82 bool live;
83 spinlock_t client_conn_cache_lock; /* Lock for ->*_client_conns */
84 spinlock_t client_conn_discard_lock; /* Prevent multiple discarders */
85 struct list_head waiting_client_conns;
86 struct list_head active_client_conns;
87 struct list_head idle_client_conns;
88 struct work_struct client_conn_reaper;
89 struct timer_list client_conn_reap_timer;
90
91 struct list_head local_endpoints;
92 struct mutex local_mutex; /* Lock for ->local_endpoints */
93
94 DECLARE_HASHTABLE (peer_hash, 10);
95 spinlock_t peer_hash_lock; /* Lock for ->peer_hash */
96
97#define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
98 u8 peer_keepalive_cursor;
99 time64_t peer_keepalive_base;
100 struct list_head peer_keepalive[32];
101 struct list_head peer_keepalive_new;
102 struct timer_list peer_keepalive_timer;
103 struct work_struct peer_keepalive_work;
104};
105
106/*
107 * Service backlog preallocation.
108 *
109 * This contains circular buffers of preallocated peers, connections and calls
110 * for incoming service calls and their head and tail pointers. This allows
111 * calls to be set up in the data_ready handler, thereby avoiding the need to
112 * shuffle packets around so much.
113 */
114struct rxrpc_backlog {
115 unsigned short peer_backlog_head;
116 unsigned short peer_backlog_tail;
117 unsigned short conn_backlog_head;
118 unsigned short conn_backlog_tail;
119 unsigned short call_backlog_head;
120 unsigned short call_backlog_tail;
121#define RXRPC_BACKLOG_MAX 32
122 struct rxrpc_peer *peer_backlog[RXRPC_BACKLOG_MAX];
123 struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
124 struct rxrpc_call *call_backlog[RXRPC_BACKLOG_MAX];
125};
126
127/*
128 * RxRPC socket definition
129 */
130struct rxrpc_sock {
131 /* WARNING: sk has to be the first member */
132 struct sock sk;
133 rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
134 rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
135 struct rxrpc_local *local; /* local endpoint */
136 struct rxrpc_backlog *backlog; /* Preallocation for services */
137 spinlock_t incoming_lock; /* Incoming call vs service shutdown lock */
138 struct list_head sock_calls; /* List of calls owned by this socket */
139 struct list_head to_be_accepted; /* calls awaiting acceptance */
140 struct list_head recvmsg_q; /* Calls awaiting recvmsg's attention */
141 rwlock_t recvmsg_lock; /* Lock for recvmsg_q */
142 struct key *key; /* security for this socket */
143 struct key *securities; /* list of server security descriptors */
144 struct rb_root calls; /* User ID -> call mapping */
145 unsigned long flags;
146#define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
147 rwlock_t call_lock; /* lock for calls */
148 u32 min_sec_level; /* minimum security level */
149#define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
150 bool exclusive; /* Exclusive connection for a client socket */
151 u16 second_service; /* Additional service bound to the endpoint */
152 struct {
153 /* Service upgrade information */
154 u16 from; /* Service ID to upgrade (if not 0) */
155 u16 to; /* service ID to upgrade to */
156 } service_upgrade;
157 sa_family_t family; /* Protocol family created with */
158 struct sockaddr_rxrpc srx; /* Primary Service/local addresses */
159 struct sockaddr_rxrpc connect_srx; /* Default client address from connect() */
160};
161
162#define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
163
164/*
165 * CPU-byteorder normalised Rx packet header.
166 */
167struct rxrpc_host_header {
168 u32 epoch; /* client boot timestamp */
169 u32 cid; /* connection and channel ID */
170 u32 callNumber; /* call ID (0 for connection-level packets) */
171 u32 seq; /* sequence number of pkt in call stream */
172 u32 serial; /* serial number of pkt sent to network */
173 u8 type; /* packet type */
174 u8 flags; /* packet flags */
175 u8 userStatus; /* app-layer defined status */
176 u8 securityIndex; /* security protocol ID */
177 union {
178 u16 _rsvd; /* reserved */
179 u16 cksum; /* kerberos security checksum */
180 };
181 u16 serviceId; /* service ID */
182} __packed;
183
184/*
185 * RxRPC socket buffer private variables
186 * - max 48 bytes (struct sk_buff::cb)
187 */
188struct rxrpc_skb_priv {
189 atomic_t nr_ring_pins; /* Number of rxtx ring pins */
190 u8 nr_subpackets; /* Number of subpackets */
191 u8 rx_flags; /* Received packet flags */
192#define RXRPC_SKB_INCL_LAST 0x01 /* - Includes last packet */
193#define RXRPC_SKB_TX_BUFFER 0x02 /* - Is transmit buffer */
194 union {
195 int remain; /* amount of space remaining for next write */
196
197 /* List of requested ACKs on subpackets */
198 unsigned long rx_req_ack[(RXRPC_MAX_NR_JUMBO + BITS_PER_LONG - 1) /
199 BITS_PER_LONG];
200 };
201
202 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
203};
204
205#define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
206
207/*
208 * RxRPC security module interface
209 */
210struct rxrpc_security {
211 const char *name; /* name of this service */
212 u8 security_index; /* security type provided */
213 u32 no_key_abort; /* Abort code indicating no key */
214
215 /* Initialise a security service */
216 int (*init)(void);
217
218 /* Clean up a security service */
219 void (*exit)(void);
220
221 /* initialise a connection's security */
222 int (*init_connection_security)(struct rxrpc_connection *);
223
224 /* prime a connection's packet security */
225 int (*prime_packet_security)(struct rxrpc_connection *);
226
227 /* impose security on a packet */
228 int (*secure_packet)(struct rxrpc_call *,
229 struct sk_buff *,
230 size_t,
231 void *);
232
233 /* verify the security on a received packet */
234 int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
235 unsigned int, unsigned int, rxrpc_seq_t, u16);
236
237 /* Free crypto request on a call */
238 void (*free_call_crypto)(struct rxrpc_call *);
239
240 /* Locate the data in a received packet that has been verified. */
241 void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
242 unsigned int *, unsigned int *);
243
244 /* issue a challenge */
245 int (*issue_challenge)(struct rxrpc_connection *);
246
247 /* respond to a challenge */
248 int (*respond_to_challenge)(struct rxrpc_connection *,
249 struct sk_buff *,
250 u32 *);
251
252 /* verify a response */
253 int (*verify_response)(struct rxrpc_connection *,
254 struct sk_buff *,
255 u32 *);
256
257 /* clear connection security */
258 void (*clear)(struct rxrpc_connection *);
259};
260
261/*
262 * RxRPC local transport endpoint description
263 * - owned by a single AF_RXRPC socket
264 * - pointed to by transport socket struct sk_user_data
265 */
266struct rxrpc_local {
267 struct rcu_head rcu;
268 atomic_t active_users; /* Number of users of the local endpoint */
269 atomic_t usage; /* Number of references to the structure */
270 struct rxrpc_net *rxnet; /* The network ns in which this resides */
271 struct list_head link;
272 struct socket *socket; /* my UDP socket */
273 struct work_struct processor;
274 struct rxrpc_sock __rcu *service; /* Service(s) listening on this endpoint */
275 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
276 struct sk_buff_head reject_queue; /* packets awaiting rejection */
277 struct sk_buff_head event_queue; /* endpoint event packets awaiting processing */
278 struct rb_root client_conns; /* Client connections by socket params */
279 spinlock_t client_conns_lock; /* Lock for client_conns */
280 spinlock_t lock; /* access lock */
281 rwlock_t services_lock; /* lock for services list */
282 int debug_id; /* debug ID for printks */
283 bool dead;
284 bool service_closed; /* Service socket closed */
285 struct sockaddr_rxrpc srx; /* local address */
286};
287
288/*
289 * RxRPC remote transport endpoint definition
290 * - matched by local endpoint, remote port, address and protocol type
291 */
292struct rxrpc_peer {
293 struct rcu_head rcu; /* This must be first */
294 atomic_t usage;
295 unsigned long hash_key;
296 struct hlist_node hash_link;
297 struct rxrpc_local *local;
298 struct hlist_head error_targets; /* targets for net error distribution */
299 struct rb_root service_conns; /* Service connections */
300 struct list_head keepalive_link; /* Link in net->peer_keepalive[] */
301 time64_t last_tx_at; /* Last time packet sent here */
302 seqlock_t service_conn_lock;
303 spinlock_t lock; /* access lock */
304 unsigned int if_mtu; /* interface MTU for this peer */
305 unsigned int mtu; /* network MTU for this peer */
306 unsigned int maxdata; /* data size (MTU - hdrsize) */
307 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
308 int debug_id; /* debug ID for printks */
309 struct sockaddr_rxrpc srx; /* remote address */
310
311 /* calculated RTT cache */
312#define RXRPC_RTT_CACHE_SIZE 32
313 spinlock_t rtt_input_lock; /* RTT lock for input routine */
314 ktime_t rtt_last_req; /* Time of last RTT request */
315 unsigned int rtt_count; /* Number of samples we've got */
316
317 u32 srtt_us; /* smoothed round trip time << 3 in usecs */
318 u32 mdev_us; /* medium deviation */
319 u32 mdev_max_us; /* maximal mdev for the last rtt period */
320 u32 rttvar_us; /* smoothed mdev_max */
321 u32 rto_j; /* Retransmission timeout in jiffies */
322 u8 backoff; /* Backoff timeout */
323
324 u8 cong_cwnd; /* Congestion window size */
325};
326
327/*
328 * Keys for matching a connection.
329 */
330struct rxrpc_conn_proto {
331 union {
332 struct {
333 u32 epoch; /* epoch of this connection */
334 u32 cid; /* connection ID */
335 };
336 u64 index_key;
337 };
338};
339
340struct rxrpc_conn_parameters {
341 struct rxrpc_local *local; /* Representation of local endpoint */
342 struct rxrpc_peer *peer; /* Remote endpoint */
343 struct key *key; /* Security details */
344 bool exclusive; /* T if conn is exclusive */
345 bool upgrade; /* T if service ID can be upgraded */
346 u16 service_id; /* Service ID for this connection */
347 u32 security_level; /* Security level selected */
348};
349
350/*
351 * Bits in the connection flags.
352 */
353enum rxrpc_conn_flag {
354 RXRPC_CONN_HAS_IDR, /* Has a client conn ID assigned */
355 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
356 RXRPC_CONN_IN_CLIENT_CONNS, /* Conn is in local->client_conns */
357 RXRPC_CONN_EXPOSED, /* Conn has extra ref for exposure */
358 RXRPC_CONN_DONT_REUSE, /* Don't reuse this connection */
359 RXRPC_CONN_COUNTED, /* Counted by rxrpc_nr_client_conns */
360 RXRPC_CONN_PROBING_FOR_UPGRADE, /* Probing for service upgrade */
361 RXRPC_CONN_FINAL_ACK_0, /* Need final ACK for channel 0 */
362 RXRPC_CONN_FINAL_ACK_1, /* Need final ACK for channel 1 */
363 RXRPC_CONN_FINAL_ACK_2, /* Need final ACK for channel 2 */
364 RXRPC_CONN_FINAL_ACK_3, /* Need final ACK for channel 3 */
365};
366
367#define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) | \
368 (1UL << RXRPC_CONN_FINAL_ACK_1) | \
369 (1UL << RXRPC_CONN_FINAL_ACK_2) | \
370 (1UL << RXRPC_CONN_FINAL_ACK_3))
371
372/*
373 * Events that can be raised upon a connection.
374 */
375enum rxrpc_conn_event {
376 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
377};
378
379/*
380 * The connection cache state.
381 */
382enum rxrpc_conn_cache_state {
383 RXRPC_CONN_CLIENT_INACTIVE, /* Conn is not yet listed */
384 RXRPC_CONN_CLIENT_WAITING, /* Conn is on wait list, waiting for capacity */
385 RXRPC_CONN_CLIENT_ACTIVE, /* Conn is on active list, doing calls */
386 RXRPC_CONN_CLIENT_UPGRADE, /* Conn is on active list, probing for upgrade */
387 RXRPC_CONN_CLIENT_CULLED, /* Conn is culled and delisted, doing calls */
388 RXRPC_CONN_CLIENT_IDLE, /* Conn is on idle list, doing mostly nothing */
389 RXRPC_CONN__NR_CACHE_STATES
390};
391
392/*
393 * The connection protocol state.
394 */
395enum rxrpc_conn_proto_state {
396 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
397 RXRPC_CONN_CLIENT, /* Client connection */
398 RXRPC_CONN_SERVICE_PREALLOC, /* Service connection preallocation */
399 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
400 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
401 RXRPC_CONN_SERVICE, /* Service secured connection */
402 RXRPC_CONN_REMOTELY_ABORTED, /* Conn aborted by peer */
403 RXRPC_CONN_LOCALLY_ABORTED, /* Conn aborted locally */
404 RXRPC_CONN__NR_STATES
405};
406
407/*
408 * RxRPC connection definition
409 * - matched by { local, peer, epoch, conn_id, direction }
410 * - each connection can only handle four simultaneous calls
411 */
412struct rxrpc_connection {
413 struct rxrpc_conn_proto proto;
414 struct rxrpc_conn_parameters params;
415
416 atomic_t usage;
417 struct rcu_head rcu;
418 struct list_head cache_link;
419
420 spinlock_t channel_lock;
421 unsigned char active_chans; /* Mask of active channels */
422#define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
423 struct list_head waiting_calls; /* Calls waiting for channels */
424 struct rxrpc_channel {
425 unsigned long final_ack_at; /* Time at which to issue final ACK */
426 struct rxrpc_call __rcu *call; /* Active call */
427 unsigned int call_debug_id; /* call->debug_id */
428 u32 call_id; /* ID of current call */
429 u32 call_counter; /* Call ID counter */
430 u32 last_call; /* ID of last call */
431 u8 last_type; /* Type of last packet */
432 union {
433 u32 last_seq;
434 u32 last_abort;
435 };
436 } channels[RXRPC_MAXCALLS];
437
438 struct timer_list timer; /* Conn event timer */
439 struct work_struct processor; /* connection event processor */
440 union {
441 struct rb_node client_node; /* Node in local->client_conns */
442 struct rb_node service_node; /* Node in peer->service_conns */
443 };
444 struct list_head proc_link; /* link in procfs list */
445 struct list_head link; /* link in master connection list */
446 struct sk_buff_head rx_queue; /* received conn-level packets */
447 const struct rxrpc_security *security; /* applied security module */
448 struct key *server_key; /* security for this service */
449 struct crypto_sync_skcipher *cipher; /* encryption handle */
450 struct rxrpc_crypt csum_iv; /* packet checksum base */
451 unsigned long flags;
452 unsigned long events;
453 unsigned long idle_timestamp; /* Time at which last became idle */
454 spinlock_t state_lock; /* state-change lock */
455 enum rxrpc_conn_cache_state cache_state;
456 enum rxrpc_conn_proto_state state; /* current state of connection */
457 u32 abort_code; /* Abort code of connection abort */
458 int debug_id; /* debug ID for printks */
459 atomic_t serial; /* packet serial number counter */
460 unsigned int hi_serial; /* highest serial number received */
461 u32 security_nonce; /* response re-use preventer */
462 u32 service_id; /* Service ID, possibly upgraded */
463 u8 size_align; /* data size alignment (for security) */
464 u8 security_size; /* security header size */
465 u8 security_ix; /* security type */
466 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
467 short error; /* Local error code */
468};
469
470static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
471{
472 return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
473}
474
475static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
476{
477 return !rxrpc_to_server(sp);
478}
479
480/*
481 * Flags in call->flags.
482 */
483enum rxrpc_call_flag {
484 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
485 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
486 RXRPC_CALL_IS_SERVICE, /* Call is service call */
487 RXRPC_CALL_EXPOSED, /* The call was exposed to the world */
488 RXRPC_CALL_RX_LAST, /* Received the last packet (at rxtx_top) */
489 RXRPC_CALL_TX_LAST, /* Last packet in Tx buffer (at rxtx_top) */
490 RXRPC_CALL_SEND_PING, /* A ping will need to be sent */
491 RXRPC_CALL_RETRANS_TIMEOUT, /* Retransmission due to timeout occurred */
492 RXRPC_CALL_BEGAN_RX_TIMER, /* We began the expect_rx_by timer */
493 RXRPC_CALL_RX_HEARD, /* The peer responded at least once to this call */
494 RXRPC_CALL_RX_UNDERRUN, /* Got data underrun */
495 RXRPC_CALL_DISCONNECTED, /* The call has been disconnected */
496};
497
498/*
499 * Events that can be raised on a call.
500 */
501enum rxrpc_call_event {
502 RXRPC_CALL_EV_ACK, /* need to generate ACK */
503 RXRPC_CALL_EV_ABORT, /* need to generate abort */
504 RXRPC_CALL_EV_RESEND, /* Tx resend required */
505 RXRPC_CALL_EV_PING, /* Ping send required */
506 RXRPC_CALL_EV_EXPIRED, /* Expiry occurred */
507 RXRPC_CALL_EV_ACK_LOST, /* ACK may be lost, send ping */
508};
509
510/*
511 * The states that a call can be in.
512 */
513enum rxrpc_call_state {
514 RXRPC_CALL_UNINITIALISED,
515 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
516 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
517 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
518 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
519 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
520 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
521 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
522 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
523 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
524 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
525 RXRPC_CALL_COMPLETE, /* - call complete */
526 NR__RXRPC_CALL_STATES
527};
528
529/*
530 * Call completion condition (state == RXRPC_CALL_COMPLETE).
531 */
532enum rxrpc_call_completion {
533 RXRPC_CALL_SUCCEEDED, /* - Normal termination */
534 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
535 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
536 RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
537 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
538 NR__RXRPC_CALL_COMPLETIONS
539};
540
541/*
542 * Call Tx congestion management modes.
543 */
544enum rxrpc_congest_mode {
545 RXRPC_CALL_SLOW_START,
546 RXRPC_CALL_CONGEST_AVOIDANCE,
547 RXRPC_CALL_PACKET_LOSS,
548 RXRPC_CALL_FAST_RETRANSMIT,
549 NR__RXRPC_CONGEST_MODES
550};
551
552/*
553 * RxRPC call definition
554 * - matched by { connection, call_id }
555 */
556struct rxrpc_call {
557 struct rcu_head rcu;
558 struct rxrpc_connection *conn; /* connection carrying call */
559 struct rxrpc_peer *peer; /* Peer record for remote address */
560 struct rxrpc_sock __rcu *socket; /* socket responsible */
561 struct rxrpc_net *rxnet; /* Network namespace to which call belongs */
562 const struct rxrpc_security *security; /* applied security module */
563 struct mutex user_mutex; /* User access mutex */
564 unsigned long ack_at; /* When deferred ACK needs to happen */
565 unsigned long ack_lost_at; /* When ACK is figured as lost */
566 unsigned long resend_at; /* When next resend needs to happen */
567 unsigned long ping_at; /* When next to send a ping */
568 unsigned long keepalive_at; /* When next to send a keepalive ping */
569 unsigned long expect_rx_by; /* When we expect to get a packet by */
570 unsigned long expect_req_by; /* When we expect to get a request DATA packet by */
571 unsigned long expect_term_by; /* When we expect call termination by */
572 u32 next_rx_timo; /* Timeout for next Rx packet (jif) */
573 u32 next_req_timo; /* Timeout for next Rx request packet (jif) */
574 struct skcipher_request *cipher_req; /* Packet cipher request buffer */
575 struct timer_list timer; /* Combined event timer */
576 struct work_struct processor; /* Event processor */
577 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
578 struct list_head link; /* link in master call list */
579 struct list_head chan_wait_link; /* Link in conn->waiting_calls */
580 struct hlist_node error_link; /* link in error distribution list */
581 struct list_head accept_link; /* Link in rx->acceptq */
582 struct list_head recvmsg_link; /* Link in rx->recvmsg_q */
583 struct list_head sock_link; /* Link in rx->sock_calls */
584 struct rb_node sock_node; /* Node in rx->calls */
585 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
586 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
587 s64 tx_total_len; /* Total length left to be transmitted (or -1) */
588 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
589 unsigned long user_call_ID; /* user-defined call ID */
590 unsigned long flags;
591 unsigned long events;
592 spinlock_t lock;
593 spinlock_t notify_lock; /* Kernel notification lock */
594 rwlock_t state_lock; /* lock for state transition */
595 u32 abort_code; /* Local/remote abort code */
596 int error; /* Local error incurred */
597 enum rxrpc_call_state state; /* current state of call */
598 enum rxrpc_call_completion completion; /* Call completion condition */
599 atomic_t usage;
600 u16 service_id; /* service ID */
601 u8 security_ix; /* Security type */
602 enum rxrpc_interruptibility interruptibility; /* At what point call may be interrupted */
603 u32 call_id; /* call ID on connection */
604 u32 cid; /* connection ID plus channel index */
605 int debug_id; /* debug ID for printks */
606 unsigned short rx_pkt_offset; /* Current recvmsg packet offset */
607 unsigned short rx_pkt_len; /* Current recvmsg packet len */
608 bool rx_pkt_last; /* Current recvmsg packet is last */
609
610 /* Rx/Tx circular buffer, depending on phase.
611 *
612 * In the Rx phase, packets are annotated with 0 or the number of the
613 * segment of a jumbo packet each buffer refers to. There can be up to
614 * 47 segments in a maximum-size UDP packet.
615 *
616 * In the Tx phase, packets are annotated with which buffers have been
617 * acked.
618 */
619#define RXRPC_RXTX_BUFF_SIZE 64
620#define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
621#define RXRPC_INIT_RX_WINDOW_SIZE 63
622 struct sk_buff **rxtx_buffer;
623 u8 *rxtx_annotations;
624#define RXRPC_TX_ANNO_ACK 0
625#define RXRPC_TX_ANNO_UNACK 1
626#define RXRPC_TX_ANNO_NAK 2
627#define RXRPC_TX_ANNO_RETRANS 3
628#define RXRPC_TX_ANNO_MASK 0x03
629#define RXRPC_TX_ANNO_LAST 0x04
630#define RXRPC_TX_ANNO_RESENT 0x08
631
632#define RXRPC_RX_ANNO_SUBPACKET 0x3f /* Subpacket number in jumbogram */
633#define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
634 rxrpc_seq_t tx_hard_ack; /* Dead slot in buffer; the first transmitted but
635 * not hard-ACK'd packet follows this.
636 */
637 rxrpc_seq_t tx_top; /* Highest Tx slot allocated. */
638 u16 tx_backoff; /* Delay to insert due to Tx failure */
639
640 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
641 * is fixed, we keep these numbers in terms of segments (ie. DATA
642 * packets) rather than bytes.
643 */
644#define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
645 u8 cong_cwnd; /* Congestion window size */
646 u8 cong_extra; /* Extra to send for congestion management */
647 u8 cong_ssthresh; /* Slow-start threshold */
648 enum rxrpc_congest_mode cong_mode:8; /* Congestion management mode */
649 u8 cong_dup_acks; /* Count of ACKs showing missing packets */
650 u8 cong_cumul_acks; /* Cumulative ACK count */
651 ktime_t cong_tstamp; /* Last time cwnd was changed */
652
653 rxrpc_seq_t rx_hard_ack; /* Dead slot in buffer; the first received but not
654 * consumed packet follows this.
655 */
656 rxrpc_seq_t rx_top; /* Highest Rx slot allocated. */
657 rxrpc_seq_t rx_expect_next; /* Expected next packet sequence number */
658 rxrpc_serial_t rx_serial; /* Highest serial received for this call */
659 u8 rx_winsize; /* Size of Rx window */
660 u8 tx_winsize; /* Maximum size of Tx window */
661 bool tx_phase; /* T if transmission phase, F if receive phase */
662 u8 nr_jumbo_bad; /* Number of jumbo dups/exceeds-windows */
663
664 spinlock_t input_lock; /* Lock for packet input to this call */
665
666 /* receive-phase ACK management */
667 u8 ackr_reason; /* reason to ACK */
668 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
669 rxrpc_serial_t ackr_first_seq; /* first sequence number received */
670 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
671 rxrpc_seq_t ackr_consumed; /* Highest packet shown consumed */
672 rxrpc_seq_t ackr_seen; /* Highest packet shown seen */
673
674 /* RTT management */
675 rxrpc_serial_t rtt_serial[4]; /* Serial number of DATA or PING sent */
676 ktime_t rtt_sent_at[4]; /* Time packet sent */
677 unsigned long rtt_avail; /* Mask of available slots in bits 0-3,
678 * Mask of pending samples in 8-11 */
679#define RXRPC_CALL_RTT_AVAIL_MASK 0xf
680#define RXRPC_CALL_RTT_PEND_SHIFT 8
681
682 /* transmission-phase ACK management */
683 ktime_t acks_latest_ts; /* Timestamp of latest ACK received */
684 rxrpc_seq_t acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
685 rxrpc_seq_t acks_lost_top; /* tx_top at the time lost-ack ping sent */
686 rxrpc_serial_t acks_lost_ping; /* Serial number of probe ACK */
687};
688
689/*
690 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
691 */
692struct rxrpc_ack_summary {
693 u8 ack_reason;
694 u8 nr_acks; /* Number of ACKs in packet */
695 u8 nr_nacks; /* Number of NACKs in packet */
696 u8 nr_new_acks; /* Number of new ACKs in packet */
697 u8 nr_new_nacks; /* Number of new NACKs in packet */
698 u8 nr_rot_new_acks; /* Number of rotated new ACKs */
699 bool new_low_nack; /* T if new low NACK found */
700 bool retrans_timeo; /* T if reTx due to timeout happened */
701 u8 flight_size; /* Number of unreceived transmissions */
702 /* Place to stash values for tracing */
703 enum rxrpc_congest_mode mode:8;
704 u8 cwnd;
705 u8 ssthresh;
706 u8 dup_acks;
707 u8 cumulative_acks;
708};
709
710/*
711 * sendmsg() cmsg-specified parameters.
712 */
713enum rxrpc_command {
714 RXRPC_CMD_SEND_DATA, /* send data message */
715 RXRPC_CMD_SEND_ABORT, /* request abort generation */
716 RXRPC_CMD_REJECT_BUSY, /* [server] reject a call as busy */
717 RXRPC_CMD_CHARGE_ACCEPT, /* [server] charge accept preallocation */
718};
719
720struct rxrpc_call_params {
721 s64 tx_total_len; /* Total Tx data length (if send data) */
722 unsigned long user_call_ID; /* User's call ID */
723 struct {
724 u32 hard; /* Maximum lifetime (sec) */
725 u32 idle; /* Max time since last data packet (msec) */
726 u32 normal; /* Max time since last call packet (msec) */
727 } timeouts;
728 u8 nr_timeouts; /* Number of timeouts specified */
729 enum rxrpc_interruptibility interruptibility; /* How is interruptible is the call? */
730};
731
732struct rxrpc_send_params {
733 struct rxrpc_call_params call;
734 u32 abort_code; /* Abort code to Tx (if abort) */
735 enum rxrpc_command command : 8; /* The command to implement */
736 bool exclusive; /* Shared or exclusive call */
737 bool upgrade; /* If the connection is upgradeable */
738};
739
740#include <trace/events/rxrpc.h>
741
742/*
743 * af_rxrpc.c
744 */
745extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
746extern struct workqueue_struct *rxrpc_workqueue;
747
748/*
749 * call_accept.c
750 */
751int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
752void rxrpc_discard_prealloc(struct rxrpc_sock *);
753struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
754 struct rxrpc_sock *,
755 struct sk_buff *);
756void rxrpc_accept_incoming_calls(struct rxrpc_local *);
757int rxrpc_user_charge_accept(struct rxrpc_sock *, unsigned long);
758
759/*
760 * call_event.c
761 */
762void rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool, bool,
763 enum rxrpc_propose_ack_trace);
764void rxrpc_process_call(struct work_struct *);
765
766static inline void rxrpc_reduce_call_timer(struct rxrpc_call *call,
767 unsigned long expire_at,
768 unsigned long now,
769 enum rxrpc_timer_trace why)
770{
771 trace_rxrpc_timer(call, why, now);
772 timer_reduce(&call->timer, expire_at);
773}
774
775/*
776 * call_object.c
777 */
778extern const char *const rxrpc_call_states[];
779extern const char *const rxrpc_call_completions[];
780extern unsigned int rxrpc_max_call_lifetime;
781extern struct kmem_cache *rxrpc_call_jar;
782
783struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
784struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
785struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
786 struct rxrpc_conn_parameters *,
787 struct sockaddr_rxrpc *,
788 struct rxrpc_call_params *, gfp_t,
789 unsigned int);
790void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
791 struct sk_buff *);
792void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
793void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
794bool __rxrpc_queue_call(struct rxrpc_call *);
795bool rxrpc_queue_call(struct rxrpc_call *);
796void rxrpc_see_call(struct rxrpc_call *);
797void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
798void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
799void rxrpc_cleanup_call(struct rxrpc_call *);
800void rxrpc_destroy_all_calls(struct rxrpc_net *);
801
802static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
803{
804 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
805}
806
807static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
808{
809 return !rxrpc_is_service_call(call);
810}
811
812/*
813 * conn_client.c
814 */
815extern unsigned int rxrpc_max_client_connections;
816extern unsigned int rxrpc_reap_client_connections;
817extern unsigned long rxrpc_conn_idle_client_expiry;
818extern unsigned long rxrpc_conn_idle_client_fast_expiry;
819extern struct idr rxrpc_client_conn_ids;
820
821void rxrpc_destroy_client_conn_ids(void);
822int rxrpc_connect_call(struct rxrpc_sock *, struct rxrpc_call *,
823 struct rxrpc_conn_parameters *, struct sockaddr_rxrpc *,
824 gfp_t);
825void rxrpc_expose_client_call(struct rxrpc_call *);
826void rxrpc_disconnect_client_call(struct rxrpc_call *);
827void rxrpc_put_client_conn(struct rxrpc_connection *);
828void rxrpc_discard_expired_client_conns(struct work_struct *);
829void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
830void rxrpc_clean_up_local_conns(struct rxrpc_local *);
831
832/*
833 * conn_event.c
834 */
835void rxrpc_process_connection(struct work_struct *);
836
837/*
838 * conn_object.c
839 */
840extern unsigned int rxrpc_connection_expiry;
841extern unsigned int rxrpc_closed_conn_expiry;
842
843struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
844struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
845 struct sk_buff *,
846 struct rxrpc_peer **);
847void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
848void rxrpc_disconnect_call(struct rxrpc_call *);
849void rxrpc_kill_connection(struct rxrpc_connection *);
850bool rxrpc_queue_conn(struct rxrpc_connection *);
851void rxrpc_see_connection(struct rxrpc_connection *);
852void rxrpc_get_connection(struct rxrpc_connection *);
853struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
854void rxrpc_put_service_conn(struct rxrpc_connection *);
855void rxrpc_service_connection_reaper(struct work_struct *);
856void rxrpc_destroy_all_connections(struct rxrpc_net *);
857
858static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
859{
860 return conn->out_clientflag;
861}
862
863static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
864{
865 return !rxrpc_conn_is_client(conn);
866}
867
868static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
869{
870 if (!conn)
871 return;
872
873 if (rxrpc_conn_is_client(conn))
874 rxrpc_put_client_conn(conn);
875 else
876 rxrpc_put_service_conn(conn);
877}
878
879static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
880 unsigned long expire_at)
881{
882 timer_reduce(&conn->timer, expire_at);
883}
884
885/*
886 * conn_service.c
887 */
888struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
889 struct sk_buff *);
890struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
891void rxrpc_new_incoming_connection(struct rxrpc_sock *, struct rxrpc_connection *,
892 const struct rxrpc_security *, struct key *,
893 struct sk_buff *);
894void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
895
896/*
897 * input.c
898 */
899int rxrpc_input_packet(struct sock *, struct sk_buff *);
900
901/*
902 * insecure.c
903 */
904extern const struct rxrpc_security rxrpc_no_security;
905
906/*
907 * key.c
908 */
909extern struct key_type key_type_rxrpc;
910extern struct key_type key_type_rxrpc_s;
911
912int rxrpc_request_key(struct rxrpc_sock *, sockptr_t , int);
913int rxrpc_server_keyring(struct rxrpc_sock *, sockptr_t, int);
914int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
915 u32);
916
917/*
918 * local_event.c
919 */
920extern void rxrpc_process_local_events(struct rxrpc_local *);
921
922/*
923 * local_object.c
924 */
925struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
926struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *);
927struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *);
928void rxrpc_put_local(struct rxrpc_local *);
929struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *);
930void rxrpc_unuse_local(struct rxrpc_local *);
931void rxrpc_queue_local(struct rxrpc_local *);
932void rxrpc_destroy_all_locals(struct rxrpc_net *);
933
934static inline bool __rxrpc_unuse_local(struct rxrpc_local *local)
935{
936 return atomic_dec_return(&local->active_users) == 0;
937}
938
939static inline bool __rxrpc_use_local(struct rxrpc_local *local)
940{
941 return atomic_fetch_add_unless(&local->active_users, 1, 0) != 0;
942}
943
944/*
945 * misc.c
946 */
947extern unsigned int rxrpc_max_backlog __read_mostly;
948extern unsigned long rxrpc_requested_ack_delay;
949extern unsigned long rxrpc_soft_ack_delay;
950extern unsigned long rxrpc_idle_ack_delay;
951extern unsigned int rxrpc_rx_window_size;
952extern unsigned int rxrpc_rx_mtu;
953extern unsigned int rxrpc_rx_jumbo_max;
954
955extern const s8 rxrpc_ack_priority[];
956
957/*
958 * net_ns.c
959 */
960extern unsigned int rxrpc_net_id;
961extern struct pernet_operations rxrpc_net_ops;
962
963static inline struct rxrpc_net *rxrpc_net(struct net *net)
964{
965 return net_generic(net, rxrpc_net_id);
966}
967
968/*
969 * output.c
970 */
971int rxrpc_send_ack_packet(struct rxrpc_call *, bool, rxrpc_serial_t *);
972int rxrpc_send_abort_packet(struct rxrpc_call *);
973int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
974void rxrpc_reject_packets(struct rxrpc_local *);
975void rxrpc_send_keepalive(struct rxrpc_peer *);
976
977/*
978 * peer_event.c
979 */
980void rxrpc_error_report(struct sock *);
981void rxrpc_peer_keepalive_worker(struct work_struct *);
982
983/*
984 * peer_object.c
985 */
986struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
987 const struct sockaddr_rxrpc *);
988struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_sock *, struct rxrpc_local *,
989 struct sockaddr_rxrpc *, gfp_t);
990struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
991void rxrpc_new_incoming_peer(struct rxrpc_sock *, struct rxrpc_local *,
992 struct rxrpc_peer *);
993void rxrpc_destroy_all_peers(struct rxrpc_net *);
994struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *);
995struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *);
996void rxrpc_put_peer(struct rxrpc_peer *);
997void rxrpc_put_peer_locked(struct rxrpc_peer *);
998
999/*
1000 * proc.c
1001 */
1002extern const struct seq_operations rxrpc_call_seq_ops;
1003extern const struct seq_operations rxrpc_connection_seq_ops;
1004extern const struct seq_operations rxrpc_peer_seq_ops;
1005
1006/*
1007 * recvmsg.c
1008 */
1009void rxrpc_notify_socket(struct rxrpc_call *);
1010bool __rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1011bool rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1012bool __rxrpc_call_completed(struct rxrpc_call *);
1013bool rxrpc_call_completed(struct rxrpc_call *);
1014bool __rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1015bool rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1016int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1017
1018/*
1019 * Abort a call due to a protocol error.
1020 */
1021static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
1022 struct sk_buff *skb,
1023 const char *eproto_why,
1024 const char *why,
1025 u32 abort_code)
1026{
1027 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
1028
1029 trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
1030 return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
1031}
1032
1033#define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
1034 __rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
1035 (abort_why), (abort_code))
1036
1037/*
1038 * rtt.c
1039 */
1040void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace, int,
1041 rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1042unsigned long rxrpc_get_rto_backoff(struct rxrpc_peer *, bool);
1043void rxrpc_peer_init_rtt(struct rxrpc_peer *);
1044
1045/*
1046 * rxkad.c
1047 */
1048#ifdef CONFIG_RXKAD
1049extern const struct rxrpc_security rxkad;
1050#endif
1051
1052/*
1053 * security.c
1054 */
1055int __init rxrpc_init_security(void);
1056void rxrpc_exit_security(void);
1057int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1058bool rxrpc_look_up_server_security(struct rxrpc_local *, struct rxrpc_sock *,
1059 const struct rxrpc_security **, struct key **,
1060 struct sk_buff *);
1061
1062/*
1063 * sendmsg.c
1064 */
1065int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1066
1067/*
1068 * skbuff.c
1069 */
1070void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1071void rxrpc_packet_destructor(struct sk_buff *);
1072void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1073void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1074void rxrpc_eaten_skb(struct sk_buff *, enum rxrpc_skb_trace);
1075void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1076void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1077void rxrpc_purge_queue(struct sk_buff_head *);
1078
1079/*
1080 * sysctl.c
1081 */
1082#ifdef CONFIG_SYSCTL
1083extern int __init rxrpc_sysctl_init(void);
1084extern void rxrpc_sysctl_exit(void);
1085#else
1086static inline int __init rxrpc_sysctl_init(void) { return 0; }
1087static inline void rxrpc_sysctl_exit(void) {}
1088#endif
1089
1090/*
1091 * utils.c
1092 */
1093int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1094
1095static inline bool before(u32 seq1, u32 seq2)
1096{
1097 return (s32)(seq1 - seq2) < 0;
1098}
1099static inline bool before_eq(u32 seq1, u32 seq2)
1100{
1101 return (s32)(seq1 - seq2) <= 0;
1102}
1103static inline bool after(u32 seq1, u32 seq2)
1104{
1105 return (s32)(seq1 - seq2) > 0;
1106}
1107static inline bool after_eq(u32 seq1, u32 seq2)
1108{
1109 return (s32)(seq1 - seq2) >= 0;
1110}
1111
1112/*
1113 * debug tracing
1114 */
1115extern unsigned int rxrpc_debug;
1116
1117#define dbgprintk(FMT,...) \
1118 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1119
1120#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1121#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1122#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1123#define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1124#define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1125
1126
1127#if defined(__KDEBUG)
1128#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1129#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1130#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1131#define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1132#define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1133
1134#elif defined(CONFIG_AF_RXRPC_DEBUG)
1135#define RXRPC_DEBUG_KENTER 0x01
1136#define RXRPC_DEBUG_KLEAVE 0x02
1137#define RXRPC_DEBUG_KDEBUG 0x04
1138#define RXRPC_DEBUG_KPROTO 0x08
1139#define RXRPC_DEBUG_KNET 0x10
1140
1141#define _enter(FMT,...) \
1142do { \
1143 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1144 kenter(FMT,##__VA_ARGS__); \
1145} while (0)
1146
1147#define _leave(FMT,...) \
1148do { \
1149 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1150 kleave(FMT,##__VA_ARGS__); \
1151} while (0)
1152
1153#define _debug(FMT,...) \
1154do { \
1155 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1156 kdebug(FMT,##__VA_ARGS__); \
1157} while (0)
1158
1159#define _proto(FMT,...) \
1160do { \
1161 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1162 kproto(FMT,##__VA_ARGS__); \
1163} while (0)
1164
1165#define _net(FMT,...) \
1166do { \
1167 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1168 knet(FMT,##__VA_ARGS__); \
1169} while (0)
1170
1171#else
1172#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1173#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1174#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1175#define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1176#define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1177#endif
1178
1179/*
1180 * debug assertion checking
1181 */
1182#if 1 // defined(__KDEBUGALL)
1183
1184#define ASSERT(X) \
1185do { \
1186 if (unlikely(!(X))) { \
1187 pr_err("Assertion failed\n"); \
1188 BUG(); \
1189 } \
1190} while (0)
1191
1192#define ASSERTCMP(X, OP, Y) \
1193do { \
1194 __typeof__(X) _x = (X); \
1195 __typeof__(Y) _y = (__typeof__(X))(Y); \
1196 if (unlikely(!(_x OP _y))) { \
1197 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1198 (unsigned long)_x, (unsigned long)_x, #OP, \
1199 (unsigned long)_y, (unsigned long)_y); \
1200 BUG(); \
1201 } \
1202} while (0)
1203
1204#define ASSERTIF(C, X) \
1205do { \
1206 if (unlikely((C) && !(X))) { \
1207 pr_err("Assertion failed\n"); \
1208 BUG(); \
1209 } \
1210} while (0)
1211
1212#define ASSERTIFCMP(C, X, OP, Y) \
1213do { \
1214 __typeof__(X) _x = (X); \
1215 __typeof__(Y) _y = (__typeof__(X))(Y); \
1216 if (unlikely((C) && !(_x OP _y))) { \
1217 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1218 (unsigned long)_x, (unsigned long)_x, #OP, \
1219 (unsigned long)_y, (unsigned long)_y); \
1220 BUG(); \
1221 } \
1222} while (0)
1223
1224#else
1225
1226#define ASSERT(X) \
1227do { \
1228} while (0)
1229
1230#define ASSERTCMP(X, OP, Y) \
1231do { \
1232} while (0)
1233
1234#define ASSERTIF(C, X) \
1235do { \
1236} while (0)
1237
1238#define ASSERTIFCMP(C, X, OP, Y) \
1239do { \
1240} while (0)
1241
1242#endif /* __KDEBUGALL */
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/* AF_RXRPC internal definitions
3 *
4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
6 */
7
8#include <linux/atomic.h>
9#include <linux/seqlock.h>
10#include <linux/win_minmax.h>
11#include <net/net_namespace.h>
12#include <net/netns/generic.h>
13#include <net/sock.h>
14#include <net/af_rxrpc.h>
15#include <keys/rxrpc-type.h>
16#include "protocol.h"
17
18#define FCRYPT_BSIZE 8
19struct rxrpc_crypt {
20 union {
21 u8 x[FCRYPT_BSIZE];
22 __be32 n[2];
23 };
24} __attribute__((aligned(8)));
25
26#define rxrpc_queue_work(WS) queue_work(rxrpc_workqueue, (WS))
27#define rxrpc_queue_delayed_work(WS,D) \
28 queue_delayed_work(rxrpc_workqueue, (WS), (D))
29
30struct key_preparsed_payload;
31struct rxrpc_connection;
32struct rxrpc_txbuf;
33
34/*
35 * Mark applied to socket buffers in skb->mark. skb->priority is used
36 * to pass supplementary information.
37 */
38enum rxrpc_skb_mark {
39 RXRPC_SKB_MARK_PACKET, /* Received packet */
40 RXRPC_SKB_MARK_ERROR, /* Error notification */
41 RXRPC_SKB_MARK_SERVICE_CONN_SECURED, /* Service connection response has been verified */
42 RXRPC_SKB_MARK_REJECT_BUSY, /* Reject with BUSY */
43 RXRPC_SKB_MARK_REJECT_ABORT, /* Reject with ABORT (code in skb->priority) */
44};
45
46/*
47 * sk_state for RxRPC sockets
48 */
49enum {
50 RXRPC_UNBOUND = 0,
51 RXRPC_CLIENT_UNBOUND, /* Unbound socket used as client */
52 RXRPC_CLIENT_BOUND, /* client local address bound */
53 RXRPC_SERVER_BOUND, /* server local address bound */
54 RXRPC_SERVER_BOUND2, /* second server local address bound */
55 RXRPC_SERVER_LISTENING, /* server listening for connections */
56 RXRPC_SERVER_LISTEN_DISABLED, /* server listening disabled */
57 RXRPC_CLOSE, /* socket is being closed */
58};
59
60/*
61 * Per-network namespace data.
62 */
63struct rxrpc_net {
64 struct proc_dir_entry *proc_net; /* Subdir in /proc/net */
65 u32 epoch; /* Local epoch for detecting local-end reset */
66 struct list_head calls; /* List of calls active in this namespace */
67 spinlock_t call_lock; /* Lock for ->calls */
68 atomic_t nr_calls; /* Count of allocated calls */
69
70 atomic_t nr_conns;
71 struct list_head conn_proc_list; /* List of conns in this namespace for proc */
72 struct list_head service_conns; /* Service conns in this namespace */
73 rwlock_t conn_lock; /* Lock for ->conn_proc_list, ->service_conns */
74 struct work_struct service_conn_reaper;
75 struct timer_list service_conn_reap_timer;
76
77 bool live;
78
79 atomic_t nr_client_conns;
80
81 struct hlist_head local_endpoints;
82 struct mutex local_mutex; /* Lock for ->local_endpoints */
83
84 DECLARE_HASHTABLE (peer_hash, 10);
85 spinlock_t peer_hash_lock; /* Lock for ->peer_hash */
86
87#define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
88 u8 peer_keepalive_cursor;
89 time64_t peer_keepalive_base;
90 struct list_head peer_keepalive[32];
91 struct list_head peer_keepalive_new;
92 struct timer_list peer_keepalive_timer;
93 struct work_struct peer_keepalive_work;
94
95 atomic_t stat_tx_data;
96 atomic_t stat_tx_data_retrans;
97 atomic_t stat_tx_data_send;
98 atomic_t stat_tx_data_send_frag;
99 atomic_t stat_tx_data_send_fail;
100 atomic_t stat_tx_data_underflow;
101 atomic_t stat_tx_data_cwnd_reset;
102 atomic_t stat_rx_data;
103 atomic_t stat_rx_data_reqack;
104 atomic_t stat_rx_data_jumbo;
105
106 atomic_t stat_tx_ack_fill;
107 atomic_t stat_tx_ack_send;
108 atomic_t stat_tx_ack_skip;
109 atomic_t stat_tx_acks[256];
110 atomic_t stat_rx_acks[256];
111
112 atomic_t stat_why_req_ack[8];
113
114 atomic_t stat_io_loop;
115};
116
117/*
118 * Service backlog preallocation.
119 *
120 * This contains circular buffers of preallocated peers, connections and calls
121 * for incoming service calls and their head and tail pointers. This allows
122 * calls to be set up in the data_ready handler, thereby avoiding the need to
123 * shuffle packets around so much.
124 */
125struct rxrpc_backlog {
126 unsigned short peer_backlog_head;
127 unsigned short peer_backlog_tail;
128 unsigned short conn_backlog_head;
129 unsigned short conn_backlog_tail;
130 unsigned short call_backlog_head;
131 unsigned short call_backlog_tail;
132#define RXRPC_BACKLOG_MAX 32
133 struct rxrpc_peer *peer_backlog[RXRPC_BACKLOG_MAX];
134 struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
135 struct rxrpc_call *call_backlog[RXRPC_BACKLOG_MAX];
136};
137
138/*
139 * RxRPC socket definition
140 */
141struct rxrpc_sock {
142 /* WARNING: sk has to be the first member */
143 struct sock sk;
144 rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
145 rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
146 struct rxrpc_local *local; /* local endpoint */
147 struct rxrpc_backlog *backlog; /* Preallocation for services */
148 spinlock_t incoming_lock; /* Incoming call vs service shutdown lock */
149 struct list_head sock_calls; /* List of calls owned by this socket */
150 struct list_head to_be_accepted; /* calls awaiting acceptance */
151 struct list_head recvmsg_q; /* Calls awaiting recvmsg's attention */
152 rwlock_t recvmsg_lock; /* Lock for recvmsg_q */
153 struct key *key; /* security for this socket */
154 struct key *securities; /* list of server security descriptors */
155 struct rb_root calls; /* User ID -> call mapping */
156 unsigned long flags;
157#define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
158 rwlock_t call_lock; /* lock for calls */
159 u32 min_sec_level; /* minimum security level */
160#define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
161 bool exclusive; /* Exclusive connection for a client socket */
162 u16 second_service; /* Additional service bound to the endpoint */
163 struct {
164 /* Service upgrade information */
165 u16 from; /* Service ID to upgrade (if not 0) */
166 u16 to; /* service ID to upgrade to */
167 } service_upgrade;
168 sa_family_t family; /* Protocol family created with */
169 struct sockaddr_rxrpc srx; /* Primary Service/local addresses */
170 struct sockaddr_rxrpc connect_srx; /* Default client address from connect() */
171};
172
173#define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
174
175/*
176 * CPU-byteorder normalised Rx packet header.
177 */
178struct rxrpc_host_header {
179 u32 epoch; /* client boot timestamp */
180 u32 cid; /* connection and channel ID */
181 u32 callNumber; /* call ID (0 for connection-level packets) */
182 u32 seq; /* sequence number of pkt in call stream */
183 u32 serial; /* serial number of pkt sent to network */
184 u8 type; /* packet type */
185 u8 flags; /* packet flags */
186 u8 userStatus; /* app-layer defined status */
187 u8 securityIndex; /* security protocol ID */
188 union {
189 u16 _rsvd; /* reserved */
190 u16 cksum; /* kerberos security checksum */
191 };
192 u16 serviceId; /* service ID */
193} __packed;
194
195/*
196 * RxRPC socket buffer private variables
197 * - max 48 bytes (struct sk_buff::cb)
198 */
199struct rxrpc_skb_priv {
200 struct rxrpc_connection *conn; /* Connection referred to (poke packet) */
201 u16 offset; /* Offset of data */
202 u16 len; /* Length of data */
203 u8 flags;
204#define RXRPC_RX_VERIFIED 0x01
205
206 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
207};
208
209#define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
210
211/*
212 * RxRPC security module interface
213 */
214struct rxrpc_security {
215 const char *name; /* name of this service */
216 u8 security_index; /* security type provided */
217 u32 no_key_abort; /* Abort code indicating no key */
218
219 /* Initialise a security service */
220 int (*init)(void);
221
222 /* Clean up a security service */
223 void (*exit)(void);
224
225 /* Parse the information from a server key */
226 int (*preparse_server_key)(struct key_preparsed_payload *);
227
228 /* Clean up the preparse buffer after parsing a server key */
229 void (*free_preparse_server_key)(struct key_preparsed_payload *);
230
231 /* Destroy the payload of a server key */
232 void (*destroy_server_key)(struct key *);
233
234 /* Describe a server key */
235 void (*describe_server_key)(const struct key *, struct seq_file *);
236
237 /* initialise a connection's security */
238 int (*init_connection_security)(struct rxrpc_connection *,
239 struct rxrpc_key_token *);
240
241 /* Work out how much data we can store in a packet, given an estimate
242 * of the amount of data remaining.
243 */
244 int (*how_much_data)(struct rxrpc_call *, size_t,
245 size_t *, size_t *, size_t *);
246
247 /* impose security on a packet */
248 int (*secure_packet)(struct rxrpc_call *, struct rxrpc_txbuf *);
249
250 /* verify the security on a received packet */
251 int (*verify_packet)(struct rxrpc_call *, struct sk_buff *);
252
253 /* Free crypto request on a call */
254 void (*free_call_crypto)(struct rxrpc_call *);
255
256 /* issue a challenge */
257 int (*issue_challenge)(struct rxrpc_connection *);
258
259 /* respond to a challenge */
260 int (*respond_to_challenge)(struct rxrpc_connection *,
261 struct sk_buff *);
262
263 /* verify a response */
264 int (*verify_response)(struct rxrpc_connection *,
265 struct sk_buff *);
266
267 /* clear connection security */
268 void (*clear)(struct rxrpc_connection *);
269};
270
271/*
272 * RxRPC local transport endpoint description
273 * - owned by a single AF_RXRPC socket
274 * - pointed to by transport socket struct sk_user_data
275 */
276struct rxrpc_local {
277 struct rcu_head rcu;
278 atomic_t active_users; /* Number of users of the local endpoint */
279 refcount_t ref; /* Number of references to the structure */
280 struct net *net; /* The network namespace */
281 struct rxrpc_net *rxnet; /* Our bits in the network namespace */
282 struct hlist_node link;
283 struct socket *socket; /* my UDP socket */
284 struct task_struct *io_thread;
285 struct completion io_thread_ready; /* Indication that the I/O thread started */
286 struct rxrpc_sock *service; /* Service(s) listening on this endpoint */
287 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
288 struct sk_buff_head rx_queue; /* Received packets */
289 struct list_head conn_attend_q; /* Conns requiring immediate attention */
290 struct list_head call_attend_q; /* Calls requiring immediate attention */
291
292 struct rb_root client_bundles; /* Client connection bundles by socket params */
293 spinlock_t client_bundles_lock; /* Lock for client_bundles */
294 bool kill_all_client_conns;
295 struct list_head idle_client_conns;
296 struct timer_list client_conn_reap_timer;
297 unsigned long client_conn_flags;
298#define RXRPC_CLIENT_CONN_REAP_TIMER 0 /* The client conn reap timer expired */
299
300 spinlock_t lock; /* access lock */
301 rwlock_t services_lock; /* lock for services list */
302 int debug_id; /* debug ID for printks */
303 bool dead;
304 bool service_closed; /* Service socket closed */
305 struct idr conn_ids; /* List of connection IDs */
306 struct list_head new_client_calls; /* Newly created client calls need connection */
307 spinlock_t client_call_lock; /* Lock for ->new_client_calls */
308 struct sockaddr_rxrpc srx; /* local address */
309};
310
311/*
312 * RxRPC remote transport endpoint definition
313 * - matched by local endpoint, remote port, address and protocol type
314 */
315struct rxrpc_peer {
316 struct rcu_head rcu; /* This must be first */
317 refcount_t ref;
318 unsigned long hash_key;
319 struct hlist_node hash_link;
320 struct rxrpc_local *local;
321 struct hlist_head error_targets; /* targets for net error distribution */
322 struct rb_root service_conns; /* Service connections */
323 struct list_head keepalive_link; /* Link in net->peer_keepalive[] */
324 time64_t last_tx_at; /* Last time packet sent here */
325 seqlock_t service_conn_lock;
326 spinlock_t lock; /* access lock */
327 unsigned int if_mtu; /* interface MTU for this peer */
328 unsigned int mtu; /* network MTU for this peer */
329 unsigned int maxdata; /* data size (MTU - hdrsize) */
330 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
331 int debug_id; /* debug ID for printks */
332 struct sockaddr_rxrpc srx; /* remote address */
333
334 /* calculated RTT cache */
335#define RXRPC_RTT_CACHE_SIZE 32
336 spinlock_t rtt_input_lock; /* RTT lock for input routine */
337 ktime_t rtt_last_req; /* Time of last RTT request */
338 unsigned int rtt_count; /* Number of samples we've got */
339
340 u32 srtt_us; /* smoothed round trip time << 3 in usecs */
341 u32 mdev_us; /* medium deviation */
342 u32 mdev_max_us; /* maximal mdev for the last rtt period */
343 u32 rttvar_us; /* smoothed mdev_max */
344 u32 rto_j; /* Retransmission timeout in jiffies */
345 u8 backoff; /* Backoff timeout */
346
347 u8 cong_ssthresh; /* Congestion slow-start threshold */
348};
349
350/*
351 * Keys for matching a connection.
352 */
353struct rxrpc_conn_proto {
354 union {
355 struct {
356 u32 epoch; /* epoch of this connection */
357 u32 cid; /* connection ID */
358 };
359 u64 index_key;
360 };
361};
362
363struct rxrpc_conn_parameters {
364 struct rxrpc_local *local; /* Representation of local endpoint */
365 struct key *key; /* Security details */
366 bool exclusive; /* T if conn is exclusive */
367 bool upgrade; /* T if service ID can be upgraded */
368 u16 service_id; /* Service ID for this connection */
369 u32 security_level; /* Security level selected */
370};
371
372/*
373 * Call completion condition (state == RXRPC_CALL_COMPLETE).
374 */
375enum rxrpc_call_completion {
376 RXRPC_CALL_SUCCEEDED, /* - Normal termination */
377 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
378 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
379 RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
380 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
381 NR__RXRPC_CALL_COMPLETIONS
382};
383
384/*
385 * Bits in the connection flags.
386 */
387enum rxrpc_conn_flag {
388 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
389 RXRPC_CONN_DONT_REUSE, /* Don't reuse this connection */
390 RXRPC_CONN_PROBING_FOR_UPGRADE, /* Probing for service upgrade */
391 RXRPC_CONN_FINAL_ACK_0, /* Need final ACK for channel 0 */
392 RXRPC_CONN_FINAL_ACK_1, /* Need final ACK for channel 1 */
393 RXRPC_CONN_FINAL_ACK_2, /* Need final ACK for channel 2 */
394 RXRPC_CONN_FINAL_ACK_3, /* Need final ACK for channel 3 */
395};
396
397#define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) | \
398 (1UL << RXRPC_CONN_FINAL_ACK_1) | \
399 (1UL << RXRPC_CONN_FINAL_ACK_2) | \
400 (1UL << RXRPC_CONN_FINAL_ACK_3))
401
402/*
403 * Events that can be raised upon a connection.
404 */
405enum rxrpc_conn_event {
406 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
407 RXRPC_CONN_EV_ABORT_CALLS, /* Abort attached calls */
408};
409
410/*
411 * The connection protocol state.
412 */
413enum rxrpc_conn_proto_state {
414 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
415 RXRPC_CONN_CLIENT_UNSECURED, /* Client connection needs security init */
416 RXRPC_CONN_CLIENT, /* Client connection */
417 RXRPC_CONN_SERVICE_PREALLOC, /* Service connection preallocation */
418 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
419 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
420 RXRPC_CONN_SERVICE, /* Service secured connection */
421 RXRPC_CONN_ABORTED, /* Conn aborted */
422 RXRPC_CONN__NR_STATES
423};
424
425/*
426 * RxRPC client connection bundle.
427 */
428struct rxrpc_bundle {
429 struct rxrpc_local *local; /* Representation of local endpoint */
430 struct rxrpc_peer *peer; /* Remote endpoint */
431 struct key *key; /* Security details */
432 const struct rxrpc_security *security; /* applied security module */
433 refcount_t ref;
434 atomic_t active; /* Number of active users */
435 unsigned int debug_id;
436 u32 security_level; /* Security level selected */
437 u16 service_id; /* Service ID for this connection */
438 bool try_upgrade; /* True if the bundle is attempting upgrade */
439 bool exclusive; /* T if conn is exclusive */
440 bool upgrade; /* T if service ID can be upgraded */
441 unsigned short alloc_error; /* Error from last conn allocation */
442 struct rb_node local_node; /* Node in local->client_conns */
443 struct list_head waiting_calls; /* Calls waiting for channels */
444 unsigned long avail_chans; /* Mask of available channels */
445 struct rxrpc_connection *conns[4]; /* The connections in the bundle (max 4) */
446};
447
448/*
449 * RxRPC connection definition
450 * - matched by { local, peer, epoch, conn_id, direction }
451 * - each connection can only handle four simultaneous calls
452 */
453struct rxrpc_connection {
454 struct rxrpc_conn_proto proto;
455 struct rxrpc_local *local; /* Representation of local endpoint */
456 struct rxrpc_peer *peer; /* Remote endpoint */
457 struct rxrpc_net *rxnet; /* Network namespace to which call belongs */
458 struct key *key; /* Security details */
459 struct list_head attend_link; /* Link in local->conn_attend_q */
460
461 refcount_t ref;
462 atomic_t active; /* Active count for service conns */
463 struct rcu_head rcu;
464 struct list_head cache_link;
465
466 unsigned char act_chans; /* Mask of active channels */
467 struct rxrpc_channel {
468 unsigned long final_ack_at; /* Time at which to issue final ACK */
469 struct rxrpc_call *call; /* Active call */
470 unsigned int call_debug_id; /* call->debug_id */
471 u32 call_id; /* ID of current call */
472 u32 call_counter; /* Call ID counter */
473 u32 last_call; /* ID of last call */
474 u8 last_type; /* Type of last packet */
475 union {
476 u32 last_seq;
477 u32 last_abort;
478 };
479 } channels[RXRPC_MAXCALLS];
480
481 struct timer_list timer; /* Conn event timer */
482 struct work_struct processor; /* connection event processor */
483 struct work_struct destructor; /* In-process-context destroyer */
484 struct rxrpc_bundle *bundle; /* Client connection bundle */
485 struct rb_node service_node; /* Node in peer->service_conns */
486 struct list_head proc_link; /* link in procfs list */
487 struct list_head link; /* link in master connection list */
488 struct sk_buff_head rx_queue; /* received conn-level packets */
489
490 struct mutex security_lock; /* Lock for security management */
491 const struct rxrpc_security *security; /* applied security module */
492 union {
493 struct {
494 struct crypto_sync_skcipher *cipher; /* encryption handle */
495 struct rxrpc_crypt csum_iv; /* packet checksum base */
496 u32 nonce; /* response re-use preventer */
497 } rxkad;
498 };
499 unsigned long flags;
500 unsigned long events;
501 unsigned long idle_timestamp; /* Time at which last became idle */
502 spinlock_t state_lock; /* state-change lock */
503 enum rxrpc_conn_proto_state state; /* current state of connection */
504 enum rxrpc_call_completion completion; /* Completion condition */
505 s32 abort_code; /* Abort code of connection abort */
506 int debug_id; /* debug ID for printks */
507 atomic_t serial; /* packet serial number counter */
508 unsigned int hi_serial; /* highest serial number received */
509 u32 service_id; /* Service ID, possibly upgraded */
510 u32 security_level; /* Security level selected */
511 u8 security_ix; /* security type */
512 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
513 u8 bundle_shift; /* Index into bundle->avail_chans */
514 bool exclusive; /* T if conn is exclusive */
515 bool upgrade; /* T if service ID can be upgraded */
516 u16 orig_service_id; /* Originally requested service ID */
517 short error; /* Local error code */
518};
519
520static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
521{
522 return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
523}
524
525static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
526{
527 return !rxrpc_to_server(sp);
528}
529
530/*
531 * Flags in call->flags.
532 */
533enum rxrpc_call_flag {
534 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
535 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
536 RXRPC_CALL_IS_SERVICE, /* Call is service call */
537 RXRPC_CALL_EXPOSED, /* The call was exposed to the world */
538 RXRPC_CALL_RX_LAST, /* Received the last packet (at rxtx_top) */
539 RXRPC_CALL_TX_LAST, /* Last packet in Tx buffer (at rxtx_top) */
540 RXRPC_CALL_TX_ALL_ACKED, /* Last packet has been hard-acked */
541 RXRPC_CALL_SEND_PING, /* A ping will need to be sent */
542 RXRPC_CALL_RETRANS_TIMEOUT, /* Retransmission due to timeout occurred */
543 RXRPC_CALL_BEGAN_RX_TIMER, /* We began the expect_rx_by timer */
544 RXRPC_CALL_RX_HEARD, /* The peer responded at least once to this call */
545 RXRPC_CALL_DISCONNECTED, /* The call has been disconnected */
546 RXRPC_CALL_KERNEL, /* The call was made by the kernel */
547 RXRPC_CALL_UPGRADE, /* Service upgrade was requested for the call */
548 RXRPC_CALL_EXCLUSIVE, /* The call uses a once-only connection */
549 RXRPC_CALL_RX_IS_IDLE, /* recvmsg() is idle - send an ACK */
550 RXRPC_CALL_RECVMSG_READ_ALL, /* recvmsg() read all of the received data */
551};
552
553/*
554 * Events that can be raised on a call.
555 */
556enum rxrpc_call_event {
557 RXRPC_CALL_EV_ACK_LOST, /* ACK may be lost, send ping */
558 RXRPC_CALL_EV_INITIAL_PING, /* Send initial ping for a new service call */
559};
560
561/*
562 * The states that a call can be in.
563 */
564enum rxrpc_call_state {
565 RXRPC_CALL_UNINITIALISED,
566 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
567 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
568 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
569 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
570 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
571 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
572 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
573 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
574 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
575 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
576 RXRPC_CALL_COMPLETE, /* - call complete */
577 NR__RXRPC_CALL_STATES
578};
579
580/*
581 * Call Tx congestion management modes.
582 */
583enum rxrpc_congest_mode {
584 RXRPC_CALL_SLOW_START,
585 RXRPC_CALL_CONGEST_AVOIDANCE,
586 RXRPC_CALL_PACKET_LOSS,
587 RXRPC_CALL_FAST_RETRANSMIT,
588 NR__RXRPC_CONGEST_MODES
589};
590
591/*
592 * RxRPC call definition
593 * - matched by { connection, call_id }
594 */
595struct rxrpc_call {
596 struct rcu_head rcu;
597 struct rxrpc_connection *conn; /* connection carrying call */
598 struct rxrpc_bundle *bundle; /* Connection bundle to use */
599 struct rxrpc_peer *peer; /* Peer record for remote address */
600 struct rxrpc_local *local; /* Representation of local endpoint */
601 struct rxrpc_sock __rcu *socket; /* socket responsible */
602 struct rxrpc_net *rxnet; /* Network namespace to which call belongs */
603 struct key *key; /* Security details */
604 const struct rxrpc_security *security; /* applied security module */
605 struct mutex user_mutex; /* User access mutex */
606 struct sockaddr_rxrpc dest_srx; /* Destination address */
607 unsigned long delay_ack_at; /* When DELAY ACK needs to happen */
608 unsigned long ack_lost_at; /* When ACK is figured as lost */
609 unsigned long resend_at; /* When next resend needs to happen */
610 unsigned long ping_at; /* When next to send a ping */
611 unsigned long keepalive_at; /* When next to send a keepalive ping */
612 unsigned long expect_rx_by; /* When we expect to get a packet by */
613 unsigned long expect_req_by; /* When we expect to get a request DATA packet by */
614 unsigned long expect_term_by; /* When we expect call termination by */
615 u32 next_rx_timo; /* Timeout for next Rx packet (jif) */
616 u32 next_req_timo; /* Timeout for next Rx request packet (jif) */
617 struct timer_list timer; /* Combined event timer */
618 struct work_struct destroyer; /* In-process-context destroyer */
619 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
620 struct list_head link; /* link in master call list */
621 struct list_head wait_link; /* Link in local->new_client_calls */
622 struct hlist_node error_link; /* link in error distribution list */
623 struct list_head accept_link; /* Link in rx->acceptq */
624 struct list_head recvmsg_link; /* Link in rx->recvmsg_q */
625 struct list_head sock_link; /* Link in rx->sock_calls */
626 struct rb_node sock_node; /* Node in rx->calls */
627 struct list_head attend_link; /* Link in local->call_attend_q */
628 struct rxrpc_txbuf *tx_pending; /* Tx buffer being filled */
629 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
630 s64 tx_total_len; /* Total length left to be transmitted (or -1) */
631 unsigned long user_call_ID; /* user-defined call ID */
632 unsigned long flags;
633 unsigned long events;
634 spinlock_t notify_lock; /* Kernel notification lock */
635 unsigned int send_abort_why; /* Why the abort [enum rxrpc_abort_reason] */
636 s32 send_abort; /* Abort code to be sent */
637 short send_abort_err; /* Error to be associated with the abort */
638 rxrpc_seq_t send_abort_seq; /* DATA packet that incurred the abort (or 0) */
639 s32 abort_code; /* Local/remote abort code */
640 int error; /* Local error incurred */
641 enum rxrpc_call_state _state; /* Current state of call (needs barrier) */
642 enum rxrpc_call_completion completion; /* Call completion condition */
643 refcount_t ref;
644 u8 security_ix; /* Security type */
645 enum rxrpc_interruptibility interruptibility; /* At what point call may be interrupted */
646 u32 call_id; /* call ID on connection */
647 u32 cid; /* connection ID plus channel index */
648 u32 security_level; /* Security level selected */
649 int debug_id; /* debug ID for printks */
650 unsigned short rx_pkt_offset; /* Current recvmsg packet offset */
651 unsigned short rx_pkt_len; /* Current recvmsg packet len */
652
653 /* Transmitted data tracking. */
654 spinlock_t tx_lock; /* Transmit queue lock */
655 struct list_head tx_sendmsg; /* Sendmsg prepared packets */
656 struct list_head tx_buffer; /* Buffer of transmissible packets */
657 rxrpc_seq_t tx_bottom; /* First packet in buffer */
658 rxrpc_seq_t tx_transmitted; /* Highest packet transmitted */
659 rxrpc_seq_t tx_prepared; /* Highest Tx slot prepared. */
660 rxrpc_seq_t tx_top; /* Highest Tx slot allocated. */
661 u16 tx_backoff; /* Delay to insert due to Tx failure */
662 u8 tx_winsize; /* Maximum size of Tx window */
663#define RXRPC_TX_MAX_WINDOW 128
664 ktime_t tx_last_sent; /* Last time a transmission occurred */
665
666 /* Received data tracking */
667 struct sk_buff_head recvmsg_queue; /* Queue of packets ready for recvmsg() */
668 struct sk_buff_head rx_oos_queue; /* Queue of out of sequence packets */
669
670 rxrpc_seq_t rx_highest_seq; /* Higest sequence number received */
671 rxrpc_seq_t rx_consumed; /* Highest packet consumed */
672 rxrpc_serial_t rx_serial; /* Highest serial received for this call */
673 u8 rx_winsize; /* Size of Rx window */
674
675 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
676 * is fixed, we keep these numbers in terms of segments (ie. DATA
677 * packets) rather than bytes.
678 */
679#define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
680#define RXRPC_MIN_CWND (RXRPC_TX_SMSS > 2190 ? 2 : RXRPC_TX_SMSS > 1095 ? 3 : 4)
681 u8 cong_cwnd; /* Congestion window size */
682 u8 cong_extra; /* Extra to send for congestion management */
683 u8 cong_ssthresh; /* Slow-start threshold */
684 enum rxrpc_congest_mode cong_mode:8; /* Congestion management mode */
685 u8 cong_dup_acks; /* Count of ACKs showing missing packets */
686 u8 cong_cumul_acks; /* Cumulative ACK count */
687 ktime_t cong_tstamp; /* Last time cwnd was changed */
688
689 /* Receive-phase ACK management (ACKs we send). */
690 u8 ackr_reason; /* reason to ACK */
691 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
692 atomic64_t ackr_window; /* Base (in LSW) and top (in MSW) of SACK window */
693 atomic_t ackr_nr_unacked; /* Number of unacked packets */
694 atomic_t ackr_nr_consumed; /* Number of packets needing hard ACK */
695 struct {
696#define RXRPC_SACK_SIZE 256
697 /* SACK table for soft-acked packets */
698 u8 ackr_sack_table[RXRPC_SACK_SIZE];
699 } __aligned(8);
700
701 /* RTT management */
702 rxrpc_serial_t rtt_serial[4]; /* Serial number of DATA or PING sent */
703 ktime_t rtt_sent_at[4]; /* Time packet sent */
704 unsigned long rtt_avail; /* Mask of available slots in bits 0-3,
705 * Mask of pending samples in 8-11 */
706#define RXRPC_CALL_RTT_AVAIL_MASK 0xf
707#define RXRPC_CALL_RTT_PEND_SHIFT 8
708
709 /* Transmission-phase ACK management (ACKs we've received). */
710 ktime_t acks_latest_ts; /* Timestamp of latest ACK received */
711 rxrpc_seq_t acks_first_seq; /* first sequence number received */
712 rxrpc_seq_t acks_prev_seq; /* Highest previousPacket received */
713 rxrpc_seq_t acks_hard_ack; /* Latest hard-ack point */
714 rxrpc_seq_t acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
715 rxrpc_serial_t acks_highest_serial; /* Highest serial number ACK'd */
716};
717
718/*
719 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
720 */
721struct rxrpc_ack_summary {
722 u16 nr_acks; /* Number of ACKs in packet */
723 u16 nr_new_acks; /* Number of new ACKs in packet */
724 u16 nr_rot_new_acks; /* Number of rotated new ACKs */
725 u8 ack_reason;
726 bool saw_nacks; /* Saw NACKs in packet */
727 bool new_low_nack; /* T if new low NACK found */
728 bool retrans_timeo; /* T if reTx due to timeout happened */
729 u8 flight_size; /* Number of unreceived transmissions */
730 /* Place to stash values for tracing */
731 enum rxrpc_congest_mode mode:8;
732 u8 cwnd;
733 u8 ssthresh;
734 u8 dup_acks;
735 u8 cumulative_acks;
736};
737
738/*
739 * sendmsg() cmsg-specified parameters.
740 */
741enum rxrpc_command {
742 RXRPC_CMD_SEND_DATA, /* send data message */
743 RXRPC_CMD_SEND_ABORT, /* request abort generation */
744 RXRPC_CMD_REJECT_BUSY, /* [server] reject a call as busy */
745 RXRPC_CMD_CHARGE_ACCEPT, /* [server] charge accept preallocation */
746};
747
748struct rxrpc_call_params {
749 s64 tx_total_len; /* Total Tx data length (if send data) */
750 unsigned long user_call_ID; /* User's call ID */
751 struct {
752 u32 hard; /* Maximum lifetime (sec) */
753 u32 idle; /* Max time since last data packet (msec) */
754 u32 normal; /* Max time since last call packet (msec) */
755 } timeouts;
756 u8 nr_timeouts; /* Number of timeouts specified */
757 bool kernel; /* T if kernel is making the call */
758 enum rxrpc_interruptibility interruptibility; /* How is interruptible is the call? */
759};
760
761struct rxrpc_send_params {
762 struct rxrpc_call_params call;
763 u32 abort_code; /* Abort code to Tx (if abort) */
764 enum rxrpc_command command : 8; /* The command to implement */
765 bool exclusive; /* Shared or exclusive call */
766 bool upgrade; /* If the connection is upgradeable */
767};
768
769/*
770 * Buffer of data to be output as a packet.
771 */
772struct rxrpc_txbuf {
773 struct rcu_head rcu;
774 struct list_head call_link; /* Link in call->tx_sendmsg/tx_buffer */
775 struct list_head tx_link; /* Link in live Enc queue or Tx queue */
776 ktime_t last_sent; /* Time at which last transmitted */
777 refcount_t ref;
778 rxrpc_seq_t seq; /* Sequence number of this packet */
779 unsigned int call_debug_id;
780 unsigned int debug_id;
781 unsigned int len; /* Amount of data in buffer */
782 unsigned int space; /* Remaining data space */
783 unsigned int offset; /* Offset of fill point */
784 unsigned long flags;
785#define RXRPC_TXBUF_LAST 0 /* Set if last packet in Tx phase */
786#define RXRPC_TXBUF_RESENT 1 /* Set if has been resent */
787 u8 /*enum rxrpc_propose_ack_trace*/ ack_why; /* If ack, why */
788 struct {
789 /* The packet for encrypting and DMA'ing. We align it such
790 * that data[] aligns correctly for any crypto blocksize.
791 */
792 u8 pad[64 - sizeof(struct rxrpc_wire_header)];
793 struct rxrpc_wire_header wire; /* Network-ready header */
794 union {
795 u8 data[RXRPC_JUMBO_DATALEN]; /* Data packet */
796 struct {
797 struct rxrpc_ackpacket ack;
798 u8 acks[0];
799 };
800 };
801 } __aligned(64);
802};
803
804static inline bool rxrpc_sending_to_server(const struct rxrpc_txbuf *txb)
805{
806 return txb->wire.flags & RXRPC_CLIENT_INITIATED;
807}
808
809static inline bool rxrpc_sending_to_client(const struct rxrpc_txbuf *txb)
810{
811 return !rxrpc_sending_to_server(txb);
812}
813
814#include <trace/events/rxrpc.h>
815
816/*
817 * af_rxrpc.c
818 */
819extern atomic_t rxrpc_n_rx_skbs;
820extern struct workqueue_struct *rxrpc_workqueue;
821
822/*
823 * call_accept.c
824 */
825int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
826void rxrpc_discard_prealloc(struct rxrpc_sock *);
827bool rxrpc_new_incoming_call(struct rxrpc_local *local,
828 struct rxrpc_peer *peer,
829 struct rxrpc_connection *conn,
830 struct sockaddr_rxrpc *peer_srx,
831 struct sk_buff *skb);
832void rxrpc_accept_incoming_calls(struct rxrpc_local *);
833int rxrpc_user_charge_accept(struct rxrpc_sock *, unsigned long);
834
835/*
836 * call_event.c
837 */
838void rxrpc_propose_ping(struct rxrpc_call *call, u32 serial,
839 enum rxrpc_propose_ack_trace why);
840void rxrpc_send_ACK(struct rxrpc_call *, u8, rxrpc_serial_t, enum rxrpc_propose_ack_trace);
841void rxrpc_propose_delay_ACK(struct rxrpc_call *, rxrpc_serial_t,
842 enum rxrpc_propose_ack_trace);
843void rxrpc_shrink_call_tx_buffer(struct rxrpc_call *);
844void rxrpc_resend(struct rxrpc_call *call, struct sk_buff *ack_skb);
845
846void rxrpc_reduce_call_timer(struct rxrpc_call *call,
847 unsigned long expire_at,
848 unsigned long now,
849 enum rxrpc_timer_trace why);
850
851bool rxrpc_input_call_event(struct rxrpc_call *call, struct sk_buff *skb);
852
853/*
854 * call_object.c
855 */
856extern const char *const rxrpc_call_states[];
857extern const char *const rxrpc_call_completions[];
858extern struct kmem_cache *rxrpc_call_jar;
859
860void rxrpc_poke_call(struct rxrpc_call *call, enum rxrpc_call_poke_trace what);
861struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
862struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
863struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
864 struct rxrpc_conn_parameters *,
865 struct sockaddr_rxrpc *,
866 struct rxrpc_call_params *, gfp_t,
867 unsigned int);
868void rxrpc_start_call_timer(struct rxrpc_call *call);
869void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
870 struct sk_buff *);
871void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
872void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
873void rxrpc_see_call(struct rxrpc_call *, enum rxrpc_call_trace);
874struct rxrpc_call *rxrpc_try_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
875void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
876void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
877void rxrpc_cleanup_call(struct rxrpc_call *);
878void rxrpc_destroy_all_calls(struct rxrpc_net *);
879
880static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
881{
882 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
883}
884
885static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
886{
887 return !rxrpc_is_service_call(call);
888}
889
890/*
891 * call_state.c
892 */
893bool rxrpc_set_call_completion(struct rxrpc_call *call,
894 enum rxrpc_call_completion compl,
895 u32 abort_code,
896 int error);
897bool rxrpc_call_completed(struct rxrpc_call *call);
898bool rxrpc_abort_call(struct rxrpc_call *call, rxrpc_seq_t seq,
899 u32 abort_code, int error, enum rxrpc_abort_reason why);
900void rxrpc_prefail_call(struct rxrpc_call *call, enum rxrpc_call_completion compl,
901 int error);
902
903static inline void rxrpc_set_call_state(struct rxrpc_call *call,
904 enum rxrpc_call_state state)
905{
906 /* Order write of completion info before write of ->state. */
907 smp_store_release(&call->_state, state);
908 wake_up(&call->waitq);
909}
910
911static inline enum rxrpc_call_state __rxrpc_call_state(const struct rxrpc_call *call)
912{
913 return call->_state; /* Only inside I/O thread */
914}
915
916static inline bool __rxrpc_call_is_complete(const struct rxrpc_call *call)
917{
918 return __rxrpc_call_state(call) == RXRPC_CALL_COMPLETE;
919}
920
921static inline enum rxrpc_call_state rxrpc_call_state(const struct rxrpc_call *call)
922{
923 /* Order read ->state before read of completion info. */
924 return smp_load_acquire(&call->_state);
925}
926
927static inline bool rxrpc_call_is_complete(const struct rxrpc_call *call)
928{
929 return rxrpc_call_state(call) == RXRPC_CALL_COMPLETE;
930}
931
932static inline bool rxrpc_call_has_failed(const struct rxrpc_call *call)
933{
934 return rxrpc_call_is_complete(call) && call->completion != RXRPC_CALL_SUCCEEDED;
935}
936
937/*
938 * conn_client.c
939 */
940extern unsigned int rxrpc_reap_client_connections;
941extern unsigned long rxrpc_conn_idle_client_expiry;
942extern unsigned long rxrpc_conn_idle_client_fast_expiry;
943
944void rxrpc_purge_client_connections(struct rxrpc_local *local);
945struct rxrpc_bundle *rxrpc_get_bundle(struct rxrpc_bundle *, enum rxrpc_bundle_trace);
946void rxrpc_put_bundle(struct rxrpc_bundle *, enum rxrpc_bundle_trace);
947int rxrpc_look_up_bundle(struct rxrpc_call *call, gfp_t gfp);
948void rxrpc_connect_client_calls(struct rxrpc_local *local);
949void rxrpc_expose_client_call(struct rxrpc_call *);
950void rxrpc_disconnect_client_call(struct rxrpc_bundle *, struct rxrpc_call *);
951void rxrpc_deactivate_bundle(struct rxrpc_bundle *bundle);
952void rxrpc_put_client_conn(struct rxrpc_connection *, enum rxrpc_conn_trace);
953void rxrpc_discard_expired_client_conns(struct rxrpc_local *local);
954void rxrpc_clean_up_local_conns(struct rxrpc_local *);
955
956/*
957 * conn_event.c
958 */
959void rxrpc_conn_retransmit_call(struct rxrpc_connection *conn, struct sk_buff *skb,
960 unsigned int channel);
961int rxrpc_abort_conn(struct rxrpc_connection *conn, struct sk_buff *skb,
962 s32 abort_code, int err, enum rxrpc_abort_reason why);
963void rxrpc_process_connection(struct work_struct *);
964void rxrpc_process_delayed_final_acks(struct rxrpc_connection *, bool);
965bool rxrpc_input_conn_packet(struct rxrpc_connection *conn, struct sk_buff *skb);
966void rxrpc_input_conn_event(struct rxrpc_connection *conn, struct sk_buff *skb);
967
968static inline bool rxrpc_is_conn_aborted(const struct rxrpc_connection *conn)
969{
970 /* Order reading the abort info after the state check. */
971 return smp_load_acquire(&conn->state) == RXRPC_CONN_ABORTED;
972}
973
974/*
975 * conn_object.c
976 */
977extern unsigned int rxrpc_connection_expiry;
978extern unsigned int rxrpc_closed_conn_expiry;
979
980void rxrpc_poke_conn(struct rxrpc_connection *conn, enum rxrpc_conn_trace why);
981struct rxrpc_connection *rxrpc_alloc_connection(struct rxrpc_net *, gfp_t);
982struct rxrpc_connection *rxrpc_find_client_connection_rcu(struct rxrpc_local *,
983 struct sockaddr_rxrpc *,
984 struct sk_buff *);
985void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
986void rxrpc_disconnect_call(struct rxrpc_call *);
987void rxrpc_kill_client_conn(struct rxrpc_connection *);
988void rxrpc_queue_conn(struct rxrpc_connection *, enum rxrpc_conn_trace);
989void rxrpc_see_connection(struct rxrpc_connection *, enum rxrpc_conn_trace);
990struct rxrpc_connection *rxrpc_get_connection(struct rxrpc_connection *,
991 enum rxrpc_conn_trace);
992struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *,
993 enum rxrpc_conn_trace);
994void rxrpc_put_connection(struct rxrpc_connection *, enum rxrpc_conn_trace);
995void rxrpc_service_connection_reaper(struct work_struct *);
996void rxrpc_destroy_all_connections(struct rxrpc_net *);
997
998static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
999{
1000 return conn->out_clientflag;
1001}
1002
1003static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
1004{
1005 return !rxrpc_conn_is_client(conn);
1006}
1007
1008static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
1009 unsigned long expire_at)
1010{
1011 timer_reduce(&conn->timer, expire_at);
1012}
1013
1014/*
1015 * conn_service.c
1016 */
1017struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
1018 struct sk_buff *);
1019struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
1020void rxrpc_new_incoming_connection(struct rxrpc_sock *, struct rxrpc_connection *,
1021 const struct rxrpc_security *, struct sk_buff *);
1022void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
1023
1024/*
1025 * input.c
1026 */
1027void rxrpc_congestion_degrade(struct rxrpc_call *);
1028void rxrpc_input_call_packet(struct rxrpc_call *, struct sk_buff *);
1029void rxrpc_implicit_end_call(struct rxrpc_call *, struct sk_buff *);
1030
1031/*
1032 * io_thread.c
1033 */
1034int rxrpc_encap_rcv(struct sock *, struct sk_buff *);
1035void rxrpc_error_report(struct sock *);
1036bool rxrpc_direct_abort(struct sk_buff *skb, enum rxrpc_abort_reason why,
1037 s32 abort_code, int err);
1038int rxrpc_io_thread(void *data);
1039static inline void rxrpc_wake_up_io_thread(struct rxrpc_local *local)
1040{
1041 wake_up_process(local->io_thread);
1042}
1043
1044static inline bool rxrpc_protocol_error(struct sk_buff *skb, enum rxrpc_abort_reason why)
1045{
1046 return rxrpc_direct_abort(skb, why, RX_PROTOCOL_ERROR, -EPROTO);
1047}
1048
1049/*
1050 * insecure.c
1051 */
1052extern const struct rxrpc_security rxrpc_no_security;
1053
1054/*
1055 * key.c
1056 */
1057extern struct key_type key_type_rxrpc;
1058
1059int rxrpc_request_key(struct rxrpc_sock *, sockptr_t , int);
1060int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
1061 u32);
1062
1063/*
1064 * local_event.c
1065 */
1066void rxrpc_send_version_request(struct rxrpc_local *local,
1067 struct rxrpc_host_header *hdr,
1068 struct sk_buff *skb);
1069
1070/*
1071 * local_object.c
1072 */
1073struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
1074struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *, enum rxrpc_local_trace);
1075struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *, enum rxrpc_local_trace);
1076void rxrpc_put_local(struct rxrpc_local *, enum rxrpc_local_trace);
1077struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *, enum rxrpc_local_trace);
1078void rxrpc_unuse_local(struct rxrpc_local *, enum rxrpc_local_trace);
1079void rxrpc_destroy_local(struct rxrpc_local *local);
1080void rxrpc_destroy_all_locals(struct rxrpc_net *);
1081
1082static inline bool __rxrpc_use_local(struct rxrpc_local *local,
1083 enum rxrpc_local_trace why)
1084{
1085 int r, u;
1086
1087 r = refcount_read(&local->ref);
1088 u = atomic_fetch_add_unless(&local->active_users, 1, 0);
1089 trace_rxrpc_local(local->debug_id, why, r, u);
1090 return u != 0;
1091}
1092
1093static inline void rxrpc_see_local(struct rxrpc_local *local,
1094 enum rxrpc_local_trace why)
1095{
1096 int r, u;
1097
1098 r = refcount_read(&local->ref);
1099 u = atomic_read(&local->active_users);
1100 trace_rxrpc_local(local->debug_id, why, r, u);
1101}
1102
1103/*
1104 * misc.c
1105 */
1106extern unsigned int rxrpc_max_backlog __read_mostly;
1107extern unsigned long rxrpc_soft_ack_delay;
1108extern unsigned long rxrpc_idle_ack_delay;
1109extern unsigned int rxrpc_rx_window_size;
1110extern unsigned int rxrpc_rx_mtu;
1111extern unsigned int rxrpc_rx_jumbo_max;
1112
1113/*
1114 * net_ns.c
1115 */
1116extern unsigned int rxrpc_net_id;
1117extern struct pernet_operations rxrpc_net_ops;
1118
1119static inline struct rxrpc_net *rxrpc_net(struct net *net)
1120{
1121 return net_generic(net, rxrpc_net_id);
1122}
1123
1124/*
1125 * output.c
1126 */
1127int rxrpc_send_ack_packet(struct rxrpc_call *call, struct rxrpc_txbuf *txb);
1128int rxrpc_send_abort_packet(struct rxrpc_call *);
1129int rxrpc_send_data_packet(struct rxrpc_call *, struct rxrpc_txbuf *);
1130void rxrpc_send_conn_abort(struct rxrpc_connection *conn);
1131void rxrpc_reject_packet(struct rxrpc_local *local, struct sk_buff *skb);
1132void rxrpc_send_keepalive(struct rxrpc_peer *);
1133void rxrpc_transmit_one(struct rxrpc_call *call, struct rxrpc_txbuf *txb);
1134
1135/*
1136 * peer_event.c
1137 */
1138void rxrpc_input_error(struct rxrpc_local *, struct sk_buff *);
1139void rxrpc_peer_keepalive_worker(struct work_struct *);
1140
1141/*
1142 * peer_object.c
1143 */
1144struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1145 const struct sockaddr_rxrpc *);
1146struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *local,
1147 struct sockaddr_rxrpc *srx, gfp_t gfp);
1148struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t,
1149 enum rxrpc_peer_trace);
1150void rxrpc_new_incoming_peer(struct rxrpc_local *local, struct rxrpc_peer *peer);
1151void rxrpc_destroy_all_peers(struct rxrpc_net *);
1152struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *, enum rxrpc_peer_trace);
1153struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *, enum rxrpc_peer_trace);
1154void rxrpc_put_peer(struct rxrpc_peer *, enum rxrpc_peer_trace);
1155
1156/*
1157 * proc.c
1158 */
1159extern const struct seq_operations rxrpc_call_seq_ops;
1160extern const struct seq_operations rxrpc_connection_seq_ops;
1161extern const struct seq_operations rxrpc_peer_seq_ops;
1162extern const struct seq_operations rxrpc_local_seq_ops;
1163
1164/*
1165 * recvmsg.c
1166 */
1167void rxrpc_notify_socket(struct rxrpc_call *);
1168int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1169
1170/*
1171 * Abort a call due to a protocol error.
1172 */
1173static inline int rxrpc_abort_eproto(struct rxrpc_call *call,
1174 struct sk_buff *skb,
1175 s32 abort_code,
1176 enum rxrpc_abort_reason why)
1177{
1178 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
1179
1180 rxrpc_abort_call(call, sp->hdr.seq, abort_code, -EPROTO, why);
1181 return -EPROTO;
1182}
1183
1184/*
1185 * rtt.c
1186 */
1187void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace, int,
1188 rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1189unsigned long rxrpc_get_rto_backoff(struct rxrpc_peer *, bool);
1190void rxrpc_peer_init_rtt(struct rxrpc_peer *);
1191
1192/*
1193 * rxkad.c
1194 */
1195#ifdef CONFIG_RXKAD
1196extern const struct rxrpc_security rxkad;
1197#endif
1198
1199/*
1200 * security.c
1201 */
1202int __init rxrpc_init_security(void);
1203const struct rxrpc_security *rxrpc_security_lookup(u8);
1204void rxrpc_exit_security(void);
1205int rxrpc_init_client_call_security(struct rxrpc_call *);
1206int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1207const struct rxrpc_security *rxrpc_get_incoming_security(struct rxrpc_sock *,
1208 struct sk_buff *);
1209struct key *rxrpc_look_up_server_security(struct rxrpc_connection *,
1210 struct sk_buff *, u32, u32);
1211
1212/*
1213 * sendmsg.c
1214 */
1215bool rxrpc_propose_abort(struct rxrpc_call *call, s32 abort_code, int error,
1216 enum rxrpc_abort_reason why);
1217int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1218
1219/*
1220 * server_key.c
1221 */
1222extern struct key_type key_type_rxrpc_s;
1223
1224int rxrpc_server_keyring(struct rxrpc_sock *, sockptr_t, int);
1225
1226/*
1227 * skbuff.c
1228 */
1229void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1230void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1231void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1232void rxrpc_eaten_skb(struct sk_buff *, enum rxrpc_skb_trace);
1233void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1234void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1235void rxrpc_purge_queue(struct sk_buff_head *);
1236
1237/*
1238 * stats.c
1239 */
1240int rxrpc_stats_show(struct seq_file *seq, void *v);
1241int rxrpc_stats_clear(struct file *file, char *buf, size_t size);
1242
1243#define rxrpc_inc_stat(rxnet, s) atomic_inc(&(rxnet)->s)
1244#define rxrpc_dec_stat(rxnet, s) atomic_dec(&(rxnet)->s)
1245
1246/*
1247 * sysctl.c
1248 */
1249#ifdef CONFIG_SYSCTL
1250extern int __init rxrpc_sysctl_init(void);
1251extern void rxrpc_sysctl_exit(void);
1252#else
1253static inline int __init rxrpc_sysctl_init(void) { return 0; }
1254static inline void rxrpc_sysctl_exit(void) {}
1255#endif
1256
1257/*
1258 * txbuf.c
1259 */
1260extern atomic_t rxrpc_nr_txbuf;
1261struct rxrpc_txbuf *rxrpc_alloc_txbuf(struct rxrpc_call *call, u8 packet_type,
1262 gfp_t gfp);
1263void rxrpc_get_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1264void rxrpc_see_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1265void rxrpc_put_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1266
1267/*
1268 * utils.c
1269 */
1270int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1271
1272static inline bool before(u32 seq1, u32 seq2)
1273{
1274 return (s32)(seq1 - seq2) < 0;
1275}
1276static inline bool before_eq(u32 seq1, u32 seq2)
1277{
1278 return (s32)(seq1 - seq2) <= 0;
1279}
1280static inline bool after(u32 seq1, u32 seq2)
1281{
1282 return (s32)(seq1 - seq2) > 0;
1283}
1284static inline bool after_eq(u32 seq1, u32 seq2)
1285{
1286 return (s32)(seq1 - seq2) >= 0;
1287}
1288
1289/*
1290 * debug tracing
1291 */
1292extern unsigned int rxrpc_debug;
1293
1294#define dbgprintk(FMT,...) \
1295 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1296
1297#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1298#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1299#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1300
1301
1302#if defined(__KDEBUG)
1303#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1304#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1305#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1306
1307#elif defined(CONFIG_AF_RXRPC_DEBUG)
1308#define RXRPC_DEBUG_KENTER 0x01
1309#define RXRPC_DEBUG_KLEAVE 0x02
1310#define RXRPC_DEBUG_KDEBUG 0x04
1311
1312#define _enter(FMT,...) \
1313do { \
1314 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1315 kenter(FMT,##__VA_ARGS__); \
1316} while (0)
1317
1318#define _leave(FMT,...) \
1319do { \
1320 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1321 kleave(FMT,##__VA_ARGS__); \
1322} while (0)
1323
1324#define _debug(FMT,...) \
1325do { \
1326 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1327 kdebug(FMT,##__VA_ARGS__); \
1328} while (0)
1329
1330#else
1331#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1332#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1333#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1334#endif
1335
1336/*
1337 * debug assertion checking
1338 */
1339#if 1 // defined(__KDEBUGALL)
1340
1341#define ASSERT(X) \
1342do { \
1343 if (unlikely(!(X))) { \
1344 pr_err("Assertion failed\n"); \
1345 BUG(); \
1346 } \
1347} while (0)
1348
1349#define ASSERTCMP(X, OP, Y) \
1350do { \
1351 __typeof__(X) _x = (X); \
1352 __typeof__(Y) _y = (__typeof__(X))(Y); \
1353 if (unlikely(!(_x OP _y))) { \
1354 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1355 (unsigned long)_x, (unsigned long)_x, #OP, \
1356 (unsigned long)_y, (unsigned long)_y); \
1357 BUG(); \
1358 } \
1359} while (0)
1360
1361#define ASSERTIF(C, X) \
1362do { \
1363 if (unlikely((C) && !(X))) { \
1364 pr_err("Assertion failed\n"); \
1365 BUG(); \
1366 } \
1367} while (0)
1368
1369#define ASSERTIFCMP(C, X, OP, Y) \
1370do { \
1371 __typeof__(X) _x = (X); \
1372 __typeof__(Y) _y = (__typeof__(X))(Y); \
1373 if (unlikely((C) && !(_x OP _y))) { \
1374 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1375 (unsigned long)_x, (unsigned long)_x, #OP, \
1376 (unsigned long)_y, (unsigned long)_y); \
1377 BUG(); \
1378 } \
1379} while (0)
1380
1381#else
1382
1383#define ASSERT(X) \
1384do { \
1385} while (0)
1386
1387#define ASSERTCMP(X, OP, Y) \
1388do { \
1389} while (0)
1390
1391#define ASSERTIF(C, X) \
1392do { \
1393} while (0)
1394
1395#define ASSERTIFCMP(C, X, OP, Y) \
1396do { \
1397} while (0)
1398
1399#endif /* __KDEBUGALL */