rxrpc: Move DATA transmission into call processor work item
[platform/kernel/linux-rpi.git] / net / rxrpc / ar-internal.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* AF_RXRPC internal definitions
3  *
4  * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
5  * Written by David Howells (dhowells@redhat.com)
6  */
7
8 #include <linux/atomic.h>
9 #include <linux/seqlock.h>
10 #include <linux/win_minmax.h>
11 #include <net/net_namespace.h>
12 #include <net/netns/generic.h>
13 #include <net/sock.h>
14 #include <net/af_rxrpc.h>
15 #include <keys/rxrpc-type.h>
16 #include "protocol.h"
17
18 #define FCRYPT_BSIZE 8
19 struct rxrpc_crypt {
20         union {
21                 u8      x[FCRYPT_BSIZE];
22                 __be32  n[2];
23         };
24 } __attribute__((aligned(8)));
25
26 #define rxrpc_queue_work(WS)    queue_work(rxrpc_workqueue, (WS))
27 #define rxrpc_queue_delayed_work(WS,D)  \
28         queue_delayed_work(rxrpc_workqueue, (WS), (D))
29
30 struct key_preparsed_payload;
31 struct rxrpc_connection;
32 struct rxrpc_txbuf;
33
34 /*
35  * Mark applied to socket buffers in skb->mark.  skb->priority is used
36  * to pass supplementary information.
37  */
38 enum rxrpc_skb_mark {
39         RXRPC_SKB_MARK_PACKET,          /* Received packet */
40         RXRPC_SKB_MARK_ERROR,           /* Error notification */
41         RXRPC_SKB_MARK_REJECT_BUSY,     /* Reject with BUSY */
42         RXRPC_SKB_MARK_REJECT_ABORT,    /* Reject with ABORT (code in skb->priority) */
43 };
44
45 /*
46  * sk_state for RxRPC sockets
47  */
48 enum {
49         RXRPC_UNBOUND = 0,
50         RXRPC_CLIENT_UNBOUND,           /* Unbound socket used as client */
51         RXRPC_CLIENT_BOUND,             /* client local address bound */
52         RXRPC_SERVER_BOUND,             /* server local address bound */
53         RXRPC_SERVER_BOUND2,            /* second server local address bound */
54         RXRPC_SERVER_LISTENING,         /* server listening for connections */
55         RXRPC_SERVER_LISTEN_DISABLED,   /* server listening disabled */
56         RXRPC_CLOSE,                    /* socket is being closed */
57 };
58
59 /*
60  * Per-network namespace data.
61  */
62 struct rxrpc_net {
63         struct proc_dir_entry   *proc_net;      /* Subdir in /proc/net */
64         u32                     epoch;          /* Local epoch for detecting local-end reset */
65         struct list_head        calls;          /* List of calls active in this namespace */
66         spinlock_t              call_lock;      /* Lock for ->calls */
67         atomic_t                nr_calls;       /* Count of allocated calls */
68
69         atomic_t                nr_conns;
70         struct list_head        conn_proc_list; /* List of conns in this namespace for proc */
71         struct list_head        service_conns;  /* Service conns in this namespace */
72         rwlock_t                conn_lock;      /* Lock for ->conn_proc_list, ->service_conns */
73         struct work_struct      service_conn_reaper;
74         struct timer_list       service_conn_reap_timer;
75
76         bool                    live;
77
78         bool                    kill_all_client_conns;
79         atomic_t                nr_client_conns;
80         spinlock_t              client_conn_cache_lock; /* Lock for ->*_client_conns */
81         struct mutex            client_conn_discard_lock; /* Prevent multiple discarders */
82         struct list_head        idle_client_conns;
83         struct work_struct      client_conn_reaper;
84         struct timer_list       client_conn_reap_timer;
85
86         struct hlist_head       local_endpoints;
87         struct mutex            local_mutex;    /* Lock for ->local_endpoints */
88
89         DECLARE_HASHTABLE       (peer_hash, 10);
90         spinlock_t              peer_hash_lock; /* Lock for ->peer_hash */
91
92 #define RXRPC_KEEPALIVE_TIME 20 /* NAT keepalive time in seconds */
93         u8                      peer_keepalive_cursor;
94         time64_t                peer_keepalive_base;
95         struct list_head        peer_keepalive[32];
96         struct list_head        peer_keepalive_new;
97         struct timer_list       peer_keepalive_timer;
98         struct work_struct      peer_keepalive_work;
99
100         atomic_t                stat_tx_data;
101         atomic_t                stat_tx_data_retrans;
102         atomic_t                stat_tx_data_send;
103         atomic_t                stat_tx_data_send_frag;
104         atomic_t                stat_rx_data;
105         atomic_t                stat_rx_data_reqack;
106         atomic_t                stat_rx_data_jumbo;
107
108         atomic_t                stat_tx_ack_fill;
109         atomic_t                stat_tx_ack_send;
110         atomic_t                stat_tx_ack_skip;
111         atomic_t                stat_tx_acks[256];
112         atomic_t                stat_rx_acks[256];
113
114         atomic_t                stat_why_req_ack[8];
115
116         atomic_t                stat_io_loop;
117 };
118
119 /*
120  * Service backlog preallocation.
121  *
122  * This contains circular buffers of preallocated peers, connections and calls
123  * for incoming service calls and their head and tail pointers.  This allows
124  * calls to be set up in the data_ready handler, thereby avoiding the need to
125  * shuffle packets around so much.
126  */
127 struct rxrpc_backlog {
128         unsigned short          peer_backlog_head;
129         unsigned short          peer_backlog_tail;
130         unsigned short          conn_backlog_head;
131         unsigned short          conn_backlog_tail;
132         unsigned short          call_backlog_head;
133         unsigned short          call_backlog_tail;
134 #define RXRPC_BACKLOG_MAX       32
135         struct rxrpc_peer       *peer_backlog[RXRPC_BACKLOG_MAX];
136         struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
137         struct rxrpc_call       *call_backlog[RXRPC_BACKLOG_MAX];
138 };
139
140 /*
141  * RxRPC socket definition
142  */
143 struct rxrpc_sock {
144         /* WARNING: sk has to be the first member */
145         struct sock             sk;
146         rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
147         rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
148         struct rxrpc_local      *local;         /* local endpoint */
149         struct rxrpc_backlog    *backlog;       /* Preallocation for services */
150         spinlock_t              incoming_lock;  /* Incoming call vs service shutdown lock */
151         struct list_head        sock_calls;     /* List of calls owned by this socket */
152         struct list_head        to_be_accepted; /* calls awaiting acceptance */
153         struct list_head        recvmsg_q;      /* Calls awaiting recvmsg's attention  */
154         rwlock_t                recvmsg_lock;   /* Lock for recvmsg_q */
155         struct key              *key;           /* security for this socket */
156         struct key              *securities;    /* list of server security descriptors */
157         struct rb_root          calls;          /* User ID -> call mapping */
158         unsigned long           flags;
159 #define RXRPC_SOCK_CONNECTED            0       /* connect_srx is set */
160         rwlock_t                call_lock;      /* lock for calls */
161         u32                     min_sec_level;  /* minimum security level */
162 #define RXRPC_SECURITY_MAX      RXRPC_SECURITY_ENCRYPT
163         bool                    exclusive;      /* Exclusive connection for a client socket */
164         u16                     second_service; /* Additional service bound to the endpoint */
165         struct {
166                 /* Service upgrade information */
167                 u16             from;           /* Service ID to upgrade (if not 0) */
168                 u16             to;             /* service ID to upgrade to */
169         } service_upgrade;
170         sa_family_t             family;         /* Protocol family created with */
171         struct sockaddr_rxrpc   srx;            /* Primary Service/local addresses */
172         struct sockaddr_rxrpc   connect_srx;    /* Default client address from connect() */
173 };
174
175 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
176
177 /*
178  * CPU-byteorder normalised Rx packet header.
179  */
180 struct rxrpc_host_header {
181         u32             epoch;          /* client boot timestamp */
182         u32             cid;            /* connection and channel ID */
183         u32             callNumber;     /* call ID (0 for connection-level packets) */
184         u32             seq;            /* sequence number of pkt in call stream */
185         u32             serial;         /* serial number of pkt sent to network */
186         u8              type;           /* packet type */
187         u8              flags;          /* packet flags */
188         u8              userStatus;     /* app-layer defined status */
189         u8              securityIndex;  /* security protocol ID */
190         union {
191                 u16     _rsvd;          /* reserved */
192                 u16     cksum;          /* kerberos security checksum */
193         };
194         u16             serviceId;      /* service ID */
195 } __packed;
196
197 /*
198  * RxRPC socket buffer private variables
199  * - max 48 bytes (struct sk_buff::cb)
200  */
201 struct rxrpc_skb_priv {
202         u16             offset;         /* Offset of data */
203         u16             len;            /* Length of data */
204         u8              flags;
205 #define RXRPC_RX_VERIFIED       0x01
206
207         struct rxrpc_host_header hdr;   /* RxRPC packet header from this packet */
208 };
209
210 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
211
212 /*
213  * RxRPC security module interface
214  */
215 struct rxrpc_security {
216         const char              *name;          /* name of this service */
217         u8                      security_index; /* security type provided */
218         u32                     no_key_abort;   /* Abort code indicating no key */
219
220         /* Initialise a security service */
221         int (*init)(void);
222
223         /* Clean up a security service */
224         void (*exit)(void);
225
226         /* Parse the information from a server key */
227         int (*preparse_server_key)(struct key_preparsed_payload *);
228
229         /* Clean up the preparse buffer after parsing a server key */
230         void (*free_preparse_server_key)(struct key_preparsed_payload *);
231
232         /* Destroy the payload of a server key */
233         void (*destroy_server_key)(struct key *);
234
235         /* Describe a server key */
236         void (*describe_server_key)(const struct key *, struct seq_file *);
237
238         /* initialise a connection's security */
239         int (*init_connection_security)(struct rxrpc_connection *,
240                                         struct rxrpc_key_token *);
241
242         /* Work out how much data we can store in a packet, given an estimate
243          * of the amount of data remaining.
244          */
245         int (*how_much_data)(struct rxrpc_call *, size_t,
246                              size_t *, size_t *, size_t *);
247
248         /* impose security on a packet */
249         int (*secure_packet)(struct rxrpc_call *, struct rxrpc_txbuf *);
250
251         /* verify the security on a received packet */
252         int (*verify_packet)(struct rxrpc_call *, struct sk_buff *);
253
254         /* Free crypto request on a call */
255         void (*free_call_crypto)(struct rxrpc_call *);
256
257         /* issue a challenge */
258         int (*issue_challenge)(struct rxrpc_connection *);
259
260         /* respond to a challenge */
261         int (*respond_to_challenge)(struct rxrpc_connection *,
262                                     struct sk_buff *,
263                                     u32 *);
264
265         /* verify a response */
266         int (*verify_response)(struct rxrpc_connection *,
267                                struct sk_buff *,
268                                u32 *);
269
270         /* clear connection security */
271         void (*clear)(struct rxrpc_connection *);
272 };
273
274 /*
275  * RxRPC local transport endpoint description
276  * - owned by a single AF_RXRPC socket
277  * - pointed to by transport socket struct sk_user_data
278  */
279 struct rxrpc_local {
280         struct rcu_head         rcu;
281         atomic_t                active_users;   /* Number of users of the local endpoint */
282         refcount_t              ref;            /* Number of references to the structure */
283         struct rxrpc_net        *rxnet;         /* The network ns in which this resides */
284         struct hlist_node       link;
285         struct socket           *socket;        /* my UDP socket */
286         struct work_struct      processor;
287         struct task_struct      *io_thread;
288         struct list_head        ack_tx_queue;   /* List of ACKs that need sending */
289         spinlock_t              ack_tx_lock;    /* ACK list lock */
290         struct rxrpc_sock __rcu *service;       /* Service(s) listening on this endpoint */
291         struct rw_semaphore     defrag_sem;     /* control re-enablement of IP DF bit */
292         struct sk_buff_head     reject_queue;   /* packets awaiting rejection */
293         struct sk_buff_head     event_queue;    /* endpoint event packets awaiting processing */
294         struct sk_buff_head     rx_queue;       /* Received packets */
295         struct list_head        call_attend_q;  /* Calls requiring immediate attention */
296         struct rb_root          client_bundles; /* Client connection bundles by socket params */
297         spinlock_t              client_bundles_lock; /* Lock for client_bundles */
298         spinlock_t              lock;           /* access lock */
299         rwlock_t                services_lock;  /* lock for services list */
300         int                     debug_id;       /* debug ID for printks */
301         bool                    dead;
302         bool                    service_closed; /* Service socket closed */
303         struct sockaddr_rxrpc   srx;            /* local address */
304 };
305
306 /*
307  * RxRPC remote transport endpoint definition
308  * - matched by local endpoint, remote port, address and protocol type
309  */
310 struct rxrpc_peer {
311         struct rcu_head         rcu;            /* This must be first */
312         refcount_t              ref;
313         unsigned long           hash_key;
314         struct hlist_node       hash_link;
315         struct rxrpc_local      *local;
316         struct hlist_head       error_targets;  /* targets for net error distribution */
317         struct rb_root          service_conns;  /* Service connections */
318         struct list_head        keepalive_link; /* Link in net->peer_keepalive[] */
319         time64_t                last_tx_at;     /* Last time packet sent here */
320         seqlock_t               service_conn_lock;
321         spinlock_t              lock;           /* access lock */
322         unsigned int            if_mtu;         /* interface MTU for this peer */
323         unsigned int            mtu;            /* network MTU for this peer */
324         unsigned int            maxdata;        /* data size (MTU - hdrsize) */
325         unsigned short          hdrsize;        /* header size (IP + UDP + RxRPC) */
326         int                     debug_id;       /* debug ID for printks */
327         struct sockaddr_rxrpc   srx;            /* remote address */
328
329         /* calculated RTT cache */
330 #define RXRPC_RTT_CACHE_SIZE 32
331         spinlock_t              rtt_input_lock; /* RTT lock for input routine */
332         ktime_t                 rtt_last_req;   /* Time of last RTT request */
333         unsigned int            rtt_count;      /* Number of samples we've got */
334
335         u32                     srtt_us;        /* smoothed round trip time << 3 in usecs */
336         u32                     mdev_us;        /* medium deviation                     */
337         u32                     mdev_max_us;    /* maximal mdev for the last rtt period */
338         u32                     rttvar_us;      /* smoothed mdev_max                    */
339         u32                     rto_j;          /* Retransmission timeout in jiffies */
340         u8                      backoff;        /* Backoff timeout */
341
342         u8                      cong_ssthresh;  /* Congestion slow-start threshold */
343 };
344
345 /*
346  * Keys for matching a connection.
347  */
348 struct rxrpc_conn_proto {
349         union {
350                 struct {
351                         u32     epoch;          /* epoch of this connection */
352                         u32     cid;            /* connection ID */
353                 };
354                 u64             index_key;
355         };
356 };
357
358 struct rxrpc_conn_parameters {
359         struct rxrpc_local      *local;         /* Representation of local endpoint */
360         struct rxrpc_peer       *peer;          /* Remote endpoint */
361         struct key              *key;           /* Security details */
362         bool                    exclusive;      /* T if conn is exclusive */
363         bool                    upgrade;        /* T if service ID can be upgraded */
364         u16                     service_id;     /* Service ID for this connection */
365         u32                     security_level; /* Security level selected */
366 };
367
368 /*
369  * Bits in the connection flags.
370  */
371 enum rxrpc_conn_flag {
372         RXRPC_CONN_HAS_IDR,             /* Has a client conn ID assigned */
373         RXRPC_CONN_IN_SERVICE_CONNS,    /* Conn is in peer->service_conns */
374         RXRPC_CONN_DONT_REUSE,          /* Don't reuse this connection */
375         RXRPC_CONN_PROBING_FOR_UPGRADE, /* Probing for service upgrade */
376         RXRPC_CONN_FINAL_ACK_0,         /* Need final ACK for channel 0 */
377         RXRPC_CONN_FINAL_ACK_1,         /* Need final ACK for channel 1 */
378         RXRPC_CONN_FINAL_ACK_2,         /* Need final ACK for channel 2 */
379         RXRPC_CONN_FINAL_ACK_3,         /* Need final ACK for channel 3 */
380 };
381
382 #define RXRPC_CONN_FINAL_ACK_MASK ((1UL << RXRPC_CONN_FINAL_ACK_0) |    \
383                                    (1UL << RXRPC_CONN_FINAL_ACK_1) |    \
384                                    (1UL << RXRPC_CONN_FINAL_ACK_2) |    \
385                                    (1UL << RXRPC_CONN_FINAL_ACK_3))
386
387 /*
388  * Events that can be raised upon a connection.
389  */
390 enum rxrpc_conn_event {
391         RXRPC_CONN_EV_CHALLENGE,        /* Send challenge packet */
392 };
393
394 /*
395  * The connection protocol state.
396  */
397 enum rxrpc_conn_proto_state {
398         RXRPC_CONN_UNUSED,              /* Connection not yet attempted */
399         RXRPC_CONN_CLIENT,              /* Client connection */
400         RXRPC_CONN_SERVICE_PREALLOC,    /* Service connection preallocation */
401         RXRPC_CONN_SERVICE_UNSECURED,   /* Service unsecured connection */
402         RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
403         RXRPC_CONN_SERVICE,             /* Service secured connection */
404         RXRPC_CONN_REMOTELY_ABORTED,    /* Conn aborted by peer */
405         RXRPC_CONN_LOCALLY_ABORTED,     /* Conn aborted locally */
406         RXRPC_CONN__NR_STATES
407 };
408
409 /*
410  * RxRPC client connection bundle.
411  */
412 struct rxrpc_bundle {
413         struct rxrpc_local      *local;         /* Representation of local endpoint */
414         struct rxrpc_peer       *peer;          /* Remote endpoint */
415         struct key              *key;           /* Security details */
416         refcount_t              ref;
417         atomic_t                active;         /* Number of active users */
418         unsigned int            debug_id;
419         u32                     security_level; /* Security level selected */
420         u16                     service_id;     /* Service ID for this connection */
421         bool                    try_upgrade;    /* True if the bundle is attempting upgrade */
422         bool                    alloc_conn;     /* True if someone's getting a conn */
423         bool                    exclusive;      /* T if conn is exclusive */
424         bool                    upgrade;        /* T if service ID can be upgraded */
425         short                   alloc_error;    /* Error from last conn allocation */
426         spinlock_t              channel_lock;
427         struct rb_node          local_node;     /* Node in local->client_conns */
428         struct list_head        waiting_calls;  /* Calls waiting for channels */
429         unsigned long           avail_chans;    /* Mask of available channels */
430         struct rxrpc_connection *conns[4];      /* The connections in the bundle (max 4) */
431 };
432
433 /*
434  * RxRPC connection definition
435  * - matched by { local, peer, epoch, conn_id, direction }
436  * - each connection can only handle four simultaneous calls
437  */
438 struct rxrpc_connection {
439         struct rxrpc_conn_proto proto;
440         struct rxrpc_local      *local;         /* Representation of local endpoint */
441         struct rxrpc_peer       *peer;          /* Remote endpoint */
442         struct rxrpc_net        *rxnet;         /* Network namespace to which call belongs */
443         struct key              *key;           /* Security details */
444
445         refcount_t              ref;
446         atomic_t                active;         /* Active count for service conns */
447         struct rcu_head         rcu;
448         struct list_head        cache_link;
449
450         unsigned char           act_chans;      /* Mask of active channels */
451         struct rxrpc_channel {
452                 unsigned long           final_ack_at;   /* Time at which to issue final ACK */
453                 struct rxrpc_call __rcu *call;          /* Active call */
454                 unsigned int            call_debug_id;  /* call->debug_id */
455                 u32                     call_id;        /* ID of current call */
456                 u32                     call_counter;   /* Call ID counter */
457                 u32                     last_call;      /* ID of last call */
458                 u8                      last_type;      /* Type of last packet */
459                 union {
460                         u32             last_seq;
461                         u32             last_abort;
462                 };
463         } channels[RXRPC_MAXCALLS];
464
465         struct timer_list       timer;          /* Conn event timer */
466         struct work_struct      processor;      /* connection event processor */
467         struct work_struct      destructor;     /* In-process-context destroyer */
468         struct rxrpc_bundle     *bundle;        /* Client connection bundle */
469         struct rb_node          service_node;   /* Node in peer->service_conns */
470         struct list_head        proc_link;      /* link in procfs list */
471         struct list_head        link;           /* link in master connection list */
472         struct sk_buff_head     rx_queue;       /* received conn-level packets */
473
474         const struct rxrpc_security *security;  /* applied security module */
475         union {
476                 struct {
477                         struct crypto_sync_skcipher *cipher;    /* encryption handle */
478                         struct rxrpc_crypt csum_iv;     /* packet checksum base */
479                         u32     nonce;          /* response re-use preventer */
480                 } rxkad;
481         };
482         unsigned long           flags;
483         unsigned long           events;
484         unsigned long           idle_timestamp; /* Time at which last became idle */
485         spinlock_t              state_lock;     /* state-change lock */
486         enum rxrpc_conn_proto_state state;      /* current state of connection */
487         u32                     abort_code;     /* Abort code of connection abort */
488         int                     debug_id;       /* debug ID for printks */
489         atomic_t                serial;         /* packet serial number counter */
490         unsigned int            hi_serial;      /* highest serial number received */
491         u32                     service_id;     /* Service ID, possibly upgraded */
492         u32                     security_level; /* Security level selected */
493         u8                      security_ix;    /* security type */
494         u8                      out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
495         u8                      bundle_shift;   /* Index into bundle->avail_chans */
496         bool                    exclusive;      /* T if conn is exclusive */
497         bool                    upgrade;        /* T if service ID can be upgraded */
498         u16                     orig_service_id; /* Originally requested service ID */
499         short                   error;          /* Local error code */
500 };
501
502 static inline bool rxrpc_to_server(const struct rxrpc_skb_priv *sp)
503 {
504         return sp->hdr.flags & RXRPC_CLIENT_INITIATED;
505 }
506
507 static inline bool rxrpc_to_client(const struct rxrpc_skb_priv *sp)
508 {
509         return !rxrpc_to_server(sp);
510 }
511
512 /*
513  * Flags in call->flags.
514  */
515 enum rxrpc_call_flag {
516         RXRPC_CALL_RELEASED,            /* call has been released - no more message to userspace */
517         RXRPC_CALL_HAS_USERID,          /* has a user ID attached */
518         RXRPC_CALL_IS_SERVICE,          /* Call is service call */
519         RXRPC_CALL_EXPOSED,             /* The call was exposed to the world */
520         RXRPC_CALL_RX_LAST,             /* Received the last packet (at rxtx_top) */
521         RXRPC_CALL_TX_LAST,             /* Last packet in Tx buffer (at rxtx_top) */
522         RXRPC_CALL_TX_ALL_ACKED,        /* Last packet has been hard-acked */
523         RXRPC_CALL_SEND_PING,           /* A ping will need to be sent */
524         RXRPC_CALL_RETRANS_TIMEOUT,     /* Retransmission due to timeout occurred */
525         RXRPC_CALL_BEGAN_RX_TIMER,      /* We began the expect_rx_by timer */
526         RXRPC_CALL_RX_HEARD,            /* The peer responded at least once to this call */
527         RXRPC_CALL_RX_UNDERRUN,         /* Got data underrun */
528         RXRPC_CALL_DISCONNECTED,        /* The call has been disconnected */
529         RXRPC_CALL_KERNEL,              /* The call was made by the kernel */
530         RXRPC_CALL_UPGRADE,             /* Service upgrade was requested for the call */
531         RXRPC_CALL_DELAY_ACK_PENDING,   /* DELAY ACK generation is pending */
532         RXRPC_CALL_IDLE_ACK_PENDING,    /* IDLE ACK generation is pending */
533         RXRPC_CALL_EXCLUSIVE,           /* The call uses a once-only connection */
534 };
535
536 /*
537  * Events that can be raised on a call.
538  */
539 enum rxrpc_call_event {
540         RXRPC_CALL_EV_ABORT,            /* need to generate abort */
541         RXRPC_CALL_EV_RESEND,           /* Tx resend required */
542         RXRPC_CALL_EV_EXPIRED,          /* Expiry occurred */
543         RXRPC_CALL_EV_ACK_LOST,         /* ACK may be lost, send ping */
544 };
545
546 /*
547  * The states that a call can be in.
548  */
549 enum rxrpc_call_state {
550         RXRPC_CALL_UNINITIALISED,
551         RXRPC_CALL_CLIENT_AWAIT_CONN,   /* - client waiting for connection to become available */
552         RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
553         RXRPC_CALL_CLIENT_AWAIT_REPLY,  /* - client awaiting reply */
554         RXRPC_CALL_CLIENT_RECV_REPLY,   /* - client receiving reply phase */
555         RXRPC_CALL_SERVER_PREALLOC,     /* - service preallocation */
556         RXRPC_CALL_SERVER_SECURING,     /* - server securing request connection */
557         RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
558         RXRPC_CALL_SERVER_ACK_REQUEST,  /* - server pending ACK of request */
559         RXRPC_CALL_SERVER_SEND_REPLY,   /* - server sending reply */
560         RXRPC_CALL_SERVER_AWAIT_ACK,    /* - server awaiting final ACK */
561         RXRPC_CALL_COMPLETE,            /* - call complete */
562         NR__RXRPC_CALL_STATES
563 };
564
565 /*
566  * Call completion condition (state == RXRPC_CALL_COMPLETE).
567  */
568 enum rxrpc_call_completion {
569         RXRPC_CALL_SUCCEEDED,           /* - Normal termination */
570         RXRPC_CALL_REMOTELY_ABORTED,    /* - call aborted by peer */
571         RXRPC_CALL_LOCALLY_ABORTED,     /* - call aborted locally on error or close */
572         RXRPC_CALL_LOCAL_ERROR,         /* - call failed due to local error */
573         RXRPC_CALL_NETWORK_ERROR,       /* - call terminated by network error */
574         NR__RXRPC_CALL_COMPLETIONS
575 };
576
577 /*
578  * Call Tx congestion management modes.
579  */
580 enum rxrpc_congest_mode {
581         RXRPC_CALL_SLOW_START,
582         RXRPC_CALL_CONGEST_AVOIDANCE,
583         RXRPC_CALL_PACKET_LOSS,
584         RXRPC_CALL_FAST_RETRANSMIT,
585         NR__RXRPC_CONGEST_MODES
586 };
587
588 /*
589  * RxRPC call definition
590  * - matched by { connection, call_id }
591  */
592 struct rxrpc_call {
593         struct rcu_head         rcu;
594         struct rxrpc_connection *conn;          /* connection carrying call */
595         struct rxrpc_peer       *peer;          /* Peer record for remote address */
596         struct rxrpc_local      *local;         /* Representation of local endpoint */
597         struct rxrpc_sock __rcu *socket;        /* socket responsible */
598         struct rxrpc_net        *rxnet;         /* Network namespace to which call belongs */
599         struct key              *key;           /* Security details */
600         const struct rxrpc_security *security;  /* applied security module */
601         struct mutex            user_mutex;     /* User access mutex */
602         struct sockaddr_rxrpc   dest_srx;       /* Destination address */
603         unsigned long           delay_ack_at;   /* When DELAY ACK needs to happen */
604         unsigned long           ack_lost_at;    /* When ACK is figured as lost */
605         unsigned long           resend_at;      /* When next resend needs to happen */
606         unsigned long           ping_at;        /* When next to send a ping */
607         unsigned long           keepalive_at;   /* When next to send a keepalive ping */
608         unsigned long           expect_rx_by;   /* When we expect to get a packet by */
609         unsigned long           expect_req_by;  /* When we expect to get a request DATA packet by */
610         unsigned long           expect_term_by; /* When we expect call termination by */
611         u32                     next_rx_timo;   /* Timeout for next Rx packet (jif) */
612         u32                     next_req_timo;  /* Timeout for next Rx request packet (jif) */
613         struct timer_list       timer;          /* Combined event timer */
614         struct work_struct      processor;      /* Event processor */
615         struct work_struct      destroyer;      /* In-process-context destroyer */
616         rxrpc_notify_rx_t       notify_rx;      /* kernel service Rx notification function */
617         struct list_head        link;           /* link in master call list */
618         struct list_head        chan_wait_link; /* Link in conn->bundle->waiting_calls */
619         struct hlist_node       error_link;     /* link in error distribution list */
620         struct list_head        accept_link;    /* Link in rx->acceptq */
621         struct list_head        recvmsg_link;   /* Link in rx->recvmsg_q */
622         struct list_head        sock_link;      /* Link in rx->sock_calls */
623         struct rb_node          sock_node;      /* Node in rx->calls */
624         struct list_head        attend_link;    /* Link in local->call_attend_q */
625         struct rxrpc_txbuf      *tx_pending;    /* Tx buffer being filled */
626         wait_queue_head_t       waitq;          /* Wait queue for channel or Tx */
627         s64                     tx_total_len;   /* Total length left to be transmitted (or -1) */
628         unsigned long           user_call_ID;   /* user-defined call ID */
629         unsigned long           flags;
630         unsigned long           events;
631         spinlock_t              notify_lock;    /* Kernel notification lock */
632         rwlock_t                state_lock;     /* lock for state transition */
633         u32                     abort_code;     /* Local/remote abort code */
634         int                     error;          /* Local error incurred */
635         enum rxrpc_call_state   state;          /* current state of call */
636         enum rxrpc_call_completion completion;  /* Call completion condition */
637         refcount_t              ref;
638         u8                      security_ix;    /* Security type */
639         enum rxrpc_interruptibility interruptibility; /* At what point call may be interrupted */
640         u32                     call_id;        /* call ID on connection  */
641         u32                     cid;            /* connection ID plus channel index */
642         u32                     security_level; /* Security level selected */
643         int                     debug_id;       /* debug ID for printks */
644         unsigned short          rx_pkt_offset;  /* Current recvmsg packet offset */
645         unsigned short          rx_pkt_len;     /* Current recvmsg packet len */
646
647         /* Transmitted data tracking. */
648         spinlock_t              tx_lock;        /* Transmit queue lock */
649         struct list_head        tx_sendmsg;     /* Sendmsg prepared packets */
650         struct list_head        tx_buffer;      /* Buffer of transmissible packets */
651         rxrpc_seq_t             tx_bottom;      /* First packet in buffer */
652         rxrpc_seq_t             tx_transmitted; /* Highest packet transmitted */
653         rxrpc_seq_t             tx_prepared;    /* Highest Tx slot prepared. */
654         rxrpc_seq_t             tx_top;         /* Highest Tx slot allocated. */
655         u16                     tx_backoff;     /* Delay to insert due to Tx failure */
656         u8                      tx_winsize;     /* Maximum size of Tx window */
657 #define RXRPC_TX_MAX_WINDOW     128
658         ktime_t                 tx_last_sent;   /* Last time a transmission occurred */
659
660         /* Received data tracking */
661         struct sk_buff_head     recvmsg_queue;  /* Queue of packets ready for recvmsg() */
662         struct sk_buff_head     rx_oos_queue;   /* Queue of out of sequence packets */
663
664         rxrpc_seq_t             rx_highest_seq; /* Higest sequence number received */
665         rxrpc_seq_t             rx_consumed;    /* Highest packet consumed */
666         rxrpc_serial_t          rx_serial;      /* Highest serial received for this call */
667         u8                      rx_winsize;     /* Size of Rx window */
668
669         /* TCP-style slow-start congestion control [RFC5681].  Since the SMSS
670          * is fixed, we keep these numbers in terms of segments (ie. DATA
671          * packets) rather than bytes.
672          */
673 #define RXRPC_TX_SMSS           RXRPC_JUMBO_DATALEN
674         u8                      cong_cwnd;      /* Congestion window size */
675         u8                      cong_extra;     /* Extra to send for congestion management */
676         u8                      cong_ssthresh;  /* Slow-start threshold */
677         enum rxrpc_congest_mode cong_mode:8;    /* Congestion management mode */
678         u8                      cong_dup_acks;  /* Count of ACKs showing missing packets */
679         u8                      cong_cumul_acks; /* Cumulative ACK count */
680         ktime_t                 cong_tstamp;    /* Last time cwnd was changed */
681
682         /* Receive-phase ACK management (ACKs we send). */
683         u8                      ackr_reason;    /* reason to ACK */
684         rxrpc_serial_t          ackr_serial;    /* serial of packet being ACK'd */
685         atomic64_t              ackr_window;    /* Base (in LSW) and top (in MSW) of SACK window */
686         atomic_t                ackr_nr_unacked; /* Number of unacked packets */
687         atomic_t                ackr_nr_consumed; /* Number of packets needing hard ACK */
688         struct {
689 #define RXRPC_SACK_SIZE 256
690                  /* SACK table for soft-acked packets */
691                 u8              ackr_sack_table[RXRPC_SACK_SIZE];
692         } __aligned(8);
693
694         /* RTT management */
695         rxrpc_serial_t          rtt_serial[4];  /* Serial number of DATA or PING sent */
696         ktime_t                 rtt_sent_at[4]; /* Time packet sent */
697         unsigned long           rtt_avail;      /* Mask of available slots in bits 0-3,
698                                                  * Mask of pending samples in 8-11 */
699 #define RXRPC_CALL_RTT_AVAIL_MASK       0xf
700 #define RXRPC_CALL_RTT_PEND_SHIFT       8
701
702         /* Transmission-phase ACK management (ACKs we've received). */
703         ktime_t                 acks_latest_ts; /* Timestamp of latest ACK received */
704         rxrpc_seq_t             acks_first_seq; /* first sequence number received */
705         rxrpc_seq_t             acks_prev_seq;  /* Highest previousPacket received */
706         rxrpc_seq_t             acks_hard_ack;  /* Latest hard-ack point */
707         rxrpc_seq_t             acks_lowest_nak; /* Lowest NACK in the buffer (or ==tx_hard_ack) */
708         rxrpc_seq_t             acks_lost_top;  /* tx_top at the time lost-ack ping sent */
709         rxrpc_serial_t          acks_lost_ping; /* Serial number of probe ACK */
710         rxrpc_serial_t          acks_highest_serial; /* Highest serial number ACK'd */
711         struct sk_buff          *acks_soft_tbl; /* The last ACK packet with NAKs in it */
712         spinlock_t              acks_ack_lock;  /* Access to ->acks_last_ack */
713 };
714
715 /*
716  * Summary of a new ACK and the changes it made to the Tx buffer packet states.
717  */
718 struct rxrpc_ack_summary {
719         u16                     nr_acks;                /* Number of ACKs in packet */
720         u16                     nr_new_acks;            /* Number of new ACKs in packet */
721         u16                     nr_rot_new_acks;        /* Number of rotated new ACKs */
722         u8                      ack_reason;
723         bool                    saw_nacks;              /* Saw NACKs in packet */
724         bool                    new_low_nack;           /* T if new low NACK found */
725         bool                    retrans_timeo;          /* T if reTx due to timeout happened */
726         u8                      flight_size;            /* Number of unreceived transmissions */
727         /* Place to stash values for tracing */
728         enum rxrpc_congest_mode mode:8;
729         u8                      cwnd;
730         u8                      ssthresh;
731         u8                      dup_acks;
732         u8                      cumulative_acks;
733 };
734
735 /*
736  * sendmsg() cmsg-specified parameters.
737  */
738 enum rxrpc_command {
739         RXRPC_CMD_SEND_DATA,            /* send data message */
740         RXRPC_CMD_SEND_ABORT,           /* request abort generation */
741         RXRPC_CMD_REJECT_BUSY,          /* [server] reject a call as busy */
742         RXRPC_CMD_CHARGE_ACCEPT,        /* [server] charge accept preallocation */
743 };
744
745 struct rxrpc_call_params {
746         s64                     tx_total_len;   /* Total Tx data length (if send data) */
747         unsigned long           user_call_ID;   /* User's call ID */
748         struct {
749                 u32             hard;           /* Maximum lifetime (sec) */
750                 u32             idle;           /* Max time since last data packet (msec) */
751                 u32             normal;         /* Max time since last call packet (msec) */
752         } timeouts;
753         u8                      nr_timeouts;    /* Number of timeouts specified */
754         bool                    kernel;         /* T if kernel is making the call */
755         enum rxrpc_interruptibility interruptibility; /* How is interruptible is the call? */
756 };
757
758 struct rxrpc_send_params {
759         struct rxrpc_call_params call;
760         u32                     abort_code;     /* Abort code to Tx (if abort) */
761         enum rxrpc_command      command : 8;    /* The command to implement */
762         bool                    exclusive;      /* Shared or exclusive call */
763         bool                    upgrade;        /* If the connection is upgradeable */
764 };
765
766 /*
767  * Buffer of data to be output as a packet.
768  */
769 struct rxrpc_txbuf {
770         struct rcu_head         rcu;
771         struct list_head        call_link;      /* Link in call->tx_sendmsg/tx_buffer */
772         struct list_head        tx_link;        /* Link in live Enc queue or Tx queue */
773         struct rxrpc_call       *call;          /* Call to which belongs */
774         ktime_t                 last_sent;      /* Time at which last transmitted */
775         refcount_t              ref;
776         rxrpc_seq_t             seq;            /* Sequence number of this packet */
777         unsigned int            call_debug_id;
778         unsigned int            debug_id;
779         unsigned int            len;            /* Amount of data in buffer */
780         unsigned int            space;          /* Remaining data space */
781         unsigned int            offset;         /* Offset of fill point */
782         unsigned long           flags;
783 #define RXRPC_TXBUF_LAST        0               /* Set if last packet in Tx phase */
784 #define RXRPC_TXBUF_RESENT      1               /* Set if has been resent */
785         u8 /*enum rxrpc_propose_ack_trace*/ ack_why;    /* If ack, why */
786         struct {
787                 /* The packet for encrypting and DMA'ing.  We align it such
788                  * that data[] aligns correctly for any crypto blocksize.
789                  */
790                 u8              pad[64 - sizeof(struct rxrpc_wire_header)];
791                 struct rxrpc_wire_header wire;  /* Network-ready header */
792                 union {
793                         u8      data[RXRPC_JUMBO_DATALEN]; /* Data packet */
794                         struct {
795                                 struct rxrpc_ackpacket ack;
796                                 u8 acks[0];
797                         };
798                 };
799         } __aligned(64);
800 };
801
802 static inline bool rxrpc_sending_to_server(const struct rxrpc_txbuf *txb)
803 {
804         return txb->wire.flags & RXRPC_CLIENT_INITIATED;
805 }
806
807 static inline bool rxrpc_sending_to_client(const struct rxrpc_txbuf *txb)
808 {
809         return !rxrpc_sending_to_server(txb);
810 }
811
812 #include <trace/events/rxrpc.h>
813
814 /*
815  * af_rxrpc.c
816  */
817 extern atomic_t rxrpc_n_rx_skbs;
818 extern struct workqueue_struct *rxrpc_workqueue;
819
820 /*
821  * call_accept.c
822  */
823 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
824 void rxrpc_discard_prealloc(struct rxrpc_sock *);
825 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
826                                            struct rxrpc_sock *,
827                                            struct sk_buff *);
828 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
829 int rxrpc_user_charge_accept(struct rxrpc_sock *, unsigned long);
830
831 /*
832  * call_event.c
833  */
834 void rxrpc_propose_ping(struct rxrpc_call *call, u32 serial,
835                         enum rxrpc_propose_ack_trace why);
836 void rxrpc_send_ACK(struct rxrpc_call *, u8, rxrpc_serial_t, enum rxrpc_propose_ack_trace);
837 void rxrpc_propose_delay_ACK(struct rxrpc_call *, rxrpc_serial_t,
838                              enum rxrpc_propose_ack_trace);
839 void rxrpc_shrink_call_tx_buffer(struct rxrpc_call *);
840 void rxrpc_process_call(struct work_struct *);
841
842 void rxrpc_reduce_call_timer(struct rxrpc_call *call,
843                              unsigned long expire_at,
844                              unsigned long now,
845                              enum rxrpc_timer_trace why);
846
847 /*
848  * call_object.c
849  */
850 extern const char *const rxrpc_call_states[];
851 extern const char *const rxrpc_call_completions[];
852 extern struct kmem_cache *rxrpc_call_jar;
853
854 void rxrpc_poke_call(struct rxrpc_call *call, enum rxrpc_call_poke_trace what);
855 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
856 struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *, gfp_t, unsigned int);
857 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
858                                          struct rxrpc_conn_parameters *,
859                                          struct sockaddr_rxrpc *,
860                                          struct rxrpc_call_params *, gfp_t,
861                                          unsigned int);
862 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
863                          struct sk_buff *);
864 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
865 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
866 void rxrpc_queue_call(struct rxrpc_call *, enum rxrpc_call_trace);
867 void rxrpc_see_call(struct rxrpc_call *, enum rxrpc_call_trace);
868 bool rxrpc_try_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
869 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
870 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
871 void rxrpc_cleanup_call(struct rxrpc_call *);
872 void rxrpc_destroy_all_calls(struct rxrpc_net *);
873
874 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
875 {
876         return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
877 }
878
879 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
880 {
881         return !rxrpc_is_service_call(call);
882 }
883
884 /*
885  * conn_client.c
886  */
887 extern unsigned int rxrpc_reap_client_connections;
888 extern unsigned long rxrpc_conn_idle_client_expiry;
889 extern unsigned long rxrpc_conn_idle_client_fast_expiry;
890 extern struct idr rxrpc_client_conn_ids;
891
892 void rxrpc_destroy_client_conn_ids(void);
893 struct rxrpc_bundle *rxrpc_get_bundle(struct rxrpc_bundle *, enum rxrpc_bundle_trace);
894 void rxrpc_put_bundle(struct rxrpc_bundle *, enum rxrpc_bundle_trace);
895 int rxrpc_connect_call(struct rxrpc_sock *, struct rxrpc_call *,
896                        struct rxrpc_conn_parameters *, struct sockaddr_rxrpc *,
897                        gfp_t);
898 void rxrpc_expose_client_call(struct rxrpc_call *);
899 void rxrpc_disconnect_client_call(struct rxrpc_bundle *, struct rxrpc_call *);
900 void rxrpc_put_client_conn(struct rxrpc_connection *, enum rxrpc_conn_trace);
901 void rxrpc_discard_expired_client_conns(struct work_struct *);
902 void rxrpc_destroy_all_client_connections(struct rxrpc_net *);
903 void rxrpc_clean_up_local_conns(struct rxrpc_local *);
904
905 /*
906  * conn_event.c
907  */
908 void rxrpc_process_connection(struct work_struct *);
909 void rxrpc_process_delayed_final_acks(struct rxrpc_connection *, bool);
910
911 /*
912  * conn_object.c
913  */
914 extern unsigned int rxrpc_connection_expiry;
915 extern unsigned int rxrpc_closed_conn_expiry;
916
917 struct rxrpc_connection *rxrpc_alloc_connection(struct rxrpc_net *, gfp_t);
918 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
919                                                    struct sk_buff *,
920                                                    struct rxrpc_peer **);
921 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
922 void rxrpc_disconnect_call(struct rxrpc_call *);
923 void rxrpc_kill_client_conn(struct rxrpc_connection *);
924 void rxrpc_queue_conn(struct rxrpc_connection *, enum rxrpc_conn_trace);
925 void rxrpc_see_connection(struct rxrpc_connection *, enum rxrpc_conn_trace);
926 struct rxrpc_connection *rxrpc_get_connection(struct rxrpc_connection *,
927                                               enum rxrpc_conn_trace);
928 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *,
929                                                     enum rxrpc_conn_trace);
930 void rxrpc_put_connection(struct rxrpc_connection *, enum rxrpc_conn_trace);
931 void rxrpc_service_connection_reaper(struct work_struct *);
932 void rxrpc_destroy_all_connections(struct rxrpc_net *);
933
934 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
935 {
936         return conn->out_clientflag;
937 }
938
939 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
940 {
941         return !rxrpc_conn_is_client(conn);
942 }
943
944 static inline void rxrpc_reduce_conn_timer(struct rxrpc_connection *conn,
945                                            unsigned long expire_at)
946 {
947         timer_reduce(&conn->timer, expire_at);
948 }
949
950 /*
951  * conn_service.c
952  */
953 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
954                                                      struct sk_buff *);
955 struct rxrpc_connection *rxrpc_prealloc_service_connection(struct rxrpc_net *, gfp_t);
956 void rxrpc_new_incoming_connection(struct rxrpc_sock *, struct rxrpc_connection *,
957                                    const struct rxrpc_security *, struct sk_buff *);
958 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
959
960 /*
961  * input.c
962  */
963 void rxrpc_input_call_event(struct rxrpc_call *, struct sk_buff *);
964 void rxrpc_input_implicit_end_call(struct rxrpc_sock *, struct rxrpc_connection *,
965                                    struct rxrpc_call *);
966
967 /*
968  * io_thread.c
969  */
970 int rxrpc_encap_rcv(struct sock *, struct sk_buff *);
971 void rxrpc_error_report(struct sock *);
972 int rxrpc_io_thread(void *data);
973 static inline void rxrpc_wake_up_io_thread(struct rxrpc_local *local)
974 {
975         wake_up_process(local->io_thread);
976 }
977
978 /*
979  * insecure.c
980  */
981 extern const struct rxrpc_security rxrpc_no_security;
982
983 /*
984  * key.c
985  */
986 extern struct key_type key_type_rxrpc;
987
988 int rxrpc_request_key(struct rxrpc_sock *, sockptr_t , int);
989 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time64_t,
990                               u32);
991
992 /*
993  * local_event.c
994  */
995 extern void rxrpc_process_local_events(struct rxrpc_local *);
996
997 /*
998  * local_object.c
999  */
1000 struct rxrpc_local *rxrpc_lookup_local(struct net *, const struct sockaddr_rxrpc *);
1001 struct rxrpc_local *rxrpc_get_local(struct rxrpc_local *, enum rxrpc_local_trace);
1002 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *, enum rxrpc_local_trace);
1003 void rxrpc_put_local(struct rxrpc_local *, enum rxrpc_local_trace);
1004 struct rxrpc_local *rxrpc_use_local(struct rxrpc_local *, enum rxrpc_local_trace);
1005 void rxrpc_unuse_local(struct rxrpc_local *, enum rxrpc_local_trace);
1006 void rxrpc_queue_local(struct rxrpc_local *);
1007 void rxrpc_destroy_local(struct rxrpc_local *local);
1008 void rxrpc_destroy_all_locals(struct rxrpc_net *);
1009
1010 static inline bool __rxrpc_unuse_local(struct rxrpc_local *local,
1011                                        enum rxrpc_local_trace why)
1012 {
1013         unsigned int debug_id = local->debug_id;
1014         int r, u;
1015
1016         r = refcount_read(&local->ref);
1017         u = atomic_dec_return(&local->active_users);
1018         trace_rxrpc_local(debug_id, why, r, u);
1019         return u == 0;
1020 }
1021
1022 static inline bool __rxrpc_use_local(struct rxrpc_local *local,
1023                                      enum rxrpc_local_trace why)
1024 {
1025         int r, u;
1026
1027         r = refcount_read(&local->ref);
1028         u = atomic_fetch_add_unless(&local->active_users, 1, 0);
1029         trace_rxrpc_local(local->debug_id, why, r, u);
1030         return u != 0;
1031 }
1032
1033 static inline void rxrpc_see_local(struct rxrpc_local *local,
1034                                    enum rxrpc_local_trace why)
1035 {
1036         int r, u;
1037
1038         r = refcount_read(&local->ref);
1039         u = atomic_read(&local->active_users);
1040         trace_rxrpc_local(local->debug_id, why, r, u);
1041 }
1042
1043 /*
1044  * misc.c
1045  */
1046 extern unsigned int rxrpc_max_backlog __read_mostly;
1047 extern unsigned long rxrpc_soft_ack_delay;
1048 extern unsigned long rxrpc_idle_ack_delay;
1049 extern unsigned int rxrpc_rx_window_size;
1050 extern unsigned int rxrpc_rx_mtu;
1051 extern unsigned int rxrpc_rx_jumbo_max;
1052
1053 /*
1054  * net_ns.c
1055  */
1056 extern unsigned int rxrpc_net_id;
1057 extern struct pernet_operations rxrpc_net_ops;
1058
1059 static inline struct rxrpc_net *rxrpc_net(struct net *net)
1060 {
1061         return net_generic(net, rxrpc_net_id);
1062 }
1063
1064 /*
1065  * output.c
1066  */
1067 void rxrpc_transmit_ack_packets(struct rxrpc_local *);
1068 int rxrpc_send_abort_packet(struct rxrpc_call *);
1069 int rxrpc_send_data_packet(struct rxrpc_call *, struct rxrpc_txbuf *);
1070 void rxrpc_reject_packets(struct rxrpc_local *);
1071 void rxrpc_send_keepalive(struct rxrpc_peer *);
1072 void rxrpc_transmit_one(struct rxrpc_call *call, struct rxrpc_txbuf *txb);
1073
1074 /*
1075  * peer_event.c
1076  */
1077 void rxrpc_input_error(struct rxrpc_local *, struct sk_buff *);
1078 void rxrpc_peer_keepalive_worker(struct work_struct *);
1079
1080 /*
1081  * peer_object.c
1082  */
1083 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
1084                                          const struct sockaddr_rxrpc *);
1085 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_sock *, struct rxrpc_local *,
1086                                      struct sockaddr_rxrpc *, gfp_t);
1087 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t,
1088                                     enum rxrpc_peer_trace);
1089 void rxrpc_new_incoming_peer(struct rxrpc_sock *, struct rxrpc_local *,
1090                              struct rxrpc_peer *);
1091 void rxrpc_destroy_all_peers(struct rxrpc_net *);
1092 struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *, enum rxrpc_peer_trace);
1093 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *, enum rxrpc_peer_trace);
1094 void rxrpc_put_peer(struct rxrpc_peer *, enum rxrpc_peer_trace);
1095 void rxrpc_put_peer_locked(struct rxrpc_peer *, enum rxrpc_peer_trace);
1096
1097 /*
1098  * proc.c
1099  */
1100 extern const struct seq_operations rxrpc_call_seq_ops;
1101 extern const struct seq_operations rxrpc_connection_seq_ops;
1102 extern const struct seq_operations rxrpc_peer_seq_ops;
1103 extern const struct seq_operations rxrpc_local_seq_ops;
1104
1105 /*
1106  * recvmsg.c
1107  */
1108 void rxrpc_notify_socket(struct rxrpc_call *);
1109 bool __rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1110 bool rxrpc_set_call_completion(struct rxrpc_call *, enum rxrpc_call_completion, u32, int);
1111 bool __rxrpc_call_completed(struct rxrpc_call *);
1112 bool rxrpc_call_completed(struct rxrpc_call *);
1113 bool __rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1114 bool rxrpc_abort_call(const char *, struct rxrpc_call *, rxrpc_seq_t, u32, int);
1115 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
1116
1117 /*
1118  * Abort a call due to a protocol error.
1119  */
1120 static inline bool __rxrpc_abort_eproto(struct rxrpc_call *call,
1121                                         struct sk_buff *skb,
1122                                         const char *eproto_why,
1123                                         const char *why,
1124                                         u32 abort_code)
1125 {
1126         struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
1127
1128         trace_rxrpc_rx_eproto(call, sp->hdr.serial, eproto_why);
1129         return rxrpc_abort_call(why, call, sp->hdr.seq, abort_code, -EPROTO);
1130 }
1131
1132 #define rxrpc_abort_eproto(call, skb, eproto_why, abort_why, abort_code) \
1133         __rxrpc_abort_eproto((call), (skb), tracepoint_string(eproto_why), \
1134                              (abort_why), (abort_code))
1135
1136 /*
1137  * rtt.c
1138  */
1139 void rxrpc_peer_add_rtt(struct rxrpc_call *, enum rxrpc_rtt_rx_trace, int,
1140                         rxrpc_serial_t, rxrpc_serial_t, ktime_t, ktime_t);
1141 unsigned long rxrpc_get_rto_backoff(struct rxrpc_peer *, bool);
1142 void rxrpc_peer_init_rtt(struct rxrpc_peer *);
1143
1144 /*
1145  * rxkad.c
1146  */
1147 #ifdef CONFIG_RXKAD
1148 extern const struct rxrpc_security rxkad;
1149 #endif
1150
1151 /*
1152  * security.c
1153  */
1154 int __init rxrpc_init_security(void);
1155 const struct rxrpc_security *rxrpc_security_lookup(u8);
1156 void rxrpc_exit_security(void);
1157 int rxrpc_init_client_call_security(struct rxrpc_call *);
1158 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
1159 const struct rxrpc_security *rxrpc_get_incoming_security(struct rxrpc_sock *,
1160                                                          struct sk_buff *);
1161 struct key *rxrpc_look_up_server_security(struct rxrpc_connection *,
1162                                           struct sk_buff *, u32, u32);
1163
1164 /*
1165  * sendmsg.c
1166  */
1167 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
1168
1169 /*
1170  * server_key.c
1171  */
1172 extern struct key_type key_type_rxrpc_s;
1173
1174 int rxrpc_server_keyring(struct rxrpc_sock *, sockptr_t, int);
1175
1176 /*
1177  * skbuff.c
1178  */
1179 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
1180 void rxrpc_packet_destructor(struct sk_buff *);
1181 void rxrpc_new_skb(struct sk_buff *, enum rxrpc_skb_trace);
1182 void rxrpc_see_skb(struct sk_buff *, enum rxrpc_skb_trace);
1183 void rxrpc_eaten_skb(struct sk_buff *, enum rxrpc_skb_trace);
1184 void rxrpc_get_skb(struct sk_buff *, enum rxrpc_skb_trace);
1185 void rxrpc_free_skb(struct sk_buff *, enum rxrpc_skb_trace);
1186 void rxrpc_purge_queue(struct sk_buff_head *);
1187
1188 /*
1189  * stats.c
1190  */
1191 int rxrpc_stats_show(struct seq_file *seq, void *v);
1192 int rxrpc_stats_clear(struct file *file, char *buf, size_t size);
1193
1194 #define rxrpc_inc_stat(rxnet, s) atomic_inc(&(rxnet)->s)
1195 #define rxrpc_dec_stat(rxnet, s) atomic_dec(&(rxnet)->s)
1196
1197 /*
1198  * sysctl.c
1199  */
1200 #ifdef CONFIG_SYSCTL
1201 extern int __init rxrpc_sysctl_init(void);
1202 extern void rxrpc_sysctl_exit(void);
1203 #else
1204 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1205 static inline void rxrpc_sysctl_exit(void) {}
1206 #endif
1207
1208 /*
1209  * txbuf.c
1210  */
1211 extern atomic_t rxrpc_nr_txbuf;
1212 struct rxrpc_txbuf *rxrpc_alloc_txbuf(struct rxrpc_call *call, u8 packet_type,
1213                                       gfp_t gfp);
1214 void rxrpc_get_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1215 void rxrpc_see_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1216 void rxrpc_put_txbuf(struct rxrpc_txbuf *txb, enum rxrpc_txbuf_trace what);
1217
1218 /*
1219  * utils.c
1220  */
1221 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1222
1223 static inline bool before(u32 seq1, u32 seq2)
1224 {
1225         return (s32)(seq1 - seq2) < 0;
1226 }
1227 static inline bool before_eq(u32 seq1, u32 seq2)
1228 {
1229         return (s32)(seq1 - seq2) <= 0;
1230 }
1231 static inline bool after(u32 seq1, u32 seq2)
1232 {
1233         return (s32)(seq1 - seq2) > 0;
1234 }
1235 static inline bool after_eq(u32 seq1, u32 seq2)
1236 {
1237         return (s32)(seq1 - seq2) >= 0;
1238 }
1239
1240 /*
1241  * debug tracing
1242  */
1243 extern unsigned int rxrpc_debug;
1244
1245 #define dbgprintk(FMT,...) \
1246         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1247
1248 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1249 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1250 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1251
1252
1253 #if defined(__KDEBUG)
1254 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1255 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1256 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1257
1258 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1259 #define RXRPC_DEBUG_KENTER      0x01
1260 #define RXRPC_DEBUG_KLEAVE      0x02
1261 #define RXRPC_DEBUG_KDEBUG      0x04
1262
1263 #define _enter(FMT,...)                                 \
1264 do {                                                    \
1265         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1266                 kenter(FMT,##__VA_ARGS__);              \
1267 } while (0)
1268
1269 #define _leave(FMT,...)                                 \
1270 do {                                                    \
1271         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1272                 kleave(FMT,##__VA_ARGS__);              \
1273 } while (0)
1274
1275 #define _debug(FMT,...)                                 \
1276 do {                                                    \
1277         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1278                 kdebug(FMT,##__VA_ARGS__);              \
1279 } while (0)
1280
1281 #else
1282 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1283 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1284 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1285 #endif
1286
1287 /*
1288  * debug assertion checking
1289  */
1290 #if 1 // defined(__KDEBUGALL)
1291
1292 #define ASSERT(X)                                               \
1293 do {                                                            \
1294         if (unlikely(!(X))) {                                   \
1295                 pr_err("Assertion failed\n");                   \
1296                 BUG();                                          \
1297         }                                                       \
1298 } while (0)
1299
1300 #define ASSERTCMP(X, OP, Y)                                             \
1301 do {                                                                    \
1302         __typeof__(X) _x = (X);                                         \
1303         __typeof__(Y) _y = (__typeof__(X))(Y);                          \
1304         if (unlikely(!(_x OP _y))) {                                    \
1305                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1306                        (unsigned long)_x, (unsigned long)_x, #OP,       \
1307                        (unsigned long)_y, (unsigned long)_y);           \
1308                 BUG();                                                  \
1309         }                                                               \
1310 } while (0)
1311
1312 #define ASSERTIF(C, X)                                          \
1313 do {                                                            \
1314         if (unlikely((C) && !(X))) {                            \
1315                 pr_err("Assertion failed\n");                   \
1316                 BUG();                                          \
1317         }                                                       \
1318 } while (0)
1319
1320 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1321 do {                                                                    \
1322         __typeof__(X) _x = (X);                                         \
1323         __typeof__(Y) _y = (__typeof__(X))(Y);                          \
1324         if (unlikely((C) && !(_x OP _y))) {                             \
1325                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1326                        (unsigned long)_x, (unsigned long)_x, #OP,       \
1327                        (unsigned long)_y, (unsigned long)_y);           \
1328                 BUG();                                                  \
1329         }                                                               \
1330 } while (0)
1331
1332 #else
1333
1334 #define ASSERT(X)                               \
1335 do {                                            \
1336 } while (0)
1337
1338 #define ASSERTCMP(X, OP, Y)                     \
1339 do {                                            \
1340 } while (0)
1341
1342 #define ASSERTIF(C, X)                          \
1343 do {                                            \
1344 } while (0)
1345
1346 #define ASSERTIFCMP(C, X, OP, Y)                \
1347 do {                                            \
1348 } while (0)
1349
1350 #endif /* __KDEBUGALL */