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