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