1 /* AF_RXRPC internal definitions
3 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
12 #include <linux/atomic.h>
13 #include <linux/seqlock.h>
14 #include <net/net_namespace.h>
15 #include <net/netns/generic.h>
17 #include <net/af_rxrpc.h>
21 #define CHECK_SLAB_OKAY(X) \
22 BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
23 (POISON_FREE << 8 | POISON_FREE))
25 #define CHECK_SLAB_OKAY(X) do {} while (0)
28 #define FCRYPT_BSIZE 8
34 } __attribute__((aligned(8)));
36 #define rxrpc_queue_work(WS) queue_work(rxrpc_workqueue, (WS))
37 #define rxrpc_queue_delayed_work(WS,D) \
38 queue_delayed_work(rxrpc_workqueue, (WS), (D))
40 struct rxrpc_connection;
43 * Mark applied to socket buffers in skb->mark. skb->priority is used
44 * to pass supplementary information.
47 RXRPC_SKB_MARK_REJECT_BUSY, /* Reject with BUSY */
48 RXRPC_SKB_MARK_REJECT_ABORT, /* Reject with ABORT (code in skb->priority) */
52 * sk_state for RxRPC sockets
56 RXRPC_CLIENT_UNBOUND, /* Unbound socket used as client */
57 RXRPC_CLIENT_BOUND, /* client local address bound */
58 RXRPC_SERVER_BOUND, /* server local address bound */
59 RXRPC_SERVER_BOUND2, /* second server local address bound */
60 RXRPC_SERVER_LISTENING, /* server listening for connections */
61 RXRPC_SERVER_LISTEN_DISABLED, /* server listening disabled */
62 RXRPC_CLOSE, /* socket is being closed */
66 * Per-network namespace data.
69 struct proc_dir_entry *proc_net; /* Subdir in /proc/net */
70 u32 epoch; /* Local epoch for detecting local-end reset */
71 struct list_head calls; /* List of calls active in this namespace */
72 rwlock_t call_lock; /* Lock for ->calls */
73 atomic_t nr_calls; /* Count of allocated calls */
76 struct list_head conn_proc_list; /* List of conns in this namespace for proc */
77 struct list_head service_conns; /* Service conns in this namespace */
78 rwlock_t conn_lock; /* Lock for ->conn_proc_list, ->service_conns */
79 struct work_struct service_conn_reaper;
80 struct timer_list service_conn_reap_timer;
82 unsigned int nr_client_conns;
83 unsigned int nr_active_client_conns;
84 bool kill_all_client_conns;
86 spinlock_t client_conn_cache_lock; /* Lock for ->*_client_conns */
87 spinlock_t client_conn_discard_lock; /* Prevent multiple discarders */
88 struct list_head waiting_client_conns;
89 struct list_head active_client_conns;
90 struct list_head idle_client_conns;
91 struct work_struct client_conn_reaper;
92 struct timer_list client_conn_reap_timer;
94 struct list_head local_endpoints;
95 struct mutex local_mutex; /* Lock for ->local_endpoints */
97 DECLARE_HASHTABLE (peer_hash, 10);
98 spinlock_t peer_hash_lock; /* Lock for ->peer_hash */
100 #define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
101 u8 peer_keepalive_cursor;
102 time64_t peer_keepalive_base;
103 struct list_head peer_keepalive[32];
104 struct list_head peer_keepalive_new;
105 struct timer_list peer_keepalive_timer;
106 struct work_struct peer_keepalive_work;
110 * Service backlog preallocation.
112 * This contains circular buffers of preallocated peers, connections and calls
113 * for incoming service calls and their head and tail pointers. This allows
114 * calls to be set up in the data_ready handler, thereby avoiding the need to
115 * shuffle packets around so much.
117 struct rxrpc_backlog {
118 unsigned short peer_backlog_head;
119 unsigned short peer_backlog_tail;
120 unsigned short conn_backlog_head;
121 unsigned short conn_backlog_tail;
122 unsigned short call_backlog_head;
123 unsigned short call_backlog_tail;
124 #define RXRPC_BACKLOG_MAX 32
125 struct rxrpc_peer *peer_backlog[RXRPC_BACKLOG_MAX];
126 struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
127 struct rxrpc_call *call_backlog[RXRPC_BACKLOG_MAX];
131 * RxRPC socket definition
134 /* WARNING: sk has to be the first member */
136 rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
137 rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
138 struct rxrpc_local *local; /* local endpoint */
139 struct rxrpc_backlog *backlog; /* Preallocation for services */
140 spinlock_t incoming_lock; /* Incoming call vs service shutdown lock */
141 struct list_head sock_calls; /* List of calls owned by this socket */
142 struct list_head to_be_accepted; /* calls awaiting acceptance */
143 struct list_head recvmsg_q; /* Calls awaiting recvmsg's attention */
144 rwlock_t recvmsg_lock; /* Lock for recvmsg_q */
145 struct key *key; /* security for this socket */
146 struct key *securities; /* list of server security descriptors */
147 struct rb_root calls; /* User ID -> call mapping */
149 #define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
150 rwlock_t call_lock; /* lock for calls */
151 u32 min_sec_level; /* minimum security level */
152 #define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
153 bool exclusive; /* Exclusive connection for a client socket */
154 u16 second_service; /* Additional service bound to the endpoint */
156 /* Service upgrade information */
157 u16 from; /* Service ID to upgrade (if not 0) */
158 u16 to; /* service ID to upgrade to */
160 sa_family_t family; /* Protocol family created with */
161 struct sockaddr_rxrpc srx; /* Primary Service/local addresses */
162 struct sockaddr_rxrpc connect_srx; /* Default client address from connect() */
165 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
168 * CPU-byteorder normalised Rx packet header.
170 struct rxrpc_host_header {
171 u32 epoch; /* client boot timestamp */
172 u32 cid; /* connection and channel ID */
173 u32 callNumber; /* call ID (0 for connection-level packets) */
174 u32 seq; /* sequence number of pkt in call stream */
175 u32 serial; /* serial number of pkt sent to network */
176 u8 type; /* packet type */
177 u8 flags; /* packet flags */
178 u8 userStatus; /* app-layer defined status */
179 u8 securityIndex; /* security protocol ID */
181 u16 _rsvd; /* reserved */
182 u16 cksum; /* kerberos security checksum */
184 u16 serviceId; /* service ID */
188 * RxRPC socket buffer private variables
189 * - max 48 bytes (struct sk_buff::cb)
191 struct rxrpc_skb_priv {
193 u8 nr_jumbo; /* Number of jumbo subpackets */
196 int remain; /* amount of space remaining for next write */
199 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
202 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
205 * RxRPC security module interface
207 struct rxrpc_security {
208 const char *name; /* name of this service */
209 u8 security_index; /* security type provided */
211 /* Initialise a security service */
214 /* Clean up a security service */
217 /* initialise a connection's security */
218 int (*init_connection_security)(struct rxrpc_connection *);
220 /* prime a connection's packet security */
221 int (*prime_packet_security)(struct rxrpc_connection *);
223 /* impose security on a packet */
224 int (*secure_packet)(struct rxrpc_call *,
229 /* verify the security on a received packet */
230 int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
231 unsigned int, unsigned int, rxrpc_seq_t, u16);
233 /* Locate the data in a received packet that has been verified. */
234 void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
235 unsigned int *, unsigned int *);
237 /* issue a challenge */
238 int (*issue_challenge)(struct rxrpc_connection *);
240 /* respond to a challenge */
241 int (*respond_to_challenge)(struct rxrpc_connection *,
245 /* verify a response */
246 int (*verify_response)(struct rxrpc_connection *,
250 /* clear connection security */
251 void (*clear)(struct rxrpc_connection *);
255 * RxRPC local transport endpoint description
256 * - owned by a single AF_RXRPC socket
257 * - pointed to by transport socket struct sk_user_data
262 struct rxrpc_net *rxnet; /* The network ns in which this resides */
263 struct list_head link;
264 struct socket *socket; /* my UDP socket */
265 struct work_struct processor;
266 struct rxrpc_sock __rcu *service; /* Service(s) listening on this endpoint */
267 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
268 struct sk_buff_head reject_queue; /* packets awaiting rejection */
269 struct sk_buff_head event_queue; /* endpoint event packets awaiting processing */
270 struct rb_root client_conns; /* Client connections by socket params */
271 spinlock_t client_conns_lock; /* Lock for client_conns */
272 spinlock_t lock; /* access lock */
273 rwlock_t services_lock; /* lock for services list */
274 int debug_id; /* debug ID for printks */
276 bool service_closed; /* Service socket closed */
277 struct sockaddr_rxrpc srx; /* local address */
281 * RxRPC remote transport endpoint definition
282 * - matched by local endpoint, remote port, address and protocol type
285 struct rcu_head rcu; /* This must be first */
287 unsigned long hash_key;
288 struct hlist_node hash_link;
289 struct rxrpc_local *local;
290 struct hlist_head error_targets; /* targets for net error distribution */
291 struct rb_root service_conns; /* Service connections */
292 struct list_head keepalive_link; /* Link in net->peer_keepalive[] */
293 time64_t last_tx_at; /* Last time packet sent here */
294 seqlock_t service_conn_lock;
295 spinlock_t lock; /* access lock */
296 unsigned int if_mtu; /* interface MTU for this peer */
297 unsigned int mtu; /* network MTU for this peer */
298 unsigned int maxdata; /* data size (MTU - hdrsize) */
299 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
300 int debug_id; /* debug ID for printks */
301 struct sockaddr_rxrpc srx; /* remote address */
303 /* calculated RTT cache */
304 #define RXRPC_RTT_CACHE_SIZE 32
305 ktime_t rtt_last_req; /* Time of last RTT request */
306 u64 rtt; /* Current RTT estimate (in nS) */
307 u64 rtt_sum; /* Sum of cache contents */
308 u64 rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* Determined RTT cache */
309 u8 rtt_cursor; /* next entry at which to insert */
310 u8 rtt_usage; /* amount of cache actually used */
312 u8 cong_cwnd; /* Congestion window size */
316 * Keys for matching a connection.
318 struct rxrpc_conn_proto {
321 u32 epoch; /* epoch of this connection */
322 u32 cid; /* connection ID */
328 struct rxrpc_conn_parameters {
329 struct rxrpc_local *local; /* Representation of local endpoint */
330 struct rxrpc_peer *peer; /* Remote endpoint */
331 struct key *key; /* Security details */
332 bool exclusive; /* T if conn is exclusive */
333 bool upgrade; /* T if service ID can be upgraded */
334 u16 service_id; /* Service ID for this connection */
335 u32 security_level; /* Security level selected */
339 * Bits in the connection flags.
341 enum rxrpc_conn_flag {
342 RXRPC_CONN_HAS_IDR, /* Has a client conn ID assigned */
343 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
344 RXRPC_CONN_IN_CLIENT_CONNS, /* Conn is in local->client_conns */
345 RXRPC_CONN_EXPOSED, /* Conn has extra ref for exposure */
346 RXRPC_CONN_DONT_REUSE, /* Don't reuse this connection */
347 RXRPC_CONN_COUNTED, /* Counted by rxrpc_nr_client_conns */
348 RXRPC_CONN_PROBING_FOR_UPGRADE, /* Probing for service upgrade */
349 RXRPC_CONN_FINAL_ACK_0, /* Need final ACK for channel 0 */
350 RXRPC_CONN_FINAL_ACK_1, /* Need final ACK for channel 1 */
351 RXRPC_CONN_FINAL_ACK_2, /* Need final ACK for channel 2 */
352 RXRPC_CONN_FINAL_ACK_3, /* Need final ACK for channel 3 */
355 #define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) | \
356 (1UL << RXRPC_CONN_FINAL_ACK_1) | \
357 (1UL << RXRPC_CONN_FINAL_ACK_2) | \
358 (1UL << RXRPC_CONN_FINAL_ACK_3))
361 * Events that can be raised upon a connection.
363 enum rxrpc_conn_event {
364 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
368 * The connection cache state.
370 enum rxrpc_conn_cache_state {
371 RXRPC_CONN_CLIENT_INACTIVE, /* Conn is not yet listed */
372 RXRPC_CONN_CLIENT_WAITING, /* Conn is on wait list, waiting for capacity */
373 RXRPC_CONN_CLIENT_ACTIVE, /* Conn is on active list, doing calls */
374 RXRPC_CONN_CLIENT_UPGRADE, /* Conn is on active list, probing for upgrade */
375 RXRPC_CONN_CLIENT_CULLED, /* Conn is culled and delisted, doing calls */
376 RXRPC_CONN_CLIENT_IDLE, /* Conn is on idle list, doing mostly nothing */
377 RXRPC_CONN__NR_CACHE_STATES
381 * The connection protocol state.
383 enum rxrpc_conn_proto_state {
384 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
385 RXRPC_CONN_CLIENT, /* Client connection */
386 RXRPC_CONN_SERVICE_PREALLOC, /* Service connection preallocation */
387 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
388 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
389 RXRPC_CONN_SERVICE, /* Service secured connection */
390 RXRPC_CONN_REMOTELY_ABORTED, /* Conn aborted by peer */
391 RXRPC_CONN_LOCALLY_ABORTED, /* Conn aborted locally */
392 RXRPC_CONN__NR_STATES
396 * RxRPC connection definition
397 * - matched by { local, peer, epoch, conn_id, direction }
398 * - each connection can only handle four simultaneous calls
400 struct rxrpc_connection {
401 struct rxrpc_conn_proto proto;
402 struct rxrpc_conn_parameters params;
406 struct list_head cache_link;
408 spinlock_t channel_lock;
409 unsigned char active_chans; /* Mask of active channels */
410 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
411 struct list_head waiting_calls; /* Calls waiting for channels */
412 struct rxrpc_channel {
413 unsigned long final_ack_at; /* Time at which to issue final ACK */
414 struct rxrpc_call __rcu *call; /* Active call */
415 unsigned int call_debug_id; /* call->debug_id */
416 u32 call_id; /* ID of current call */
417 u32 call_counter; /* Call ID counter */
418 u32 last_call; /* ID of last call */
419 u8 last_type; /* Type of last packet */
424 } channels[RXRPC_MAXCALLS];
426 struct timer_list timer; /* Conn event timer */
427 struct work_struct processor; /* connection event processor */
429 struct rb_node client_node; /* Node in local->client_conns */
430 struct rb_node service_node; /* Node in peer->service_conns */
432 struct list_head proc_link; /* link in procfs list */
433 struct list_head link; /* link in master connection list */
434 struct sk_buff_head rx_queue; /* received conn-level packets */
435 const struct rxrpc_security *security; /* applied security module */
436 struct key *server_key; /* security for this service */
437 struct crypto_skcipher *cipher; /* encryption handle */
438 struct rxrpc_crypt csum_iv; /* packet checksum base */
440 unsigned long events;
441 unsigned long idle_timestamp; /* Time at which last became idle */
442 spinlock_t state_lock; /* state-change lock */
443 enum rxrpc_conn_cache_state cache_state;
444 enum rxrpc_conn_proto_state state; /* current state of connection */
445 u32 local_abort; /* local abort code */
446 u32 remote_abort; /* remote abort code */
447 int debug_id; /* debug ID for printks */
448 atomic_t serial; /* packet serial number counter */
449 unsigned int hi_serial; /* highest serial number received */
450 u32 security_nonce; /* response re-use preventer */
451 u16 service_id; /* Service ID, possibly upgraded */
452 u8 size_align; /* data size alignment (for security) */
453 u8 security_size; /* security header size */
454 u8 security_ix; /* security type */
455 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
458 static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
460 return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
463 static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
465 return !rxrpc_to_server(sp);
469 * Flags in call->flags.
471 enum rxrpc_call_flag {
472 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
473 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
474 RXRPC_CALL_IS_SERVICE, /* Call is service call */
475 RXRPC_CALL_EXPOSED, /* The call was exposed to the world */
476 RXRPC_CALL_RX_LAST, /* Received the last packet (at rxtx_top) */
477 RXRPC_CALL_TX_LAST, /* Last packet in Tx buffer (at rxtx_top) */
478 RXRPC_CALL_TX_LASTQ, /* Last packet has been queued */
479 RXRPC_CALL_SEND_PING, /* A ping will need to be sent */
480 RXRPC_CALL_PINGING, /* Ping in process */
481 RXRPC_CALL_RETRANS_TIMEOUT, /* Retransmission due to timeout occurred */
482 RXRPC_CALL_BEGAN_RX_TIMER, /* We began the expect_rx_by timer */
483 RXRPC_CALL_RX_HEARD, /* The peer responded at least once to this call */
484 RXRPC_CALL_RX_UNDERRUN, /* Got data underrun */
488 * Events that can be raised on a call.
490 enum rxrpc_call_event {
491 RXRPC_CALL_EV_ACK, /* need to generate ACK */
492 RXRPC_CALL_EV_ABORT, /* need to generate abort */
493 RXRPC_CALL_EV_RESEND, /* Tx resend required */
494 RXRPC_CALL_EV_PING, /* Ping send required */
495 RXRPC_CALL_EV_EXPIRED, /* Expiry occurred */
496 RXRPC_CALL_EV_ACK_LOST, /* ACK may be lost, send ping */
500 * The states that a call can be in.
502 enum rxrpc_call_state {
503 RXRPC_CALL_UNINITIALISED,
504 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
505 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
506 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
507 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
508 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
509 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
510 RXRPC_CALL_SERVER_ACCEPTING, /* - server accepting request */
511 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
512 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
513 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
514 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
515 RXRPC_CALL_COMPLETE, /* - call complete */
516 NR__RXRPC_CALL_STATES
520 * Call Tx congestion management modes.
522 enum rxrpc_congest_mode {
523 RXRPC_CALL_SLOW_START,
524 RXRPC_CALL_CONGEST_AVOIDANCE,
525 RXRPC_CALL_PACKET_LOSS,
526 RXRPC_CALL_FAST_RETRANSMIT,
527 NR__RXRPC_CONGEST_MODES
531 * RxRPC call definition
532 * - matched by { connection, call_id }
536 struct rxrpc_connection *conn; /* connection carrying call */
537 struct rxrpc_peer *peer; /* Peer record for remote address */
538 struct rxrpc_sock __rcu *socket; /* socket responsible */
539 struct rxrpc_net *rxnet; /* Network namespace to which call belongs */
540 struct mutex user_mutex; /* User access mutex */
541 unsigned long ack_at; /* When deferred ACK needs to happen */
542 unsigned long ack_lost_at; /* When ACK is figured as lost */
543 unsigned long resend_at; /* When next resend needs to happen */
544 unsigned long ping_at; /* When next to send a ping */
545 unsigned long keepalive_at; /* When next to send a keepalive ping */
546 unsigned long expect_rx_by; /* When we expect to get a packet by */
547 unsigned long expect_req_by; /* When we expect to get a request DATA packet by */
548 unsigned long expect_term_by; /* When we expect call termination by */
549 u32 next_rx_timo; /* Timeout for next Rx packet (jif) */
550 u32 next_req_timo; /* Timeout for next Rx request packet (jif) */
551 struct timer_list timer; /* Combined event timer */
552 struct work_struct processor; /* Event processor */
553 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
554 struct list_head link; /* link in master call list */
555 struct list_head chan_wait_link; /* Link in conn->waiting_calls */
556 struct hlist_node error_link; /* link in error distribution list */
557 struct list_head accept_link; /* Link in rx->acceptq */
558 struct list_head recvmsg_link; /* Link in rx->recvmsg_q */
559 struct list_head sock_link; /* Link in rx->sock_calls */
560 struct rb_node sock_node; /* Node in rx->calls */
561 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
562 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
563 s64 tx_total_len; /* Total length left to be transmitted (or -1) */
564 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
565 unsigned long user_call_ID; /* user-defined call ID */
567 unsigned long events;
569 spinlock_t notify_lock; /* Kernel notification lock */
570 rwlock_t state_lock; /* lock for state transition */
571 u32 abort_code; /* Local/remote abort code */
572 int error; /* Local error incurred */
573 enum rxrpc_call_state state; /* current state of call */
574 enum rxrpc_call_completion completion; /* Call completion condition */
576 u16 service_id; /* service ID */
577 u8 security_ix; /* Security type */
578 u32 call_id; /* call ID on connection */
579 u32 cid; /* connection ID plus channel index */
580 int debug_id; /* debug ID for printks */
581 unsigned short rx_pkt_offset; /* Current recvmsg packet offset */
582 unsigned short rx_pkt_len; /* Current recvmsg packet len */
584 /* Rx/Tx circular buffer, depending on phase.
586 * In the Rx phase, packets are annotated with 0 or the number of the
587 * segment of a jumbo packet each buffer refers to. There can be up to
588 * 47 segments in a maximum-size UDP packet.
590 * In the Tx phase, packets are annotated with which buffers have been
593 #define RXRPC_RXTX_BUFF_SIZE 64
594 #define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
595 #define RXRPC_INIT_RX_WINDOW_SIZE 63
596 struct sk_buff **rxtx_buffer;
597 u8 *rxtx_annotations;
598 #define RXRPC_TX_ANNO_ACK 0
599 #define RXRPC_TX_ANNO_UNACK 1
600 #define RXRPC_TX_ANNO_NAK 2
601 #define RXRPC_TX_ANNO_RETRANS 3
602 #define RXRPC_TX_ANNO_MASK 0x03
603 #define RXRPC_TX_ANNO_LAST 0x04
604 #define RXRPC_TX_ANNO_RESENT 0x08
606 #define RXRPC_RX_ANNO_JUMBO 0x3f /* Jumbo subpacket number + 1 if not zero */
607 #define RXRPC_RX_ANNO_JLAST 0x40 /* Set if last element of a jumbo packet */
608 #define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
609 rxrpc_seq_t tx_hard_ack; /* Dead slot in buffer; the first transmitted but
610 * not hard-ACK'd packet follows this.
612 rxrpc_seq_t tx_top; /* Highest Tx slot allocated. */
614 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
615 * is fixed, we keep these numbers in terms of segments (ie. DATA
616 * packets) rather than bytes.
618 #define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
619 u8 cong_cwnd; /* Congestion window size */
620 u8 cong_extra; /* Extra to send for congestion management */
621 u8 cong_ssthresh; /* Slow-start threshold */
622 enum rxrpc_congest_mode cong_mode:8; /* Congestion management mode */
623 u8 cong_dup_acks; /* Count of ACKs showing missing packets */
624 u8 cong_cumul_acks; /* Cumulative ACK count */
625 ktime_t cong_tstamp; /* Last time cwnd was changed */
627 rxrpc_seq_t rx_hard_ack; /* Dead slot in buffer; the first received but not
628 * consumed packet follows this.
630 rxrpc_seq_t rx_top; /* Highest Rx slot allocated. */
631 rxrpc_seq_t rx_expect_next; /* Expected next packet sequence number */
632 rxrpc_serial_t rx_serial; /* Highest serial received for this call */
633 u8 rx_winsize; /* Size of Rx window */
634 u8 tx_winsize; /* Maximum size of Tx window */
635 bool tx_phase; /* T if transmission phase, F if receive phase */
636 u8 nr_jumbo_bad; /* Number of jumbo dups/exceeds-windows */
638 /* receive-phase ACK management */
639 u8 ackr_reason; /* reason to ACK */
640 u16 ackr_skew; /* skew on packet being ACK'd */
641 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
642 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
643 rxrpc_seq_t ackr_consumed; /* Highest packet shown consumed */
644 rxrpc_seq_t ackr_seen; /* Highest packet shown seen */
646 /* ping management */
647 rxrpc_serial_t ping_serial; /* Last ping sent */
648 ktime_t ping_time; /* Time last ping sent */
650 /* transmission-phase ACK management */
651 ktime_t acks_latest_ts; /* Timestamp of latest ACK received */
652 rxrpc_serial_t acks_latest; /* serial number of latest ACK received */
653 rxrpc_seq_t acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
654 rxrpc_seq_t acks_lost_top; /* tx_top at the time lost-ack ping sent */
655 rxrpc_serial_t acks_lost_ping; /* Serial number of probe ACK */
659 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
661 struct rxrpc_ack_summary {
663 u8 nr_acks; /* Number of ACKs in packet */
664 u8 nr_nacks; /* Number of NACKs in packet */
665 u8 nr_new_acks; /* Number of new ACKs in packet */
666 u8 nr_new_nacks; /* Number of new NACKs in packet */
667 u8 nr_rot_new_acks; /* Number of rotated new ACKs */
668 bool new_low_nack; /* T if new low NACK found */
669 bool retrans_timeo; /* T if reTx due to timeout happened */
670 u8 flight_size; /* Number of unreceived transmissions */
671 /* Place to stash values for tracing */
672 enum rxrpc_congest_mode mode:8;
680 * sendmsg() cmsg-specified parameters.
683 RXRPC_CMD_SEND_DATA, /* send data message */
684 RXRPC_CMD_SEND_ABORT, /* request abort generation */
685 RXRPC_CMD_ACCEPT, /* [server] accept incoming call */
686 RXRPC_CMD_REJECT_BUSY, /* [server] reject a call as busy */
689 struct rxrpc_call_params {
690 s64 tx_total_len; /* Total Tx data length (if send data) */
691 unsigned long user_call_ID; /* User's call ID */
693 u32 hard; /* Maximum lifetime (sec) */
694 u32 idle; /* Max time since last data packet (msec) */
695 u32 normal; /* Max time since last call packet (msec) */
697 u8 nr_timeouts; /* Number of timeouts specified */
700 struct rxrpc_send_params {
701 struct rxrpc_call_params call;
702 u32 abort_code; /* Abort code to Tx (if abort) */
703 enum rxrpc_command command : 8; /* The command to implement */
704 bool exclusive; /* Shared or exclusive call */
705 bool upgrade; /* If the connection is upgradeable */
708 #include <trace/events/rxrpc.h>
713 extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
714 extern struct workqueue_struct *rxrpc_workqueue;
719 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
720 void rxrpc_discard_prealloc(struct rxrpc_sock *);
721 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
724 struct rxrpc_connection *,
726 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
727 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
729 int rxrpc_reject_call(struct rxrpc_sock *);
734 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool, bool,
735 enum rxrpc_propose_ack_trace);
736 void rxrpc_process_call(struct work_struct *);
738 static inline void rxrpc_reduce_call_timer(struct rxrpc_call *call,
739 unsigned long expire_at,
741 enum rxrpc_timer_trace why)
743 trace_rxrpc_timer(call, why, now);
744 timer_reduce(&call->timer, expire_at);
750 extern const char *const rxrpc_call_states[];
751 extern const char *const rxrpc_call_completions[];
752 extern unsigned int rxrpc_max_call_lifetime;
753 extern struct kmem_cache *rxrpc_call_jar;
755 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
756 struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
757 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
758 struct rxrpc_conn_parameters *,
759 struct sockaddr_rxrpc *,
760 struct rxrpc_call_params *, gfp_t,
762 int rxrpc_retry_client_call(struct rxrpc_sock *,
764 struct rxrpc_conn_parameters *,
765 struct sockaddr_rxrpc *,
767 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
769 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
770 int rxrpc_prepare_call_for_retry(struct rxrpc_sock *, struct rxrpc_call *);
771 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
772 bool __rxrpc_queue_call(struct rxrpc_call *);
773 bool rxrpc_queue_call(struct rxrpc_call *);
774 void rxrpc_see_call(struct rxrpc_call *);
775 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
776 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
777 void rxrpc_cleanup_call(struct rxrpc_call *);
778 void rxrpc_destroy_all_calls(struct rxrpc_net *);
780 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
782 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
785 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
787 return !rxrpc_is_service_call(call);
791 * Transition a call to the complete state.
793 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
794 enum rxrpc_call_completion compl,
798 if (call->state < RXRPC_CALL_COMPLETE) {
799 call->abort_code = abort_code;
801 call->completion = compl,
802 call->state = RXRPC_CALL_COMPLETE;
803 trace_rxrpc_call_complete(call);
804 wake_up(&call->waitq);
810 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
811 enum rxrpc_call_completion compl,
817 write_lock_bh(&call->state_lock);
818 ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
819 write_unlock_bh(&call->state_lock);
824 * Record that a call successfully completed.
826 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
828 return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
831 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
835 write_lock_bh(&call->state_lock);
836 ret = __rxrpc_call_completed(call);
837 write_unlock_bh(&call->state_lock);
842 * Record that a call is locally aborted.
844 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
846 u32 abort_code, int error)
848 trace_rxrpc_abort(call->debug_id, why, call->cid, call->call_id, seq,
850 return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
854 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
855 rxrpc_seq_t seq, u32 abort_code, int error)
859 write_lock_bh(&call->state_lock);
860 ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
861 write_unlock_bh(&call->state_lock);
866 * Abort a call due to a protocol error.
868 static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
870 const char *eproto_why,
874 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
876 trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
877 return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
880 #define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
881 __rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
882 (abort_why), (abort_code))
887 extern unsigned int rxrpc_max_client_connections;
888 extern unsigned int rxrpc_reap_client_connections;
889 extern unsigned long rxrpc_conn_idle_client_expiry;
890 extern unsigned long rxrpc_conn_idle_client_fast_expiry;
891 extern struct idr rxrpc_client_conn_ids;
893 void rxrpc_destroy_client_conn_ids(void);
894 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
895 struct sockaddr_rxrpc *, gfp_t);
896 void rxrpc_expose_client_call(struct rxrpc_call *);
897 void rxrpc_disconnect_client_call(struct rxrpc_call *);
898 void rxrpc_put_client_conn(struct rxrpc_connection *);
899 void rxrpc_discard_expired_client_conns(struct work_struct *);
900 void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
905 void rxrpc_process_connection(struct work_struct *);
910 extern unsigned int rxrpc_connection_expiry;
911 extern unsigned int rxrpc_closed_conn_expiry;
913 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
914 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
916 struct rxrpc_peer **);
917 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
918 void rxrpc_disconnect_call(struct rxrpc_call *);
919 void rxrpc_kill_connection(struct rxrpc_connection *);
920 bool rxrpc_queue_conn(struct rxrpc_connection *);
921 void rxrpc_see_connection(struct rxrpc_connection *);
922 void rxrpc_get_connection(struct rxrpc_connection *);
923 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
924 void rxrpc_put_service_conn(struct rxrpc_connection *);
925 void rxrpc_service_connection_reaper(struct work_struct *);
926 void rxrpc_destroy_all_connections(struct rxrpc_net *);
928 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
930 return conn->out_clientflag;
933 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
935 return !rxrpc_conn_is_client(conn);
938 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
943 if (rxrpc_conn_is_client(conn))
944 rxrpc_put_client_conn(conn);
946 rxrpc_put_service_conn(conn);
949 static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
950 unsigned long expire_at)
952 timer_reduce(&conn->timer, expire_at);
958 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
960 struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
961 void rxrpc_new_incoming_connection(struct rxrpc_sock *,
962 struct rxrpc_connection *, struct sk_buff *);
963 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
968 void rxrpc_data_ready(struct sock *);
973 extern const struct rxrpc_security rxrpc_no_security;
978 extern struct key_type key_type_rxrpc;
979 extern struct key_type key_type_rxrpc_s;
981 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
982 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
983 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
989 extern void rxrpc_process_local_events(struct rxrpc_local *);
994 struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
995 struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *);
996 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *);
997 void rxrpc_put_local(struct rxrpc_local *);
998 void rxrpc_queue_local(struct rxrpc_local *);
999 void rxrpc_destroy_all_locals(struct rxrpc_net *);
1004 extern unsigned int rxrpc_max_backlog __read_mostly;
1005 extern unsigned long rxrpc_requested_ack_delay;
1006 extern unsigned long rxrpc_soft_ack_delay;
1007 extern unsigned long rxrpc_idle_ack_delay;
1008 extern unsigned int rxrpc_rx_window_size;
1009 extern unsigned int rxrpc_rx_mtu;
1010 extern unsigned int rxrpc_rx_jumbo_max;
1011 extern unsigned long rxrpc_resend_timeout;
1013 extern const s8 rxrpc_ack_priority[];
1018 extern unsigned int rxrpc_net_id;
1019 extern struct pernet_operations rxrpc_net_ops;
1021 static inline struct rxrpc_net *rxrpc_net(struct net *net)
1023 return net_generic(net, rxrpc_net_id);
1029 int rxrpc_send_ack_packet(struct rxrpc_call *, bool, rxrpc_serial_t *);
1030 int rxrpc_send_abort_packet(struct rxrpc_call *);
1031 int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
1032 void rxrpc_reject_packets(struct rxrpc_local *);
1033 void rxrpc_send_keepalive(struct rxrpc_peer *);
1038 void rxrpc_error_report(struct sock *);
1039 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace,
1040 rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1041 void rxrpc_peer_keepalive_worker(struct work_struct *);
1046 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1047 const struct sockaddr_rxrpc *);
1048 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
1049 struct sockaddr_rxrpc *, gfp_t);
1050 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
1051 void rxrpc_new_incoming_peer(struct rxrpc_local *, struct rxrpc_peer *);
1052 void rxrpc_destroy_all_peers(struct rxrpc_net *);
1053 struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *);
1054 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *);
1055 void rxrpc_put_peer(struct rxrpc_peer *);
1060 extern const struct seq_operations rxrpc_call_seq_ops;
1061 extern const struct seq_operations rxrpc_connection_seq_ops;
1066 void rxrpc_notify_socket(struct rxrpc_call *);
1067 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1073 extern const struct rxrpc_security rxkad;
1079 int __init rxrpc_init_security(void);
1080 void rxrpc_exit_security(void);
1081 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1082 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
1087 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1092 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1093 void rxrpc_packet_destructor(struct sk_buff *);
1094 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1095 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1096 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1097 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1098 void rxrpc_lose_skb(struct sk_buff *, enum rxrpc_skb_trace);
1099 void rxrpc_purge_queue(struct sk_buff_head *);
1104 #ifdef CONFIG_SYSCTL
1105 extern int __init rxrpc_sysctl_init(void);
1106 extern void rxrpc_sysctl_exit(void);
1108 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1109 static inline void rxrpc_sysctl_exit(void) {}
1115 int rxrpc_extract_addr_from_skb(struct rxrpc_local *, struct sockaddr_rxrpc *,
1118 static inline bool before(u32 seq1, u32 seq2)
1120 return (s32)(seq1 - seq2) < 0;
1122 static inline bool before_eq(u32 seq1, u32 seq2)
1124 return (s32)(seq1 - seq2) <= 0;
1126 static inline bool after(u32 seq1, u32 seq2)
1128 return (s32)(seq1 - seq2) > 0;
1130 static inline bool after_eq(u32 seq1, u32 seq2)
1132 return (s32)(seq1 - seq2) >= 0;
1138 extern unsigned int rxrpc_debug;
1140 #define dbgprintk(FMT,...) \
1141 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1143 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1144 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1145 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1146 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1147 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1150 #if defined(__KDEBUG)
1151 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1152 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1153 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1154 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1155 #define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1157 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1158 #define RXRPC_DEBUG_KENTER 0x01
1159 #define RXRPC_DEBUG_KLEAVE 0x02
1160 #define RXRPC_DEBUG_KDEBUG 0x04
1161 #define RXRPC_DEBUG_KPROTO 0x08
1162 #define RXRPC_DEBUG_KNET 0x10
1164 #define _enter(FMT,...) \
1166 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1167 kenter(FMT,##__VA_ARGS__); \
1170 #define _leave(FMT,...) \
1172 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1173 kleave(FMT,##__VA_ARGS__); \
1176 #define _debug(FMT,...) \
1178 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1179 kdebug(FMT,##__VA_ARGS__); \
1182 #define _proto(FMT,...) \
1184 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1185 kproto(FMT,##__VA_ARGS__); \
1188 #define _net(FMT,...) \
1190 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1191 knet(FMT,##__VA_ARGS__); \
1195 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1196 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1197 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1198 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1199 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1203 * debug assertion checking
1205 #if 1 // defined(__KDEBUGALL)
1209 if (unlikely(!(X))) { \
1210 pr_err("Assertion failed\n"); \
1215 #define ASSERTCMP(X, OP, Y) \
1217 __typeof__(X) _x = (X); \
1218 __typeof__(Y) _y = (__typeof__(X))(Y); \
1219 if (unlikely(!(_x OP _y))) { \
1220 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1221 (unsigned long)_x, (unsigned long)_x, #OP, \
1222 (unsigned long)_y, (unsigned long)_y); \
1227 #define ASSERTIF(C, X) \
1229 if (unlikely((C) && !(X))) { \
1230 pr_err("Assertion failed\n"); \
1235 #define ASSERTIFCMP(C, X, OP, Y) \
1237 __typeof__(X) _x = (X); \
1238 __typeof__(Y) _y = (__typeof__(X))(Y); \
1239 if (unlikely((C) && !(_x OP _y))) { \
1240 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1241 (unsigned long)_x, (unsigned long)_x, #OP, \
1242 (unsigned long)_y, (unsigned long)_y); \
1253 #define ASSERTCMP(X, OP, Y) \
1257 #define ASSERTIF(C, X) \
1261 #define ASSERTIFCMP(C, X, OP, Y) \
1265 #endif /* __KDEBUGALL */