net/rxrpc/ar-internal.h

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