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  * Service backlog preallocation.
  68  *
  69  * This contains circular buffers of preallocated peers, connections and calls
  70  * for incoming service calls and their head and tail pointers.  This allows
  71  * calls to be set up in the data_ready handler, thereby avoiding the need to
  72  * shuffle packets around so much.
  73  */
  74 struct rxrpc_backlog {
  75         unsigned short          peer_backlog_head;
  76         unsigned short          peer_backlog_tail;
  77         unsigned short          conn_backlog_head;
  78         unsigned short          conn_backlog_tail;
  79         unsigned short          call_backlog_head;
  80         unsigned short          call_backlog_tail;
  81 #define RXRPC_BACKLOG_MAX       32
  82         struct rxrpc_peer       *peer_backlog[RXRPC_BACKLOG_MAX];
  83         struct rxrpc_connection *conn_backlog[RXRPC_BACKLOG_MAX];
  84         struct rxrpc_call       *call_backlog[RXRPC_BACKLOG_MAX];
  85 };
  86
  87 /*
  88  * RxRPC socket definition
  89  */
  90 struct rxrpc_sock {
  91         /* WARNING: sk has to be the first member */
  92         struct sock             sk;
  93         rxrpc_notify_new_call_t notify_new_call; /* Func to notify of new call */
  94         rxrpc_discard_new_call_t discard_new_call; /* Func to discard a new call */
  95         struct rxrpc_local      *local;         /* local endpoint */
  96         struct hlist_node       listen_link;    /* link in the local endpoint's listen list */
  97         struct rxrpc_backlog    *backlog;       /* Preallocation for services */
  98         spinlock_t              incoming_lock;  /* Incoming call vs service shutdown lock */
  99         struct list_head        sock_calls;     /* List of calls owned by this socket */
 100         struct list_head        to_be_accepted; /* calls awaiting acceptance */
 101         struct list_head        recvmsg_q;      /* Calls awaiting recvmsg's attention  */
 102         rwlock_t                recvmsg_lock;   /* Lock for recvmsg_q */
 103         struct key              *key;           /* security for this socket */
 104         struct key              *securities;    /* list of server security descriptors */
 105         struct rb_root          calls;          /* User ID -> call mapping */
 106         unsigned long           flags;
 107 #define RXRPC_SOCK_CONNECTED            0       /* connect_srx is set */
 108         rwlock_t                call_lock;      /* lock for calls */
 109         u32                     min_sec_level;  /* minimum security level */
 110 #define RXRPC_SECURITY_MAX      RXRPC_SECURITY_ENCRYPT
 111         bool                    exclusive;      /* Exclusive connection for a client socket */
 112         sa_family_t             family;         /* Protocol family created with */
 113         struct sockaddr_rxrpc   srx;            /* local address */
 114         struct sockaddr_rxrpc   connect_srx;    /* Default client address from connect() */
 115 };
 116
 117 #define rxrpc_sk(__sk) container_of((__sk), struct rxrpc_sock, sk)
 118
 119 /*
 120  * CPU-byteorder normalised Rx packet header.
 121  */
 122 struct rxrpc_host_header {
 123         u32             epoch;          /* client boot timestamp */
 124         u32             cid;            /* connection and channel ID */
 125         u32             callNumber;     /* call ID (0 for connection-level packets) */
 126         u32             seq;            /* sequence number of pkt in call stream */
 127         u32             serial;         /* serial number of pkt sent to network */
 128         u8              type;           /* packet type */
 129         u8              flags;          /* packet flags */
 130         u8              userStatus;     /* app-layer defined status */
 131         u8              securityIndex;  /* security protocol ID */
 132         union {
 133                 u16     _rsvd;          /* reserved */
 134                 u16     cksum;          /* kerberos security checksum */
 135         };
 136         u16             serviceId;      /* service ID */
 137 } __packed;
 138
 139 /*
 140  * RxRPC socket buffer private variables
 141  * - max 48 bytes (struct sk_buff::cb)
 142  */
 143 struct rxrpc_skb_priv {
 144         union {
 145                 unsigned long   resend_at;      /* time in jiffies at which to resend */
 146                 struct {
 147                         u8      nr_jumbo;       /* Number of jumbo subpackets */
 148                 };
 149         };
 150         union {
 151                 unsigned int    offset;         /* offset into buffer of next read */
 152                 int             remain;         /* amount of space remaining for next write */
 153                 u32             error;          /* network error code */
 154         };
 155
 156         struct rxrpc_host_header hdr;           /* RxRPC packet header from this packet */
 157 };
 158
 159 #define rxrpc_skb(__skb) ((struct rxrpc_skb_priv *) &(__skb)->cb)
 160
 161 /*
 162  * RxRPC security module interface
 163  */
 164 struct rxrpc_security {
 165         const char              *name;          /* name of this service */
 166         u8                      security_index; /* security type provided */
 167
 168         /* Initialise a security service */
 169         int (*init)(void);
 170
 171         /* Clean up a security service */
 172         void (*exit)(void);
 173
 174         /* initialise a connection's security */
 175         int (*init_connection_security)(struct rxrpc_connection *);
 176
 177         /* prime a connection's packet security */
 178         int (*prime_packet_security)(struct rxrpc_connection *);
 179
 180         /* impose security on a packet */
 181         int (*secure_packet)(struct rxrpc_call *,
 182                              struct sk_buff *,
 183                              size_t,
 184                              void *);
 185
 186         /* verify the security on a received packet */
 187         int (*verify_packet)(struct rxrpc_call *, struct sk_buff *,
 188                              unsigned int, unsigned int, rxrpc_seq_t, u16);
 189
 190         /* Locate the data in a received packet that has been verified. */
 191         void (*locate_data)(struct rxrpc_call *, struct sk_buff *,
 192                             unsigned int *, unsigned int *);
 193
 194         /* issue a challenge */
 195         int (*issue_challenge)(struct rxrpc_connection *);
 196
 197         /* respond to a challenge */
 198         int (*respond_to_challenge)(struct rxrpc_connection *,
 199                                     struct sk_buff *,
 200                                     u32 *);
 201
 202         /* verify a response */
 203         int (*verify_response)(struct rxrpc_connection *,
 204                                struct sk_buff *,
 205                                u32 *);
 206
 207         /* clear connection security */
 208         void (*clear)(struct rxrpc_connection *);
 209 };
 210
 211 /*
 212  * RxRPC local transport endpoint description
 213  * - owned by a single AF_RXRPC socket
 214  * - pointed to by transport socket struct sk_user_data
 215  */
 216 struct rxrpc_local {
 217         struct rcu_head         rcu;
 218         atomic_t                usage;
 219         struct list_head        link;
 220         struct socket           *socket;        /* my UDP socket */
 221         struct work_struct      processor;
 222         struct hlist_head       services;       /* services listening on this endpoint */
 223         struct rw_semaphore     defrag_sem;     /* control re-enablement of IP DF bit */
 224         struct sk_buff_head     reject_queue;   /* packets awaiting rejection */
 225         struct sk_buff_head     event_queue;    /* endpoint event packets awaiting processing */
 226         struct rb_root          client_conns;   /* Client connections by socket params */
 227         spinlock_t              client_conns_lock; /* Lock for client_conns */
 228         spinlock_t              lock;           /* access lock */
 229         rwlock_t                services_lock;  /* lock for services list */
 230         int                     debug_id;       /* debug ID for printks */
 231         bool                    dead;
 232         struct sockaddr_rxrpc   srx;            /* local address */
 233 };
 234
 235 /*
 236  * RxRPC remote transport endpoint definition
 237  * - matched by local endpoint, remote port, address and protocol type
 238  */
 239 struct rxrpc_peer {
 240         struct rcu_head         rcu;            /* This must be first */
 241         atomic_t                usage;
 242         unsigned long           hash_key;
 243         struct hlist_node       hash_link;
 244         struct rxrpc_local      *local;
 245         struct hlist_head       error_targets;  /* targets for net error distribution */
 246         struct work_struct      error_distributor;
 247         struct rb_root          service_conns;  /* Service connections */
 248         seqlock_t               service_conn_lock;
 249         spinlock_t              lock;           /* access lock */
 250         unsigned int            if_mtu;         /* interface MTU for this peer */
 251         unsigned int            mtu;            /* network MTU for this peer */
 252         unsigned int            maxdata;        /* data size (MTU - hdrsize) */
 253         unsigned short          hdrsize;        /* header size (IP + UDP + RxRPC) */
 254         int                     debug_id;       /* debug ID for printks */
 255         int                     error_report;   /* Net (+0) or local (+1000000) to distribute */
 256 #define RXRPC_LOCAL_ERROR_OFFSET 1000000
 257         struct sockaddr_rxrpc   srx;            /* remote address */
 258
 259         /* calculated RTT cache */
 260 #define RXRPC_RTT_CACHE_SIZE 32
 261         suseconds_t             rtt;            /* current RTT estimate (in uS) */
 262         unsigned int            rtt_point;      /* next entry at which to insert */
 263         unsigned int            rtt_usage;      /* amount of cache actually used */
 264         suseconds_t             rtt_cache[RXRPC_RTT_CACHE_SIZE]; /* calculated RTT cache */
 265 };
 266
 267 /*
 268  * Keys for matching a connection.
 269  */
 270 struct rxrpc_conn_proto {
 271         union {
 272                 struct {
 273                         u32     epoch;          /* epoch of this connection */
 274                         u32     cid;            /* connection ID */
 275                 };
 276                 u64             index_key;
 277         };
 278 };
 279
 280 struct rxrpc_conn_parameters {
 281         struct rxrpc_local      *local;         /* Representation of local endpoint */
 282         struct rxrpc_peer       *peer;          /* Remote endpoint */
 283         struct key              *key;           /* Security details */
 284         bool                    exclusive;      /* T if conn is exclusive */
 285         u16                     service_id;     /* Service ID for this connection */
 286         u32                     security_level; /* Security level selected */
 287 };
 288
 289 /*
 290  * Bits in the connection flags.
 291  */
 292 enum rxrpc_conn_flag {
 293         RXRPC_CONN_HAS_IDR,             /* Has a client conn ID assigned */
 294         RXRPC_CONN_IN_SERVICE_CONNS,    /* Conn is in peer->service_conns */
 295         RXRPC_CONN_IN_CLIENT_CONNS,     /* Conn is in local->client_conns */
 296         RXRPC_CONN_EXPOSED,             /* Conn has extra ref for exposure */
 297         RXRPC_CONN_DONT_REUSE,          /* Don't reuse this connection */
 298         RXRPC_CONN_COUNTED,             /* Counted by rxrpc_nr_client_conns */
 299 };
 300
 301 /*
 302  * Events that can be raised upon a connection.
 303  */
 304 enum rxrpc_conn_event {
 305         RXRPC_CONN_EV_CHALLENGE,        /* Send challenge packet */
 306 };
 307
 308 /*
 309  * The connection cache state.
 310  */
 311 enum rxrpc_conn_cache_state {
 312         RXRPC_CONN_CLIENT_INACTIVE,     /* Conn is not yet listed */
 313         RXRPC_CONN_CLIENT_WAITING,      /* Conn is on wait list, waiting for capacity */
 314         RXRPC_CONN_CLIENT_ACTIVE,       /* Conn is on active list, doing calls */
 315         RXRPC_CONN_CLIENT_CULLED,       /* Conn is culled and delisted, doing calls */
 316         RXRPC_CONN_CLIENT_IDLE,         /* Conn is on idle list, doing mostly nothing */
 317         RXRPC_CONN__NR_CACHE_STATES
 318 };
 319
 320 /*
 321  * The connection protocol state.
 322  */
 323 enum rxrpc_conn_proto_state {
 324         RXRPC_CONN_UNUSED,              /* Connection not yet attempted */
 325         RXRPC_CONN_CLIENT,              /* Client connection */
 326         RXRPC_CONN_SERVICE_PREALLOC,    /* Service connection preallocation */
 327         RXRPC_CONN_SERVICE_UNSECURED,   /* Service unsecured connection */
 328         RXRPC_CONN_SERVICE_CHALLENGING, /* Service challenging for security */
 329         RXRPC_CONN_SERVICE,             /* Service secured connection */
 330         RXRPC_CONN_REMOTELY_ABORTED,    /* Conn aborted by peer */
 331         RXRPC_CONN_LOCALLY_ABORTED,     /* Conn aborted locally */
 332         RXRPC_CONN__NR_STATES
 333 };
 334
 335 /*
 336  * RxRPC connection definition
 337  * - matched by { local, peer, epoch, conn_id, direction }
 338  * - each connection can only handle four simultaneous calls
 339  */
 340 struct rxrpc_connection {
 341         struct rxrpc_conn_proto proto;
 342         struct rxrpc_conn_parameters params;
 343
 344         atomic_t                usage;
 345         struct rcu_head         rcu;
 346         struct list_head        cache_link;
 347
 348         spinlock_t              channel_lock;
 349         unsigned char           active_chans;   /* Mask of active channels */
 350 #define RXRPC_ACTIVE_CHANS_MASK ((1 << RXRPC_MAXCALLS) - 1)
 351         struct list_head        waiting_calls;  /* Calls waiting for channels */
 352         struct rxrpc_channel {
 353                 struct rxrpc_call __rcu *call;          /* Active call */
 354                 u32                     call_id;        /* ID of current call */
 355                 u32                     call_counter;   /* Call ID counter */
 356                 u32                     last_call;      /* ID of last call */
 357                 u8                      last_type;      /* Type of last packet */
 358                 u16                     last_service_id;
 359                 union {
 360                         u32             last_seq;
 361                         u32             last_abort;
 362                 };
 363         } channels[RXRPC_MAXCALLS];
 364
 365         struct work_struct      processor;      /* connection event processor */
 366         union {
 367                 struct rb_node  client_node;    /* Node in local->client_conns */
 368                 struct rb_node  service_node;   /* Node in peer->service_conns */
 369         };
 370         struct list_head        proc_link;      /* link in procfs list */
 371         struct list_head        link;           /* link in master connection list */
 372         struct sk_buff_head     rx_queue;       /* received conn-level packets */
 373         const struct rxrpc_security *security;  /* applied security module */
 374         struct key              *server_key;    /* security for this service */
 375         struct crypto_skcipher  *cipher;        /* encryption handle */
 376         struct rxrpc_crypt      csum_iv;        /* packet checksum base */
 377         unsigned long           flags;
 378         unsigned long           events;
 379         unsigned long           idle_timestamp; /* Time at which last became idle */
 380         spinlock_t              state_lock;     /* state-change lock */
 381         enum rxrpc_conn_cache_state cache_state;
 382         enum rxrpc_conn_proto_state state;      /* current state of connection */
 383         u32                     local_abort;    /* local abort code */
 384         u32                     remote_abort;   /* remote abort code */
 385         int                     debug_id;       /* debug ID for printks */
 386         atomic_t                serial;         /* packet serial number counter */
 387         unsigned int            hi_serial;      /* highest serial number received */
 388         u8                      size_align;     /* data size alignment (for security) */
 389         u8                      header_size;    /* rxrpc + security header size */
 390         u8                      security_size;  /* security header size */
 391         u32                     security_nonce; /* response re-use preventer */
 392         u8                      security_ix;    /* security type */
 393         u8                      out_clientflag; /* RXRPC_CLIENT_INITIATED if we are client */
 394 };
 395
 396 /*
 397  * Flags in call->flags.
 398  */
 399 enum rxrpc_call_flag {
 400         RXRPC_CALL_RELEASED,            /* call has been released - no more message to userspace */
 401         RXRPC_CALL_HAS_USERID,          /* has a user ID attached */
 402         RXRPC_CALL_IS_SERVICE,          /* Call is service call */
 403         RXRPC_CALL_EXPOSED,             /* The call was exposed to the world */
 404         RXRPC_CALL_RX_LAST,             /* Received the last packet (at rxtx_top) */
 405         RXRPC_CALL_TX_LAST,             /* Last packet in Tx buffer (at rxtx_top) */
 406 };
 407
 408 /*
 409  * Events that can be raised on a call.
 410  */
 411 enum rxrpc_call_event {
 412         RXRPC_CALL_EV_ACK,              /* need to generate ACK */
 413         RXRPC_CALL_EV_ABORT,            /* need to generate abort */
 414         RXRPC_CALL_EV_TIMER,            /* Timer expired */
 415         RXRPC_CALL_EV_RESEND,           /* Tx resend required */
 416 };
 417
 418 /*
 419  * The states that a call can be in.
 420  */
 421 enum rxrpc_call_state {
 422         RXRPC_CALL_UNINITIALISED,
 423         RXRPC_CALL_CLIENT_AWAIT_CONN,   /* - client waiting for connection to become available */
 424         RXRPC_CALL_CLIENT_SEND_REQUEST, /* - client sending request phase */
 425         RXRPC_CALL_CLIENT_AWAIT_REPLY,  /* - client awaiting reply */
 426         RXRPC_CALL_CLIENT_RECV_REPLY,   /* - client receiving reply phase */
 427         RXRPC_CALL_SERVER_PREALLOC,     /* - service preallocation */
 428         RXRPC_CALL_SERVER_SECURING,     /* - server securing request connection */
 429         RXRPC_CALL_SERVER_ACCEPTING,    /* - server accepting request */
 430         RXRPC_CALL_SERVER_RECV_REQUEST, /* - server receiving request */
 431         RXRPC_CALL_SERVER_ACK_REQUEST,  /* - server pending ACK of request */
 432         RXRPC_CALL_SERVER_SEND_REPLY,   /* - server sending reply */
 433         RXRPC_CALL_SERVER_AWAIT_ACK,    /* - server awaiting final ACK */
 434         RXRPC_CALL_COMPLETE,            /* - call complete */
 435         NR__RXRPC_CALL_STATES
 436 };
 437
 438 /*
 439  * Call completion condition (state == RXRPC_CALL_COMPLETE).
 440  */
 441 enum rxrpc_call_completion {
 442         RXRPC_CALL_SUCCEEDED,           /* - Normal termination */
 443         RXRPC_CALL_REMOTELY_ABORTED,    /* - call aborted by peer */
 444         RXRPC_CALL_LOCALLY_ABORTED,     /* - call aborted locally on error or close */
 445         RXRPC_CALL_LOCAL_ERROR,         /* - call failed due to local error */
 446         RXRPC_CALL_NETWORK_ERROR,       /* - call terminated by network error */
 447         NR__RXRPC_CALL_COMPLETIONS
 448 };
 449
 450 /*
 451  * RxRPC call definition
 452  * - matched by { connection, call_id }
 453  */
 454 struct rxrpc_call {
 455         struct rcu_head         rcu;
 456         struct rxrpc_connection *conn;          /* connection carrying call */
 457         struct rxrpc_peer       *peer;          /* Peer record for remote address */
 458         struct rxrpc_sock __rcu *socket;        /* socket responsible */
 459         unsigned long           ack_at;         /* When deferred ACK needs to happen */
 460         unsigned long           resend_at;      /* When next resend needs to happen */
 461         unsigned long           expire_at;      /* When the call times out */
 462         struct timer_list       timer;          /* Combined event timer */
 463         struct work_struct      processor;      /* Event processor */
 464         rxrpc_notify_rx_t       notify_rx;      /* kernel service Rx notification function */
 465         struct list_head        link;           /* link in master call list */
 466         struct list_head        chan_wait_link; /* Link in conn->waiting_calls */
 467         struct hlist_node       error_link;     /* link in error distribution list */
 468         struct list_head        accept_link;    /* Link in rx->acceptq */
 469         struct list_head        recvmsg_link;   /* Link in rx->recvmsg_q */
 470         struct list_head        sock_link;      /* Link in rx->sock_calls */
 471         struct rb_node          sock_node;      /* Node in rx->calls */
 472         struct sk_buff          *tx_pending;    /* Tx socket buffer being filled */
 473         wait_queue_head_t       waitq;          /* Wait queue for channel or Tx */
 474         __be32                  crypto_buf[2];  /* Temporary packet crypto buffer */
 475         unsigned long           user_call_ID;   /* user-defined call ID */
 476         unsigned long           flags;
 477         unsigned long           events;
 478         spinlock_t              lock;
 479         rwlock_t                state_lock;     /* lock for state transition */
 480         u32                     abort_code;     /* Local/remote abort code */
 481         int                     error;          /* Local error incurred */
 482         enum rxrpc_call_state   state;          /* current state of call */
 483         enum rxrpc_call_completion completion;  /* Call completion condition */
 484         atomic_t                usage;
 485         u16                     service_id;     /* service ID */
 486         u8                      security_ix;    /* Security type */
 487         u32                     call_id;        /* call ID on connection  */
 488         u32                     cid;            /* connection ID plus channel index */
 489         int                     debug_id;       /* debug ID for printks */
 490
 491         /* Rx/Tx circular buffer, depending on phase.
 492          *
 493          * In the Rx phase, packets are annotated with 0 or the number of the
 494          * segment of a jumbo packet each buffer refers to.  There can be up to
 495          * 47 segments in a maximum-size UDP packet.
 496          *
 497          * In the Tx phase, packets are annotated with which buffers have been
 498          * acked.
 499          */
 500 #define RXRPC_RXTX_BUFF_SIZE    64
 501 #define RXRPC_RXTX_BUFF_MASK    (RXRPC_RXTX_BUFF_SIZE - 1)
 502 #define RXRPC_INIT_RX_WINDOW_SIZE 32
 503         struct sk_buff          **rxtx_buffer;
 504         u8                      *rxtx_annotations;
 505 #define RXRPC_TX_ANNO_ACK       0
 506 #define RXRPC_TX_ANNO_UNACK     1
 507 #define RXRPC_TX_ANNO_NAK       2
 508 #define RXRPC_TX_ANNO_RETRANS   3
 509 #define RXRPC_RX_ANNO_JUMBO     0x3f            /* Jumbo subpacket number + 1 if not zero */
 510 #define RXRPC_RX_ANNO_JLAST     0x40            /* Set if last element of a jumbo packet */
 511 #define RXRPC_RX_ANNO_VERIFIED  0x80            /* Set if verified and decrypted */
 512         rxrpc_seq_t             tx_hard_ack;    /* Dead slot in buffer; the first transmitted but
 513                                                  * not hard-ACK'd packet follows this.
 514                                                  */
 515         rxrpc_seq_t             tx_top;         /* Highest Tx slot allocated. */
 516         rxrpc_seq_t             rx_hard_ack;    /* Dead slot in buffer; the first received but not
 517                                                  * consumed packet follows this.
 518                                                  */
 519         rxrpc_seq_t             rx_top;         /* Highest Rx slot allocated. */
 520         rxrpc_seq_t             rx_expect_next; /* Expected next packet sequence number */
 521         u8                      rx_winsize;     /* Size of Rx window */
 522         u8                      tx_winsize;     /* Maximum size of Tx window */
 523         u8                      nr_jumbo_bad;   /* Number of jumbo dups/exceeds-windows */
 524
 525         /* receive-phase ACK management */
 526         u8                      ackr_reason;    /* reason to ACK */
 527         u16                     ackr_skew;      /* skew on packet being ACK'd */
 528         rxrpc_serial_t          ackr_serial;    /* serial of packet being ACK'd */
 529         rxrpc_seq_t             ackr_prev_seq;  /* previous sequence number received */
 530         unsigned short          rx_pkt_offset;  /* Current recvmsg packet offset */
 531         unsigned short          rx_pkt_len;     /* Current recvmsg packet len */
 532
 533         /* transmission-phase ACK management */
 534         rxrpc_serial_t          acks_latest;    /* serial number of latest ACK received */
 535 };
 536
 537 enum rxrpc_conn_trace {
 538         rxrpc_conn_new_client,
 539         rxrpc_conn_new_service,
 540         rxrpc_conn_queued,
 541         rxrpc_conn_seen,
 542         rxrpc_conn_got,
 543         rxrpc_conn_put_client,
 544         rxrpc_conn_put_service,
 545         rxrpc_conn__nr_trace
 546 };
 547
 548 extern const char rxrpc_conn_traces[rxrpc_conn__nr_trace][4];
 549
 550 enum rxrpc_client_trace {
 551         rxrpc_client_activate_chans,
 552         rxrpc_client_alloc,
 553         rxrpc_client_chan_activate,
 554         rxrpc_client_chan_disconnect,
 555         rxrpc_client_chan_pass,
 556         rxrpc_client_chan_unstarted,
 557         rxrpc_client_cleanup,
 558         rxrpc_client_count,
 559         rxrpc_client_discard,
 560         rxrpc_client_duplicate,
 561         rxrpc_client_exposed,
 562         rxrpc_client_replace,
 563         rxrpc_client_to_active,
 564         rxrpc_client_to_culled,
 565         rxrpc_client_to_idle,
 566         rxrpc_client_to_inactive,
 567         rxrpc_client_to_waiting,
 568         rxrpc_client_uncount,
 569         rxrpc_client__nr_trace
 570 };
 571
 572 extern const char rxrpc_client_traces[rxrpc_client__nr_trace][7];
 573 extern const char rxrpc_conn_cache_states[RXRPC_CONN__NR_CACHE_STATES][5];
 574
 575 enum rxrpc_call_trace {
 576         rxrpc_call_new_client,
 577         rxrpc_call_new_service,
 578         rxrpc_call_queued,
 579         rxrpc_call_queued_ref,
 580         rxrpc_call_seen,
 581         rxrpc_call_connected,
 582         rxrpc_call_release,
 583         rxrpc_call_got,
 584         rxrpc_call_got_userid,
 585         rxrpc_call_got_kernel,
 586         rxrpc_call_put,
 587         rxrpc_call_put_userid,
 588         rxrpc_call_put_kernel,
 589         rxrpc_call_put_noqueue,
 590         rxrpc_call_error,
 591         rxrpc_call__nr_trace
 592 };
 593
 594 extern const char rxrpc_call_traces[rxrpc_call__nr_trace][4];
 595
 596 enum rxrpc_transmit_trace {
 597         rxrpc_transmit_wait,
 598         rxrpc_transmit_queue,
 599         rxrpc_transmit_queue_reqack,
 600         rxrpc_transmit_queue_last,
 601         rxrpc_transmit_rotate,
 602         rxrpc_transmit_end,
 603         rxrpc_transmit__nr_trace
 604 };
 605
 606 extern const char rxrpc_transmit_traces[rxrpc_transmit__nr_trace][4];
 607
 608 enum rxrpc_receive_trace {
 609         rxrpc_receive_incoming,
 610         rxrpc_receive_queue,
 611         rxrpc_receive_queue_last,
 612         rxrpc_receive_front,
 613         rxrpc_receive_rotate,
 614         rxrpc_receive_end,
 615         rxrpc_receive__nr_trace
 616 };
 617
 618 extern const char rxrpc_receive_traces[rxrpc_receive__nr_trace][4];
 619
 620 extern const char *const rxrpc_pkts[];
 621 extern const char *rxrpc_acks(u8 reason);
 622
 623 #include <trace/events/rxrpc.h>
 624
 625 /*
 626  * af_rxrpc.c
 627  */
 628 extern atomic_t rxrpc_n_skbs;
 629 extern u32 rxrpc_epoch;
 630 extern atomic_t rxrpc_debug_id;
 631 extern struct workqueue_struct *rxrpc_workqueue;
 632
 633 /*
 634  * call_accept.c
 635  */
 636 int rxrpc_service_prealloc(struct rxrpc_sock *, gfp_t);
 637 void rxrpc_discard_prealloc(struct rxrpc_sock *);
 638 struct rxrpc_call *rxrpc_new_incoming_call(struct rxrpc_local *,
 639                                            struct rxrpc_connection *,
 640                                            struct sk_buff *);
 641 void rxrpc_accept_incoming_calls(struct rxrpc_local *);
 642 struct rxrpc_call *rxrpc_accept_call(struct rxrpc_sock *, unsigned long,
 643                                      rxrpc_notify_rx_t);
 644 int rxrpc_reject_call(struct rxrpc_sock *);
 645
 646 /*
 647  * call_event.c
 648  */
 649 void rxrpc_propose_ACK(struct rxrpc_call *, u8, u16, u32, bool, bool);
 650 void rxrpc_process_call(struct work_struct *);
 651
 652 /*
 653  * call_object.c
 654  */
 655 extern const char *const rxrpc_call_states[];
 656 extern const char *const rxrpc_call_completions[];
 657 extern unsigned int rxrpc_max_call_lifetime;
 658 extern struct kmem_cache *rxrpc_call_jar;
 659 extern struct list_head rxrpc_calls;
 660 extern rwlock_t rxrpc_call_lock;
 661
 662 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *, unsigned long);
 663 struct rxrpc_call *rxrpc_alloc_call(gfp_t);
 664 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *,
 665                                          struct rxrpc_conn_parameters *,
 666                                          struct sockaddr_rxrpc *,
 667                                          unsigned long, gfp_t);
 668 void rxrpc_incoming_call(struct rxrpc_sock *, struct rxrpc_call *,
 669                          struct sk_buff *);
 670 void rxrpc_release_call(struct rxrpc_sock *, struct rxrpc_call *);
 671 void rxrpc_release_calls_on_socket(struct rxrpc_sock *);
 672 bool __rxrpc_queue_call(struct rxrpc_call *);
 673 bool rxrpc_queue_call(struct rxrpc_call *);
 674 void rxrpc_see_call(struct rxrpc_call *);
 675 void rxrpc_get_call(struct rxrpc_call *, enum rxrpc_call_trace);
 676 void rxrpc_put_call(struct rxrpc_call *, enum rxrpc_call_trace);
 677 void rxrpc_cleanup_call(struct rxrpc_call *);
 678 void __exit rxrpc_destroy_all_calls(void);
 679
 680 static inline bool rxrpc_is_service_call(const struct rxrpc_call *call)
 681 {
 682         return test_bit(RXRPC_CALL_IS_SERVICE, &call->flags);
 683 }
 684
 685 static inline bool rxrpc_is_client_call(const struct rxrpc_call *call)
 686 {
 687         return !rxrpc_is_service_call(call);
 688 }
 689
 690 /*
 691  * Transition a call to the complete state.
 692  */
 693 static inline bool __rxrpc_set_call_completion(struct rxrpc_call *call,
 694                                                enum rxrpc_call_completion compl,
 695                                                u32 abort_code,
 696                                                int error)
 697 {
 698         if (call->state < RXRPC_CALL_COMPLETE) {
 699                 call->abort_code = abort_code;
 700                 call->error = error;
 701                 call->completion = compl,
 702                 call->state = RXRPC_CALL_COMPLETE;
 703                 return true;
 704         }
 705         return false;
 706 }
 707
 708 static inline bool rxrpc_set_call_completion(struct rxrpc_call *call,
 709                                              enum rxrpc_call_completion compl,
 710                                              u32 abort_code,
 711                                              int error)
 712 {
 713         bool ret;
 714
 715         write_lock_bh(&call->state_lock);
 716         ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
 717         write_unlock_bh(&call->state_lock);
 718         return ret;
 719 }
 720
 721 /*
 722  * Record that a call successfully completed.
 723  */
 724 static inline bool __rxrpc_call_completed(struct rxrpc_call *call)
 725 {
 726         return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
 727 }
 728
 729 static inline bool rxrpc_call_completed(struct rxrpc_call *call)
 730 {
 731         bool ret;
 732
 733         write_lock_bh(&call->state_lock);
 734         ret = __rxrpc_call_completed(call);
 735         write_unlock_bh(&call->state_lock);
 736         return ret;
 737 }
 738
 739 /*
 740  * Record that a call is locally aborted.
 741  */
 742 static inline bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
 743                                       rxrpc_seq_t seq,
 744                                       u32 abort_code, int error)
 745 {
 746         trace_rxrpc_abort(why, call->cid, call->call_id, seq,
 747                           abort_code, error);
 748         return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
 749                                            abort_code, error);
 750 }
 751
 752 static inline bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
 753                                     rxrpc_seq_t seq, u32 abort_code, int error)
 754 {
 755         bool ret;
 756
 757         write_lock_bh(&call->state_lock);
 758         ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
 759         write_unlock_bh(&call->state_lock);
 760         return ret;
 761 }
 762
 763 /*
 764  * conn_client.c
 765  */
 766 extern unsigned int rxrpc_max_client_connections;
 767 extern unsigned int rxrpc_reap_client_connections;
 768 extern unsigned int rxrpc_conn_idle_client_expiry;
 769 extern unsigned int rxrpc_conn_idle_client_fast_expiry;
 770 extern struct idr rxrpc_client_conn_ids;
 771
 772 void rxrpc_destroy_client_conn_ids(void);
 773 int rxrpc_connect_call(struct rxrpc_call *, struct rxrpc_conn_parameters *,
 774                        struct sockaddr_rxrpc *, gfp_t);
 775 void rxrpc_expose_client_call(struct rxrpc_call *);
 776 void rxrpc_disconnect_client_call(struct rxrpc_call *);
 777 void rxrpc_put_client_conn(struct rxrpc_connection *);
 778 void __exit rxrpc_destroy_all_client_connections(void);
 779
 780 /*
 781  * conn_event.c
 782  */
 783 void rxrpc_process_connection(struct work_struct *);
 784
 785 /*
 786  * conn_object.c
 787  */
 788 extern unsigned int rxrpc_connection_expiry;
 789 extern struct list_head rxrpc_connections;
 790 extern struct list_head rxrpc_connection_proc_list;
 791 extern rwlock_t rxrpc_connection_lock;
 792
 793 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
 794 struct rxrpc_connection *rxrpc_alloc_connection(gfp_t);
 795 struct rxrpc_connection *rxrpc_find_connection_rcu(struct rxrpc_local *,
 796                                                    struct sk_buff *);
 797 void __rxrpc_disconnect_call(struct rxrpc_connection *, struct rxrpc_call *);
 798 void rxrpc_disconnect_call(struct rxrpc_call *);
 799 void rxrpc_kill_connection(struct rxrpc_connection *);
 800 bool rxrpc_queue_conn(struct rxrpc_connection *);
 801 void rxrpc_see_connection(struct rxrpc_connection *);
 802 void rxrpc_get_connection(struct rxrpc_connection *);
 803 struct rxrpc_connection *rxrpc_get_connection_maybe(struct rxrpc_connection *);
 804 void rxrpc_put_service_conn(struct rxrpc_connection *);
 805 void __exit rxrpc_destroy_all_connections(void);
 806
 807 static inline bool rxrpc_conn_is_client(const struct rxrpc_connection *conn)
 808 {
 809         return conn->out_clientflag;
 810 }
 811
 812 static inline bool rxrpc_conn_is_service(const struct rxrpc_connection *conn)
 813 {
 814         return !rxrpc_conn_is_client(conn);
 815 }
 816
 817 static inline void rxrpc_put_connection(struct rxrpc_connection *conn)
 818 {
 819         if (!conn)
 820                 return;
 821
 822         if (rxrpc_conn_is_client(conn))
 823                 rxrpc_put_client_conn(conn);
 824         else
 825                 rxrpc_put_service_conn(conn);
 826 }
 827
 828 /*
 829  * conn_service.c
 830  */
 831 struct rxrpc_connection *rxrpc_find_service_conn_rcu(struct rxrpc_peer *,
 832                                                      struct sk_buff *);
 833 struct rxrpc_connection *rxrpc_prealloc_service_connection(gfp_t);
 834 void rxrpc_new_incoming_connection(struct rxrpc_connection *, struct sk_buff *);
 835 void rxrpc_unpublish_service_conn(struct rxrpc_connection *);
 836
 837 /*
 838  * input.c
 839  */
 840 void rxrpc_data_ready(struct sock *);
 841
 842 /*
 843  * insecure.c
 844  */
 845 extern const struct rxrpc_security rxrpc_no_security;
 846
 847 /*
 848  * key.c
 849  */
 850 extern struct key_type key_type_rxrpc;
 851 extern struct key_type key_type_rxrpc_s;
 852
 853 int rxrpc_request_key(struct rxrpc_sock *, char __user *, int);
 854 int rxrpc_server_keyring(struct rxrpc_sock *, char __user *, int);
 855 int rxrpc_get_server_data_key(struct rxrpc_connection *, const void *, time_t,
 856                               u32);
 857
 858 /*
 859  * local_event.c
 860  */
 861 extern void rxrpc_process_local_events(struct rxrpc_local *);
 862
 863 /*
 864  * local_object.c
 865  */
 866 struct rxrpc_local *rxrpc_lookup_local(const struct sockaddr_rxrpc *);
 867 void __rxrpc_put_local(struct rxrpc_local *);
 868 void __exit rxrpc_destroy_all_locals(void);
 869
 870 static inline void rxrpc_get_local(struct rxrpc_local *local)
 871 {
 872         atomic_inc(&local->usage);
 873 }
 874
 875 static inline
 876 struct rxrpc_local *rxrpc_get_local_maybe(struct rxrpc_local *local)
 877 {
 878         return atomic_inc_not_zero(&local->usage) ? local : NULL;
 879 }
 880
 881 static inline void rxrpc_put_local(struct rxrpc_local *local)
 882 {
 883         if (local && atomic_dec_and_test(&local->usage))
 884                 __rxrpc_put_local(local);
 885 }
 886
 887 static inline void rxrpc_queue_local(struct rxrpc_local *local)
 888 {
 889         rxrpc_queue_work(&local->processor);
 890 }
 891
 892 /*
 893  * misc.c
 894  */
 895 extern unsigned int rxrpc_max_backlog __read_mostly;
 896 extern unsigned int rxrpc_requested_ack_delay;
 897 extern unsigned int rxrpc_soft_ack_delay;
 898 extern unsigned int rxrpc_idle_ack_delay;
 899 extern unsigned int rxrpc_rx_window_size;
 900 extern unsigned int rxrpc_rx_mtu;
 901 extern unsigned int rxrpc_rx_jumbo_max;
 902 extern unsigned int rxrpc_resend_timeout;
 903
 904 extern const s8 rxrpc_ack_priority[];
 905
 906 /*
 907  * output.c
 908  */
 909 int rxrpc_send_call_packet(struct rxrpc_call *, u8);
 910 int rxrpc_send_data_packet(struct rxrpc_connection *, struct sk_buff *);
 911 void rxrpc_reject_packets(struct rxrpc_local *);
 912
 913 /*
 914  * peer_event.c
 915  */
 916 void rxrpc_error_report(struct sock *);
 917 void rxrpc_peer_error_distributor(struct work_struct *);
 918
 919 /*
 920  * peer_object.c
 921  */
 922 struct rxrpc_peer *rxrpc_lookup_peer_rcu(struct rxrpc_local *,
 923                                          const struct sockaddr_rxrpc *);
 924 struct rxrpc_peer *rxrpc_lookup_peer(struct rxrpc_local *,
 925                                      struct sockaddr_rxrpc *, gfp_t);
 926 struct rxrpc_peer *rxrpc_alloc_peer(struct rxrpc_local *, gfp_t);
 927 struct rxrpc_peer *rxrpc_lookup_incoming_peer(struct rxrpc_local *,
 928                                               struct rxrpc_peer *);
 929
 930 static inline struct rxrpc_peer *rxrpc_get_peer(struct rxrpc_peer *peer)
 931 {
 932         atomic_inc(&peer->usage);
 933         return peer;
 934 }
 935
 936 static inline
 937 struct rxrpc_peer *rxrpc_get_peer_maybe(struct rxrpc_peer *peer)
 938 {
 939         return atomic_inc_not_zero(&peer->usage) ? peer : NULL;
 940 }
 941
 942 extern void __rxrpc_put_peer(struct rxrpc_peer *peer);
 943 static inline void rxrpc_put_peer(struct rxrpc_peer *peer)
 944 {
 945         if (peer && atomic_dec_and_test(&peer->usage))
 946                 __rxrpc_put_peer(peer);
 947 }
 948
 949 /*
 950  * proc.c
 951  */
 952 extern const struct file_operations rxrpc_call_seq_fops;
 953 extern const struct file_operations rxrpc_connection_seq_fops;
 954
 955 /*
 956  * recvmsg.c
 957  */
 958 void rxrpc_notify_socket(struct rxrpc_call *);
 959 int rxrpc_recvmsg(struct socket *, struct msghdr *, size_t, int);
 960
 961 /*
 962  * rxkad.c
 963  */
 964 #ifdef CONFIG_RXKAD
 965 extern const struct rxrpc_security rxkad;
 966 #endif
 967
 968 /*
 969  * security.c
 970  */
 971 int __init rxrpc_init_security(void);
 972 void rxrpc_exit_security(void);
 973 int rxrpc_init_client_conn_security(struct rxrpc_connection *);
 974 int rxrpc_init_server_conn_security(struct rxrpc_connection *);
 975
 976 /*
 977  * sendmsg.c
 978  */
 979 int rxrpc_do_sendmsg(struct rxrpc_sock *, struct msghdr *, size_t);
 980
 981 /*
 982  * skbuff.c
 983  */
 984 void rxrpc_kernel_data_consumed(struct rxrpc_call *, struct sk_buff *);
 985 void rxrpc_packet_destructor(struct sk_buff *);
 986 void rxrpc_new_skb(struct sk_buff *);
 987 void rxrpc_see_skb(struct sk_buff *);
 988 void rxrpc_get_skb(struct sk_buff *);
 989 void rxrpc_free_skb(struct sk_buff *);
 990 void rxrpc_purge_queue(struct sk_buff_head *);
 991
 992 /*
 993  * sysctl.c
 994  */
 995 #ifdef CONFIG_SYSCTL
 996 extern int __init rxrpc_sysctl_init(void);
 997 extern void rxrpc_sysctl_exit(void);
 998 #else
 999 static inline int __init rxrpc_sysctl_init(void) { return 0; }
