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.
46 RXRPC_SKB_MARK_DATA, /* data message */
47 RXRPC_SKB_MARK_FINAL_ACK, /* final ACK received message */
48 RXRPC_SKB_MARK_BUSY, /* server busy message */
49 RXRPC_SKB_MARK_REMOTE_ABORT, /* remote abort message */
50 RXRPC_SKB_MARK_LOCAL_ABORT, /* local abort message */
51 RXRPC_SKB_MARK_NET_ERROR, /* network error message */
52 RXRPC_SKB_MARK_LOCAL_ERROR, /* local error message */
53 RXRPC_SKB_MARK_NEW_CALL, /* local error message */
57 * sk_state for RxRPC sockets
61 RXRPC_CLIENT_UNBOUND, /* Unbound socket used as client */
62 RXRPC_CLIENT_BOUND, /* client local address bound */
63 RXRPC_SERVER_BOUND, /* server local address bound */
64 RXRPC_SERVER_BOUND2, /* second server local address bound */
65 RXRPC_SERVER_LISTENING, /* server listening for connections */
66 RXRPC_SERVER_LISTEN_DISABLED, /* server listening disabled */
67 RXRPC_CLOSE, /* socket is being closed */
71 * Per-network namespace data.
74 struct proc_dir_entry *proc_net; /* Subdir in /proc/net */
75 u32 epoch; /* Local epoch for detecting local-end reset */
76 struct list_head calls; /* List of calls active in this namespace */
77 rwlock_t call_lock; /* Lock for ->calls */
78 atomic_t nr_calls; /* Count of allocated calls */
81 struct list_head conn_proc_list; /* List of conns in this namespace for proc */
82 struct list_head service_conns; /* Service conns in this namespace */
83 rwlock_t conn_lock; /* Lock for ->conn_proc_list, ->service_conns */
84 struct work_struct service_conn_reaper;
85 struct timer_list service_conn_reap_timer;
87 unsigned int nr_client_conns;
88 unsigned int nr_active_client_conns;
89 bool kill_all_client_conns;
91 spinlock_t client_conn_cache_lock; /* Lock for ->*_client_conns */
92 spinlock_t client_conn_discard_lock; /* Prevent multiple discarders */
93 struct list_head waiting_client_conns;
94 struct list_head active_client_conns;
95 struct list_head idle_client_conns;
96 struct work_struct client_conn_reaper;
97 struct timer_list client_conn_reap_timer;
99 struct list_head local_endpoints;
100 struct mutex local_mutex; /* Lock for ->local_endpoints */
102 DECLARE_HASHTABLE (peer_hash, 10);
103 spinlock_t peer_hash_lock; /* Lock for ->peer_hash */
105 #define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
106 u8 peer_keepalive_cursor;
107 ktime_t peer_keepalive_base;
108 struct hlist_head peer_keepalive[RXRPC_KEEPALIVE_TIME + 1];
109 struct hlist_head peer_keepalive_new;
110 struct timer_list peer_keepalive_timer;
111 struct work_struct peer_keepalive_work;
115 * Service backlog preallocation.
117 * This contains circular buffers of preallocated peers, connections and calls
118 * for incoming service calls and their head and tail pointers. This allows
119 * calls to be set up in the data_ready handler, thereby avoiding the need to
120 * shuffle packets around so much.
122 struct rxrpc_backlog {
123 unsigned short peer_backlog_head;
124 unsigned short peer_backlog_tail;
125 unsigned short conn_backlog_head;
126 unsigned short conn_backlog_tail;
127 unsigned short call_backlog_head;
128 unsigned short call_backlog_tail;
129 #define RXRPC_BACKLOG_MAX 32
130 struct rxrpc_peer *peer_backlog[RXRPC_BACKLOG_MAX];
131 struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
132 struct rxrpc_call *call_backlog[RXRPC_BACKLOG_MAX];
136 * RxRPC socket definition
139 /* WARNING: sk has to be the first member */
141 rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
142 rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
143 struct rxrpc_local *local; /* local endpoint */
144 struct rxrpc_backlog *backlog; /* Preallocation for services */
145 spinlock_t incoming_lock; /* Incoming call vs service shutdown lock */
146 struct list_head sock_calls; /* List of calls owned by this socket */
147 struct list_head to_be_accepted; /* calls awaiting acceptance */
148 struct list_head recvmsg_q; /* Calls awaiting recvmsg's attention */
149 rwlock_t recvmsg_lock; /* Lock for recvmsg_q */
150 struct key *key; /* security for this socket */
151 struct key *securities; /* list of server security descriptors */
152 struct rb_root calls; /* User ID -> call mapping */
154 #define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
155 rwlock_t call_lock; /* lock for calls */
156 u32 min_sec_level; /* minimum security level */
157 #define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
158 bool exclusive; /* Exclusive connection for a client socket */
159 u16 second_service; /* Additional service bound to the endpoint */
161 /* Service upgrade information */
162 u16 from; /* Service ID to upgrade (if not 0) */
163 u16 to; /* service ID to upgrade to */
165 sa_family_t family; /* Protocol family created with */
166 struct sockaddr_rxrpc srx; /* Primary Service/local addresses */
167 struct sockaddr_rxrpc connect_srx; /* Default client address from connect() */
170 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
173 * CPU-byteorder normalised Rx packet header.
175 struct rxrpc_host_header {
176 u32 epoch; /* client boot timestamp */
177 u32 cid; /* connection and channel ID */
178 u32 callNumber; /* call ID (0 for connection-level packets) */
179 u32 seq; /* sequence number of pkt in call stream */
180 u32 serial; /* serial number of pkt sent to network */
181 u8 type; /* packet type */
182 u8 flags; /* packet flags */
183 u8 userStatus; /* app-layer defined status */
184 u8 securityIndex; /* security protocol ID */
186 u16 _rsvd; /* reserved */
187 u16 cksum; /* kerberos security checksum */
189 u16 serviceId; /* service ID */
193 * RxRPC socket buffer private variables
194 * - max 48 bytes (struct sk_buff::cb)
196 struct rxrpc_skb_priv {
198 u8 nr_jumbo; /* Number of jumbo subpackets */
201 int remain; /* amount of space remaining for next write */
204 struct rxrpc_host_header hdr; /* RxRPC packet header from this packet */
207 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
210 * RxRPC security module interface
212 struct rxrpc_security {
213 const char *name; /* name of this service */
214 u8 security_index; /* security type provided */
216 /* Initialise a security service */
219 /* Clean up a security service */
222 /* initialise a connection's security */
223 int (*init_connection_security)(struct rxrpc_connection *);
225 /* prime a connection's packet security */
226 int (*prime_packet_security)(struct rxrpc_connection *);
228 /* impose security on a packet */
229 int (*secure_packet)(struct rxrpc_call *,
234 /* verify the security on a received packet */
235 int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
236 unsigned int, unsigned int, rxrpc_seq_t, u16);
238 /* Locate the data in a received packet that has been verified. */
239 void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
240 unsigned int *, unsigned int *);
242 /* issue a challenge */
243 int (*issue_challenge)(struct rxrpc_connection *);
245 /* respond to a challenge */
246 int (*respond_to_challenge)(struct rxrpc_connection *,
250 /* verify a response */
251 int (*verify_response)(struct rxrpc_connection *,
255 /* clear connection security */
256 void (*clear)(struct rxrpc_connection *);
260 * RxRPC local transport endpoint description
261 * - owned by a single AF_RXRPC socket
262 * - pointed to by transport socket struct sk_user_data
267 struct rxrpc_net *rxnet; /* The network ns in which this resides */
268 struct list_head link;
269 struct socket *socket; /* my UDP socket */
270 struct work_struct processor;
271 struct rxrpc_sock __rcu *service; /* Service(s) listening on this endpoint */
272 struct rw_semaphore defrag_sem; /* control re-enablement of IP DF bit */
273 struct sk_buff_head reject_queue; /* packets awaiting rejection */
274 struct sk_buff_head event_queue; /* endpoint event packets awaiting processing */
275 struct rb_root client_conns; /* Client connections by socket params */
276 spinlock_t client_conns_lock; /* Lock for client_conns */
277 spinlock_t lock; /* access lock */
278 rwlock_t services_lock; /* lock for services list */
279 int debug_id; /* debug ID for printks */
281 bool service_closed; /* Service socket closed */
282 struct sockaddr_rxrpc srx; /* local address */
286 * RxRPC remote transport endpoint definition
287 * - matched by local endpoint, remote port, address and protocol type
290 struct rcu_head rcu; /* This must be first */
292 unsigned long hash_key;
293 struct hlist_node hash_link;
294 struct rxrpc_local *local;
295 struct hlist_head error_targets; /* targets for net error distribution */
296 struct work_struct error_distributor;
297 struct rb_root service_conns; /* Service connections */
298 struct hlist_node keepalive_link; /* Link in net->peer_keepalive[] */
299 time64_t last_tx_at; /* Last time packet sent here */
300 seqlock_t service_conn_lock;
301 spinlock_t lock; /* access lock */
302 unsigned int if_mtu; /* interface MTU for this peer */
303 unsigned int mtu; /* network MTU for this peer */
304 unsigned int maxdata; /* data size (MTU - hdrsize) */
305 unsigned short hdrsize; /* header size (IP + UDP + RxRPC) */
306 int debug_id; /* debug ID for printks */
307 int error_report; /* Net (+0) or local (+1000000) to distribute */
308 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
309 struct sockaddr_rxrpc srx; /* remote address */
311 /* calculated RTT cache */
312 #define RXRPC_RTT_CACHE_SIZE 32
313 ktime_t rtt_last_req; /* Time of last RTT request */
314 u64 rtt; /* Current RTT estimate (in nS) */
315 u64 rtt_sum; /* Sum of cache contents */
316 u64 rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* Determined RTT cache */
317 u8 rtt_cursor; /* next entry at which to insert */
318 u8 rtt_usage; /* amount of cache actually used */
320 u8 cong_cwnd; /* Congestion window size */
324 * Keys for matching a connection.
326 struct rxrpc_conn_proto {
329 u32 epoch; /* epoch of this connection */
330 u32 cid; /* connection ID */
336 struct rxrpc_conn_parameters {
337 struct rxrpc_local *local; /* Representation of local endpoint */
338 struct rxrpc_peer *peer; /* Remote endpoint */
339 struct key *key; /* Security details */
340 bool exclusive; /* T if conn is exclusive */
341 bool upgrade; /* T if service ID can be upgraded */
342 u16 service_id; /* Service ID for this connection */
343 u32 security_level; /* Security level selected */
347 * Bits in the connection flags.
349 enum rxrpc_conn_flag {
350 RXRPC_CONN_HAS_IDR, /* Has a client conn ID assigned */
351 RXRPC_CONN_IN_SERVICE_CONNS, /* Conn is in peer->service_conns */
352 RXRPC_CONN_IN_CLIENT_CONNS, /* Conn is in local->client_conns */
353 RXRPC_CONN_EXPOSED, /* Conn has extra ref for exposure */
354 RXRPC_CONN_DONT_REUSE, /* Don't reuse this connection */
355 RXRPC_CONN_COUNTED, /* Counted by rxrpc_nr_client_conns */
356 RXRPC_CONN_PROBING_FOR_UPGRADE, /* Probing for service upgrade */
357 RXRPC_CONN_FINAL_ACK_0, /* Need final ACK for channel 0 */
358 RXRPC_CONN_FINAL_ACK_1, /* Need final ACK for channel 1 */
359 RXRPC_CONN_FINAL_ACK_2, /* Need final ACK for channel 2 */
360 RXRPC_CONN_FINAL_ACK_3, /* Need final ACK for channel 3 */
363 #define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) | \
364 (1UL << RXRPC_CONN_FINAL_ACK_1) | \
365 (1UL << RXRPC_CONN_FINAL_ACK_2) | \
366 (1UL << RXRPC_CONN_FINAL_ACK_3))
369 * Events that can be raised upon a connection.
371 enum rxrpc_conn_event {
372 RXRPC_CONN_EV_CHALLENGE, /* Send challenge packet */
376 * The connection cache state.
378 enum rxrpc_conn_cache_state {
379 RXRPC_CONN_CLIENT_INACTIVE, /* Conn is not yet listed */
380 RXRPC_CONN_CLIENT_WAITING, /* Conn is on wait list, waiting for capacity */
381 RXRPC_CONN_CLIENT_ACTIVE, /* Conn is on active list, doing calls */
382 RXRPC_CONN_CLIENT_UPGRADE, /* Conn is on active list, probing for upgrade */
383 RXRPC_CONN_CLIENT_CULLED, /* Conn is culled and delisted, doing calls */
384 RXRPC_CONN_CLIENT_IDLE, /* Conn is on idle list, doing mostly nothing */
385 RXRPC_CONN__NR_CACHE_STATES
389 * The connection protocol state.
391 enum rxrpc_conn_proto_state {
392 RXRPC_CONN_UNUSED, /* Connection not yet attempted */
393 RXRPC_CONN_CLIENT, /* Client connection */
394 RXRPC_CONN_SERVICE_PREALLOC, /* Service connection preallocation */
395 RXRPC_CONN_SERVICE_UNSECURED, /* Service unsecured connection */
396 RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
397 RXRPC_CONN_SERVICE, /* Service secured connection */
398 RXRPC_CONN_REMOTELY_ABORTED, /* Conn aborted by peer */
399 RXRPC_CONN_LOCALLY_ABORTED, /* Conn aborted locally */
400 RXRPC_CONN__NR_STATES
404 * RxRPC connection definition
405 * - matched by { local, peer, epoch, conn_id, direction }
406 * - each connection can only handle four simultaneous calls
408 struct rxrpc_connection {
409 struct rxrpc_conn_proto proto;
410 struct rxrpc_conn_parameters params;
414 struct list_head cache_link;
416 spinlock_t channel_lock;
417 unsigned char active_chans; /* Mask of active channels */
418 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
419 struct list_head waiting_calls; /* Calls waiting for channels */
420 struct rxrpc_channel {
421 unsigned long final_ack_at; /* Time at which to issue final ACK */
422 struct rxrpc_call __rcu *call; /* Active call */
423 unsigned int call_debug_id; /* call->debug_id */
424 u32 call_id; /* ID of current call */
425 u32 call_counter; /* Call ID counter */
426 u32 last_call; /* ID of last call */
427 u8 last_type; /* Type of last packet */
432 } channels[RXRPC_MAXCALLS];
434 struct timer_list timer; /* Conn event timer */
435 struct work_struct processor; /* connection event processor */
437 struct rb_node client_node; /* Node in local->client_conns */
438 struct rb_node service_node; /* Node in peer->service_conns */
440 struct list_head proc_link; /* link in procfs list */
441 struct list_head link; /* link in master connection list */
442 struct sk_buff_head rx_queue; /* received conn-level packets */
443 const struct rxrpc_security *security; /* applied security module */
444 struct key *server_key; /* security for this service */
445 struct crypto_skcipher *cipher; /* encryption handle */
446 struct rxrpc_crypt csum_iv; /* packet checksum base */
448 unsigned long events;
449 unsigned long idle_timestamp; /* Time at which last became idle */
450 spinlock_t state_lock; /* state-change lock */
451 enum rxrpc_conn_cache_state cache_state;
452 enum rxrpc_conn_proto_state state; /* current state of connection */
453 u32 local_abort; /* local abort code */
454 u32 remote_abort; /* remote abort code */
455 int debug_id; /* debug ID for printks */
456 atomic_t serial; /* packet serial number counter */
457 unsigned int hi_serial; /* highest serial number received */
458 u32 security_nonce; /* response re-use preventer */
459 u16 service_id; /* Service ID, possibly upgraded */
460 u8 size_align; /* data size alignment (for security) */
461 u8 security_size; /* security header size */
462 u8 security_ix; /* security type */
463 u8 out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
467 * Flags in call->flags.
469 enum rxrpc_call_flag {
470 RXRPC_CALL_RELEASED, /* call has been released - no more message to userspace */
471 RXRPC_CALL_HAS_USERID, /* has a user ID attached */
472 RXRPC_CALL_IS_SERVICE, /* Call is service call */
473 RXRPC_CALL_EXPOSED, /* The call was exposed to the world */
474 RXRPC_CALL_RX_LAST, /* Received the last packet (at rxtx_top) */
475 RXRPC_CALL_TX_LAST, /* Last packet in Tx buffer (at rxtx_top) */
476 RXRPC_CALL_TX_LASTQ, /* Last packet has been queued */
477 RXRPC_CALL_SEND_PING, /* A ping will need to be sent */
478 RXRPC_CALL_PINGING, /* Ping in process */
479 RXRPC_CALL_RETRANS_TIMEOUT, /* Retransmission due to timeout occurred */
480 RXRPC_CALL_BEGAN_RX_TIMER, /* We began the expect_rx_by timer */
481 RXRPC_CALL_RX_HEARD, /* The peer responded at least once to this call */
485 * Events that can be raised on a call.
487 enum rxrpc_call_event {
488 RXRPC_CALL_EV_ACK, /* need to generate ACK */
489 RXRPC_CALL_EV_ABORT, /* need to generate abort */
490 RXRPC_CALL_EV_RESEND, /* Tx resend required */
491 RXRPC_CALL_EV_PING, /* Ping send required */
492 RXRPC_CALL_EV_EXPIRED, /* Expiry occurred */
493 RXRPC_CALL_EV_ACK_LOST, /* ACK may be lost, send ping */
497 * The states that a call can be in.
499 enum rxrpc_call_state {
500 RXRPC_CALL_UNINITIALISED,
501 RXRPC_CALL_CLIENT_AWAIT_CONN, /* - client waiting for connection to become available */
502 RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
503 RXRPC_CALL_CLIENT_AWAIT_REPLY, /* - client awaiting reply */
504 RXRPC_CALL_CLIENT_RECV_REPLY, /* - client receiving reply phase */
505 RXRPC_CALL_SERVER_PREALLOC, /* - service preallocation */
506 RXRPC_CALL_SERVER_SECURING, /* - server securing request connection */
507 RXRPC_CALL_SERVER_ACCEPTING, /* - server accepting request */
508 RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
509 RXRPC_CALL_SERVER_ACK_REQUEST, /* - server pending ACK of request */
510 RXRPC_CALL_SERVER_SEND_REPLY, /* - server sending reply */
511 RXRPC_CALL_SERVER_AWAIT_ACK, /* - server awaiting final ACK */
512 RXRPC_CALL_COMPLETE, /* - call complete */
513 NR__RXRPC_CALL_STATES
517 * Call Tx congestion management modes.
519 enum rxrpc_congest_mode {
520 RXRPC_CALL_SLOW_START,
521 RXRPC_CALL_CONGEST_AVOIDANCE,
522 RXRPC_CALL_PACKET_LOSS,
523 RXRPC_CALL_FAST_RETRANSMIT,
524 NR__RXRPC_CONGEST_MODES
528 * RxRPC call definition
529 * - matched by { connection, call_id }
533 struct rxrpc_connection *conn; /* connection carrying call */
534 struct rxrpc_peer *peer; /* Peer record for remote address */
535 struct rxrpc_sock __rcu *socket; /* socket responsible */
536 struct rxrpc_net *rxnet; /* Network namespace to which call belongs */
537 struct mutex user_mutex; /* User access mutex */
538 unsigned long ack_at; /* When deferred ACK needs to happen */
539 unsigned long ack_lost_at; /* When ACK is figured as lost */
540 unsigned long resend_at; /* When next resend needs to happen */
541 unsigned long ping_at; /* When next to send a ping */
542 unsigned long keepalive_at; /* When next to send a keepalive ping */
543 unsigned long expect_rx_by; /* When we expect to get a packet by */
544 unsigned long expect_req_by; /* When we expect to get a request DATA packet by */
545 unsigned long expect_term_by; /* When we expect call termination by */
546 u32 next_rx_timo; /* Timeout for next Rx packet (jif) */
547 u32 next_req_timo; /* Timeout for next Rx request packet (jif) */
548 struct timer_list timer; /* Combined event timer */
549 struct work_struct processor; /* Event processor */
550 rxrpc_notify_rx_t notify_rx; /* kernel service Rx notification function */
551 struct list_head link; /* link in master call list */
552 struct list_head chan_wait_link; /* Link in conn->waiting_calls */
553 struct hlist_node error_link; /* link in error distribution list */
554 struct list_head accept_link; /* Link in rx->acceptq */
555 struct list_head recvmsg_link; /* Link in rx->recvmsg_q */
556 struct list_head sock_link; /* Link in rx->sock_calls */
557 struct rb_node sock_node; /* Node in rx->calls */
558 struct sk_buff *tx_pending; /* Tx socket buffer being filled */
559 wait_queue_head_t waitq; /* Wait queue for channel or Tx */
560 s64 tx_total_len; /* Total length left to be transmitted (or -1) */
561 __be32 crypto_buf[2]; /* Temporary packet crypto buffer */
562 unsigned long user_call_ID; /* user-defined call ID */
564 unsigned long events;
566 spinlock_t notify_lock; /* Kernel notification lock */
567 rwlock_t state_lock; /* lock for state transition */
568 u32 abort_code; /* Local/remote abort code */
569 int error; /* Local error incurred */
570 enum rxrpc_call_state state; /* current state of call */
571 enum rxrpc_call_completion completion; /* Call completion condition */
573 u16 service_id; /* service ID */
574 u8 security_ix; /* Security type */
575 u32 call_id; /* call ID on connection */
576 u32 cid; /* connection ID plus channel index */
577 int debug_id; /* debug ID for printks */
578 unsigned short rx_pkt_offset; /* Current recvmsg packet offset */
579 unsigned short rx_pkt_len; /* Current recvmsg packet len */
581 /* Rx/Tx circular buffer, depending on phase.
583 * In the Rx phase, packets are annotated with 0 or the number of the
584 * segment of a jumbo packet each buffer refers to. There can be up to
585 * 47 segments in a maximum-size UDP packet.
587 * In the Tx phase, packets are annotated with which buffers have been
590 #define RXRPC_RXTX_BUFF_SIZE 64
591 #define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
592 #define RXRPC_INIT_RX_WINDOW_SIZE 32
593 struct sk_buff **rxtx_buffer;
594 u8 *rxtx_annotations;
595 #define RXRPC_TX_ANNO_ACK 0
596 #define RXRPC_TX_ANNO_UNACK 1
597 #define RXRPC_TX_ANNO_NAK 2
598 #define RXRPC_TX_ANNO_RETRANS 3
599 #define RXRPC_TX_ANNO_MASK 0x03
600 #define RXRPC_TX_ANNO_LAST 0x04
601 #define RXRPC_TX_ANNO_RESENT 0x08
603 #define RXRPC_RX_ANNO_JUMBO 0x3f /* Jumbo subpacket number + 1 if not zero */
604 #define RXRPC_RX_ANNO_JLAST 0x40 /* Set if last element of a jumbo packet */
605 #define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
606 rxrpc_seq_t tx_hard_ack; /* Dead slot in buffer; the first transmitted but
607 * not hard-ACK'd packet follows this.
609 rxrpc_seq_t tx_top; /* Highest Tx slot allocated. */
611 /* TCP-style slow-start congestion control [RFC5681]. Since the SMSS
612 * is fixed, we keep these numbers in terms of segments (ie. DATA
613 * packets) rather than bytes.
615 #define RXRPC_TX_SMSS RXRPC_JUMBO_DATALEN
616 u8 cong_cwnd; /* Congestion window size */
617 u8 cong_extra; /* Extra to send for congestion management */
618 u8 cong_ssthresh; /* Slow-start threshold */
619 enum rxrpc_congest_mode cong_mode:8; /* Congestion management mode */
620 u8 cong_dup_acks; /* Count of ACKs showing missing packets */
621 u8 cong_cumul_acks; /* Cumulative ACK count */
622 ktime_t cong_tstamp; /* Last time cwnd was changed */
624 rxrpc_seq_t rx_hard_ack; /* Dead slot in buffer; the first received but not
625 * consumed packet follows this.
627 rxrpc_seq_t rx_top; /* Highest Rx slot allocated. */
628 rxrpc_seq_t rx_expect_next; /* Expected next packet sequence number */
629 rxrpc_serial_t rx_serial; /* Highest serial received for this call */
630 u8 rx_winsize; /* Size of Rx window */
631 u8 tx_winsize; /* Maximum size of Tx window */
632 bool tx_phase; /* T if transmission phase, F if receive phase */
633 u8 nr_jumbo_bad; /* Number of jumbo dups/exceeds-windows */
635 /* receive-phase ACK management */
636 u8 ackr_reason; /* reason to ACK */
637 u16 ackr_skew; /* skew on packet being ACK'd */
638 rxrpc_serial_t ackr_serial; /* serial of packet being ACK'd */
639 rxrpc_seq_t ackr_prev_seq; /* previous sequence number received */
640 rxrpc_seq_t ackr_consumed; /* Highest packet shown consumed */
641 rxrpc_seq_t ackr_seen; /* Highest packet shown seen */
643 /* ping management */
644 rxrpc_serial_t ping_serial; /* Last ping sent */
645 ktime_t ping_time; /* Time last ping sent */
647 /* transmission-phase ACK management */
648 ktime_t acks_latest_ts; /* Timestamp of latest ACK received */
649 rxrpc_serial_t acks_latest; /* serial number of latest ACK received */
650 rxrpc_seq_t acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
651 rxrpc_seq_t acks_lost_top; /* tx_top at the time lost-ack ping sent */
652 rxrpc_serial_t acks_lost_ping; /* Serial number of probe ACK */
656 * Summary of a new ACK and the changes it made to the Tx buffer packet states.
658 struct rxrpc_ack_summary {
660 u8 nr_acks; /* Number of ACKs in packet */
661 u8 nr_nacks; /* Number of NACKs in packet */
662 u8 nr_new_acks; /* Number of new ACKs in packet */
663 u8 nr_new_nacks; /* Number of new NACKs in packet */
664 u8 nr_rot_new_acks; /* Number of rotated new ACKs */
665 bool new_low_nack; /* T if new low NACK found */
666 bool retrans_timeo; /* T if reTx due to timeout happened */
667 u8 flight_size; /* Number of unreceived transmissions */
668 /* Place to stash values for tracing */
669 enum rxrpc_congest_mode mode:8;
677 * sendmsg() cmsg-specified parameters.
680 RXRPC_CMD_SEND_DATA, /* send data message */
681 RXRPC_CMD_SEND_ABORT, /* request abort generation */
682 RXRPC_CMD_ACCEPT, /* [server] accept incoming call */
683 RXRPC_CMD_REJECT_BUSY, /* [server] reject a call as busy */
686 struct rxrpc_call_params {
687 s64 tx_total_len; /* Total Tx data length (if send data) */
688 unsigned long user_call_ID; /* User's call ID */
690 u32 hard; /* Maximum lifetime (sec) */
691 u32 idle; /* Max time since last data packet (msec) */
692 u32 normal; /* Max time since last call packet (msec) */
694 u8 nr_timeouts; /* Number of timeouts specified */
697 struct rxrpc_send_params {
698 struct rxrpc_call_params call;
699 u32 abort_code; /* Abort code to Tx (if abort) */
700 enum rxrpc_command command : 8; /* The command to implement */
701 bool exclusive; /* Shared or exclusive call */
702 bool upgrade; /* If the connection is upgradeable */
705 #include <trace/events/rxrpc.h>
710 extern atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_skbs;
711 extern struct workqueue_struct *rxrpc_workqueue;
716 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
717 void rxrpc_discard_prealloc(struct rxrpc_sock *);
718 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
719 struct rxrpc_connection *,
721 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
722 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
724 int rxrpc_reject_call(struct rxrpc_sock *);
729 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool, bool,
730 enum rxrpc_propose_ack_trace);
731 void rxrpc_process_call(struct work_struct *);
733 static inline void rxrpc_reduce_call_timer(struct rxrpc_call *call,
734 unsigned long expire_at,
736 enum rxrpc_timer_trace why)
738 trace_rxrpc_timer(call, why, now);
739 timer_reduce(&call->timer, expire_at);
745 extern const char *const rxrpc_call_states[];
746 extern const char *const rxrpc_call_completions[];
747 extern unsigned int rxrpc_max_call_lifetime;
748 extern struct kmem_cache *rxrpc_call_jar;
750 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
751 struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
752 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
753 struct rxrpc_conn_parameters *,
754 struct sockaddr_rxrpc *,
755 struct rxrpc_call_params *, gfp_t,
757 int rxrpc_retry_client_call(struct rxrpc_sock *,
759 struct rxrpc_conn_parameters *,
760 struct sockaddr_rxrpc *,
762 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
764 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
765 int rxrpc_prepare_call_for_retry(struct rxrpc_sock *, struct rxrpc_call *);
766 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
767 bool __rxrpc_queue_call(struct rxrpc_call *);
768 bool rxrpc_queue_call(struct rxrpc_call *);
769 void rxrpc_see_call(struct rxrpc_call *);
770 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
771 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
772 void rxrpc_cleanup_call(struct rxrpc_call *);
773 void rxrpc_destroy_all_calls(struct rxrpc_net *);
775 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
777 return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
780 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
782 return !rxrpc_is_service_call(call);
786 * Transition a call to the complete state.
788 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
789 enum rxrpc_call_completion compl,
793 if (call->state < RXRPC_CALL_COMPLETE) {
794 call->abort_code = abort_code;
796 call->completion = compl,
797 call->state = RXRPC_CALL_COMPLETE;
798 trace_rxrpc_call_complete(call);
799 wake_up(&call->waitq);
805 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
806 enum rxrpc_call_completion compl,
812 write_lock_bh(&call->state_lock);
813 ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
814 write_unlock_bh(&call->state_lock);
819 * Record that a call successfully completed.
821 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
823 return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
826 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
830 write_lock_bh(&call->state_lock);
831 ret = __rxrpc_call_completed(call);
832 write_unlock_bh(&call->state_lock);
837 * Record that a call is locally aborted.
839 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
841 u32 abort_code, int error)
843 trace_rxrpc_abort(call->debug_id, why, call->cid, call->call_id, seq,
845 return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
849 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
850 rxrpc_seq_t seq, u32 abort_code, int error)
854 write_lock_bh(&call->state_lock);
855 ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
856 write_unlock_bh(&call->state_lock);
861 * Abort a call due to a protocol error.
863 static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
865 const char *eproto_why,
869 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
871 trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
872 return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
875 #define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
876 __rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
877 (abort_why), (abort_code))
882 extern unsigned int rxrpc_max_client_connections;
883 extern unsigned int rxrpc_reap_client_connections;
884 extern unsigned long rxrpc_conn_idle_client_expiry;
885 extern unsigned long rxrpc_conn_idle_client_fast_expiry;
886 extern struct idr rxrpc_client_conn_ids;
888 void rxrpc_destroy_client_conn_ids(void);
889 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
890 struct sockaddr_rxrpc *, gfp_t);
891 void rxrpc_expose_client_call(struct rxrpc_call *);
892 void rxrpc_disconnect_client_call(struct rxrpc_call *);
893 void rxrpc_put_client_conn(struct rxrpc_connection *);
894 void rxrpc_discard_expired_client_conns(struct work_struct *);
895 void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
900 void rxrpc_process_connection(struct work_struct *);
905 extern unsigned int rxrpc_connection_expiry;
906 extern unsigned int rxrpc_closed_conn_expiry;
908 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
909 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
911 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
912 void rxrpc_disconnect_call(struct rxrpc_call *);
913 void rxrpc_kill_connection(struct rxrpc_connection *);
914 bool rxrpc_queue_conn(struct rxrpc_connection *);
915 void rxrpc_see_connection(struct rxrpc_connection *);
916 void rxrpc_get_connection(struct rxrpc_connection *);
917 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
918 void rxrpc_put_service_conn(struct rxrpc_connection *);
919 void rxrpc_service_connection_reaper(struct work_struct *);
920 void rxrpc_destroy_all_connections(struct rxrpc_net *);
922 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
924 return conn->out_clientflag;
927 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
929 return !rxrpc_conn_is_client(conn);
932 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
937 if (rxrpc_conn_is_client(conn))
938 rxrpc_put_client_conn(conn);
940 rxrpc_put_service_conn(conn);
943 static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
944 unsigned long expire_at)
946 timer_reduce(&conn->timer, expire_at);
952 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
954 struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
955 void rxrpc_new_incoming_connection(struct rxrpc_sock *,
956 struct rxrpc_connection *, struct sk_buff *);
957 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
962 void rxrpc_data_ready(struct sock *);
967 extern const struct rxrpc_security rxrpc_no_security;
972 extern struct key_type key_type_rxrpc;
973 extern struct key_type key_type_rxrpc_s;
975 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
976 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
977 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
983 extern void rxrpc_process_local_events(struct rxrpc_local *);
988 struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
989 struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *);
990 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *);
991 void rxrpc_put_local(struct rxrpc_local *);
992 void rxrpc_queue_local(struct rxrpc_local *);
993 void rxrpc_destroy_all_locals(struct rxrpc_net *);
998 extern unsigned int rxrpc_max_backlog __read_mostly;
999 extern unsigned long rxrpc_requested_ack_delay;
1000 extern unsigned long rxrpc_soft_ack_delay;
1001 extern unsigned long rxrpc_idle_ack_delay;
1002 extern unsigned int rxrpc_rx_window_size;
1003 extern unsigned int rxrpc_rx_mtu;
1004 extern unsigned int rxrpc_rx_jumbo_max;
1005 extern unsigned long rxrpc_resend_timeout;
1007 extern const s8 rxrpc_ack_priority[];
1012 extern unsigned int rxrpc_net_id;
1013 extern struct pernet_operations rxrpc_net_ops;
1015 static inline struct rxrpc_net *rxrpc_net(struct net *net)
1017 return net_generic(net, rxrpc_net_id);
1023 int rxrpc_send_ack_packet(struct rxrpc_call *, bool, rxrpc_serial_t *);
1024 int rxrpc_send_abort_packet(struct rxrpc_call *);
1025 int rxrpc_send_data_packet(struct rxrpc_call *, struct sk_buff *, bool);
1026 void rxrpc_reject_packets(struct rxrpc_local *);
1027 void rxrpc_send_keepalive(struct rxrpc_peer *);
1032 void rxrpc_error_report(struct sock *);
1033 void rxrpc_peer_error_distributor(struct work_struct *);
1034 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace,
1035 rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1036 void rxrpc_peer_keepalive_worker(struct work_struct *);
1041 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1042 const struct sockaddr_rxrpc *);
1043 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
1044 struct sockaddr_rxrpc *, gfp_t);
1045 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
1046 struct rxrpc_peer *rxrpc_lookup_incoming_peer(struct rxrpc_local *,
1047 struct rxrpc_peer *);
1048 void rxrpc_destroy_all_peers(struct rxrpc_net *);
1049 struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *);
1050 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *);
1051 void rxrpc_put_peer(struct rxrpc_peer *);
1052 void __rxrpc_queue_peer_error(struct rxrpc_peer *);
1057 extern const struct seq_operations rxrpc_call_seq_ops;
1058 extern const struct seq_operations rxrpc_connection_seq_ops;
1063 void rxrpc_notify_socket(struct rxrpc_call *);
1064 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1070 extern const struct rxrpc_security rxkad;
1076 int __init rxrpc_init_security(void);
1077 void rxrpc_exit_security(void);
1078 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1079 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
1084 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1089 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1090 void rxrpc_packet_destructor(struct sk_buff *);
1091 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1092 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1093 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1094 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1095 void rxrpc_lose_skb(struct sk_buff *, enum rxrpc_skb_trace);
1096 void rxrpc_purge_queue(struct sk_buff_head *);
1101 #ifdef CONFIG_SYSCTL
1102 extern int __init rxrpc_sysctl_init(void);
1103 extern void rxrpc_sysctl_exit(void);
1105 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1106 static inline void rxrpc_sysctl_exit(void) {}
1112 int rxrpc_extract_addr_from_skb(struct rxrpc_local *, struct sockaddr_rxrpc *,
1115 static inline bool before(u32 seq1, u32 seq2)
1117 return (s32)(seq1 - seq2) < 0;
1119 static inline bool before_eq(u32 seq1, u32 seq2)
1121 return (s32)(seq1 - seq2) <= 0;
1123 static inline bool after(u32 seq1, u32 seq2)
1125 return (s32)(seq1 - seq2) > 0;
1127 static inline bool after_eq(u32 seq1, u32 seq2)
1129 return (s32)(seq1 - seq2) >= 0;
1135 extern unsigned int rxrpc_debug;
1137 #define dbgprintk(FMT,...) \
1138 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1140 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1141 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1142 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1143 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1144 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1147 #if defined(__KDEBUG)
1148 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1149 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1150 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1151 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1152 #define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1154 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1155 #define RXRPC_DEBUG_KENTER 0x01
1156 #define RXRPC_DEBUG_KLEAVE 0x02
1157 #define RXRPC_DEBUG_KDEBUG 0x04
1158 #define RXRPC_DEBUG_KPROTO 0x08
1159 #define RXRPC_DEBUG_KNET 0x10
1161 #define _enter(FMT,...) \
1163 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1164 kenter(FMT,##__VA_ARGS__); \
1167 #define _leave(FMT,...) \
1169 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1170 kleave(FMT,##__VA_ARGS__); \
1173 #define _debug(FMT,...) \
1175 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1176 kdebug(FMT,##__VA_ARGS__); \
1179 #define _proto(FMT,...) \
1181 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1182 kproto(FMT,##__VA_ARGS__); \
1185 #define _net(FMT,...) \
1187 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1188 knet(FMT,##__VA_ARGS__); \
1192 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1193 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1194 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1195 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1196 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1200 * debug assertion checking
1202 #if 1 // defined(__KDEBUGALL)
1206 if (unlikely(!(X))) { \
1207 pr_err("Assertion failed\n"); \
1212 #define ASSERTCMP(X, OP, Y) \
1214 __typeof__(X) _x = (X); \
1215 __typeof__(Y) _y = (__typeof__(X))(Y); \
1216 if (unlikely(!(_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); \
1224 #define ASSERTIF(C, X) \
1226 if (unlikely((C) && !(X))) { \
1227 pr_err("Assertion failed\n"); \
1232 #define ASSERTIFCMP(C, X, OP, Y) \
1234 __typeof__(X) _x = (X); \
1235 __typeof__(Y) _y = (__typeof__(X))(Y); \
1236 if (unlikely((C) && !(_x OP _y))) { \
1237 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1238 (unsigned long)_x, (unsigned long)_x, #OP, \
1239 (unsigned long)_y, (unsigned long)_y); \
1250 #define ASSERTCMP(X, OP, Y) \
1254 #define ASSERTIF(C, X) \
1258 #define ASSERTIFCMP(C, X, OP, Y) \
1262 #endif /* __KDEBUGALL */