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>
15 #include <net/af_rxrpc.h>
16 #include <rxrpc/packet.h>
19 #define CHECK_SLAB_OKAY(X) \
20 BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
21 (POISON_FREE << 8 | POISON_FREE))
23 #define CHECK_SLAB_OKAY(X) do {} while (0)
26 #define FCRYPT_BSIZE 8
32 } __attribute__((aligned(8)));
34 #define rxrpc_queue_work(WS) queue_work(rxrpc_workqueue, (WS))
35 #define rxrpc_queue_delayed_work(WS,D) \
36 queue_delayed_work(rxrpc_workqueue, (WS), (D))
38 struct rxrpc_connection
;
41 * Mark applied to socket buffers.
44 RXRPC_SKB_MARK_DATA
, /* data message */
45 RXRPC_SKB_MARK_FINAL_ACK
, /* final ACK received message */
46 RXRPC_SKB_MARK_BUSY
, /* server busy message */
47 RXRPC_SKB_MARK_REMOTE_ABORT
, /* remote abort message */
48 RXRPC_SKB_MARK_LOCAL_ABORT
, /* local abort message */
49 RXRPC_SKB_MARK_NET_ERROR
, /* network error message */
50 RXRPC_SKB_MARK_LOCAL_ERROR
, /* local error message */
51 RXRPC_SKB_MARK_NEW_CALL
, /* local error message */
55 * sk_state for RxRPC sockets
59 RXRPC_CLIENT_UNBOUND
, /* Unbound socket used as client */
60 RXRPC_CLIENT_BOUND
, /* client local address bound */
61 RXRPC_SERVER_BOUND
, /* server local address bound */
62 RXRPC_SERVER_LISTENING
, /* server listening for connections */
63 RXRPC_CLOSE
, /* socket is being closed */
67 * Service backlog preallocation.
69 * This contains circular buffers of preallocated peers, connections and calls
70 * for incoming service calls and their head and tail pointers. This allows
71 * calls to be set up in the data_ready handler, thereby avoiding the need to
72 * shuffle packets around so much.
74 struct rxrpc_backlog
{
75 unsigned short peer_backlog_head
;
76 unsigned short peer_backlog_tail
;
77 unsigned short conn_backlog_head
;
78 unsigned short conn_backlog_tail
;
79 unsigned short call_backlog_head
;
80 unsigned short call_backlog_tail
;
81 #define RXRPC_BACKLOG_MAX 32
82 struct rxrpc_peer
*peer_backlog
[RXRPC_BACKLOG_MAX
];
83 struct rxrpc_connection
*conn_backlog
[RXRPC_BACKLOG_MAX
];
84 struct rxrpc_call
*call_backlog
[RXRPC_BACKLOG_MAX
];
88 * RxRPC socket definition
91 /* WARNING: sk has to be the first member */
93 rxrpc_notify_new_call_t notify_new_call
; /* Func to notify of new call */
94 rxrpc_discard_new_call_t discard_new_call
; /* Func to discard a new call */
95 struct rxrpc_local
*local
; /* local endpoint */
96 struct hlist_node listen_link
; /* link in the local endpoint's listen list */
97 struct rxrpc_backlog
*backlog
; /* Preallocation for services */
98 spinlock_t incoming_lock
; /* Incoming call vs service shutdown lock */
99 struct list_head sock_calls
; /* List of calls owned by this socket */
100 struct list_head to_be_accepted
; /* calls awaiting acceptance */
101 struct list_head recvmsg_q
; /* Calls awaiting recvmsg's attention */
102 rwlock_t recvmsg_lock
; /* Lock for recvmsg_q */
103 struct key
*key
; /* security for this socket */
104 struct key
*securities
; /* list of server security descriptors */
105 struct rb_root calls
; /* User ID -> call mapping */
107 #define RXRPC_SOCK_CONNECTED 0 /* connect_srx is set */
108 rwlock_t call_lock
; /* lock for calls */
109 u32 min_sec_level
; /* minimum security level */
110 #define RXRPC_SECURITY_MAX RXRPC_SECURITY_ENCRYPT
111 bool exclusive
; /* Exclusive connection for a client socket */
112 sa_family_t family
; /* Protocol family created with */
113 struct sockaddr_rxrpc srx
; /* local address */
114 struct sockaddr_rxrpc connect_srx
; /* Default client address from connect() */
117 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
120 * CPU-byteorder normalised Rx packet header.
122 struct rxrpc_host_header
{
123 u32 epoch
; /* client boot timestamp */
124 u32 cid
; /* connection and channel ID */
125 u32 callNumber
; /* call ID (0 for connection-level packets) */
126 u32 seq
; /* sequence number of pkt in call stream */
127 u32 serial
; /* serial number of pkt sent to network */
128 u8 type
; /* packet type */
129 u8 flags
; /* packet flags */
130 u8 userStatus
; /* app-layer defined status */
131 u8 securityIndex
; /* security protocol ID */
133 u16 _rsvd
; /* reserved */
134 u16 cksum
; /* kerberos security checksum */
136 u16 serviceId
; /* service ID */
140 * RxRPC socket buffer private variables
141 * - max 48 bytes (struct sk_buff::cb)
143 struct rxrpc_skb_priv
{
145 u8 nr_jumbo
; /* Number of jumbo subpackets */
148 unsigned int offset
; /* offset into buffer of next read */
149 int remain
; /* amount of space remaining for next write */
150 u32 error
; /* network error code */
153 struct rxrpc_host_header hdr
; /* RxRPC packet header from this packet */
156 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
159 * RxRPC security module interface
161 struct rxrpc_security
{
162 const char *name
; /* name of this service */
163 u8 security_index
; /* security type provided */
165 /* Initialise a security service */
168 /* Clean up a security service */
171 /* initialise a connection's security */
172 int (*init_connection_security
)(struct rxrpc_connection
*);
174 /* prime a connection's packet security */
175 int (*prime_packet_security
)(struct rxrpc_connection
*);
177 /* impose security on a packet */
178 int (*secure_packet
)(struct rxrpc_call
*,
183 /* verify the security on a received packet */
184 int (*verify_packet
)(struct rxrpc_call
*, struct sk_buff
*,
185 unsigned int, unsigned int, rxrpc_seq_t
, u16
);
187 /* Locate the data in a received packet that has been verified. */
188 void (*locate_data
)(struct rxrpc_call
*, struct sk_buff
*,
189 unsigned int *, unsigned int *);
191 /* issue a challenge */
192 int (*issue_challenge
)(struct rxrpc_connection
*);
194 /* respond to a challenge */
195 int (*respond_to_challenge
)(struct rxrpc_connection
*,
199 /* verify a response */
200 int (*verify_response
)(struct rxrpc_connection
*,
204 /* clear connection security */
205 void (*clear
)(struct rxrpc_connection
*);
209 * RxRPC local transport endpoint description
210 * - owned by a single AF_RXRPC socket
211 * - pointed to by transport socket struct sk_user_data
216 struct list_head link
;
217 struct socket
*socket
; /* my UDP socket */
218 struct work_struct processor
;
219 struct hlist_head services
; /* services listening on this endpoint */
220 struct rw_semaphore defrag_sem
; /* control re-enablement of IP DF bit */
221 struct sk_buff_head reject_queue
; /* packets awaiting rejection */
222 struct sk_buff_head event_queue
; /* endpoint event packets awaiting processing */
223 struct rb_root client_conns
; /* Client connections by socket params */
224 spinlock_t client_conns_lock
; /* Lock for client_conns */
225 spinlock_t lock
; /* access lock */
226 rwlock_t services_lock
; /* lock for services list */
227 int debug_id
; /* debug ID for printks */
229 struct sockaddr_rxrpc srx
; /* local address */
233 * RxRPC remote transport endpoint definition
234 * - matched by local endpoint, remote port, address and protocol type
237 struct rcu_head rcu
; /* This must be first */
239 unsigned long hash_key
;
240 struct hlist_node hash_link
;
241 struct rxrpc_local
*local
;
242 struct hlist_head error_targets
; /* targets for net error distribution */
243 struct work_struct error_distributor
;
244 struct rb_root service_conns
; /* Service connections */
245 seqlock_t service_conn_lock
;
246 spinlock_t lock
; /* access lock */
247 unsigned int if_mtu
; /* interface MTU for this peer */
248 unsigned int mtu
; /* network MTU for this peer */
249 unsigned int maxdata
; /* data size (MTU - hdrsize) */
250 unsigned short hdrsize
; /* header size (IP + UDP + RxRPC) */
251 int debug_id
; /* debug ID for printks */
252 int error_report
; /* Net (+0) or local (+1000000) to distribute */
253 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
254 struct sockaddr_rxrpc srx
; /* remote address */
256 /* calculated RTT cache */
257 #define RXRPC_RTT_CACHE_SIZE 32
258 ktime_t rtt_last_req
; /* Time of last RTT request */
259 u64 rtt
; /* Current RTT estimate (in nS) */
260 u64 rtt_sum
; /* Sum of cache contents */
261 u64 rtt_cache
[RXRPC_RTT_CACHE_SIZE
]; /* Determined RTT cache */
262 u8 rtt_cursor
; /* next entry at which to insert */
263 u8 rtt_usage
; /* amount of cache actually used */
267 * Keys for matching a connection.
269 struct rxrpc_conn_proto
{
272 u32 epoch
; /* epoch of this connection */
273 u32 cid
; /* connection ID */
279 struct rxrpc_conn_parameters
{
280 struct rxrpc_local
*local
; /* Representation of local endpoint */
281 struct rxrpc_peer
*peer
; /* Remote endpoint */
282 struct key
*key
; /* Security details */
283 bool exclusive
; /* T if conn is exclusive */
284 u16 service_id
; /* Service ID for this connection */
285 u32 security_level
; /* Security level selected */
289 * Bits in the connection flags.
291 enum rxrpc_conn_flag
{
292 RXRPC_CONN_HAS_IDR
, /* Has a client conn ID assigned */
293 RXRPC_CONN_IN_SERVICE_CONNS
, /* Conn is in peer->service_conns */
294 RXRPC_CONN_IN_CLIENT_CONNS
, /* Conn is in local->client_conns */
295 RXRPC_CONN_EXPOSED
, /* Conn has extra ref for exposure */
296 RXRPC_CONN_DONT_REUSE
, /* Don't reuse this connection */
297 RXRPC_CONN_COUNTED
, /* Counted by rxrpc_nr_client_conns */
301 * Events that can be raised upon a connection.
303 enum rxrpc_conn_event
{
304 RXRPC_CONN_EV_CHALLENGE
, /* Send challenge packet */
308 * The connection cache state.
310 enum rxrpc_conn_cache_state
{
311 RXRPC_CONN_CLIENT_INACTIVE
, /* Conn is not yet listed */
312 RXRPC_CONN_CLIENT_WAITING
, /* Conn is on wait list, waiting for capacity */
313 RXRPC_CONN_CLIENT_ACTIVE
, /* Conn is on active list, doing calls */
314 RXRPC_CONN_CLIENT_CULLED
, /* Conn is culled and delisted, doing calls */
315 RXRPC_CONN_CLIENT_IDLE
, /* Conn is on idle list, doing mostly nothing */
316 RXRPC_CONN__NR_CACHE_STATES
320 * The connection protocol state.
322 enum rxrpc_conn_proto_state
{
323 RXRPC_CONN_UNUSED
, /* Connection not yet attempted */
324 RXRPC_CONN_CLIENT
, /* Client connection */
325 RXRPC_CONN_SERVICE_PREALLOC
, /* Service connection preallocation */
326 RXRPC_CONN_SERVICE_UNSECURED
, /* Service unsecured connection */
327 RXRPC_CONN_SERVICE_CHALLENGING
, /* Service challenging for security */
328 RXRPC_CONN_SERVICE
, /* Service secured connection */
329 RXRPC_CONN_REMOTELY_ABORTED
, /* Conn aborted by peer */
330 RXRPC_CONN_LOCALLY_ABORTED
, /* Conn aborted locally */
331 RXRPC_CONN__NR_STATES
335 * RxRPC connection definition
336 * - matched by { local, peer, epoch, conn_id, direction }
337 * - each connection can only handle four simultaneous calls
339 struct rxrpc_connection
{
340 struct rxrpc_conn_proto proto
;
341 struct rxrpc_conn_parameters params
;
345 struct list_head cache_link
;
347 spinlock_t channel_lock
;
348 unsigned char active_chans
; /* Mask of active channels */
349 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
350 struct list_head waiting_calls
; /* Calls waiting for channels */
351 struct rxrpc_channel
{
352 struct rxrpc_call __rcu
*call
; /* Active call */
353 u32 call_id
; /* ID of current call */
354 u32 call_counter
; /* Call ID counter */
355 u32 last_call
; /* ID of last call */
356 u8 last_type
; /* Type of last packet */
362 } channels
[RXRPC_MAXCALLS
];
364 struct work_struct processor
; /* connection event processor */
366 struct rb_node client_node
; /* Node in local->client_conns */
367 struct rb_node service_node
; /* Node in peer->service_conns */
369 struct list_head proc_link
; /* link in procfs list */
370 struct list_head link
; /* link in master connection list */
371 struct sk_buff_head rx_queue
; /* received conn-level packets */
372 const struct rxrpc_security
*security
; /* applied security module */
373 struct key
*server_key
; /* security for this service */
374 struct crypto_skcipher
*cipher
; /* encryption handle */
375 struct rxrpc_crypt csum_iv
; /* packet checksum base */
377 unsigned long events
;
378 unsigned long idle_timestamp
; /* Time at which last became idle */
379 spinlock_t state_lock
; /* state-change lock */
380 enum rxrpc_conn_cache_state cache_state
;
381 enum rxrpc_conn_proto_state state
; /* current state of connection */
382 u32 local_abort
; /* local abort code */
383 u32 remote_abort
; /* remote abort code */
384 int debug_id
; /* debug ID for printks */
385 atomic_t serial
; /* packet serial number counter */
386 unsigned int hi_serial
; /* highest serial number received */
387 u32 security_nonce
; /* response re-use preventer */
388 u8 size_align
; /* data size alignment (for security) */
389 u8 security_size
; /* security header size */
390 u8 security_ix
; /* security type */
391 u8 out_clientflag
; /* RXRPC_CLIENT_INITIATED if we are client */
395 * Flags in call->flags.
397 enum rxrpc_call_flag
{
398 RXRPC_CALL_RELEASED
, /* call has been released - no more message to userspace */
399 RXRPC_CALL_HAS_USERID
, /* has a user ID attached */
400 RXRPC_CALL_IS_SERVICE
, /* Call is service call */
401 RXRPC_CALL_EXPOSED
, /* The call was exposed to the world */
402 RXRPC_CALL_RX_LAST
, /* Received the last packet (at rxtx_top) */
403 RXRPC_CALL_TX_LAST
, /* Last packet in Tx buffer (at rxtx_top) */
404 RXRPC_CALL_PINGING
, /* Ping in process */
408 * Events that can be raised on a call.
410 enum rxrpc_call_event
{
411 RXRPC_CALL_EV_ACK
, /* need to generate ACK */
412 RXRPC_CALL_EV_ABORT
, /* need to generate abort */
413 RXRPC_CALL_EV_TIMER
, /* Timer expired */
414 RXRPC_CALL_EV_RESEND
, /* Tx resend required */
418 * The states that a call can be in.
420 enum rxrpc_call_state
{
421 RXRPC_CALL_UNINITIALISED
,
422 RXRPC_CALL_CLIENT_AWAIT_CONN
, /* - client waiting for connection to become available */
423 RXRPC_CALL_CLIENT_SEND_REQUEST
, /* - client sending request phase */
424 RXRPC_CALL_CLIENT_AWAIT_REPLY
, /* - client awaiting reply */
425 RXRPC_CALL_CLIENT_RECV_REPLY
, /* - client receiving reply phase */
426 RXRPC_CALL_SERVER_PREALLOC
, /* - service preallocation */
427 RXRPC_CALL_SERVER_SECURING
, /* - server securing request connection */
428 RXRPC_CALL_SERVER_ACCEPTING
, /* - server accepting request */
429 RXRPC_CALL_SERVER_RECV_REQUEST
, /* - server receiving request */
430 RXRPC_CALL_SERVER_ACK_REQUEST
, /* - server pending ACK of request */
431 RXRPC_CALL_SERVER_SEND_REPLY
, /* - server sending reply */
432 RXRPC_CALL_SERVER_AWAIT_ACK
, /* - server awaiting final ACK */
433 RXRPC_CALL_COMPLETE
, /* - call complete */
434 NR__RXRPC_CALL_STATES
438 * Call completion condition (state == RXRPC_CALL_COMPLETE).
440 enum rxrpc_call_completion
{
441 RXRPC_CALL_SUCCEEDED
, /* - Normal termination */
442 RXRPC_CALL_REMOTELY_ABORTED
, /* - call aborted by peer */
443 RXRPC_CALL_LOCALLY_ABORTED
, /* - call aborted locally on error or close */
444 RXRPC_CALL_LOCAL_ERROR
, /* - call failed due to local error */
445 RXRPC_CALL_NETWORK_ERROR
, /* - call terminated by network error */
446 NR__RXRPC_CALL_COMPLETIONS
450 * RxRPC call definition
451 * - matched by { connection, call_id }
455 struct rxrpc_connection
*conn
; /* connection carrying call */
456 struct rxrpc_peer
*peer
; /* Peer record for remote address */
457 struct rxrpc_sock __rcu
*socket
; /* socket responsible */
458 unsigned long ack_at
; /* When deferred ACK needs to happen */
459 unsigned long resend_at
; /* When next resend needs to happen */
460 unsigned long expire_at
; /* When the call times out */
461 struct timer_list timer
; /* Combined event timer */
462 struct work_struct processor
; /* Event processor */
463 rxrpc_notify_rx_t notify_rx
; /* kernel service Rx notification function */
464 struct list_head link
; /* link in master call list */
465 struct list_head chan_wait_link
; /* Link in conn->waiting_calls */
466 struct hlist_node error_link
; /* link in error distribution list */
467 struct list_head accept_link
; /* Link in rx->acceptq */
468 struct list_head recvmsg_link
; /* Link in rx->recvmsg_q */
469 struct list_head sock_link
; /* Link in rx->sock_calls */
470 struct rb_node sock_node
; /* Node in rx->calls */
471 struct sk_buff
*tx_pending
; /* Tx socket buffer being filled */
472 wait_queue_head_t waitq
; /* Wait queue for channel or Tx */
473 __be32 crypto_buf
[2]; /* Temporary packet crypto buffer */
474 unsigned long user_call_ID
; /* user-defined call ID */
476 unsigned long events
;
478 rwlock_t state_lock
; /* lock for state transition */
479 u32 abort_code
; /* Local/remote abort code */
480 int error
; /* Local error incurred */
481 enum rxrpc_call_state state
; /* current state of call */
482 enum rxrpc_call_completion completion
; /* Call completion condition */
484 u16 service_id
; /* service ID */
485 u8 security_ix
; /* Security type */
486 u32 call_id
; /* call ID on connection */
487 u32 cid
; /* connection ID plus channel index */
488 int debug_id
; /* debug ID for printks */
489 unsigned short rx_pkt_offset
; /* Current recvmsg packet offset */
490 unsigned short rx_pkt_len
; /* Current recvmsg packet len */
492 /* Rx/Tx circular buffer, depending on phase.
494 * In the Rx phase, packets are annotated with 0 or the number of the
495 * segment of a jumbo packet each buffer refers to. There can be up to
496 * 47 segments in a maximum-size UDP packet.
498 * In the Tx phase, packets are annotated with which buffers have been
501 #define RXRPC_RXTX_BUFF_SIZE 64
502 #define RXRPC_RXTX_BUFF_MASK (RXRPC_RXTX_BUFF_SIZE - 1)
503 #define RXRPC_INIT_RX_WINDOW_SIZE 32
504 struct sk_buff
**rxtx_buffer
;
505 u8
*rxtx_annotations
;
506 #define RXRPC_TX_ANNO_ACK 0
507 #define RXRPC_TX_ANNO_UNACK 1
508 #define RXRPC_TX_ANNO_NAK 2
509 #define RXRPC_TX_ANNO_RETRANS 3
510 #define RXRPC_TX_ANNO_MASK 0x03
511 #define RXRPC_TX_ANNO_LAST 0x04
512 #define RXRPC_TX_ANNO_RESENT 0x08
514 #define RXRPC_RX_ANNO_JUMBO 0x3f /* Jumbo subpacket number + 1 if not zero */
515 #define RXRPC_RX_ANNO_JLAST 0x40 /* Set if last element of a jumbo packet */
516 #define RXRPC_RX_ANNO_VERIFIED 0x80 /* Set if verified and decrypted */
517 rxrpc_seq_t tx_hard_ack
; /* Dead slot in buffer; the first transmitted but
518 * not hard-ACK'd packet follows this.
520 rxrpc_seq_t tx_top
; /* Highest Tx slot allocated. */
521 rxrpc_seq_t rx_hard_ack
; /* Dead slot in buffer; the first received but not
522 * consumed packet follows this.
524 rxrpc_seq_t rx_top
; /* Highest Rx slot allocated. */
525 rxrpc_seq_t rx_expect_next
; /* Expected next packet sequence number */
526 u8 rx_winsize
; /* Size of Rx window */
527 u8 tx_winsize
; /* Maximum size of Tx window */
528 bool tx_phase
; /* T if transmission phase, F if receive phase */
529 u8 nr_jumbo_bad
; /* Number of jumbo dups/exceeds-windows */
531 /* receive-phase ACK management */
532 u8 ackr_reason
; /* reason to ACK */
533 u16 ackr_skew
; /* skew on packet being ACK'd */
534 rxrpc_serial_t ackr_serial
; /* serial of packet being ACK'd */
535 rxrpc_seq_t ackr_prev_seq
; /* previous sequence number received */
536 rxrpc_seq_t ackr_consumed
; /* Highest packet shown consumed */
537 rxrpc_seq_t ackr_seen
; /* Highest packet shown seen */
538 rxrpc_serial_t ackr_ping
; /* Last ping sent */
539 ktime_t ackr_ping_time
; /* Time last ping sent */
541 /* transmission-phase ACK management */
542 rxrpc_serial_t acks_latest
; /* serial number of latest ACK received */
543 rxrpc_seq_t acks_lowest_nak
; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
547 * Summary of a new ACK and the changes it made.
549 struct rxrpc_ack_summary
{
551 u8 nr_acks
; /* Number of ACKs in packet */
552 u8 nr_nacks
; /* Number of NACKs in packet */
553 u8 nr_new_acks
; /* Number of new ACKs in packet */
554 u8 nr_new_nacks
; /* Number of new NACKs in packet */
555 u8 nr_rot_new_acks
; /* Number of rotated new ACKs */
556 bool new_low_nack
; /* T if new low NACK found */
559 enum rxrpc_skb_trace
{
560 rxrpc_skb_rx_cleaned
,
564 rxrpc_skb_rx_received
,
565 rxrpc_skb_rx_rotated
,
568 rxrpc_skb_tx_cleaned
,
573 rxrpc_skb_tx_rotated
,
578 extern const char rxrpc_skb_traces
[rxrpc_skb__nr_trace
][7];
580 enum rxrpc_conn_trace
{
581 rxrpc_conn_new_client
,
582 rxrpc_conn_new_service
,
586 rxrpc_conn_put_client
,
587 rxrpc_conn_put_service
,
591 extern const char rxrpc_conn_traces
[rxrpc_conn__nr_trace
][4];
593 enum rxrpc_client_trace
{
594 rxrpc_client_activate_chans
,
596 rxrpc_client_chan_activate
,
597 rxrpc_client_chan_disconnect
,
598 rxrpc_client_chan_pass
,
599 rxrpc_client_chan_unstarted
,
600 rxrpc_client_cleanup
,
602 rxrpc_client_discard
,
603 rxrpc_client_duplicate
,
604 rxrpc_client_exposed
,
605 rxrpc_client_replace
,
606 rxrpc_client_to_active
,
607 rxrpc_client_to_culled
,
608 rxrpc_client_to_idle
,
609 rxrpc_client_to_inactive
,
610 rxrpc_client_to_waiting
,
611 rxrpc_client_uncount
,
612 rxrpc_client__nr_trace
615 extern const char rxrpc_client_traces
[rxrpc_client__nr_trace
][7];
616 extern const char rxrpc_conn_cache_states
[RXRPC_CONN__NR_CACHE_STATES
][5];
618 enum rxrpc_call_trace
{
619 rxrpc_call_new_client
,
620 rxrpc_call_new_service
,
622 rxrpc_call_queued_ref
,
624 rxrpc_call_connected
,
627 rxrpc_call_got_userid
,
628 rxrpc_call_got_kernel
,
630 rxrpc_call_put_userid
,
631 rxrpc_call_put_kernel
,
632 rxrpc_call_put_noqueue
,
637 extern const char rxrpc_call_traces
[rxrpc_call__nr_trace
][4];
639 enum rxrpc_transmit_trace
{
641 rxrpc_transmit_queue
,
642 rxrpc_transmit_queue_last
,
643 rxrpc_transmit_rotate
,
644 rxrpc_transmit_rotate_last
,
645 rxrpc_transmit_await_reply
,
647 rxrpc_transmit__nr_trace
650 extern const char rxrpc_transmit_traces
[rxrpc_transmit__nr_trace
][4];
652 enum rxrpc_receive_trace
{
653 rxrpc_receive_incoming
,
655 rxrpc_receive_queue_last
,
657 rxrpc_receive_rotate
,
659 rxrpc_receive__nr_trace
662 extern const char rxrpc_receive_traces
[rxrpc_receive__nr_trace
][4];
664 enum rxrpc_recvmsg_trace
{
667 rxrpc_recvmsg_dequeue
,
672 rxrpc_recvmsg_data_return
,
673 rxrpc_recvmsg_terminal
,
674 rxrpc_recvmsg_to_be_accepted
,
675 rxrpc_recvmsg_return
,
676 rxrpc_recvmsg__nr_trace
679 extern const char rxrpc_recvmsg_traces
[rxrpc_recvmsg__nr_trace
][5];
681 enum rxrpc_rtt_tx_trace
{
684 rxrpc_rtt_tx__nr_trace
687 extern const char rxrpc_rtt_tx_traces
[rxrpc_rtt_tx__nr_trace
][5];
689 enum rxrpc_rtt_rx_trace
{
690 rxrpc_rtt_rx_ping_response
,
691 rxrpc_rtt_rx_requested_ack
,
692 rxrpc_rtt_rx__nr_trace
695 extern const char rxrpc_rtt_rx_traces
[rxrpc_rtt_rx__nr_trace
][5];
697 enum rxrpc_timer_trace
{
699 rxrpc_timer_init_for_reply
,
701 rxrpc_timer_set_for_ack
,
702 rxrpc_timer_set_for_resend
,
703 rxrpc_timer_set_for_send
,
704 rxrpc_timer__nr_trace
707 extern const char rxrpc_timer_traces
[rxrpc_timer__nr_trace
][8];
709 enum rxrpc_propose_ack_trace
{
710 rxrpc_propose_ack_client_tx_end
,
711 rxrpc_propose_ack_input_data
,
712 rxrpc_propose_ack_ping_for_lost_reply
,
713 rxrpc_propose_ack_ping_for_params
,
714 rxrpc_propose_ack_respond_to_ack
,
715 rxrpc_propose_ack_respond_to_ping
,
716 rxrpc_propose_ack_retry_tx
,
717 rxrpc_propose_ack_rotate_rx
,
718 rxrpc_propose_ack_terminal_ack
,
719 rxrpc_propose_ack__nr_trace
722 enum rxrpc_propose_ack_outcome
{
723 rxrpc_propose_ack_use
,
724 rxrpc_propose_ack_update
,
725 rxrpc_propose_ack_subsume
,
726 rxrpc_propose_ack__nr_outcomes
729 extern const char rxrpc_propose_ack_traces
[rxrpc_propose_ack__nr_trace
][8];
730 extern const char *const rxrpc_propose_ack_outcomes
[rxrpc_propose_ack__nr_outcomes
];
732 extern const char *const rxrpc_pkts
[];
733 extern const char const rxrpc_ack_names
[RXRPC_ACK__INVALID
+ 1][4];
735 #include <trace/events/rxrpc.h>
740 extern atomic_t rxrpc_n_tx_skbs
, rxrpc_n_rx_skbs
;
741 extern u32 rxrpc_epoch
;
742 extern atomic_t rxrpc_debug_id
;
743 extern struct workqueue_struct
*rxrpc_workqueue
;
748 int rxrpc_service_prealloc(struct rxrpc_sock
*, gfp_t
);
749 void rxrpc_discard_prealloc(struct rxrpc_sock
*);
750 struct rxrpc_call
*rxrpc_new_incoming_call(struct rxrpc_local
*,
751 struct rxrpc_connection
*,
753 void rxrpc_accept_incoming_calls(struct rxrpc_local
*);
754 struct rxrpc_call
*rxrpc_accept_call(struct rxrpc_sock
*, unsigned long,
756 int rxrpc_reject_call(struct rxrpc_sock
*);
761 void rxrpc_set_timer(struct rxrpc_call
*, enum rxrpc_timer_trace
);
762 void rxrpc_propose_ACK(struct rxrpc_call
*, u8
, u16
, u32
, bool, bool,
763 enum rxrpc_propose_ack_trace
);
764 void rxrpc_process_call(struct work_struct
*);
769 extern const char *const rxrpc_call_states
[];
770 extern const char *const rxrpc_call_completions
[];
771 extern unsigned int rxrpc_max_call_lifetime
;
772 extern struct kmem_cache
*rxrpc_call_jar
;
773 extern struct list_head rxrpc_calls
;
774 extern rwlock_t rxrpc_call_lock
;
776 struct rxrpc_call
*rxrpc_find_call_by_user_ID(struct rxrpc_sock
*, unsigned long);
777 struct rxrpc_call
*rxrpc_alloc_call(gfp_t
);
778 struct rxrpc_call
*rxrpc_new_client_call(struct rxrpc_sock
*,
779 struct rxrpc_conn_parameters
*,
780 struct sockaddr_rxrpc
*,
781 unsigned long, gfp_t
);
782 void rxrpc_incoming_call(struct rxrpc_sock
*, struct rxrpc_call
*,
784 void rxrpc_release_call(struct rxrpc_sock
*, struct rxrpc_call
*);
785 void rxrpc_release_calls_on_socket(struct rxrpc_sock
*);
786 bool __rxrpc_queue_call(struct rxrpc_call
*);
787 bool rxrpc_queue_call(struct rxrpc_call
*);
788 void rxrpc_see_call(struct rxrpc_call
*);
789 void rxrpc_get_call(struct rxrpc_call
*, enum rxrpc_call_trace
);
790 void rxrpc_put_call(struct rxrpc_call
*, enum rxrpc_call_trace
);
791 void rxrpc_cleanup_call(struct rxrpc_call
*);
792 void __exit
rxrpc_destroy_all_calls(void);
794 static inline bool rxrpc_is_service_call(const struct rxrpc_call
*call
)
796 return test_bit(RXRPC_CALL_IS_SERVICE
, &call
->flags
);
799 static inline bool rxrpc_is_client_call(const struct rxrpc_call
*call
)
801 return !rxrpc_is_service_call(call
);
805 * Transition a call to the complete state.
807 static inline bool __rxrpc_set_call_completion(struct rxrpc_call
*call
,
808 enum rxrpc_call_completion
compl,
812 if (call
->state
< RXRPC_CALL_COMPLETE
) {
813 call
->abort_code
= abort_code
;
815 call
->completion
= compl,
816 call
->state
= RXRPC_CALL_COMPLETE
;
817 wake_up(&call
->waitq
);
823 static inline bool rxrpc_set_call_completion(struct rxrpc_call
*call
,
824 enum rxrpc_call_completion
compl,
830 write_lock_bh(&call
->state_lock
);
831 ret
= __rxrpc_set_call_completion(call
, compl, abort_code
, error
);
832 write_unlock_bh(&call
->state_lock
);
837 * Record that a call successfully completed.
839 static inline bool __rxrpc_call_completed(struct rxrpc_call
*call
)
841 return __rxrpc_set_call_completion(call
, RXRPC_CALL_SUCCEEDED
, 0, 0);
844 static inline bool rxrpc_call_completed(struct rxrpc_call
*call
)
848 write_lock_bh(&call
->state_lock
);
849 ret
= __rxrpc_call_completed(call
);
850 write_unlock_bh(&call
->state_lock
);
855 * Record that a call is locally aborted.
857 static inline bool __rxrpc_abort_call(const char *why
, struct rxrpc_call
*call
,
859 u32 abort_code
, int error
)
861 trace_rxrpc_abort(why
, call
->cid
, call
->call_id
, seq
,
863 return __rxrpc_set_call_completion(call
, RXRPC_CALL_LOCALLY_ABORTED
,
867 static inline bool rxrpc_abort_call(const char *why
, struct rxrpc_call
*call
,
868 rxrpc_seq_t seq
, u32 abort_code
, int error
)
872 write_lock_bh(&call
->state_lock
);
873 ret
= __rxrpc_abort_call(why
, call
, seq
, abort_code
, error
);
874 write_unlock_bh(&call
->state_lock
);
881 extern unsigned int rxrpc_max_client_connections
;
882 extern unsigned int rxrpc_reap_client_connections
;
883 extern unsigned int rxrpc_conn_idle_client_expiry
;
884 extern unsigned int rxrpc_conn_idle_client_fast_expiry
;
885 extern struct idr rxrpc_client_conn_ids
;
887 void rxrpc_destroy_client_conn_ids(void);
888 int rxrpc_connect_call(struct rxrpc_call
*, struct rxrpc_conn_parameters
*,
889 struct sockaddr_rxrpc
*, gfp_t
);
890 void rxrpc_expose_client_call(struct rxrpc_call
*);
891 void rxrpc_disconnect_client_call(struct rxrpc_call
*);
892 void rxrpc_put_client_conn(struct rxrpc_connection
*);
893 void __exit
rxrpc_destroy_all_client_connections(void);
898 void rxrpc_process_connection(struct work_struct
*);
903 extern unsigned int rxrpc_connection_expiry
;
904 extern struct list_head rxrpc_connections
;
905 extern struct list_head rxrpc_connection_proc_list
;
906 extern rwlock_t rxrpc_connection_lock
;
908 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc
*, struct sk_buff
*);
909 struct rxrpc_connection
*rxrpc_alloc_connection(gfp_t
);
910 struct rxrpc_connection
*rxrpc_find_connection_rcu(struct rxrpc_local
*,
912 void __rxrpc_disconnect_call(struct rxrpc_connection
*, struct rxrpc_call
*);
913 void rxrpc_disconnect_call(struct rxrpc_call
*);
914 void rxrpc_kill_connection(struct rxrpc_connection
*);
915 bool rxrpc_queue_conn(struct rxrpc_connection
*);
916 void rxrpc_see_connection(struct rxrpc_connection
*);
917 void rxrpc_get_connection(struct rxrpc_connection
*);
918 struct rxrpc_connection
*rxrpc_get_connection_maybe(struct rxrpc_connection
*);
919 void rxrpc_put_service_conn(struct rxrpc_connection
*);
920 void __exit
rxrpc_destroy_all_connections(void);
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
);
946 struct rxrpc_connection
*rxrpc_find_service_conn_rcu(struct rxrpc_peer
*,
948 struct rxrpc_connection
*rxrpc_prealloc_service_connection(gfp_t
);
949 void rxrpc_new_incoming_connection(struct rxrpc_connection
*, struct sk_buff
*);
950 void rxrpc_unpublish_service_conn(struct rxrpc_connection
*);
955 void rxrpc_data_ready(struct sock
*);
960 extern const struct rxrpc_security rxrpc_no_security
;
965 extern struct key_type key_type_rxrpc
;
966 extern struct key_type key_type_rxrpc_s
;
968 int rxrpc_request_key(struct rxrpc_sock
*, char __user
*, int);
969 int rxrpc_server_keyring(struct rxrpc_sock
*, char __user
*, int);
970 int rxrpc_get_server_data_key(struct rxrpc_connection
*, const void *, time_t,
976 extern void rxrpc_process_local_events(struct rxrpc_local
*);
981 struct rxrpc_local
*rxrpc_lookup_local(const struct sockaddr_rxrpc
*);
982 void __rxrpc_put_local(struct rxrpc_local
*);
983 void __exit
rxrpc_destroy_all_locals(void);
985 static inline void rxrpc_get_local(struct rxrpc_local
*local
)
987 atomic_inc(&local
->usage
);
991 struct rxrpc_local
*rxrpc_get_local_maybe(struct rxrpc_local
*local
)
993 return atomic_inc_not_zero(&local
->usage
) ? local
: NULL
;
996 static inline void rxrpc_put_local(struct rxrpc_local
*local
)
998 if (local
&& atomic_dec_and_test(&local
->usage
))
999 __rxrpc_put_local(local
);
1002 static inline void rxrpc_queue_local(struct rxrpc_local
*local
)
1004 rxrpc_queue_work(&local
->processor
);
1010 extern unsigned int rxrpc_max_backlog __read_mostly
;
1011 extern unsigned int rxrpc_requested_ack_delay
;
1012 extern unsigned int rxrpc_soft_ack_delay
;
1013 extern unsigned int rxrpc_idle_ack_delay
;
1014 extern unsigned int rxrpc_rx_window_size
;
1015 extern unsigned int rxrpc_rx_mtu
;
1016 extern unsigned int rxrpc_rx_jumbo_max
;
1017 extern unsigned int rxrpc_resend_timeout
;
1019 extern const s8 rxrpc_ack_priority
[];
1024 int rxrpc_send_call_packet(struct rxrpc_call
*, u8
);
1025 int rxrpc_send_data_packet(struct rxrpc_call
*, struct sk_buff
*);
1026 void rxrpc_reject_packets(struct rxrpc_local
*);
1031 void rxrpc_error_report(struct sock
*);
1032 void rxrpc_peer_error_distributor(struct work_struct
*);
1033 void rxrpc_peer_add_rtt(struct rxrpc_call
*, enum rxrpc_rtt_rx_trace
,
1034 rxrpc_serial_t
, rxrpc_serial_t
, ktime_t
, ktime_t
);
1039 struct rxrpc_peer
*rxrpc_lookup_peer_rcu(struct rxrpc_local
*,
1040 const struct sockaddr_rxrpc
*);
1041 struct rxrpc_peer
*rxrpc_lookup_peer(struct rxrpc_local
*,
1042 struct sockaddr_rxrpc
*, gfp_t
);
1043 struct rxrpc_peer
*rxrpc_alloc_peer(struct rxrpc_local
*, gfp_t
);
1044 struct rxrpc_peer
*rxrpc_lookup_incoming_peer(struct rxrpc_local
*,
1045 struct rxrpc_peer
*);
1047 static inline struct rxrpc_peer
*rxrpc_get_peer(struct rxrpc_peer
*peer
)
1049 atomic_inc(&peer
->usage
);
1054 struct rxrpc_peer
*rxrpc_get_peer_maybe(struct rxrpc_peer
*peer
)
1056 return atomic_inc_not_zero(&peer
->usage
) ? peer
: NULL
;
1059 extern void __rxrpc_put_peer(struct rxrpc_peer
*peer
);
1060 static inline void rxrpc_put_peer(struct rxrpc_peer
*peer
)
1062 if (peer
&& atomic_dec_and_test(&peer
->usage
))
1063 __rxrpc_put_peer(peer
);
1069 extern const struct file_operations rxrpc_call_seq_fops
;
1070 extern const struct file_operations rxrpc_connection_seq_fops
;
1075 void rxrpc_notify_socket(struct rxrpc_call
*);
1076 int rxrpc_recvmsg(struct socket
*, struct msghdr
*, size_t, int);
1082 extern const struct rxrpc_security rxkad
;
1088 int __init
rxrpc_init_security(void);
1089 void rxrpc_exit_security(void);
1090 int rxrpc_init_client_conn_security(struct rxrpc_connection
*);
1091 int rxrpc_init_server_conn_security(struct rxrpc_connection
*);
1096 int rxrpc_do_sendmsg(struct rxrpc_sock
*, struct msghdr
*, size_t);
1101 void rxrpc_kernel_data_consumed(struct rxrpc_call
*, struct sk_buff
*);
1102 void rxrpc_packet_destructor(struct sk_buff
*);
1103 void rxrpc_new_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1104 void rxrpc_see_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1105 void rxrpc_get_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1106 void rxrpc_free_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1107 void rxrpc_lose_skb(struct sk_buff
*, enum rxrpc_skb_trace
);
1108 void rxrpc_purge_queue(struct sk_buff_head
*);
1113 #ifdef CONFIG_SYSCTL
1114 extern int __init
rxrpc_sysctl_init(void);
1115 extern void rxrpc_sysctl_exit(void);
1117 static inline int __init
rxrpc_sysctl_init(void) { return 0; }
1118 static inline void rxrpc_sysctl_exit(void) {}
1124 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc
*, struct sk_buff
*);
1126 static inline bool before(u32 seq1
, u32 seq2
)
1128 return (s32
)(seq1
- seq2
) < 0;
1130 static inline bool before_eq(u32 seq1
, u32 seq2
)
1132 return (s32
)(seq1
- seq2
) <= 0;
1134 static inline bool after(u32 seq1
, u32 seq2
)
1136 return (s32
)(seq1
- seq2
) > 0;
1138 static inline bool after_eq(u32 seq1
, u32 seq2
)
1140 return (s32
)(seq1
- seq2
) >= 0;
1146 extern unsigned int rxrpc_debug
;
1148 #define dbgprintk(FMT,...) \
1149 printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1151 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1152 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1153 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
1154 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1155 #define knet(FMT,...) dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1158 #if defined(__KDEBUG)
1159 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1160 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1161 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1162 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1163 #define _net(FMT,...) knet(FMT,##__VA_ARGS__)
1165 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1166 #define RXRPC_DEBUG_KENTER 0x01
1167 #define RXRPC_DEBUG_KLEAVE 0x02
1168 #define RXRPC_DEBUG_KDEBUG 0x04
1169 #define RXRPC_DEBUG_KPROTO 0x08
1170 #define RXRPC_DEBUG_KNET 0x10
1172 #define _enter(FMT,...) \
1174 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1175 kenter(FMT,##__VA_ARGS__); \
1178 #define _leave(FMT,...) \
1180 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1181 kleave(FMT,##__VA_ARGS__); \
1184 #define _debug(FMT,...) \
1186 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1187 kdebug(FMT,##__VA_ARGS__); \
1190 #define _proto(FMT,...) \
1192 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1193 kproto(FMT,##__VA_ARGS__); \
1196 #define _net(FMT,...) \
1198 if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET)) \
1199 knet(FMT,##__VA_ARGS__); \
1203 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1204 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1205 #define _debug(FMT,...) no_printk(" "FMT ,##__VA_ARGS__)
1206 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1207 #define _net(FMT,...) no_printk("@@@ "FMT ,##__VA_ARGS__)
1211 * debug assertion checking
1213 #if 1 // defined(__KDEBUGALL)
1217 if (unlikely(!(X))) { \
1218 pr_err("Assertion failed\n"); \
1223 #define ASSERTCMP(X, OP, Y) \
1225 __typeof__(X) _x = (X); \
1226 __typeof__(Y) _y = (__typeof__(X))(Y); \
1227 if (unlikely(!(_x OP _y))) { \
1228 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1229 (unsigned long)_x, (unsigned long)_x, #OP, \
1230 (unsigned long)_y, (unsigned long)_y); \
1235 #define ASSERTIF(C, X) \
1237 if (unlikely((C) && !(X))) { \
1238 pr_err("Assertion failed\n"); \
1243 #define ASSERTIFCMP(C, X, OP, Y) \
1245 __typeof__(X) _x = (X); \
1246 __typeof__(Y) _y = (__typeof__(X))(Y); \
1247 if (unlikely((C) && !(_x OP _y))) { \
1248 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1249 (unsigned long)_x, (unsigned long)_x, #OP, \
1250 (unsigned long)_y, (unsigned long)_y); \
1261 #define ASSERTCMP(X, OP, Y) \
1265 #define ASSERTIF(C, X) \
1269 #define ASSERTIFCMP(C, X, OP, Y) \
1273 #endif /* __KDEBUGALL */