1000 static inline void rxrpc_sysctl_exit(void) {}
1001 #endif
1002
1003 /*
1004  * utils.c
1005  */
1006 int rxrpc_extract_addr_from_skb(struct sockaddr_rxrpc *, struct sk_buff *);
1007
1008 static inline bool before(u32 seq1, u32 seq2)
1009 {
1010         return (s32)(seq1 - seq2) < 0;
1011 }
1012 static inline bool before_eq(u32 seq1, u32 seq2)
1013 {
1014         return (s32)(seq1 - seq2) <= 0;
1015 }
1016 static inline bool after(u32 seq1, u32 seq2)
1017 {
1018         return (s32)(seq1 - seq2) > 0;
1019 }
1020 static inline bool after_eq(u32 seq1, u32 seq2)
1021 {
1022         return (s32)(seq1 - seq2) >= 0;
1023 }
1024
1025 /*
1026  * debug tracing
1027  */
1028 extern unsigned int rxrpc_debug;
1029
1030 #define dbgprintk(FMT,...) \
1031         printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1032
1033 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1034 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1035 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
1036 #define kproto(FMT,...) dbgprintk("### "FMT ,##__VA_ARGS__)
1037 #define knet(FMT,...)   dbgprintk("@@@ "FMT ,##__VA_ARGS__)
1038
1039
1040 #if defined(__KDEBUG)
1041 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
1042 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
1043 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
1044 #define _proto(FMT,...) kproto(FMT,##__VA_ARGS__)
1045 #define _net(FMT,...)   knet(FMT,##__VA_ARGS__)
1046
1047 #elif defined(CONFIG_AF_RXRPC_DEBUG)
1048 #define RXRPC_DEBUG_KENTER      0x01
1049 #define RXRPC_DEBUG_KLEAVE      0x02
1050 #define RXRPC_DEBUG_KDEBUG      0x04
1051 #define RXRPC_DEBUG_KPROTO      0x08
1052 #define RXRPC_DEBUG_KNET        0x10
1053
1054 #define _enter(FMT,...)                                 \
1055 do {                                                    \
1056         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KENTER)) \
1057                 kenter(FMT,##__VA_ARGS__);              \
1058 } while (0)
1059
1060 #define _leave(FMT,...)                                 \
1061 do {                                                    \
1062         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KLEAVE)) \
1063                 kleave(FMT,##__VA_ARGS__);              \
1064 } while (0)
1065
1066 #define _debug(FMT,...)                                 \
1067 do {                                                    \
1068         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KDEBUG)) \
1069                 kdebug(FMT,##__VA_ARGS__);              \
1070 } while (0)
1071
1072 #define _proto(FMT,...)                                 \
1073 do {                                                    \
1074         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KPROTO)) \
1075                 kproto(FMT,##__VA_ARGS__);              \
1076 } while (0)
1077
1078 #define _net(FMT,...)                                   \
1079 do {                                                    \
1080         if (unlikely(rxrpc_debug & RXRPC_DEBUG_KNET))   \
1081                 knet(FMT,##__VA_ARGS__);                \
1082 } while (0)
1083
1084 #else
1085 #define _enter(FMT,...) no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1086 #define _leave(FMT,...) no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1087 #define _debug(FMT,...) no_printk("    "FMT ,##__VA_ARGS__)
1088 #define _proto(FMT,...) no_printk("### "FMT ,##__VA_ARGS__)
1089 #define _net(FMT,...)   no_printk("@@@ "FMT ,##__VA_ARGS__)
1090 #endif
1091
1092 /*
1093  * debug assertion checking
1094  */
1095 #if 1 // defined(__KDEBUGALL)
1096
1097 #define ASSERT(X)                                               \
1098 do {                                                            \
1099         if (unlikely(!(X))) {                                   \
1100                 pr_err("Assertion failed\n");                   \
1101                 BUG();                                          \
1102         }                                                       \
1103 } while (0)
1104
1105 #define ASSERTCMP(X, OP, Y)                                             \
1106 do {                                                                    \
1107         __typeof__(X) _x = (X);                                         \
1108         __typeof__(Y) _y = (__typeof__(X))(Y);                          \
1109         if (unlikely(!(_x OP _y))) {                                    \
1110                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1111                        (unsigned long)_x, (unsigned long)_x, #OP,       \
1112                        (unsigned long)_y, (unsigned long)_y);           \
1113                 BUG();                                                  \
1114         }                                                               \
1115 } while (0)
1116
1117 #define ASSERTIF(C, X)                                          \
1118 do {                                                            \
1119         if (unlikely((C) && !(X))) {                            \
1120                 pr_err("Assertion failed\n");                   \
1121                 BUG();                                          \
1122         }                                                       \
1123 } while (0)
1124
1125 #define ASSERTIFCMP(C, X, OP, Y)                                        \
1126 do {                                                                    \
1127         __typeof__(X) _x = (X);                                         \
1128         __typeof__(Y) _y = (__typeof__(X))(Y);                          \
1129         if (unlikely((C) && !(_x OP _y))) {                             \
1130                 pr_err("Assertion failed - %lu(0x%lx) %s %lu(0x%lx) is false\n", \
1131                        (unsigned long)_x, (unsigned long)_x, #OP,       \
1132                        (unsigned long)_y, (unsigned long)_y);           \
1133                 BUG();                                                  \
1134         }                                                               \
1135 } while (0)
1136
1137 #else
1138
1139 #define ASSERT(X)                               \
1140 do {                                            \
1141 } while (0)
1142
1143 #define ASSERTCMP(X, OP, Y)                     \
1144 do {                                            \
1145 } while (0)
1146
1147 #define ASSERTIF(C, X)                          \
1148 do {                                            \
1149 } while (0)
1150
1151 #define ASSERTIFCMP(C, X, OP, Y)                \
1152 do {                                            \
1153 } while (0)
1154
1155 #endif /* __KDEBUGALL */