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