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