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