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 <rxrpc/packet.h>
13
14#if 0
15#define CHECK_SLAB_OKAY(X) \
16 BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
17 (POISON_FREE << 8 | POISON_FREE))
18#else
19#define CHECK_SLAB_OKAY(X) do {} while (0)
20#endif
21
22#define FCRYPT_BSIZE 8
23struct rxrpc_crypt {
24 union {
25 u8 x[FCRYPT_BSIZE];
26 __be32 n[2];
27 };
28} __attribute__((aligned(8)));
29
30#define rxrpc_queue_work(WS) queue_work(rxrpc_workqueue, (WS))
31#define rxrpc_queue_delayed_work(WS,D) \
32 queue_delayed_work(rxrpc_workqueue, (WS), (D))
33
34#define rxrpc_queue_call(CALL) rxrpc_queue_work(&(CALL)->processor)
35#define rxrpc_queue_conn(CONN) rxrpc_queue_work(&(CONN)->processor)
36
37/*
38 * sk_state for RxRPC sockets
39 */
40enum {
41 RXRPC_UNCONNECTED = 0,
42 RXRPC_CLIENT_BOUND, /* client local address bound */
43 RXRPC_CLIENT_CONNECTED, /* client is connected */
44 RXRPC_SERVER_BOUND, /* server local address bound */
45 RXRPC_SERVER_LISTENING, /* server listening for connections */
46 RXRPC_CLOSE, /* socket is being closed */
47};
48
49/*
50 * RxRPC socket definition
51 */
52struct rxrpc_sock {
53 /* WARNING: sk has to be the first member */
54 struct sock sk;
55 rxrpc_interceptor_t interceptor; /* kernel service Rx interceptor function */
56 struct rxrpc_local *local; /* local endpoint */
57 struct rxrpc_transport *trans; /* transport handler */
58 struct rxrpc_conn_bundle *bundle; /* virtual connection bundle */
59 struct rxrpc_connection *conn; /* exclusive virtual connection */
60 struct list_head listen_link; /* link in the local endpoint's listen list */
61 struct list_head secureq; /* calls awaiting connection security clearance */
62 struct list_head acceptq; /* calls awaiting acceptance */
63 struct key *key; /* security for this socket */
64 struct key *securities; /* list of server security descriptors */
65 struct rb_root calls; /* outstanding calls on this socket */
66 unsigned long flags;
67#define RXRPC_SOCK_EXCLUSIVE_CONN 1 /* exclusive connection for a client socket */
68 rwlock_t call_lock; /* lock for calls */
69 u32 min_sec_level; /* minimum security level */
70#define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
71 struct sockaddr_rxrpc srx; /* local address */
72 sa_family_t proto; /* protocol created with */
73};
74
75#define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
76
77/*
78 * CPU-byteorder normalised Rx packet header.
79 */
80struct rxrpc_host_header {
81 u32 epoch; /* client boot timestamp */
82 u32 cid; /* connection and channel ID */
83 u32 callNumber; /* call ID (0 for connection-level packets) */
84 u32 seq; /* sequence number of pkt in call stream */
85 u32 serial; /* serial number of pkt sent to network */
86 u8 type; /* packet type */
87 u8 flags; /* packet flags */
88 u8 userStatus; /* app-layer defined status */
89 u8 securityIndex; /* security protocol ID */
90 union {
91 u16 _rsvd; /* reserved */
92 u16 cksum; /* kerberos security checksum */
93 };
94 u16 serviceId; /* service ID */
95} __packed;
96
97/*
98 * RxRPC socket buffer private variables
99 * - max 48 bytes (struct sk_buff::cb)
100 */
101struct rxrpc_skb_priv {
102 struct rxrpc_call *call; /* call with which associated */
103 unsigned long resend_at; /* time in jiffies at which to resend */
104 union {
105 unsigned int offset; /* offset into buffer of next read */
106 int remain; /* amount of space remaining for next write */
107 u32 error; /* network error code */
108 bool need_resend; /* T if needs resending */
109 };
110
111 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
112};
113
114#define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
115
116enum rxrpc_command {
117 RXRPC_CMD_SEND_DATA, /* send data message */
118 RXRPC_CMD_SEND_ABORT, /* request abort generation */
119 RXRPC_CMD_ACCEPT, /* [server] accept incoming call */
120 RXRPC_CMD_REJECT_BUSY, /* [server] reject a call as busy */
121};
122
123/*
124 * RxRPC security module interface
125 */
126struct rxrpc_security {
127 struct module *owner; /* providing module */
128 struct list_head link; /* link in master list */
129 const char *name; /* name of this service */
130 u8 security_index; /* security type provided */
131
132 /* initialise a connection's security */
133 int (*init_connection_security)(struct rxrpc_connection *);
134
135 /* prime a connection's packet security */
136 void (*prime_packet_security)(struct rxrpc_connection *);
137
138 /* impose security on a packet */
139 int (*secure_packet)(const struct rxrpc_call *,
140 struct sk_buff *,
141 size_t,
142 void *);
143
144 /* verify the security on a received packet */
145 int (*verify_packet)(const struct rxrpc_call *, struct sk_buff *,
146 u32 *);
147
148 /* issue a challenge */
149 int (*issue_challenge)(struct rxrpc_connection *);
150
151 /* respond to a challenge */
152 int (*respond_to_challenge)(struct rxrpc_connection *,
153 struct sk_buff *,
154 u32 *);
155
156 /* verify a response */
157 int (*verify_response)(struct rxrpc_connection *,
158 struct sk_buff *,
159 u32 *);
160
161 /* clear connection security */
162 void (*clear)(struct rxrpc_connection *);
163};
164
165/*
166 * RxRPC local transport endpoint definition
167 * - matched by local port, address and protocol type
168 */
169struct rxrpc_local {
170 struct socket *socket; /* my UDP socket */
171 struct work_struct destroyer; /* endpoint destroyer */
172 struct work_struct acceptor; /* incoming call processor */
173 struct work_struct rejecter; /* packet reject writer */
174 struct work_struct event_processor; /* endpoint event processor */
175 struct list_head services; /* services listening on this endpoint */
176 struct list_head link; /* link in endpoint list */
177 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
178 struct sk_buff_head accept_queue; /* incoming calls awaiting acceptance */
179 struct sk_buff_head reject_queue; /* packets awaiting rejection */
180 struct sk_buff_head event_queue; /* endpoint event packets awaiting processing */
181 spinlock_t lock; /* access lock */
182 rwlock_t services_lock; /* lock for services list */
183 atomic_t usage;
184 int debug_id; /* debug ID for printks */
185 volatile char error_rcvd; /* T if received ICMP error outstanding */
186 struct sockaddr_rxrpc srx; /* local address */
187};
188
189/*
190 * RxRPC remote transport endpoint definition
191 * - matched by remote port, address and protocol type
192 * - holds the connection ID counter for connections between the two endpoints
193 */
194struct rxrpc_peer {
195 struct work_struct destroyer; /* peer destroyer */
196 struct list_head link; /* link in master peer list */
197 struct list_head error_targets; /* targets for net error distribution */
198 spinlock_t lock; /* access lock */
199 atomic_t usage;
200 unsigned int if_mtu; /* interface MTU for this peer */
201 unsigned int mtu; /* network MTU for this peer */
202 unsigned int maxdata; /* data size (MTU - hdrsize) */
203 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
204 int debug_id; /* debug ID for printks */
205 int net_error; /* network error distributed */
206 struct sockaddr_rxrpc srx; /* remote address */
207
208 /* calculated RTT cache */
209#define RXRPC_RTT_CACHE_SIZE 32
210 suseconds_t rtt; /* current RTT estimate (in uS) */
211 unsigned int rtt_point; /* next entry at which to insert */
212 unsigned int rtt_usage; /* amount of cache actually used */
213 suseconds_t rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* calculated RTT cache */
214};
215
216/*
217 * RxRPC point-to-point transport / connection manager definition
218 * - handles a bundle of connections between two endpoints
219 * - matched by { local, peer }
220 */
221struct rxrpc_transport {
222 struct rxrpc_local *local; /* local transport endpoint */
223 struct rxrpc_peer *peer; /* remote transport endpoint */
224 struct work_struct error_handler; /* network error distributor */
225 struct rb_root bundles; /* client connection bundles on this transport */
226 struct rb_root client_conns; /* client connections on this transport */
227 struct rb_root server_conns; /* server connections on this transport */
228 struct list_head link; /* link in master session list */
229 struct sk_buff_head error_queue; /* error packets awaiting processing */
230 unsigned long put_time; /* time at which to reap */
231 spinlock_t client_lock; /* client connection allocation lock */
232 rwlock_t conn_lock; /* lock for active/dead connections */
233 atomic_t usage;
234 int debug_id; /* debug ID for printks */
235 unsigned int conn_idcounter; /* connection ID counter (client) */
236};
237
238/*
239 * RxRPC client connection bundle
240 * - matched by { transport, service_id, key }
241 */
242struct rxrpc_conn_bundle {
243 struct rb_node node; /* node in transport's lookup tree */
244 struct list_head unused_conns; /* unused connections in this bundle */
245 struct list_head avail_conns; /* available connections in this bundle */
246 struct list_head busy_conns; /* busy connections in this bundle */
247 struct key *key; /* security for this bundle */
248 wait_queue_head_t chanwait; /* wait for channel to become available */
249 atomic_t usage;
250 int debug_id; /* debug ID for printks */
251 unsigned short num_conns; /* number of connections in this bundle */
252 u16 service_id; /* Service ID for this bundle */
253 u8 security_ix; /* security type */
254};
255
256/*
257 * RxRPC connection definition
258 * - matched by { transport, service_id, conn_id, direction, key }
259 * - each connection can only handle four simultaneous calls
260 */
261struct rxrpc_connection {
262 struct rxrpc_transport *trans; /* transport session */
263 struct rxrpc_conn_bundle *bundle; /* connection bundle (client) */
264 struct work_struct processor; /* connection event processor */
265 struct rb_node node; /* node in transport's lookup tree */
266 struct list_head link; /* link in master connection list */
267 struct list_head bundle_link; /* link in bundle */
268 struct rb_root calls; /* calls on this connection */
269 struct sk_buff_head rx_queue; /* received conn-level packets */
270 struct rxrpc_call *channels[RXRPC_MAXCALLS]; /* channels (active calls) */
271 struct rxrpc_security *security; /* applied security module */
272 struct key *key; /* security for this connection (client) */
273 struct key *server_key; /* security for this service */
274 struct crypto_skcipher *cipher; /* encryption handle */
275 struct rxrpc_crypt csum_iv; /* packet checksum base */
276 unsigned long events;
277#define RXRPC_CONN_CHALLENGE 0 /* send challenge packet */
278 unsigned long put_time; /* time at which to reap */
279 rwlock_t lock; /* access lock */
280 spinlock_t state_lock; /* state-change lock */
281 atomic_t usage;
282 enum { /* current state of connection */
283 RXRPC_CONN_UNUSED, /* - connection not yet attempted */
284 RXRPC_CONN_CLIENT, /* - client connection */
285 RXRPC_CONN_SERVER_UNSECURED, /* - server unsecured connection */
286 RXRPC_CONN_SERVER_CHALLENGING, /* - server challenging for security */
287 RXRPC_CONN_SERVER, /* - server secured connection */
288 RXRPC_CONN_REMOTELY_ABORTED, /* - conn aborted by peer */
289 RXRPC_CONN_LOCALLY_ABORTED, /* - conn aborted locally */
290 RXRPC_CONN_NETWORK_ERROR, /* - conn terminated by network error */
291 } state;
292 int error; /* error code for local abort */
293 int debug_id; /* debug ID for printks */
294 unsigned int call_counter; /* call ID counter */
295 atomic_t serial; /* packet serial number counter */
296 atomic_t hi_serial; /* highest serial number received */
297 u8 avail_calls; /* number of calls available */
298 u8 size_align; /* data size alignment (for security) */
299 u8 header_size; /* rxrpc + security header size */
300 u8 security_size; /* security header size */
301 u32 security_level; /* security level negotiated */
302 u32 security_nonce; /* response re-use preventer */
303 u32 epoch; /* epoch of this connection */
304 u32 cid; /* connection ID */
305 u16 service_id; /* service ID for this connection */
306 u8 security_ix; /* security type */
307 u8 in_clientflag; /* RXRPC_CLIENT_INITIATED if we are server */
308 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
309};
310
311/*
312 * Flags in call->flags.
313 */
314enum rxrpc_call_flag {
315 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
316 RXRPC_CALL_TERMINAL_MSG, /* call has given the socket its final message */
317 RXRPC_CALL_RCVD_LAST, /* all packets received */
318 RXRPC_CALL_RUN_RTIMER, /* Tx resend timer started */
319 RXRPC_CALL_TX_SOFT_ACK, /* sent some soft ACKs */
320 RXRPC_CALL_PROC_BUSY, /* the processor is busy */
321 RXRPC_CALL_INIT_ACCEPT, /* acceptance was initiated */
322 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
323 RXRPC_CALL_EXPECT_OOS, /* expect out of sequence packets */
324};
325
326/*
327 * Events that can be raised on a call.
328 */
329enum rxrpc_call_event {
330 RXRPC_CALL_EV_RCVD_ACKALL, /* ACKALL or reply received */
331 RXRPC_CALL_EV_RCVD_BUSY, /* busy packet received */
332 RXRPC_CALL_EV_RCVD_ABORT, /* abort packet received */
333 RXRPC_CALL_EV_RCVD_ERROR, /* network error received */
334 RXRPC_CALL_EV_ACK_FINAL, /* need to generate final ACK (and release call) */
335 RXRPC_CALL_EV_ACK, /* need to generate ACK */
336 RXRPC_CALL_EV_REJECT_BUSY, /* need to generate busy message */
337 RXRPC_CALL_EV_ABORT, /* need to generate abort */
338 RXRPC_CALL_EV_CONN_ABORT, /* local connection abort generated */
339 RXRPC_CALL_EV_RESEND_TIMER, /* Tx resend timer expired */
340 RXRPC_CALL_EV_RESEND, /* Tx resend required */
341 RXRPC_CALL_EV_DRAIN_RX_OOS, /* drain the Rx out of sequence queue */
342 RXRPC_CALL_EV_LIFE_TIMER, /* call's lifetimer ran out */
343 RXRPC_CALL_EV_ACCEPTED, /* incoming call accepted by userspace app */
344 RXRPC_CALL_EV_SECURED, /* incoming call's connection is now secure */
345 RXRPC_CALL_EV_POST_ACCEPT, /* need to post an "accept?" message to the app */
346 RXRPC_CALL_EV_RELEASE, /* need to release the call's resources */
347};
348
349/*
350 * The states that a call can be in.
351 */
352enum rxrpc_call_state {
353 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
354 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
355 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
356 RXRPC_CALL_CLIENT_FINAL_ACK, /* - client sending final ACK phase */
357 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
358 RXRPC_CALL_SERVER_ACCEPTING, /* - server accepting request */
359 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
360 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
361 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
362 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
363 RXRPC_CALL_COMPLETE, /* - call completed */
364 RXRPC_CALL_SERVER_BUSY, /* - call rejected by busy server */
365 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
366 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
367 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
368 RXRPC_CALL_DEAD, /* - call is dead */
369 NR__RXRPC_CALL_STATES
370};
371
372/*
373 * RxRPC call definition
374 * - matched by { connection, call_id }
375 */
376struct rxrpc_call {
377 struct rxrpc_connection *conn; /* connection carrying call */
378 struct rxrpc_sock *socket; /* socket responsible */
379 struct timer_list lifetimer; /* lifetime remaining on call */
380 struct timer_list deadspan; /* reap timer for re-ACK'ing, etc */
381 struct timer_list ack_timer; /* ACK generation timer */
382 struct timer_list resend_timer; /* Tx resend timer */
383 struct work_struct destroyer; /* call destroyer */
384 struct work_struct processor; /* packet processor and ACK generator */
385 struct list_head link; /* link in master call list */
386 struct list_head error_link; /* link in error distribution list */
387 struct list_head accept_link; /* calls awaiting acceptance */
388 struct rb_node sock_node; /* node in socket call tree */
389 struct rb_node conn_node; /* node in connection call tree */
390 struct sk_buff_head rx_queue; /* received packets */
391 struct sk_buff_head rx_oos_queue; /* packets received out of sequence */
392 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
393 wait_queue_head_t tx_waitq; /* wait for Tx window space to become available */
394 unsigned long user_call_ID; /* user-defined call ID */
395 unsigned long creation_jif; /* time of call creation */
396 unsigned long flags;
397 unsigned long events;
398 spinlock_t lock;
399 rwlock_t state_lock; /* lock for state transition */
400 atomic_t usage;
401 atomic_t sequence; /* Tx data packet sequence counter */
402 u32 abort_code; /* local/remote abort code */
403 enum rxrpc_call_state state : 8; /* current state of call */
404 int debug_id; /* debug ID for printks */
405 u8 channel; /* connection channel occupied by this call */
406
407 /* transmission-phase ACK management */
408 u8 acks_head; /* offset into window of first entry */
409 u8 acks_tail; /* offset into window of last entry */
410 u8 acks_winsz; /* size of un-ACK'd window */
411 u8 acks_unacked; /* lowest unacked packet in last ACK received */
412 int acks_latest; /* serial number of latest ACK received */
413 rxrpc_seq_t acks_hard; /* highest definitively ACK'd msg seq */
414 unsigned long *acks_window; /* sent packet window
415 * - elements are pointers with LSB set if ACK'd
416 */
417
418 /* receive-phase ACK management */
419 rxrpc_seq_t rx_data_expect; /* next data seq ID expected to be received */
420 rxrpc_seq_t rx_data_post; /* next data seq ID expected to be posted */
421 rxrpc_seq_t rx_data_recv; /* last data seq ID encountered by recvmsg */
422 rxrpc_seq_t rx_data_eaten; /* last data seq ID consumed by recvmsg */
423 rxrpc_seq_t rx_first_oos; /* first packet in rx_oos_queue (or 0) */
424 rxrpc_seq_t ackr_win_top; /* top of ACK window (rx_data_eaten is bottom) */
425 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
426 u8 ackr_reason; /* reason to ACK */
427 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
428 atomic_t ackr_not_idle; /* number of packets in Rx queue */
429
430 /* received packet records, 1 bit per record */
431#define RXRPC_ACKR_WINDOW_ASZ DIV_ROUND_UP(RXRPC_MAXACKS, BITS_PER_LONG)
432 unsigned long ackr_window[RXRPC_ACKR_WINDOW_ASZ + 1];
433
434 struct hlist_node hash_node;
435 unsigned long hash_key; /* Full hash key */
436 u8 in_clientflag; /* Copy of conn->in_clientflag for hashing */
437 struct rxrpc_local *local; /* Local endpoint. Used for hashing. */
438 sa_family_t proto; /* Frame protocol */
439 u32 call_id; /* call ID on connection */
440 u32 cid; /* connection ID plus channel index */
441 u32 epoch; /* epoch of this connection */
442 u16 service_id; /* service ID */
443 union { /* Peer IP address for hashing */
444 __be32 ipv4_addr;
445 __u8 ipv6_addr[16]; /* Anticipates eventual IPv6 support */
446 } peer_ip;
447};
448
449/*
450 * locally abort an RxRPC call
451 */
452static inline void rxrpc_abort_call(struct rxrpc_call *call, u32 abort_code)
453{
454 write_lock_bh(&call->state_lock);
455 if (call->state < RXRPC_CALL_COMPLETE) {
456 call->abort_code = abort_code;
457 call->state = RXRPC_CALL_LOCALLY_ABORTED;
458 set_bit(RXRPC_CALL_EV_ABORT, &call->events);
459 }
460 write_unlock_bh(&call->state_lock);
461}
462
463/*
464 * af_rxrpc.c
465 */
466extern atomic_t rxrpc_n_skbs;
467extern u32 rxrpc_epoch;
468extern atomic_t rxrpc_debug_id;
469extern struct workqueue_struct *rxrpc_workqueue;
470
471/*
472 * ar-accept.c
473 */
474void rxrpc_accept_incoming_calls(struct work_struct *);
475struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long);
476int rxrpc_reject_call(struct rxrpc_sock *);
477
478/*
479 * ar-ack.c
480 */
481extern unsigned int rxrpc_requested_ack_delay;
482extern unsigned int rxrpc_soft_ack_delay;
483extern unsigned int rxrpc_idle_ack_delay;
484extern unsigned int rxrpc_rx_window_size;
485extern unsigned int rxrpc_rx_mtu;
486extern unsigned int rxrpc_rx_jumbo_max;
487
488void __rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool);
489void rxrpc_propose_ACK(struct rxrpc_call *, u8, u32, bool);
490void rxrpc_process_call(struct work_struct *);
491
492/*
493 * ar-call.c
494 */
495extern unsigned int rxrpc_max_call_lifetime;
496extern unsigned int rxrpc_dead_call_expiry;
497extern struct kmem_cache *rxrpc_call_jar;
498extern struct list_head rxrpc_calls;
499extern rwlock_t rxrpc_call_lock;
500
501struct rxrpc_call *rxrpc_find_call_hash(struct rxrpc_host_header *,
502 void *, sa_family_t, const void *);
503struct rxrpc_call *rxrpc_get_client_call(struct rxrpc_sock *,
504 struct rxrpc_transport *,
505 struct rxrpc_conn_bundle *,
506 unsigned long, int, gfp_t);
507struct rxrpc_call *rxrpc_incoming_call(struct rxrpc_sock *,
508 struct rxrpc_connection *,
509 struct rxrpc_host_header *, gfp_t);
510struct rxrpc_call *rxrpc_find_server_call(struct rxrpc_sock *, unsigned long);
511void rxrpc_release_call(struct rxrpc_call *);
512void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
513void __rxrpc_put_call(struct rxrpc_call *);
514void __exit rxrpc_destroy_all_calls(void);
515
516/*
517 * ar-connection.c
518 */
519extern unsigned int rxrpc_connection_expiry;
520extern struct list_head rxrpc_connections;
521extern rwlock_t rxrpc_connection_lock;
522
523struct rxrpc_conn_bundle *rxrpc_get_bundle(struct rxrpc_sock *,
524 struct rxrpc_transport *,
525 struct key *, u16, gfp_t);
526void rxrpc_put_bundle(struct rxrpc_transport *, struct rxrpc_conn_bundle *);
527int rxrpc_connect_call(struct rxrpc_sock *, struct rxrpc_transport *,
528 struct rxrpc_conn_bundle *, struct rxrpc_call *, gfp_t);
529void rxrpc_put_connection(struct rxrpc_connection *);
530void __exit rxrpc_destroy_all_connections(void);
531struct rxrpc_connection *rxrpc_find_connection(struct rxrpc_transport *,
532 struct rxrpc_host_header *);
533extern struct rxrpc_connection *
534rxrpc_incoming_connection(struct rxrpc_transport *, struct rxrpc_host_header *,
535 gfp_t);
536
537/*
538 * ar-connevent.c
539 */
540void rxrpc_process_connection(struct work_struct *);
541void rxrpc_reject_packet(struct rxrpc_local *, struct sk_buff *);
542void rxrpc_reject_packets(struct work_struct *);
543
544/*
545 * ar-error.c
546 */
547void rxrpc_UDP_error_report(struct sock *);
548void rxrpc_UDP_error_handler(struct work_struct *);
549
550/*
551 * ar-input.c
552 */
553extern const char *rxrpc_pkts[];
554
555void rxrpc_data_ready(struct sock *);
556int rxrpc_queue_rcv_skb(struct rxrpc_call *, struct sk_buff *, bool, bool);
557void rxrpc_fast_process_packet(struct rxrpc_call *, struct sk_buff *);
558
559/*
560 * ar-local.c
561 */
562extern rwlock_t rxrpc_local_lock;
563
564struct rxrpc_local *rxrpc_lookup_local(struct sockaddr_rxrpc *);
565void rxrpc_put_local(struct rxrpc_local *);
566void __exit rxrpc_destroy_all_locals(void);
567
568/*
569 * ar-key.c
570 */
571extern struct key_type key_type_rxrpc;
572extern struct key_type key_type_rxrpc_s;
573
574int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
575int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
576int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
577 u32);
578
579/*
580 * ar-output.c
581 */
582extern unsigned int rxrpc_resend_timeout;
583
584int rxrpc_send_packet(struct rxrpc_transport *, struct sk_buff *);
585int rxrpc_client_sendmsg(struct rxrpc_sock *, struct rxrpc_transport *,
586 struct msghdr *, size_t);
587int rxrpc_server_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
588
589/*
590 * ar-peer.c
591 */
592struct rxrpc_peer *rxrpc_get_peer(struct sockaddr_rxrpc *, gfp_t);
593void rxrpc_put_peer(struct rxrpc_peer *);
594struct rxrpc_peer *rxrpc_find_peer(struct rxrpc_local *, __be32, __be16);
595void __exit rxrpc_destroy_all_peers(void);
596
597/*
598 * ar-proc.c
599 */
600extern const char *const rxrpc_call_states[];
601extern const struct file_operations rxrpc_call_seq_fops;
602extern const struct file_operations rxrpc_connection_seq_fops;
603
604/*
605 * ar-recvmsg.c
606 */
607void rxrpc_remove_user_ID(struct rxrpc_sock *, struct rxrpc_call *);
608int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
609
610/*
611 * ar-security.c
612 */
613int rxrpc_register_security(struct rxrpc_security *);
614void rxrpc_unregister_security(struct rxrpc_security *);
615int rxrpc_init_client_conn_security(struct rxrpc_connection *);
616int rxrpc_init_server_conn_security(struct rxrpc_connection *);
617int rxrpc_secure_packet(const struct rxrpc_call *, struct sk_buff *, size_t,
618 void *);
619int rxrpc_verify_packet(const struct rxrpc_call *, struct sk_buff *, u32 *);
620void rxrpc_clear_conn_security(struct rxrpc_connection *);
621
622/*
623 * ar-skbuff.c
624 */
625void rxrpc_packet_destructor(struct sk_buff *);
626
627/*
628 * ar-transport.c
629 */
630extern unsigned int rxrpc_transport_expiry;
631
632struct rxrpc_transport *rxrpc_get_transport(struct rxrpc_local *,
633 struct rxrpc_peer *, gfp_t);
634void rxrpc_put_transport(struct rxrpc_transport *);
635void __exit rxrpc_destroy_all_transports(void);
636struct rxrpc_transport *rxrpc_find_transport(struct rxrpc_local *,
637 struct rxrpc_peer *);
638
639/*
640 * sysctl.c
641 */
642#ifdef CONFIG_SYSCTL
643extern int __init rxrpc_sysctl_init(void);
644extern void rxrpc_sysctl_exit(void);
645#else
646static inline int __init rxrpc_sysctl_init(void) { return 0; }
647static inline void rxrpc_sysctl_exit(void) {}
648#endif
649
650/*
651 * debug tracing
652 */
653extern unsigned int rxrpc_debug;
654
655#define dbgprintk(FMT,...) \
656 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
657
658#define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
659#define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
660#define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
661#define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
662#define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
663
664
665#if defined(__KDEBUG)
666#define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
667#define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
668#define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
669#define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
670#define _net(FMT,...) knet(FMT,##__VA_ARGS__)
671
672#elif defined(CONFIG_AF_RXRPC_DEBUG)
673#define RXRPC_DEBUG_KENTER 0x01
674#define RXRPC_DEBUG_KLEAVE 0x02
675#define RXRPC_DEBUG_KDEBUG 0x04
676#define RXRPC_DEBUG_KPROTO 0x08
677#define RXRPC_DEBUG_KNET 0x10
678
679#define _enter(FMT,...) \
680do { \
681 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
682 kenter(FMT,##__VA_ARGS__); \
683} while (0)
684
685#define _leave(FMT,...) \
686do { \
687 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
688 kleave(FMT,##__VA_ARGS__); \
689} while (0)
690
691#define _debug(FMT,...) \
692do { \
693 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
694 kdebug(FMT,##__VA_ARGS__); \
695} while (0)
696
697#define _proto(FMT,...) \
698do { \
699 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
700 kproto(FMT,##__VA_ARGS__); \
701} while (0)
702
703#define _net(FMT,...) \
704do { \
705 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
706 knet(FMT,##__VA_ARGS__); \
707} while (0)
708
709#else
710#define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
711#define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
712#define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
713#define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
714#define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
715#endif
716
717/*
718 * debug assertion checking
719 */
720#if 1 // defined(__KDEBUGALL)
721
722#define ASSERT(X) \
723do { \
724 if (unlikely(!(X))) { \
725 printk(KERN_ERR "\n"); \
726 printk(KERN_ERR "RxRPC: Assertion failed\n"); \
727 BUG(); \
728 } \
729} while (0)
730
731#define ASSERTCMP(X, OP, Y) \
732do { \
733 if (unlikely(!((X) OP (Y)))) { \
734 printk(KERN_ERR "\n"); \
735 printk(KERN_ERR "RxRPC: Assertion failed\n"); \
736 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
737 (unsigned long)(X), (unsigned long)(Y)); \
738 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
739 (unsigned long)(X), (unsigned long)(Y)); \
740 BUG(); \
741 } \
742} while (0)
743
744#define ASSERTIF(C, X) \
745do { \
746 if (unlikely((C) && !(X))) { \
747 printk(KERN_ERR "\n"); \
748 printk(KERN_ERR "RxRPC: Assertion failed\n"); \
749 BUG(); \
750 } \
751} while (0)
752
753#define ASSERTIFCMP(C, X, OP, Y) \
754do { \
755 if (unlikely((C) && !((X) OP (Y)))) { \
756 printk(KERN_ERR "\n"); \
757 printk(KERN_ERR "RxRPC: Assertion failed\n"); \
758 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
759 (unsigned long)(X), (unsigned long)(Y)); \
760 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
761 (unsigned long)(X), (unsigned long)(Y)); \
762 BUG(); \
763 } \
764} while (0)
765
766#else
767
768#define ASSERT(X) \
769do { \
770} while (0)
771
772#define ASSERTCMP(X, OP, Y) \
773do { \
774} while (0)
775
776#define ASSERTIF(C, X) \
777do { \
778} while (0)
779
780#define ASSERTIFCMP(C, X, OP, Y) \
781do { \
782} while (0)
783
784#endif /* __KDEBUGALL */
785
786/*
787 * socket buffer accounting / leak finding
788 */
789static inline void __rxrpc_new_skb(struct sk_buff *skb, const char *fn)
790{
791 //_net("new skb %p %s [%d]", skb, fn, atomic_read(&rxrpc_n_skbs));
792 //atomic_inc(&rxrpc_n_skbs);
793}
794
795#define rxrpc_new_skb(skb) __rxrpc_new_skb((skb), __func__)
796
797static inline void __rxrpc_kill_skb(struct sk_buff *skb, const char *fn)
798{
799 //_net("kill skb %p %s [%d]", skb, fn, atomic_read(&rxrpc_n_skbs));
800 //atomic_dec(&rxrpc_n_skbs);
801}
802
803#define rxrpc_kill_skb(skb) __rxrpc_kill_skb((skb), __func__)
804
805static inline void __rxrpc_free_skb(struct sk_buff *skb, const char *fn)
806{
807 if (skb) {
808 CHECK_SLAB_OKAY(&skb->users);
809 //_net("free skb %p %s [%d]",
810 // skb, fn, atomic_read(&rxrpc_n_skbs));
811 //atomic_dec(&rxrpc_n_skbs);
812 kfree_skb(skb);
813 }
814}
815
816#define rxrpc_free_skb(skb) __rxrpc_free_skb((skb), __func__)
817
818static inline void rxrpc_purge_queue(struct sk_buff_head *list)
819{
820 struct sk_buff *skb;
821 while ((skb = skb_dequeue((list))) != NULL)
822 rxrpc_free_skb(skb);
823}
824
825static inline void __rxrpc_get_local(struct rxrpc_local *local, const char *f)
826{
827 CHECK_SLAB_OKAY(&local->usage);
828 if (atomic_inc_return(&local->usage) == 1)
829 printk("resurrected (%s)\n", f);
830}
831
832#define rxrpc_get_local(LOCAL) __rxrpc_get_local((LOCAL), __func__)
833
834#define rxrpc_get_call(CALL) \
835do { \
836 CHECK_SLAB_OKAY(&(CALL)->usage); \
837 if (atomic_inc_return(&(CALL)->usage) == 1) \
838 BUG(); \
839} while (0)
840
841#define rxrpc_put_call(CALL) \
842do { \
843 __rxrpc_put_call(CALL); \
844} while (0)