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/* AF_RXRPC internal definitions
2 *
3 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
12#include <linux/atomic.h>
13#include <linux/seqlock.h>
14#include <net/sock.h>
15#include <net/af_rxrpc.h>
16#include <rxrpc/packet.h>
17
18#if 0
19#define CHECK_SLAB_OKAY(X) \
20 BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
21 (POISON_FREE << 8 | POISON_FREE))
22#else
23#define CHECK_SLAB_OKAY(X) do {} while (0)
24#endif
25
26#define FCRYPT_BSIZE 8
27struct rxrpc_crypt {
28 union {
29 u8 x[FCRYPT_BSIZE];
30 __be32 n[2];
31 };
32} __attribute__((aligned(8)));
33
34#define rxrpc_queue_work(WS) queue_work(rxrpc_workqueue, (WS))
35#define rxrpc_queue_delayed_work(WS,D) \
36 queue_delayed_work(rxrpc_workqueue, (WS), (D))
37
38struct rxrpc_connection;
39
40/*
41 * Mark applied to socket buffers.
42 */
43enum rxrpc_skb_mark {
44 RXRPC_SKB_MARK_DATA, /* data message */
45 RXRPC_SKB_MARK_FINAL_ACK, /* final ACK received message */
46 RXRPC_SKB_MARK_BUSY, /* server busy message */
47 RXRPC_SKB_MARK_REMOTE_ABORT, /* remote abort message */
48 RXRPC_SKB_MARK_LOCAL_ABORT, /* local abort message */
49 RXRPC_SKB_MARK_NET_ERROR, /* network error message */
50 RXRPC_SKB_MARK_LOCAL_ERROR, /* local error message */
51 RXRPC_SKB_MARK_NEW_CALL, /* local error message */
52};
53
54/*
55 * sk_state for RxRPC sockets
56 */
57enum {
58 RXRPC_UNBOUND = 0,
59 RXRPC_CLIENT_UNBOUND, /* Unbound socket used as client */
60 RXRPC_CLIENT_BOUND, /* client local address bound */
61 RXRPC_SERVER_BOUND, /* server local address bound */
62 RXRPC_SERVER_LISTENING, /* server listening for connections */
63 RXRPC_CLOSE, /* socket is being closed */
64};
65
66/*
67 * Service backlog preallocation.
68 *
69 * This contains circular buffers of preallocated peers, connections and calls
70 * for incoming service calls and their head and tail pointers. This allows
71 * calls to be set up in the data_ready handler, thereby avoiding the need to
72 * shuffle packets around so much.
73 */
74struct rxrpc_backlog {
75 unsigned short peer_backlog_head;
76 unsigned short peer_backlog_tail;
77 unsigned short conn_backlog_head;
78 unsigned short conn_backlog_tail;
79 unsigned short call_backlog_head;
80 unsigned short call_backlog_tail;
81#define RXRPC_BACKLOG_MAX 32
82 struct rxrpc_peer *peer_backlog[RXRPC_BACKLOG_MAX];
83 struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
84 struct rxrpc_call *call_backlog[RXRPC_BACKLOG_MAX];
85};
86
87/*
88 * RxRPC socket definition
89 */
90struct rxrpc_sock {
91 /* WARNING: sk has to be the first member */
92 struct sock sk;
93 rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
94 rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
95 struct rxrpc_local *local; /* local endpoint */
96 struct rxrpc_backlog *backlog; /* Preallocation for services */
97 spinlock_t incoming_lock; /* Incoming call vs service shutdown lock */
98 struct list_head sock_calls; /* List of calls owned by this socket */
99 struct list_head to_be_accepted; /* calls awaiting acceptance */
100 struct list_head recvmsg_q; /* Calls awaiting recvmsg's attention */
101 rwlock_t recvmsg_lock; /* Lock for recvmsg_q */
102 struct key *key; /* security for this socket */
103 struct key *securities; /* list of server security descriptors */
104 struct rb_root calls; /* User ID -> call mapping */
105 unsigned long flags;
106#define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
107 rwlock_t call_lock; /* lock for calls */
108 u32 min_sec_level; /* minimum security level */
109#define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
110 bool exclusive; /* Exclusive connection for a client socket */
111 sa_family_t family; /* Protocol family created with */
112 struct sockaddr_rxrpc srx; /* local address */
113 struct sockaddr_rxrpc connect_srx; /* Default client address from connect() */
114};
115
116#define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
117
118/*
119 * CPU-byteorder normalised Rx packet header.
120 */
121struct rxrpc_host_header {
122 u32 epoch; /* client boot timestamp */
123 u32 cid; /* connection and channel ID */
124 u32 callNumber; /* call ID (0 for connection-level packets) */
125 u32 seq; /* sequence number of pkt in call stream */
126 u32 serial; /* serial number of pkt sent to network */
127 u8 type; /* packet type */
128 u8 flags; /* packet flags */
129 u8 userStatus; /* app-layer defined status */
130 u8 securityIndex; /* security protocol ID */
131 union {
132 u16 _rsvd; /* reserved */
133 u16 cksum; /* kerberos security checksum */
134 };
135 u16 serviceId; /* service ID */
136} __packed;
137
138/*
139 * RxRPC socket buffer private variables
140 * - max 48 bytes (struct sk_buff::cb)
141 */
142struct rxrpc_skb_priv {
143 union {
144 u8 nr_jumbo; /* Number of jumbo subpackets */
145 };
146 union {
147 int remain; /* amount of space remaining for next write */
148 };
149
150 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
151};
152
153#define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
154
155/*
156 * RxRPC security module interface
157 */
158struct rxrpc_security {
159 const char *name; /* name of this service */
160 u8 security_index; /* security type provided */
161
162 /* Initialise a security service */
163 int (*init)(void);
164
165 /* Clean up a security service */
166 void (*exit)(void);
167
168 /* initialise a connection's security */
169 int (*init_connection_security)(struct rxrpc_connection *);
170
171 /* prime a connection's packet security */
172 int (*prime_packet_security)(struct rxrpc_connection *);
173
174 /* impose security on a packet */
175 int (*secure_packet)(struct rxrpc_call *,
176 struct sk_buff *,
177 size_t,
178 void *);
179
180 /* verify the security on a received packet */
181 int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
182 unsigned int, unsigned int, rxrpc_seq_t, u16);
183
184 /* Locate the data in a received packet that has been verified. */
185 void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
186 unsigned int *, unsigned int *);
187
188 /* issue a challenge */
189 int (*issue_challenge)(struct rxrpc_connection *);
190
191 /* respond to a challenge */
192 int (*respond_to_challenge)(struct rxrpc_connection *,
193 struct sk_buff *,
194 u32 *);
195
196 /* verify a response */
197 int (*verify_response)(struct rxrpc_connection *,
198 struct sk_buff *,
199 u32 *);
200
201 /* clear connection security */
202 void (*clear)(struct rxrpc_connection *);
203};
204
205/*
206 * RxRPC local transport endpoint description
207 * - owned by a single AF_RXRPC socket
208 * - pointed to by transport socket struct sk_user_data
209 */
210struct rxrpc_local {
211 struct rcu_head rcu;
212 atomic_t usage;
213 struct list_head link;
214 struct socket *socket; /* my UDP socket */
215 struct work_struct processor;
216 struct rxrpc_sock __rcu *service; /* Service(s) listening on this endpoint */
217 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
218 struct sk_buff_head reject_queue; /* packets awaiting rejection */
219 struct sk_buff_head event_queue; /* endpoint event packets awaiting processing */
220 struct rb_root client_conns; /* Client connections by socket params */
221 spinlock_t client_conns_lock; /* Lock for client_conns */
222 spinlock_t lock; /* access lock */
223 rwlock_t services_lock; /* lock for services list */
224 int debug_id; /* debug ID for printks */
225 bool dead;
226 struct sockaddr_rxrpc srx; /* local address */
227};
228
229/*
230 * RxRPC remote transport endpoint definition
231 * - matched by local endpoint, remote port, address and protocol type
232 */
233struct rxrpc_peer {
234 struct rcu_head rcu; /* This must be first */
235 atomic_t usage;
236 unsigned long hash_key;
237 struct hlist_node hash_link;
238 struct rxrpc_local *local;
239 struct hlist_head error_targets; /* targets for net error distribution */
240 struct work_struct error_distributor;
241 struct rb_root service_conns; /* Service connections */
242 seqlock_t service_conn_lock;
243 spinlock_t lock; /* access lock */
244 unsigned int if_mtu; /* interface MTU for this peer */
245 unsigned int mtu; /* network MTU for this peer */
246 unsigned int maxdata; /* data size (MTU - hdrsize) */
247 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
248 int debug_id; /* debug ID for printks */
249 int error_report; /* Net (+0) or local (+1000000) to distribute */
250#define RXRPC_LOCAL_ERROR_OFFSET 1000000
251 struct sockaddr_rxrpc srx; /* remote address */
252
253 /* calculated RTT cache */
254#define RXRPC_RTT_CACHE_SIZE 32
255 ktime_t rtt_last_req; /* Time of last RTT request */
256 u64 rtt; /* Current RTT estimate (in nS) */
257 u64 rtt_sum; /* Sum of cache contents */
258 u64 rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* Determined RTT cache */
259 u8 rtt_cursor; /* next entry at which to insert */
260 u8 rtt_usage; /* amount of cache actually used */
261};
262
263/*
264 * Keys for matching a connection.
265 */
266struct rxrpc_conn_proto {
267 union {
268 struct {
269 u32 epoch; /* epoch of this connection */
270 u32 cid; /* connection ID */
271 };
272 u64 index_key;
273 };
274};
275
276struct rxrpc_conn_parameters {
277 struct rxrpc_local *local; /* Representation of local endpoint */
278 struct rxrpc_peer *peer; /* Remote endpoint */
279 struct key *key; /* Security details */
280 bool exclusive; /* T if conn is exclusive */
281 u16 service_id; /* Service ID for this connection */
282 u32 security_level; /* Security level selected */
283};
284
285/*
286 * Bits in the connection flags.
287 */
288enum rxrpc_conn_flag {
289 RXRPC_CONN_HAS_IDR, /* Has a client conn ID assigned */
290 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
291 RXRPC_CONN_IN_CLIENT_CONNS, /* Conn is in local->client_conns */
292 RXRPC_CONN_EXPOSED, /* Conn has extra ref for exposure */
293 RXRPC_CONN_DONT_REUSE, /* Don't reuse this connection */
294 RXRPC_CONN_COUNTED, /* Counted by rxrpc_nr_client_conns */
295};
296
297/*
298 * Events that can be raised upon a connection.
299 */
300enum rxrpc_conn_event {
301 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
302};
303
304/*
305 * The connection cache state.
306 */
307enum rxrpc_conn_cache_state {
308 RXRPC_CONN_CLIENT_INACTIVE, /* Conn is not yet listed */
309 RXRPC_CONN_CLIENT_WAITING, /* Conn is on wait list, waiting for capacity */
310 RXRPC_CONN_CLIENT_ACTIVE, /* Conn is on active list, doing calls */
311 RXRPC_CONN_CLIENT_CULLED, /* Conn is culled and delisted, doing calls */
312 RXRPC_CONN_CLIENT_IDLE, /* Conn is on idle list, doing mostly nothing */
313 RXRPC_CONN__NR_CACHE_STATES
314};
315
316/*
317 * The connection protocol state.
318 */
319enum rxrpc_conn_proto_state {
320 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
321 RXRPC_CONN_CLIENT, /* Client connection */
322 RXRPC_CONN_SERVICE_PREALLOC, /* Service connection preallocation */
323 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
324 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
325 RXRPC_CONN_SERVICE, /* Service secured connection */
326 RXRPC_CONN_REMOTELY_ABORTED, /* Conn aborted by peer */
327 RXRPC_CONN_LOCALLY_ABORTED, /* Conn aborted locally */
328 RXRPC_CONN__NR_STATES
329};
330
331/*
332 * RxRPC connection definition
333 * - matched by { local, peer, epoch, conn_id, direction }
334 * - each connection can only handle four simultaneous calls
335 */
336struct rxrpc_connection {
337 struct rxrpc_conn_proto proto;
338 struct rxrpc_conn_parameters params;
339
340 atomic_t usage;
341 struct rcu_head rcu;
342 struct list_head cache_link;
343
344 spinlock_t channel_lock;
345 unsigned char active_chans; /* Mask of active channels */
346#define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
347 struct list_head waiting_calls; /* Calls waiting for channels */
348 struct rxrpc_channel {
349 struct rxrpc_call __rcu *call; /* Active call */
350 u32 call_id; /* ID of current call */
351 u32 call_counter; /* Call ID counter */
352 u32 last_call; /* ID of last call */
353 u8 last_type; /* Type of last packet */
354 u16 last_service_id;
355 union {
356 u32 last_seq;
357 u32 last_abort;
358 };
359 } channels[RXRPC_MAXCALLS];
360
361 struct work_struct processor; /* connection event processor */
362 union {
363 struct rb_node client_node; /* Node in local->client_conns */
364 struct rb_node service_node; /* Node in peer->service_conns */
365 };
366 struct list_head proc_link; /* link in procfs list */
367 struct list_head link; /* link in master connection list */
368 struct sk_buff_head rx_queue; /* received conn-level packets */
369 const struct rxrpc_security *security; /* applied security module */
370 struct key *server_key; /* security for this service */
371 struct crypto_skcipher *cipher; /* encryption handle */
372 struct rxrpc_crypt csum_iv; /* packet checksum base */
373 unsigned long flags;
374 unsigned long events;
375 unsigned long idle_timestamp; /* Time at which last became idle */
376 spinlock_t state_lock; /* state-change lock */
377 enum rxrpc_conn_cache_state cache_state;
378 enum rxrpc_conn_proto_state state; /* current state of connection */
379 u32 local_abort; /* local abort code */
380 u32 remote_abort; /* remote abort code */
381 int debug_id; /* debug ID for printks */
382 atomic_t serial; /* packet serial number counter */
383 unsigned int hi_serial; /* highest serial number received */
384 u32 security_nonce; /* response re-use preventer */
385 u8 size_align; /* data size alignment (for security) */
386 u8 security_size; /* security header size */
387 u8 security_ix; /* security type */
388 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
389};
390
391/*
392 * Flags in call->flags.
393 */
394enum rxrpc_call_flag {
395 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
396 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
397 RXRPC_CALL_IS_SERVICE, /* Call is service call */
398 RXRPC_CALL_EXPOSED, /* The call was exposed to the world */
399 RXRPC_CALL_RX_LAST, /* Received the last packet (at rxtx_top) */
400 RXRPC_CALL_TX_LAST, /* Last packet in Tx buffer (at rxtx_top) */
401 RXRPC_CALL_SEND_PING, /* A ping will need to be sent */
402 RXRPC_CALL_PINGING, /* Ping in process */
403 RXRPC_CALL_RETRANS_TIMEOUT, /* Retransmission due to timeout occurred */
404};
405
406/*
407 * Events that can be raised on a call.
408 */
409enum rxrpc_call_event {
410 RXRPC_CALL_EV_ACK, /* need to generate ACK */
411 RXRPC_CALL_EV_ABORT, /* need to generate abort */
412 RXRPC_CALL_EV_TIMER, /* Timer expired */
413 RXRPC_CALL_EV_RESEND, /* Tx resend required */
414 RXRPC_CALL_EV_PING, /* Ping send required */
415};
416
417/*
418 * The states that a call can be in.
419 */
420enum rxrpc_call_state {
421 RXRPC_CALL_UNINITIALISED,
422 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
423 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
424 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
425 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
426 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
427 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
428 RXRPC_CALL_SERVER_ACCEPTING, /* - server accepting request */
429 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
430 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
431 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
432 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
433 RXRPC_CALL_COMPLETE, /* - call complete */
434 NR__RXRPC_CALL_STATES
435};
436
437/*
438 * Call completion condition (state == RXRPC_CALL_COMPLETE).
439 */
440enum rxrpc_call_completion {
441 RXRPC_CALL_SUCCEEDED, /* - Normal termination */
442 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
443 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
444 RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
445 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
446 NR__RXRPC_CALL_COMPLETIONS
447};
448
449/*
450 * Call Tx congestion management modes.
451 */
452enum rxrpc_congest_mode {
453 RXRPC_CALL_SLOW_START,
454 RXRPC_CALL_CONGEST_AVOIDANCE,
455 RXRPC_CALL_PACKET_LOSS,
456 RXRPC_CALL_FAST_RETRANSMIT,
457 NR__RXRPC_CONGEST_MODES
458};
459
460/*
461 * RxRPC call definition
462 * - matched by { connection, call_id }
463 */
464struct rxrpc_call {
465 struct rcu_head rcu;
466 struct rxrpc_connection *conn; /* connection carrying call */
467 struct rxrpc_peer *peer; /* Peer record for remote address */
468 struct rxrpc_sock __rcu *socket; /* socket responsible */
469 ktime_t ack_at; /* When deferred ACK needs to happen */
470 ktime_t resend_at; /* When next resend needs to happen */
471 ktime_t ping_at; /* When next to send a ping */
472 ktime_t expire_at; /* When the call times out */
473 struct timer_list timer; /* Combined event timer */
474 struct work_struct processor; /* Event processor */
475 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
476 struct list_head link; /* link in master call list */
477 struct list_head chan_wait_link; /* Link in conn->waiting_calls */
478 struct hlist_node error_link; /* link in error distribution list */
479 struct list_head accept_link; /* Link in rx->acceptq */
480 struct list_head recvmsg_link; /* Link in rx->recvmsg_q */
481 struct list_head sock_link; /* Link in rx->sock_calls */
482 struct rb_node sock_node; /* Node in rx->calls */
483 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
484 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
485 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
486 unsigned long user_call_ID; /* user-defined call ID */
487 unsigned long flags;
488 unsigned long events;
489 spinlock_t lock;
490 rwlock_t state_lock; /* lock for state transition */
491 u32 abort_code; /* Local/remote abort code */
492 int error; /* Local error incurred */
493 enum rxrpc_call_state state; /* current state of call */
494 enum rxrpc_call_completion completion; /* Call completion condition */
495 atomic_t usage;
496 u16 service_id; /* service ID */
497 u8 security_ix; /* Security type */
498 u32 call_id; /* call ID on connection */
499 u32 cid; /* connection ID plus channel index */
500 int debug_id; /* debug ID for printks */
501 unsigned short rx_pkt_offset; /* Current recvmsg packet offset */
502 unsigned short rx_pkt_len; /* Current recvmsg packet len */
503
504 /* Rx/Tx circular buffer, depending on phase.
505 *
506 * In the Rx phase, packets are annotated with 0 or the number of the
507 * segment of a jumbo packet each buffer refers to. There can be up to
508 * 47 segments in a maximum-size UDP packet.
509 *
510 * In the Tx phase, packets are annotated with which buffers have been
511 * acked.
512 */
513#define RXRPC_RXTX_BUFF_SIZE 64
514#define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
515#define RXRPC_INIT_RX_WINDOW_SIZE 32
516 struct sk_buff **rxtx_buffer;
517 u8 *rxtx_annotations;
518#define RXRPC_TX_ANNO_ACK 0
519#define RXRPC_TX_ANNO_UNACK 1
520#define RXRPC_TX_ANNO_NAK 2
521#define RXRPC_TX_ANNO_RETRANS 3
522#define RXRPC_TX_ANNO_MASK 0x03
523#define RXRPC_TX_ANNO_LAST 0x04
524#define RXRPC_TX_ANNO_RESENT 0x08
525
526#define RXRPC_RX_ANNO_JUMBO 0x3f /* Jumbo subpacket number + 1 if not zero */
527#define RXRPC_RX_ANNO_JLAST 0x40 /* Set if last element of a jumbo packet */
528#define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
529 rxrpc_seq_t tx_hard_ack; /* Dead slot in buffer; the first transmitted but
530 * not hard-ACK'd packet follows this.
531 */
532 rxrpc_seq_t tx_top; /* Highest Tx slot allocated. */
533
534 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
535 * is fixed, we keep these numbers in terms of segments (ie. DATA
536 * packets) rather than bytes.
537 */
538#define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
539 u8 cong_cwnd; /* Congestion window size */
540 u8 cong_extra; /* Extra to send for congestion management */
541 u8 cong_ssthresh; /* Slow-start threshold */
542 enum rxrpc_congest_mode cong_mode:8; /* Congestion management mode */
543 u8 cong_dup_acks; /* Count of ACKs showing missing packets */
544 u8 cong_cumul_acks; /* Cumulative ACK count */
545 ktime_t cong_tstamp; /* Last time cwnd was changed */
546
547 rxrpc_seq_t rx_hard_ack; /* Dead slot in buffer; the first received but not
548 * consumed packet follows this.
549 */
550 rxrpc_seq_t rx_top; /* Highest Rx slot allocated. */
551 rxrpc_seq_t rx_expect_next; /* Expected next packet sequence number */
552 u8 rx_winsize; /* Size of Rx window */
553 u8 tx_winsize; /* Maximum size of Tx window */
554 bool tx_phase; /* T if transmission phase, F if receive phase */
555 u8 nr_jumbo_bad; /* Number of jumbo dups/exceeds-windows */
556
557 /* receive-phase ACK management */
558 u8 ackr_reason; /* reason to ACK */
559 u16 ackr_skew; /* skew on packet being ACK'd */
560 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
561 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
562 rxrpc_seq_t ackr_consumed; /* Highest packet shown consumed */
563 rxrpc_seq_t ackr_seen; /* Highest packet shown seen */
564
565 /* ping management */
566 rxrpc_serial_t ping_serial; /* Last ping sent */
567 ktime_t ping_time; /* Time last ping sent */
568
569 /* transmission-phase ACK management */
570 ktime_t acks_latest_ts; /* Timestamp of latest ACK received */
571 rxrpc_serial_t acks_latest; /* serial number of latest ACK received */
572 rxrpc_seq_t acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
573};
574
575/*
576 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
577 */
578struct rxrpc_ack_summary {
579 u8 ack_reason;
580 u8 nr_acks; /* Number of ACKs in packet */
581 u8 nr_nacks; /* Number of NACKs in packet */
582 u8 nr_new_acks; /* Number of new ACKs in packet */
583 u8 nr_new_nacks; /* Number of new NACKs in packet */
584 u8 nr_rot_new_acks; /* Number of rotated new ACKs */
585 bool new_low_nack; /* T if new low NACK found */
586 bool retrans_timeo; /* T if reTx due to timeout happened */
587 u8 flight_size; /* Number of unreceived transmissions */
588 /* Place to stash values for tracing */
589 enum rxrpc_congest_mode mode:8;
590 u8 cwnd;
591 u8 ssthresh;
592 u8 dup_acks;
593 u8 cumulative_acks;
594};
595
596enum rxrpc_skb_trace {
597 rxrpc_skb_rx_cleaned,
598 rxrpc_skb_rx_freed,
599 rxrpc_skb_rx_got,
600 rxrpc_skb_rx_lost,
601 rxrpc_skb_rx_received,
602 rxrpc_skb_rx_rotated,
603 rxrpc_skb_rx_purged,
604 rxrpc_skb_rx_seen,
605 rxrpc_skb_tx_cleaned,
606 rxrpc_skb_tx_freed,
607 rxrpc_skb_tx_got,
608 rxrpc_skb_tx_new,
609 rxrpc_skb_tx_rotated,
610 rxrpc_skb_tx_seen,
611 rxrpc_skb__nr_trace
612};
613
614extern const char rxrpc_skb_traces[rxrpc_skb__nr_trace][7];
615
616enum rxrpc_conn_trace {
617 rxrpc_conn_new_client,
618 rxrpc_conn_new_service,
619 rxrpc_conn_queued,
620 rxrpc_conn_seen,
621 rxrpc_conn_got,
622 rxrpc_conn_put_client,
623 rxrpc_conn_put_service,
624 rxrpc_conn__nr_trace
625};
626
627extern const char rxrpc_conn_traces[rxrpc_conn__nr_trace][4];
628
629enum rxrpc_client_trace {
630 rxrpc_client_activate_chans,
631 rxrpc_client_alloc,
632 rxrpc_client_chan_activate,
633 rxrpc_client_chan_disconnect,
634 rxrpc_client_chan_pass,
635 rxrpc_client_chan_unstarted,
636 rxrpc_client_cleanup,
637 rxrpc_client_count,
638 rxrpc_client_discard,
639 rxrpc_client_duplicate,
640 rxrpc_client_exposed,
641 rxrpc_client_replace,
642 rxrpc_client_to_active,
643 rxrpc_client_to_culled,
644 rxrpc_client_to_idle,
645 rxrpc_client_to_inactive,
646 rxrpc_client_to_waiting,
647 rxrpc_client_uncount,
648 rxrpc_client__nr_trace
649};
650
651extern const char rxrpc_client_traces[rxrpc_client__nr_trace][7];
652extern const char rxrpc_conn_cache_states[RXRPC_CONN__NR_CACHE_STATES][5];
653
654enum rxrpc_call_trace {
655 rxrpc_call_new_client,
656 rxrpc_call_new_service,
657 rxrpc_call_queued,
658 rxrpc_call_queued_ref,
659 rxrpc_call_seen,
660 rxrpc_call_connected,
661 rxrpc_call_release,
662 rxrpc_call_got,
663 rxrpc_call_got_userid,
664 rxrpc_call_got_kernel,
665 rxrpc_call_put,
666 rxrpc_call_put_userid,
667 rxrpc_call_put_kernel,
668 rxrpc_call_put_noqueue,
669 rxrpc_call_error,
670 rxrpc_call__nr_trace
671};
672
673extern const char rxrpc_call_traces[rxrpc_call__nr_trace][4];
674
675enum rxrpc_transmit_trace {
676 rxrpc_transmit_wait,
677 rxrpc_transmit_queue,
678 rxrpc_transmit_queue_last,
679 rxrpc_transmit_rotate,
680 rxrpc_transmit_rotate_last,
681 rxrpc_transmit_await_reply,
682 rxrpc_transmit_end,
683 rxrpc_transmit__nr_trace
684};
685
686extern const char rxrpc_transmit_traces[rxrpc_transmit__nr_trace][4];
687
688enum rxrpc_receive_trace {
689 rxrpc_receive_incoming,
690 rxrpc_receive_queue,
691 rxrpc_receive_queue_last,
692 rxrpc_receive_front,
693 rxrpc_receive_rotate,
694 rxrpc_receive_end,
695 rxrpc_receive__nr_trace
696};
697
698extern const char rxrpc_receive_traces[rxrpc_receive__nr_trace][4];
699
700enum rxrpc_recvmsg_trace {
701 rxrpc_recvmsg_enter,
702 rxrpc_recvmsg_wait,
703 rxrpc_recvmsg_dequeue,
704 rxrpc_recvmsg_hole,
705 rxrpc_recvmsg_next,
706 rxrpc_recvmsg_cont,
707 rxrpc_recvmsg_full,
708 rxrpc_recvmsg_data_return,
709 rxrpc_recvmsg_terminal,
710 rxrpc_recvmsg_to_be_accepted,
711 rxrpc_recvmsg_return,
712 rxrpc_recvmsg__nr_trace
713};
714
715extern const char rxrpc_recvmsg_traces[rxrpc_recvmsg__nr_trace][5];
716
717enum rxrpc_rtt_tx_trace {
718 rxrpc_rtt_tx_ping,
719 rxrpc_rtt_tx_data,
720 rxrpc_rtt_tx__nr_trace
721};
722
723extern const char rxrpc_rtt_tx_traces[rxrpc_rtt_tx__nr_trace][5];
724
725enum rxrpc_rtt_rx_trace {
726 rxrpc_rtt_rx_ping_response,
727 rxrpc_rtt_rx_requested_ack,
728 rxrpc_rtt_rx__nr_trace
729};
730
731extern const char rxrpc_rtt_rx_traces[rxrpc_rtt_rx__nr_trace][5];
732
733enum rxrpc_timer_trace {
734 rxrpc_timer_begin,
735 rxrpc_timer_init_for_reply,
736 rxrpc_timer_init_for_send_reply,
737 rxrpc_timer_expired,
738 rxrpc_timer_set_for_ack,
739 rxrpc_timer_set_for_ping,
740 rxrpc_timer_set_for_resend,
741 rxrpc_timer_set_for_send,
742 rxrpc_timer__nr_trace
743};
744
745extern const char rxrpc_timer_traces[rxrpc_timer__nr_trace][8];
746
747enum rxrpc_propose_ack_trace {
748 rxrpc_propose_ack_client_tx_end,
749 rxrpc_propose_ack_input_data,
750 rxrpc_propose_ack_ping_for_lost_ack,
751 rxrpc_propose_ack_ping_for_lost_reply,
752 rxrpc_propose_ack_ping_for_params,
753 rxrpc_propose_ack_processing_op,
754 rxrpc_propose_ack_respond_to_ack,
755 rxrpc_propose_ack_respond_to_ping,
756 rxrpc_propose_ack_retry_tx,
757 rxrpc_propose_ack_rotate_rx,
758 rxrpc_propose_ack_terminal_ack,
759 rxrpc_propose_ack__nr_trace
760};
761
762enum rxrpc_propose_ack_outcome {
763 rxrpc_propose_ack_use,
764 rxrpc_propose_ack_update,
765 rxrpc_propose_ack_subsume,
766 rxrpc_propose_ack__nr_outcomes
767};
768
769extern const char rxrpc_propose_ack_traces[rxrpc_propose_ack__nr_trace][8];
770extern const char *const rxrpc_propose_ack_outcomes[rxrpc_propose_ack__nr_outcomes];
771
772enum rxrpc_congest_change {
773 rxrpc_cong_begin_retransmission,
774 rxrpc_cong_cleared_nacks,
775 rxrpc_cong_new_low_nack,
776 rxrpc_cong_no_change,
777 rxrpc_cong_progress,
778 rxrpc_cong_retransmit_again,
779 rxrpc_cong_rtt_window_end,
780 rxrpc_cong_saw_nack,
781 rxrpc_congest__nr_change
782};
783
784extern const char rxrpc_congest_modes[NR__RXRPC_CONGEST_MODES][10];
785extern const char rxrpc_congest_changes[rxrpc_congest__nr_change][9];
786
787extern const char *const rxrpc_pkts[];
788extern const char rxrpc_ack_names[RXRPC_ACK__INVALID + 1][4];
789
790#include <trace/events/rxrpc.h>
791
792/*
793 * af_rxrpc.c
794 */
795extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
796extern u32 rxrpc_epoch;
797extern atomic_t rxrpc_debug_id;
798extern struct workqueue_struct *rxrpc_workqueue;
799
800/*
801 * call_accept.c
802 */
803int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
804void rxrpc_discard_prealloc(struct rxrpc_sock *);
805struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
806 struct rxrpc_connection *,
807 struct sk_buff *);
808void rxrpc_accept_incoming_calls(struct rxrpc_local *);
809struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
810 rxrpc_notify_rx_t);
811int rxrpc_reject_call(struct rxrpc_sock *);
812
813/*
814 * call_event.c
815 */
816void __rxrpc_set_timer(struct rxrpc_call *, enum rxrpc_timer_trace, ktime_t);
817void rxrpc_set_timer(struct rxrpc_call *, enum rxrpc_timer_trace, ktime_t);
818void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool, bool,
819 enum rxrpc_propose_ack_trace);
820void rxrpc_process_call(struct work_struct *);
821
822/*
823 * call_object.c
824 */
825extern const char *const rxrpc_call_states[];
826extern const char *const rxrpc_call_completions[];
827extern unsigned int rxrpc_max_call_lifetime;
828extern struct kmem_cache *rxrpc_call_jar;
829extern struct list_head rxrpc_calls;
830extern rwlock_t rxrpc_call_lock;
831
832struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
833struct rxrpc_call *rxrpc_alloc_call(gfp_t);
834struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
835 struct rxrpc_conn_parameters *,
836 struct sockaddr_rxrpc *,
837 unsigned long, gfp_t);
838void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
839 struct sk_buff *);
840void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
841void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
842bool __rxrpc_queue_call(struct rxrpc_call *);
843bool rxrpc_queue_call(struct rxrpc_call *);
844void rxrpc_see_call(struct rxrpc_call *);
845void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
846void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
847void rxrpc_cleanup_call(struct rxrpc_call *);
848void __exit rxrpc_destroy_all_calls(void);
849
850static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
851{
852 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
853}
854
855static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
856{
857 return !rxrpc_is_service_call(call);
858}
859
860/*
861 * Transition a call to the complete state.
862 */
863static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
864 enum rxrpc_call_completion compl,
865 u32 abort_code,
866 int error)
867{
868 if (call->state < RXRPC_CALL_COMPLETE) {
869 call->abort_code = abort_code;
870 call->error = error;
871 call->completion = compl,
872 call->state = RXRPC_CALL_COMPLETE;
873 wake_up(&call->waitq);
874 return true;
875 }
876 return false;
877}
878
879static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
880 enum rxrpc_call_completion compl,
881 u32 abort_code,
882 int error)
883{
884 bool ret;
885
886 write_lock_bh(&call->state_lock);
887 ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
888 write_unlock_bh(&call->state_lock);
889 return ret;
890}
891
892/*
893 * Record that a call successfully completed.
894 */
895static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
896{
897 return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
898}
899
900static inline bool rxrpc_call_completed(struct rxrpc_call *call)
901{
902 bool ret;
903
904 write_lock_bh(&call->state_lock);
905 ret = __rxrpc_call_completed(call);
906 write_unlock_bh(&call->state_lock);
907 return ret;
908}
909
910/*
911 * Record that a call is locally aborted.
912 */
913static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
914 rxrpc_seq_t seq,
915 u32 abort_code, int error)
916{
917 trace_rxrpc_abort(why, call->cid, call->call_id, seq,
918 abort_code, error);
919 return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
920 abort_code, error);
921}
922
923static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
924 rxrpc_seq_t seq, u32 abort_code, int error)
925{
926 bool ret;
927
928 write_lock_bh(&call->state_lock);
929 ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
930 write_unlock_bh(&call->state_lock);
931 return ret;
932}
933
934/*
935 * conn_client.c
936 */
937extern unsigned int rxrpc_max_client_connections;
938extern unsigned int rxrpc_reap_client_connections;
939extern unsigned int rxrpc_conn_idle_client_expiry;
940extern unsigned int rxrpc_conn_idle_client_fast_expiry;
941extern struct idr rxrpc_client_conn_ids;
942
943void rxrpc_destroy_client_conn_ids(void);
944int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
945 struct sockaddr_rxrpc *, gfp_t);
946void rxrpc_expose_client_call(struct rxrpc_call *);
947void rxrpc_disconnect_client_call(struct rxrpc_call *);
948void rxrpc_put_client_conn(struct rxrpc_connection *);
949void __exit rxrpc_destroy_all_client_connections(void);
950
951/*
952 * conn_event.c
953 */
954void rxrpc_process_connection(struct work_struct *);
955
956/*
957 * conn_object.c
958 */
959extern unsigned int rxrpc_connection_expiry;
960extern struct list_head rxrpc_connections;
961extern struct list_head rxrpc_connection_proc_list;
962extern rwlock_t rxrpc_connection_lock;
963
964int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
965struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
966struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
967 struct sk_buff *);
968void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
969void rxrpc_disconnect_call(struct rxrpc_call *);
970void rxrpc_kill_connection(struct rxrpc_connection *);
971bool rxrpc_queue_conn(struct rxrpc_connection *);
972void rxrpc_see_connection(struct rxrpc_connection *);
973void rxrpc_get_connection(struct rxrpc_connection *);
974struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
975void rxrpc_put_service_conn(struct rxrpc_connection *);
976void __exit rxrpc_destroy_all_connections(void);
977
978static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
979{
980 return conn->out_clientflag;
981}
982
983static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
984{
985 return !rxrpc_conn_is_client(conn);
986}
987
988static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
989{
990 if (!conn)
991 return;
992
993 if (rxrpc_conn_is_client(conn))
994 rxrpc_put_client_conn(conn);
995 else
996 rxrpc_put_service_conn(conn);
997}
998
999/*
1000 * conn_service.c
1001 */
1002struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
1003 struct sk_buff *);
1004struct rxrpc_connection *rxrpc_prealloc_service_connection(gfp_t);
1005void rxrpc_new_incoming_connection(struct rxrpc_connection *, struct sk_buff *);
1006void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
1007
1008/*
1009 * input.c
1010 */
1011void rxrpc_data_ready(struct sock *);
1012
1013/*
1014 * insecure.c
1015 */
1016extern const struct rxrpc_security rxrpc_no_security;
1017
1018/*
1019 * key.c
1020 */
1021extern struct key_type key_type_rxrpc;
1022extern struct key_type key_type_rxrpc_s;
1023
1024int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
1025int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
1026int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
1027 u32);
1028
1029/*
1030 * local_event.c
1031 */
1032extern void rxrpc_process_local_events(struct rxrpc_local *);
1033
1034/*
1035 * local_object.c
1036 */
1037struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
1038void __rxrpc_put_local(struct rxrpc_local *);
1039void __exit rxrpc_destroy_all_locals(void);
1040
1041static inline void rxrpc_get_local(struct rxrpc_local *local)
1042{
1043 atomic_inc(&local->usage);
1044}
1045
1046static inline
1047struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
1048{
1049 return atomic_inc_not_zero(&local->usage) ? local : NULL;
1050}
1051
1052static inline void rxrpc_put_local(struct rxrpc_local *local)
1053{
1054 if (local && atomic_dec_and_test(&local->usage))
1055 __rxrpc_put_local(local);
1056}
1057
1058static inline void rxrpc_queue_local(struct rxrpc_local *local)
1059{
1060 rxrpc_queue_work(&local->processor);
1061}
1062
1063/*
1064 * misc.c
1065 */
1066extern unsigned int rxrpc_max_backlog __read_mostly;
1067extern unsigned int rxrpc_requested_ack_delay;
1068extern unsigned int rxrpc_soft_ack_delay;
1069extern unsigned int rxrpc_idle_ack_delay;
1070extern unsigned int rxrpc_rx_window_size;
1071extern unsigned int rxrpc_rx_mtu;
1072extern unsigned int rxrpc_rx_jumbo_max;
1073extern unsigned int rxrpc_resend_timeout;
1074
1075extern const s8 rxrpc_ack_priority[];
1076
1077/*
1078 * output.c
1079 */
1080int rxrpc_send_ack_packet(struct rxrpc_call *, bool);
1081int rxrpc_send_abort_packet(struct rxrpc_call *);
1082int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
1083void rxrpc_reject_packets(struct rxrpc_local *);
1084
1085/*
1086 * peer_event.c
1087 */
1088void rxrpc_error_report(struct sock *);
1089void rxrpc_peer_error_distributor(struct work_struct *);
1090void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace,
1091 rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1092
1093/*
1094 * peer_object.c
1095 */
1096struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1097 const struct sockaddr_rxrpc *);
1098struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
1099 struct sockaddr_rxrpc *, gfp_t);
1100struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
1101struct rxrpc_peer *rxrpc_lookup_incoming_peer(struct rxrpc_local *,
1102 struct rxrpc_peer *);
1103
1104static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
1105{
1106 atomic_inc(&peer->usage);
1107 return peer;
1108}
1109
1110static inline
1111struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
1112{
1113 return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
1114}
1115
1116extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
1117static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
1118{
1119 if (peer && atomic_dec_and_test(&peer->usage))
1120 __rxrpc_put_peer(peer);
1121}
1122
1123/*
1124 * proc.c
1125 */
1126extern const struct file_operations rxrpc_call_seq_fops;
1127extern const struct file_operations rxrpc_connection_seq_fops;
1128
1129/*
1130 * recvmsg.c
1131 */
1132void rxrpc_notify_socket(struct rxrpc_call *);
1133int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1134
1135/*
1136 * rxkad.c
1137 */
1138#ifdef CONFIG_RXKAD
1139extern const struct rxrpc_security rxkad;
1140#endif
1141
1142/*
1143 * security.c
1144 */
1145int __init rxrpc_init_security(void);
1146void rxrpc_exit_security(void);
1147int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1148int rxrpc_init_server_conn_security(struct rxrpc_connection *);
1149
1150/*
1151 * sendmsg.c
1152 */
1153int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1154
1155/*
1156 * skbuff.c
1157 */
1158void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1159void rxrpc_packet_destructor(struct sk_buff *);
1160void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1161void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1162void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1163void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1164void rxrpc_lose_skb(struct sk_buff *, enum rxrpc_skb_trace);
1165void rxrpc_purge_queue(struct sk_buff_head *);
1166
1167/*
1168 * sysctl.c
1169 */
1170#ifdef CONFIG_SYSCTL
1171extern int __init rxrpc_sysctl_init(void);
1172extern void rxrpc_sysctl_exit(void);
1173#else
1174static inline int __init rxrpc_sysctl_init(void) { return 0; }
1175static inline void rxrpc_sysctl_exit(void) {}
1176#endif
1177
1178/*
1179 * utils.c
1180 */
1181int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1182
1183static inline bool before(u32 seq1, u32 seq2)
1184{
1185 return (s32)(seq1 - seq2) < 0;
1186}
1187static inline bool before_eq(u32 seq1, u32 seq2)
1188{
1189 return (s32)(seq1 - seq2) <= 0;
1190}
1191static inline bool after(u32 seq1, u32 seq2)
1192{
1193 return (s32)(seq1 - seq2) > 0;
1194}
1195static inline bool after_eq(u32 seq1, u32 seq2)
1196{
1197 return (s32)(seq1 - seq2) >= 0;
1198}
1199
1200/*
1201 * debug tracing
1202 */
1203extern unsigned int rxrpc_debug;
1204
1205#define dbgprintk(FMT,...) \
1206 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1207
1208#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1209#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1210#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1211#define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1212#define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1213
1214
1215#if defined(__KDEBUG)
1216#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1217#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1218#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1219#define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1220#define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1221
1222#elif defined(CONFIG_AF_RXRPC_DEBUG)
1223#define RXRPC_DEBUG_KENTER 0x01
1224#define RXRPC_DEBUG_KLEAVE 0x02
1225#define RXRPC_DEBUG_KDEBUG 0x04
1226#define RXRPC_DEBUG_KPROTO 0x08
1227#define RXRPC_DEBUG_KNET 0x10
1228
1229#define _enter(FMT,...) \
1230do { \
1231 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1232 kenter(FMT,##__VA_ARGS__); \
1233} while (0)
1234
1235#define _leave(FMT,...) \
1236do { \
1237 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1238 kleave(FMT,##__VA_ARGS__); \
1239} while (0)
1240
1241#define _debug(FMT,...) \
1242do { \
1243 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1244 kdebug(FMT,##__VA_ARGS__); \
1245} while (0)
1246
1247#define _proto(FMT,...) \
1248do { \
1249 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1250 kproto(FMT,##__VA_ARGS__); \
1251} while (0)
1252
1253#define _net(FMT,...) \
1254do { \
1255 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1256 knet(FMT,##__VA_ARGS__); \
1257} while (0)
1258
1259#else
1260#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1261#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1262#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1263#define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1264#define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1265#endif
1266
1267/*
1268 * debug assertion checking
1269 */
1270#if 1 // defined(__KDEBUGALL)
1271
1272#define ASSERT(X) \
1273do { \
1274 if (unlikely(!(X))) { \
1275 pr_err("Assertion failed\n"); \
1276 BUG(); \
1277 } \
1278} while (0)
1279
1280#define ASSERTCMP(X, OP, Y) \
1281do { \
1282 __typeof__(X) _x = (X); \
1283 __typeof__(Y) _y = (__typeof__(X))(Y); \
1284 if (unlikely(!(_x OP _y))) { \
1285 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1286 (unsigned long)_x, (unsigned long)_x, #OP, \
1287 (unsigned long)_y, (unsigned long)_y); \
1288 BUG(); \
1289 } \
1290} while (0)
1291
1292#define ASSERTIF(C, X) \
1293do { \
1294 if (unlikely((C) && !(X))) { \
1295 pr_err("Assertion failed\n"); \
1296 BUG(); \
1297 } \
1298} while (0)
1299
1300#define ASSERTIFCMP(C, X, OP, Y) \
1301do { \
1302 __typeof__(X) _x = (X); \
1303 __typeof__(Y) _y = (__typeof__(X))(Y); \
1304 if (unlikely((C) && !(_x OP _y))) { \
1305 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1306 (unsigned long)_x, (unsigned long)_x, #OP, \
1307 (unsigned long)_y, (unsigned long)_y); \
1308 BUG(); \
1309 } \
1310} while (0)
1311
1312#else
1313
1314#define ASSERT(X) \
1315do { \
1316} while (0)
1317
1318#define ASSERTCMP(X, OP, Y) \
1319do { \
1320} while (0)
1321
1322#define ASSERTIF(C, X) \
1323do { \
1324} while (0)
1325
1326#define ASSERTIFCMP(C, X, OP, Y) \
1327do { \
1328} while (0)
1329
1330#endif /* __KDEBUGALL */