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