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/sock.h>
  15 #include <net/af_rxrpc.h>
  16 #include <rxrpc/packet.h>
  17
  18 #if 0
  19 #define CHECK_SLAB_OKAY(X)                                   \
  20         BUG_ON(atomic_read((X)) >> (sizeof(atomic_t) - 2) == \
  21                (POISON_FREE << 8 | POISON_FREE))
  22 #else
  23 #define CHECK_SLAB_OKAY(X) do {} while (0)
  24 #endif
  25
  26 #define FCRYPT_BSIZE 8
  27 struct rxrpc_crypt {
  28         union {
  29                 u8      x[FCRYPT_BSIZE];
  30                 __be32  n[2];
  31         };
  32 } __attribute__((aligned(8)));
  33
  34 #define rxrpc_queue_work(WS)    queue_work(rxrpc_workqueue, (WS))
  35 #define rxrpc_queue_delayed_work(WS,D)  \
  36         queue_delayed_work(rxrpc_workqueue, (WS), (D))
  37
  38 struct rxrpc_connection;
  39
  40 /*
  41  * Mark applied to socket buffers.
  42  */
  43 enum rxrpc_skb_mark {
  44         RXRPC_SKB_MARK_DATA,            /* data message */
  45         RXRPC_SKB_MARK_FINAL_ACK,       /* final ACK received message */
  46         RXRPC_SKB_MARK_BUSY,            /* server busy message */
  47         RXRPC_SKB_MARK_REMOTE_ABORT,    /* remote abort message */
  48         RXRPC_SKB_MARK_LOCAL_ABORT,     /* local abort message */
  49         RXRPC_SKB_MARK_NET_ERROR,       /* network error message */
  50         RXRPC_SKB_MARK_LOCAL_ERROR,     /* local error message */
  51         RXRPC_SKB_MARK_NEW_CALL,        /* local error message */
  52 };
  53
  54 /*
  55  * sk_state for RxRPC sockets
  56  */
  57 enum {
  58         RXRPC_UNBOUND = 0,
  59         RXRPC_CLIENT_UNBOUND,           /* Unbound socket used as client */
  60         RXRPC_CLIENT_BOUND,             /* client local address bound */
  61         RXRPC_SERVER_BOUND,             /* server local address bound */
  62         RXRPC_SERVER_LISTENING,         /* server listening for connections */
  63         RXRPC_CLOSE,                    /* socket is being closed */
  64 };
  65
  66 /*
  67  * RxRPC socket definition
  68  */
  69 struct rxrpc_sock {
  70         /* WARNING: sk has to be the first member */
  71         struct sock             sk;
  72         rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
  73         struct rxrpc_local      *local;         /* local endpoint */
  74         struct list_head        listen_link;    /* link in the local endpoint's listen list */
  75         struct list_head        secureq;        /* calls awaiting connection security clearance */
  76         struct list_head        acceptq;        /* calls awaiting acceptance */
  77         struct key              *key;           /* security for this socket */
  78         struct key              *securities;    /* list of server security descriptors */
  79         struct rb_root          calls;          /* outstanding calls on this socket */
  80         unsigned long           flags;
  81 #define RXRPC_SOCK_CONNECTED            0       /* connect_srx is set */
  82         rwlock_t                call_lock;      /* lock for calls */
  83         u32                     min_sec_level;  /* minimum security level */
  84 #define RXRPC_SECURITY_MAX      RXRPC_SECURITY_ENCRYPT
  85         bool                    exclusive;      /* Exclusive connection for a client socket */
  86         sa_family_t             family;         /* Protocol family created with */
  87         struct sockaddr_rxrpc   srx;            /* local address */
  88         struct sockaddr_rxrpc   connect_srx;    /* Default client address from connect() */
  89 };
  90
  91 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
  92
  93 /*
  94  * CPU-byteorder normalised Rx packet header.
  95  */
  96 struct rxrpc_host_header {
  97         u32             epoch;          /* client boot timestamp */
  98         u32             cid;            /* connection and channel ID */
  99         u32             callNumber;     /* call ID (0 for connection-level packets) */
 100         u32             seq;            /* sequence number of pkt in call stream */
 101         u32             serial;         /* serial number of pkt sent to network */
 102         u8              type;           /* packet type */
 103         u8              flags;          /* packet flags */
 104         u8              userStatus;     /* app-layer defined status */
 105         u8              securityIndex;  /* security protocol ID */
 106         union {
 107                 u16     _rsvd;          /* reserved */
 108                 u16     cksum;          /* kerberos security checksum */
 109         };
 110         u16             serviceId;      /* service ID */
 111 } __packed;
 112
 113 /*
 114  * RxRPC socket buffer private variables
 115  * - max 48 bytes (struct sk_buff::cb)
 116  */
 117 struct rxrpc_skb_priv {
 118         struct rxrpc_call       *call;          /* call with which associated */
 119         unsigned long           resend_at;      /* time in jiffies at which to resend */
 120         union {
 121                 unsigned int    offset;         /* offset into buffer of next read */
 122                 int             remain;         /* amount of space remaining for next write */
 123                 u32             error;          /* network error code */
 124                 bool            need_resend;    /* T if needs resending */
 125         };
 126
 127         struct rxrpc_host_header hdr;           /* RxRPC packet header from this packet */
 128 };
 129
 130 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
 131
 132 /*
 133  * RxRPC security module interface
 134  */
 135 struct rxrpc_security {
 136         const char              *name;          /* name of this service */
 137         u8                      security_index; /* security type provided */
 138
 139         /* Initialise a security service */
 140         int (*init)(void);
 141
 142         /* Clean up a security service */
 143         void (*exit)(void);
 144
 145         /* initialise a connection's security */
 146         int (*init_connection_security)(struct rxrpc_connection *);
 147
 148         /* prime a connection's packet security */
 149         int (*prime_packet_security)(struct rxrpc_connection *);
 150
 151         /* impose security on a packet */
 152         int (*secure_packet)(struct rxrpc_call *,
 153                              struct sk_buff *,
 154                              size_t,
 155                              void *);
 156
 157         /* verify the security on a received packet */
 158         int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
 159                              rxrpc_seq_t, u16);
 160
 161         /* issue a challenge */
 162         int (*issue_challenge)(struct rxrpc_connection *);
 163
 164         /* respond to a challenge */
 165         int (*respond_to_challenge)(struct rxrpc_connection *,
 166                                     struct sk_buff *,
 167                                     u32 *);
 168
 169         /* verify a response */
 170         int (*verify_response)(struct rxrpc_connection *,
 171                                struct sk_buff *,
 172                                u32 *);
 173
 174         /* clear connection security */
 175         void (*clear)(struct rxrpc_connection *);
 176 };
 177
 178 /*
 179  * RxRPC local transport endpoint description
 180  * - owned by a single AF_RXRPC socket
 181  * - pointed to by transport socket struct sk_user_data
 182  */
 183 struct rxrpc_local {
 184         struct rcu_head         rcu;
 185         atomic_t                usage;
 186         struct list_head        link;
 187         struct socket           *socket;        /* my UDP socket */
 188         struct work_struct      processor;
 189         struct list_head        services;       /* services listening on this endpoint */
 190         struct rw_semaphore     defrag_sem;     /* control re-enablement of IP DF bit */
 191         struct sk_buff_head     accept_queue;   /* incoming calls awaiting acceptance */
 192         struct sk_buff_head     reject_queue;   /* packets awaiting rejection */
 193         struct sk_buff_head     event_queue;    /* endpoint event packets awaiting processing */
 194         struct rb_root          client_conns;   /* Client connections by socket params */
 195         spinlock_t              client_conns_lock; /* Lock for client_conns */
 196         spinlock_t              lock;           /* access lock */
 197         rwlock_t                services_lock;  /* lock for services list */
 198         int                     debug_id;       /* debug ID for printks */
 199         bool                    dead;
 200         struct sockaddr_rxrpc   srx;            /* local address */
 201 };
 202
 203 /*
 204  * RxRPC remote transport endpoint definition
 205  * - matched by local endpoint, remote port, address and protocol type
 206  */
 207 struct rxrpc_peer {
 208         struct rcu_head         rcu;            /* This must be first */
 209         atomic_t                usage;
 210         unsigned long           hash_key;
 211         struct hlist_node       hash_link;
 212         struct rxrpc_local      *local;
 213         struct hlist_head       error_targets;  /* targets for net error distribution */
 214         struct work_struct      error_distributor;
 215         struct rb_root          service_conns;  /* Service connections */
 216         seqlock_t               service_conn_lock;
 217         spinlock_t              lock;           /* access lock */
 218         unsigned int            if_mtu;         /* interface MTU for this peer */
 219         unsigned int            mtu;            /* network MTU for this peer */
 220         unsigned int            maxdata;        /* data size (MTU - hdrsize) */
 221         unsigned short          hdrsize;        /* header size (IP + UDP + RxRPC) */
 222         int                     debug_id;       /* debug ID for printks */
 223         int                     error_report;   /* Net (+0) or local (+1000000) to distribute */
 224 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
 225         struct sockaddr_rxrpc   srx;            /* remote address */
 226
 227         /* calculated RTT cache */
 228 #define RXRPC_RTT_CACHE_SIZE 32
 229         suseconds_t             rtt;            /* current RTT estimate (in uS) */
 230         unsigned int            rtt_point;      /* next entry at which to insert */
 231         unsigned int            rtt_usage;      /* amount of cache actually used */
 232         suseconds_t             rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* calculated RTT cache */
 233 };
 234
 235 /*
 236  * Keys for matching a connection.
 237  */
 238 struct rxrpc_conn_proto {
 239         union {
 240                 struct {
 241                         u32     epoch;          /* epoch of this connection */
 242                         u32     cid;            /* connection ID */
 243                 };
 244                 u64             index_key;
 245         };
 246 };
 247
 248 struct rxrpc_conn_parameters {
 249         struct rxrpc_local      *local;         /* Representation of local endpoint */
 250         struct rxrpc_peer       *peer;          /* Remote endpoint */
 251         struct key              *key;           /* Security details */
 252         bool                    exclusive;      /* T if conn is exclusive */
 253         u16                     service_id;     /* Service ID for this connection */
 254         u32                     security_level; /* Security level selected */
 255 };
 256
 257 /*
 258  * Bits in the connection flags.
 259  */
 260 enum rxrpc_conn_flag {
 261         RXRPC_CONN_HAS_IDR,             /* Has a client conn ID assigned */
 262         RXRPC_CONN_IN_SERVICE_CONNS,    /* Conn is in peer->service_conns */
 263         RXRPC_CONN_IN_CLIENT_CONNS,     /* Conn is in local->client_conns */
 264         RXRPC_CONN_EXPOSED,             /* Conn has extra ref for exposure */
 265         RXRPC_CONN_DONT_REUSE,          /* Don't reuse this connection */
 266         RXRPC_CONN_COUNTED,             /* Counted by rxrpc_nr_client_conns */
 267 };
 268
 269 /*
 270  * Events that can be raised upon a connection.
 271  */
 272 enum rxrpc_conn_event {
 273         RXRPC_CONN_EV_CHALLENGE,        /* Send challenge packet */
 274 };
 275
 276 /*
 277  * The connection cache state.
 278  */
 279 enum rxrpc_conn_cache_state {
 280         RXRPC_CONN_CLIENT_INACTIVE,     /* Conn is not yet listed */
 281         RXRPC_CONN_CLIENT_WAITING,      /* Conn is on wait list, waiting for capacity */
 282         RXRPC_CONN_CLIENT_ACTIVE,       /* Conn is on active list, doing calls */
 283         RXRPC_CONN_CLIENT_CULLED,       /* Conn is culled and delisted, doing calls */
 284         RXRPC_CONN_CLIENT_IDLE,         /* Conn is on idle list, doing mostly nothing */
 285 };
 286
 287 /*
 288  * The connection protocol state.
 289  */
 290 enum rxrpc_conn_proto_state {
 291         RXRPC_CONN_UNUSED,              /* Connection not yet attempted */
 292         RXRPC_CONN_CLIENT,              /* Client connection */
 293         RXRPC_CONN_SERVICE_UNSECURED,   /* Service unsecured connection */
 294         RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
 295         RXRPC_CONN_SERVICE,             /* Service secured connection */
 296         RXRPC_CONN_REMOTELY_ABORTED,    /* Conn aborted by peer */
 297         RXRPC_CONN_LOCALLY_ABORTED,     /* Conn aborted locally */
 298         RXRPC_CONN__NR_STATES
 299 };
 300
 301 /*
 302  * RxRPC connection definition
 303  * - matched by { local, peer, epoch, conn_id, direction }
 304  * - each connection can only handle four simultaneous calls
 305  */
 306 struct rxrpc_connection {
 307         struct rxrpc_conn_proto proto;
 308         struct rxrpc_conn_parameters params;
 309
 310         atomic_t                usage;
 311         struct rcu_head         rcu;
 312         struct list_head        cache_link;
 313
 314         spinlock_t              channel_lock;
 315         unsigned char           active_chans;   /* Mask of active channels */
 316 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
 317         struct list_head        waiting_calls;  /* Calls waiting for channels */
 318         struct rxrpc_channel {
 319                 struct rxrpc_call __rcu *call;          /* Active call */
 320                 u32                     call_id;        /* ID of current call */
 321                 u32                     call_counter;   /* Call ID counter */
 322                 u32                     last_call;      /* ID of last call */
 323                 u8                      last_type;      /* Type of last packet */
 324                 u16                     last_service_id;
 325                 union {
 326                         u32             last_seq;
 327                         u32             last_abort;
 328                 };
 329         } channels[RXRPC_MAXCALLS];
 330
 331         struct work_struct      processor;      /* connection event processor */
 332         union {
 333                 struct rb_node  client_node;    /* Node in local->client_conns */
 334                 struct rb_node  service_node;   /* Node in peer->service_conns */
 335         };
 336         struct list_head        proc_link;      /* link in procfs list */
 337         struct list_head        link;           /* link in master connection list */
 338         struct sk_buff_head     rx_queue;       /* received conn-level packets */
 339         const struct rxrpc_security *security;  /* applied security module */
 340         struct key              *server_key;    /* security for this service */
 341         struct crypto_skcipher  *cipher;        /* encryption handle */
 342         struct rxrpc_crypt      csum_iv;        /* packet checksum base */
 343         unsigned long           flags;
 344         unsigned long           events;
 345         unsigned long           idle_timestamp; /* Time at which last became idle */
 346         spinlock_t              state_lock;     /* state-change lock */
 347         enum rxrpc_conn_cache_state cache_state : 8;
 348         enum rxrpc_conn_proto_state state : 8;  /* current state of connection */
 349         u32                     local_abort;    /* local abort code */
 350         u32                     remote_abort;   /* remote abort code */
 351         int                     debug_id;       /* debug ID for printks */
 352         atomic_t                serial;         /* packet serial number counter */
 353         unsigned int            hi_serial;      /* highest serial number received */
 354         u8                      size_align;     /* data size alignment (for security) */
 355         u8                      header_size;    /* rxrpc + security header size */
 356         u8                      security_size;  /* security header size */
 357         u32                     security_nonce; /* response re-use preventer */
 358         u8                      security_ix;    /* security type */
 359         u8                      out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
 360 };
 361
 362 /*
 363  * Flags in call->flags.
 364  */
 365 enum rxrpc_call_flag {
 366         RXRPC_CALL_RELEASED,            /* call has been released - no more message to userspace */
 367         RXRPC_CALL_TERMINAL_MSG,        /* call has given the socket its final message */
 368         RXRPC_CALL_RCVD_LAST,           /* all packets received */
 369         RXRPC_CALL_RUN_RTIMER,          /* Tx resend timer started */
 370         RXRPC_CALL_TX_SOFT_ACK,         /* sent some soft ACKs */
 371         RXRPC_CALL_INIT_ACCEPT,         /* acceptance was initiated */
 372         RXRPC_CALL_HAS_USERID,          /* has a user ID attached */
 373         RXRPC_CALL_EXPECT_OOS,          /* expect out of sequence packets */
 374         RXRPC_CALL_IS_SERVICE,          /* Call is service call */
 375         RXRPC_CALL_EXPOSED,             /* The call was exposed to the world */
 376         RXRPC_CALL_RX_NO_MORE,          /* Don't indicate MSG_MORE from recvmsg() */
 377 };
 378
 379 /*
 380  * Events that can be raised on a call.
 381  */
 382 enum rxrpc_call_event {
 383         RXRPC_CALL_EV_RCVD_ACKALL,      /* ACKALL or reply received */
 384         RXRPC_CALL_EV_RCVD_BUSY,        /* busy packet received */
 385         RXRPC_CALL_EV_RCVD_ABORT,       /* abort packet received */
 386         RXRPC_CALL_EV_RCVD_ERROR,       /* network error received */
 387         RXRPC_CALL_EV_ACK_FINAL,        /* need to generate final ACK (and release call) */
 388         RXRPC_CALL_EV_ACK,              /* need to generate ACK */
 389         RXRPC_CALL_EV_REJECT_BUSY,      /* need to generate busy message */
 390         RXRPC_CALL_EV_ABORT,            /* need to generate abort */
 391         RXRPC_CALL_EV_CONN_ABORT,       /* local connection abort generated */
 392         RXRPC_CALL_EV_RESEND_TIMER,     /* Tx resend timer expired */
 393         RXRPC_CALL_EV_RESEND,           /* Tx resend required */
 394         RXRPC_CALL_EV_DRAIN_RX_OOS,     /* drain the Rx out of sequence queue */
 395         RXRPC_CALL_EV_LIFE_TIMER,       /* call's lifetimer ran out */
 396         RXRPC_CALL_EV_ACCEPTED,         /* incoming call accepted by userspace app */
 397         RXRPC_CALL_EV_SECURED,          /* incoming call's connection is now secure */
 398         RXRPC_CALL_EV_POST_ACCEPT,      /* need to post an "accept?" message to the app */
 399 };
 400
 401 /*
 402  * The states that a call can be in.
 403  */
 404 enum rxrpc_call_state {
 405         RXRPC_CALL_UNINITIALISED,
 406         RXRPC_CALL_CLIENT_AWAIT_CONN,   /* - client waiting for connection to become available */
 407         RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
 408         RXRPC_CALL_CLIENT_AWAIT_REPLY,  /* - client awaiting reply */
 409         RXRPC_CALL_CLIENT_RECV_REPLY,   /* - client receiving reply phase */
 410         RXRPC_CALL_CLIENT_FINAL_ACK,    /* - client sending final ACK phase */
 411         RXRPC_CALL_SERVER_SECURING,     /* - server securing request connection */
 412         RXRPC_CALL_SERVER_ACCEPTING,    /* - server accepting request */
 413         RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
 414         RXRPC_CALL_SERVER_ACK_REQUEST,  /* - server pending ACK of request */
 415         RXRPC_CALL_SERVER_SEND_REPLY,   /* - server sending reply */
 416         RXRPC_CALL_SERVER_AWAIT_ACK,    /* - server awaiting final ACK */
 417         RXRPC_CALL_COMPLETE,            /* - call complete */
 418         NR__RXRPC_CALL_STATES
 419 };
 420
 421 /*
 422  * Call completion condition (state == RXRPC_CALL_COMPLETE).
 423  */
 424 enum rxrpc_call_completion {
 425         RXRPC_CALL_SUCCEEDED,           /* - Normal termination */
 426         RXRPC_CALL_SERVER_BUSY,         /* - call rejected by busy server */
 427         RXRPC_CALL_REMOTELY_ABORTED,    /* - call aborted by peer */
 428         RXRPC_CALL_LOCALLY_ABORTED,     /* - call aborted locally on error or close */
 429         RXRPC_CALL_LOCAL_ERROR,         /* - call failed due to local error */
 430         RXRPC_CALL_NETWORK_ERROR,       /* - call terminated by network error */
 431         NR__RXRPC_CALL_COMPLETIONS
 432 };
 433
 434 /*
 435  * RxRPC call definition
 436  * - matched by { connection, call_id }
 437  */
 438 struct rxrpc_call {
 439         struct rcu_head         rcu;
 440         struct rxrpc_connection *conn;          /* connection carrying call */
 441         struct rxrpc_peer       *peer;          /* Peer record for remote address */
 442         struct rxrpc_sock __rcu *socket;        /* socket responsible */
 443         struct timer_list       lifetimer;      /* lifetime remaining on call */
 444         struct timer_list       ack_timer;      /* ACK generation timer */
 445         struct timer_list       resend_timer;   /* Tx resend timer */
 446         struct work_struct      processor;      /* packet processor and ACK generator */
 447         rxrpc_notify_rx_t       notify_rx;      /* kernel service Rx notification function */
 448         struct list_head        link;           /* link in master call list */
 449         struct list_head        chan_wait_link; /* Link in conn->waiting_calls */
 450         struct hlist_node       error_link;     /* link in error distribution list */
 451         struct list_head        accept_link;    /* calls awaiting acceptance */
 452         struct rb_node          sock_node;      /* node in socket call tree */
 453         struct sk_buff_head     rx_queue;       /* received packets */
 454         struct sk_buff_head     rx_oos_queue;   /* packets received out of sequence */
 455         struct sk_buff_head     knlrecv_queue;  /* Queue for kernel_recv [TODO: replace this] */
 456         struct sk_buff          *tx_pending;    /* Tx socket buffer being filled */
 457         wait_queue_head_t       waitq;          /* Wait queue for channel or Tx */
 458         __be32                  crypto_buf[2];  /* Temporary packet crypto buffer */
 459         unsigned long           user_call_ID;   /* user-defined call ID */
 460         unsigned long           creation_jif;   /* time of call creation */
 461         unsigned long           flags;
 462         unsigned long           events;
 463         spinlock_t              lock;
 464         rwlock_t                state_lock;     /* lock for state transition */
 465         u32                     abort_code;     /* Local/remote abort code */
 466         int                     error;          /* Local error incurred */
 467         enum rxrpc_call_state   state : 8;      /* current state of call */
 468         enum rxrpc_call_completion completion : 8; /* Call completion condition */
 469         atomic_t                usage;
 470         atomic_t                skb_count;      /* Outstanding packets on this call */
 471         atomic_t                sequence;       /* Tx data packet sequence counter */
 472         u16                     service_id;     /* service ID */
 473         u8                      security_ix;    /* Security type */
 474         u32                     call_id;        /* call ID on connection  */
 475         u32                     cid;            /* connection ID plus channel index */
 476         int                     debug_id;       /* debug ID for printks */
 477
 478         /* transmission-phase ACK management */
 479         u8                      acks_head;      /* offset into window of first entry */
 480         u8                      acks_tail;      /* offset into window of last entry */
 481         u8                      acks_winsz;     /* size of un-ACK'd window */
 482         u8                      acks_unacked;   /* lowest unacked packet in last ACK received */
 483         int                     acks_latest;    /* serial number of latest ACK received */
 484         rxrpc_seq_t             acks_hard;      /* highest definitively ACK'd msg seq */
 485         unsigned long           *acks_window;   /* sent packet window
 486                                                  * - elements are pointers with LSB set if ACK'd
 487                                                  */
 488
 489         /* receive-phase ACK management */
 490         rxrpc_seq_t             rx_data_expect; /* next data seq ID expected to be received */
 491         rxrpc_seq_t             rx_data_post;   /* next data seq ID expected to be posted */
 492         rxrpc_seq_t             rx_data_recv;   /* last data seq ID encountered by recvmsg */
 493         rxrpc_seq_t             rx_data_eaten;  /* last data seq ID consumed by recvmsg */
 494         rxrpc_seq_t             rx_first_oos;   /* first packet in rx_oos_queue (or 0) */
 495         rxrpc_seq_t             ackr_win_top;   /* top of ACK window (rx_data_eaten is bottom) */
 496         rxrpc_seq_t             ackr_prev_seq;  /* previous sequence number received */
 497         u8                      ackr_reason;    /* reason to ACK */
 498         u16                     ackr_skew;      /* skew on packet being ACK'd */
 499         rxrpc_serial_t          ackr_serial;    /* serial of packet being ACK'd */
 500         atomic_t                ackr_not_idle;  /* number of packets in Rx queue */
 501
 502         /* received packet records, 1 bit per record */
 503 #define RXRPC_ACKR_WINDOW_ASZ DIV_ROUND_UP(RXRPC_MAXACKS, BITS_PER_LONG)
 504         unsigned long           ackr_window[RXRPC_ACKR_WINDOW_ASZ + 1];
 505 };
 506
 507 enum rxrpc_call_trace {
 508         rxrpc_call_new_client,
 509         rxrpc_call_new_service,
 510         rxrpc_call_queued,
 511         rxrpc_call_queued_ref,
 512         rxrpc_call_seen,
 513         rxrpc_call_got,
 514         rxrpc_call_got_skb,
 515         rxrpc_call_got_userid,
 516         rxrpc_call_put,
 517         rxrpc_call_put_skb,
 518         rxrpc_call_put_userid,
 519         rxrpc_call_put_noqueue,
 520         rxrpc_call__nr_trace
 521 };
 522
 523 extern const char rxrpc_call_traces[rxrpc_call__nr_trace][4];
 524
 525 #include <trace/events/rxrpc.h>
 526
 527 /*
 528  * af_rxrpc.c
 529  */
 530 extern atomic_t rxrpc_n_skbs;
 531 extern u32 rxrpc_epoch;
 532 extern atomic_t rxrpc_debug_id;
 533 extern struct workqueue_struct *rxrpc_workqueue;
 534
 535 /*
 536  * call_accept.c
 537  */
 538 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
 539 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
 540                                      rxrpc_notify_rx_t);
 541 int rxrpc_reject_call(struct rxrpc_sock *);
 542
 543 /*
 544  * call_event.c
 545  */
 546 void __rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool);
 547 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool);
 548 void rxrpc_process_call(struct work_struct *);
 549
 550 /*
 551  * call_object.c
 552  */
 553 extern const char *const rxrpc_call_states[];
 554 extern const char *const rxrpc_call_completions[];
 555 extern unsigned int rxrpc_max_call_lifetime;
 556 extern struct kmem_cache *rxrpc_call_jar;
 557 extern struct list_head rxrpc_calls;
 558 extern rwlock_t rxrpc_call_lock;
 559
 560 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
 561 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
 562                                          struct rxrpc_conn_parameters *,
 563                                          struct sockaddr_rxrpc *,
 564                                          unsigned long, gfp_t);
 565 struct rxrpc_call *rxrpc_incoming_call(struct rxrpc_sock *,
 566                                        struct rxrpc_connection *,
 567                                        struct sk_buff *);
 568 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
 569 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
 570 bool __rxrpc_queue_call(struct rxrpc_call *);
 571 bool rxrpc_queue_call(struct rxrpc_call *);
 572 void rxrpc_see_call(struct rxrpc_call *);
 573 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
 574 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
 575 void rxrpc_get_call_for_skb(struct rxrpc_call *, struct sk_buff *);
 576 void rxrpc_put_call_for_skb(struct rxrpc_call *, struct sk_buff *);
 577 void __exit rxrpc_destroy_all_calls(void);
 578
 579 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
 580 {
 581         return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
 582 }
 583
 584 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
 585 {
 586         return !rxrpc_is_service_call(call);
 587 }
 588
 589 /*
 590  * Transition a call to the complete state.
 591  */
 592 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
 593                                                enum rxrpc_call_completion compl,
 594                                                u32 abort_code,
 595                                                int error)
 596 {
 597         if (call->state < RXRPC_CALL_COMPLETE) {
 598                 call->abort_code = abort_code;
 599                 call->error = error;
 600                 call->completion = compl,
 601                 call->state = RXRPC_CALL_COMPLETE;
 602                 return true;
 603         }
 604         return false;
 605 }
 606
 607 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
 608                                              enum rxrpc_call_completion compl,
 609                                              u32 abort_code,
 610                                              int error)
 611 {
 612         bool ret;
 613
 614         write_lock_bh(&call->state_lock);
 615         ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
 616         write_unlock_bh(&call->state_lock);
 617         return ret;
 618 }
 619
 620 /*
 621  * Record that a call successfully completed.
 622  */
 623 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
 624 {
 625         return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
 626 }
 627
 628 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
 629 {
 630         bool ret;
 631
 632         write_lock_bh(&call->state_lock);
 633         ret = __rxrpc_call_completed(call);
 634         write_unlock_bh(&call->state_lock);
 635         return ret;
 636 }
 637
 638 /*
 639  * Record that a call is locally aborted.
 640  */
 641 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
 642                                       rxrpc_seq_t seq,
 643                                       u32 abort_code, int error)
 644 {
 645         trace_rxrpc_abort(why, call->cid, call->call_id, seq,
 646                           abort_code, error);
 647         if (__rxrpc_set_call_completion(call,
 648                                         RXRPC_CALL_LOCALLY_ABORTED,
 649                                         abort_code, error)) {
 650                 set_bit(RXRPC_CALL_EV_ABORT, &call->events);
 651                 return true;
 652         }
 653         return false;
 654 }
 655
 656 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
 657                                     rxrpc_seq_t seq, u32 abort_code, int error)
 658 {
 659         bool ret;
 660
 661         write_lock_bh(&call->state_lock);
 662         ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
 663         write_unlock_bh(&call->state_lock);
 664         return ret;
 665 }
 666
 667 /*
 668  * conn_client.c
 669  */
 670 extern unsigned int rxrpc_max_client_connections;
 671 extern unsigned int rxrpc_reap_client_connections;
 672 extern unsigned int rxrpc_conn_idle_client_expiry;
 673 extern unsigned int rxrpc_conn_idle_client_fast_expiry;
 674 extern struct idr rxrpc_client_conn_ids;
 675
 676 void rxrpc_destroy_client_conn_ids(void);
 677 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
 678                        struct sockaddr_rxrpc *, gfp_t);
 679 void rxrpc_expose_client_call(struct rxrpc_call *);
 680 void rxrpc_disconnect_client_call(struct rxrpc_call *);
 681 void rxrpc_put_client_conn(struct rxrpc_connection *);
 682 void __exit rxrpc_destroy_all_client_connections(void);
 683
 684 /*
 685  * conn_event.c
 686  */
 687 void rxrpc_process_connection(struct work_struct *);
 688 void rxrpc_reject_packet(struct rxrpc_local *, struct sk_buff *);
 689 void rxrpc_reject_packets(struct rxrpc_local *);
 690
 691 /*
 692  * conn_object.c
 693  */
 694 extern unsigned int rxrpc_connection_expiry;
 695 extern struct list_head rxrpc_connections;
 696 extern struct list_head rxrpc_connection_proc_list;
 697 extern rwlock_t rxrpc_connection_lock;
 698
 699 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
 700 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
 701 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
 702                                                    struct sk_buff *);
 703 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
 704 void rxrpc_disconnect_call(struct rxrpc_call *);
 705 void rxrpc_kill_connection(struct rxrpc_connection *);
 706 void __rxrpc_put_connection(struct rxrpc_connection *);
 707 void __exit rxrpc_destroy_all_connections(void);
 708
 709 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
 710 {
 711         return conn->out_clientflag;
 712 }
 713
 714 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
 715 {
 716         return !rxrpc_conn_is_client(conn);
 717 }
 718
 719 static inline void rxrpc_get_connection(struct rxrpc_connection *conn)
 720 {
 721         atomic_inc(&conn->usage);
 722 }
 723
 724 static inline
 725 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *conn)
 726 {
 727         return atomic_inc_not_zero(&conn->usage) ? conn : NULL;
 728 }
 729
 730 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
 731 {
 732         if (!conn)
 733                 return;
 734
 735         if (rxrpc_conn_is_client(conn)) {
 736                 if (atomic_dec_and_test(&conn->usage))
 737                         rxrpc_put_client_conn(conn);
 738         } else {
 739                 if (atomic_dec_return(&conn->usage) == 1)
 740                         __rxrpc_put_connection(conn);
 741         }
 742 }
 743
 744 static inline bool rxrpc_queue_conn(struct rxrpc_connection *conn)
 745 {
 746         if (!rxrpc_get_connection_maybe(conn))
 747                 return false;
 748         if (!rxrpc_queue_work(&conn->processor))
 749                 rxrpc_put_connection(conn);
 750         return true;
 751 }
 752
 753 /*
 754  * conn_service.c
 755  */
 756 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
 757                                                      struct sk_buff *);
 758 struct rxrpc_connection *rxrpc_incoming_connection(struct rxrpc_local *,
 759                                                    struct sockaddr_rxrpc *,
 760                                                    struct sk_buff *);
 761 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
 762
 763 /*
 764  * input.c
 765  */
 766 void rxrpc_data_ready(struct sock *);
 767 int rxrpc_queue_rcv_skb(struct rxrpc_call *, struct sk_buff *, bool, bool);
 768 void rxrpc_fast_process_packet(struct rxrpc_call *, struct sk_buff *);
 769
 770 /*
 771  * insecure.c
 772  */
 773 extern const struct rxrpc_security rxrpc_no_security;
 774
 775 /*
 776  * key.c
 777  */
 778 extern struct key_type key_type_rxrpc;
 779 extern struct key_type key_type_rxrpc_s;
 780
 781 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
 782 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
 783 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
 784                               u32);
 785
 786 /*
 787  * local_event.c
 788  */
 789 extern void rxrpc_process_local_events(struct rxrpc_local *);
 790
 791 /*
 792  * local_object.c
 793  */
 794 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
 795 void __rxrpc_put_local(struct rxrpc_local *);
 796 void __exit rxrpc_destroy_all_locals(void);
 797
 798 static inline void rxrpc_get_local(struct rxrpc_local *local)
 799 {
 800         atomic_inc(&local->usage);
 801 }
 802
 803 static inline
 804 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
 805 {
 806         return atomic_inc_not_zero(&local->usage) ? local : NULL;
 807 }
 808
 809 static inline void rxrpc_put_local(struct rxrpc_local *local)
 810 {
 811         if (local && atomic_dec_and_test(&local->usage))
 812                 __rxrpc_put_local(local);
 813 }
 814
 815 static inline void rxrpc_queue_local(struct rxrpc_local *local)
 816 {
 817         rxrpc_queue_work(&local->processor);
 818 }
 819
 820 /*
 821  * misc.c
 822  */
 823 extern unsigned int rxrpc_max_backlog __read_mostly;
 824 extern unsigned int rxrpc_requested_ack_delay;
 825 extern unsigned int rxrpc_soft_ack_delay;
 826 extern unsigned int rxrpc_idle_ack_delay;
 827 extern unsigned int rxrpc_rx_window_size;
 828 extern unsigned int rxrpc_rx_mtu;
 829 extern unsigned int rxrpc_rx_jumbo_max;
 830 extern unsigned int rxrpc_resend_timeout;
 831
 832 extern const char *const rxrpc_pkts[];
 833 extern const s8 rxrpc_ack_priority[];
 834
 835 extern const char *rxrpc_acks(u8 reason);
 836
 837 /*
 838  * output.c
 839  */
 840 int rxrpc_send_call_packet(struct rxrpc_call *, u8);
 841 int rxrpc_send_data_packet(struct rxrpc_connection *, struct sk_buff *);
 842
 843 /*
 844  * peer_event.c
 845  */
 846 void rxrpc_error_report(struct sock *);
 847 void rxrpc_peer_error_distributor(struct work_struct *);
 848
 849 /*
 850  * peer_object.c
 851  */
 852 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
 853                                          const struct sockaddr_rxrpc *);
 854 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
 855                                      struct sockaddr_rxrpc *, gfp_t);
 856 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
 857
 858 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
 859 {
 860         atomic_inc(&peer->usage);
 861         return peer;
 862 }
 863
 864 static inline
 865 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
 866 {
 867         return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
 868 }
 869
 870 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
 871 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
 872 {
 873         if (peer && atomic_dec_and_test(&peer->usage))
 874                 __rxrpc_put_peer(peer);
 875 }
 876
 877 /*
 878  * proc.c
 879  */
 880 extern const struct file_operations rxrpc_call_seq_fops;
 881 extern const struct file_operations rxrpc_connection_seq_fops;
 882
 883 /*
 884  * recvmsg.c
 885  */
 886 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
 887
 888 /*
 889  * rxkad.c
 890  */
 891 #ifdef CONFIG_RXKAD
 892 extern const struct rxrpc_security rxkad;
 893 #endif
 894
 895 /*
 896  * security.c
 897  */
 898 int __init rxrpc_init_security(void);
 899 void rxrpc_exit_security(void);
 900 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
 901 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
 902
 903 /*
 904  * sendmsg.c
 905  */
 906 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
 907
 908 /*
 909  * skbuff.c
 910  */
 911 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
 912 void rxrpc_packet_destructor(struct sk_buff *);
 913 void rxrpc_new_skb(struct sk_buff *);
 914 void rxrpc_see_skb(struct sk_buff *);
 915 void rxrpc_get_skb(struct sk_buff *);
 916 void rxrpc_free_skb(struct sk_buff *);
 917 void rxrpc_purge_queue(struct sk_buff_head *);
 918
 919 /*
 920  * sysctl.c
 921  */
 922 #ifdef CONFIG_SYSCTL
 923 extern int __init rxrpc_sysctl_init(void);
 924 extern void rxrpc_sysctl_exit(void);
 925 #else
 926 static inline int __init rxrpc_sysctl_init(void) { return 0; }
 927 static inline void rxrpc_sysctl_exit(void) {}
 928 #endif
 929
 930 /*
 931  * utils.c
 932  */
 933 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
 934
 935 /*
 936  * debug tracing
 937  */
 938 extern unsigned int rxrpc_debug;
 939
 940 #define dbgprintk(FMT,...) \
 941         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
 942
 943 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
 944 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
 945 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
 946 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
 947 #define knet(FMT,...)   dbgprintk("@@@ "FMT ,##__VA_ARGS__)
 948
 949
 950 #if defined(__KDEBUG)
 951 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
 952 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
 953 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
 954 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
 955 #define _net(FMT,...)   knet(FMT,##__VA_ARGS__)
 956
 957 #elif defined(CONFIG_AF_RXRPC_DEBUG)
 958 #define RXRPC_DEBUG_KENTER      0x01
 959 #define RXRPC_DEBUG_KLEAVE      0x02
 960 #define RXRPC_DEBUG_KDEBUG      0x04
 961 #define RXRPC_DEBUG_KPROTO      0x08
 962 #define RXRPC_DEBUG_KNET        0x10
 963
 964 #define _enter(FMT,...)                                 \
 965 do {                                                    \
 966         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
 967                 kenter(FMT,##__VA_ARGS__);              \
 968 } while (0)
 969
 970 #define _leave(FMT,...)                                 \
 971 do {                                                    \
 972         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
 973                 kleave(FMT,##__VA_ARGS__);              \
 974 } while (0)
 975
 976 #define _debug(FMT,...)                                 \
 977 do {                                                    \
 978         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
 979                 kdebug(FMT,##__VA_ARGS__);              \
 980 } while (0)
 981
 982 #define _proto(FMT,...)                                 \
 983 do {                                                    \
 984         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
 985                 kproto(FMT,##__VA_ARGS__);              \
 986 } while (0)
 987
 988 #define _net(FMT,...)                                   \
 989 do {                                                    \
 990         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))   \
 991                 knet(FMT,##__VA_ARGS__);                \
 992 } while (0)
 993
 994 #else
 995 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
 996 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
 997 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
 998 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
 999 #define _net(FMT,...)   no_printk("@@@ "FMT ,##__VA_ARGS__)
1000 #endif
1001
1002 /*
1003  * debug assertion checking
1004  */
1005 #if 1 // defined(__KDEBUGALL)
1006
1007 #define ASSERT(X)                                               \
1008 do {                                                            \
1009         if (unlikely(!(X))) {                                   \
1010                 pr_err("Assertion failed\n");                   \
1011                 BUG();                                          \
1012         }                                                       \
1013 } while (0)
1014
1015 #define ASSERTCMP(X, OP, Y)                                             \
1016 do {                                                                    \
1017         unsigned long _x = (unsigned long)(X);                          \
1018         unsigned long _y = (unsigned long)(Y);                          \
1019         if (unlikely(!(_x OP _y))) {                                    \
1020                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n",                        \
1021                        _x, _x, #OP, _y, _y);                            \
1022                 BUG();                                                  \
1023         }                                                               \
1024 } while (0)
1025
1026 #define ASSERTIF(C, X)                                          \
1027 do {                                                            \
1028         if (unlikely((C) && !(X))) {                            \
1029                 pr_err("Assertion failed\n");                   \
1030                 BUG();                                          \
1031         }                                                       \
1032 } while (0)
1033
1034 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1035 do {                                                                    \
1036         unsigned long _x = (unsigned long)(X);                          \
1037         unsigned long _y = (unsigned long)(Y);                          \
1038         if (unlikely((C) && !(_x OP _y))) {                             \
1039                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1040                        _x, _x, #OP, _y, _y);                            \
1041                 BUG();                                                  \
1042         }                                                               \
1043 } while (0)
1044
1045 #else
1046
1047 #define ASSERT(X)                               \
1048 do {                                            \
1049 } while (0)
1050
1051 #define ASSERTCMP(X, OP, Y)                     \
1052 do {                                            \
1053 } while (0)
1054
1055 #define ASSERTIF(C, X)                          \
1056 do {                                            \
1057 } while (0)
1058
1059 #define ASSERTIFCMP(C, X, OP, Y)                \
1060 do {                                            \
1061 } while (0)
1062
1063 #endif /* __KDEBUGALL */