include/linux/sunrpc/xprt.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  *  linux/include/linux/sunrpc/xprt.h
   4  *
   5  *  Declarations for the RPC transport interface.
   6  *
   7  *  Copyright (C) 1995, 1996 Olaf Kirch <[email protected]>
   8  */
   9
  10 #ifndef _LINUX_SUNRPC_XPRT_H
  11 #define _LINUX_SUNRPC_XPRT_H
  12
  13 #include <linux/uio.h>
  14 #include <linux/socket.h>
  15 #include <linux/in.h>
  16 #include <linux/ktime.h>
  17 #include <linux/kref.h>
  18 #include <linux/sunrpc/sched.h>
  19 #include <linux/sunrpc/xdr.h>
  20 #include <linux/sunrpc/msg_prot.h>
  21
  22 #ifdef __KERNEL__
  23
  24 #define RPC_MIN_SLOT_TABLE      (2U)
  25 #define RPC_DEF_SLOT_TABLE      (16U)
  26 #define RPC_MAX_SLOT_TABLE_LIMIT        (65536U)
  27 #define RPC_MAX_SLOT_TABLE      RPC_MAX_SLOT_TABLE_LIMIT
  28
  29 #define RPC_CWNDSHIFT           (8U)
  30 #define RPC_CWNDSCALE           (1U << RPC_CWNDSHIFT)
  31 #define RPC_INITCWND            RPC_CWNDSCALE
  32 #define RPC_MAXCWND(xprt)       ((xprt)->max_reqs << RPC_CWNDSHIFT)
  33 #define RPCXPRT_CONGESTED(xprt) ((xprt)->cong >= (xprt)->cwnd)
  34
  35 /*
  36  * This describes a timeout strategy
  37  */
  38 struct rpc_timeout {
  39         unsigned long           to_initval,             /* initial timeout */
  40                                 to_maxval,              /* max timeout */
  41                                 to_increment;           /* if !exponential */
  42         unsigned int            to_retries;             /* max # of retries */
  43         unsigned char           to_exponential;
  44 };
  45
  46 enum rpc_display_format_t {
  47         RPC_DISPLAY_ADDR = 0,
  48         RPC_DISPLAY_PORT,
  49         RPC_DISPLAY_PROTO,
  50         RPC_DISPLAY_HEX_ADDR,
  51         RPC_DISPLAY_HEX_PORT,
  52         RPC_DISPLAY_NETID,
  53         RPC_DISPLAY_MAX,
  54 };
  55
  56 struct rpc_task;
  57 struct rpc_xprt;
  58 struct seq_file;
  59 struct svc_serv;
  60 struct net;
  61
  62 /*
  63  * This describes a complete RPC request
  64  */
  65 struct rpc_rqst {
  66         /*
  67          * This is the user-visible part
  68          */
  69         struct rpc_xprt *       rq_xprt;                /* RPC client */
  70         struct xdr_buf          rq_snd_buf;             /* send buffer */
  71         struct xdr_buf          rq_rcv_buf;             /* recv buffer */
  72
  73         /*
  74          * This is the private part
  75          */
  76         struct rpc_task *       rq_task;        /* RPC task data */
  77         struct rpc_cred *       rq_cred;        /* Bound cred */
  78         __be32                  rq_xid;         /* request XID */
  79         int                     rq_cong;        /* has incremented xprt->cong */
  80         u32                     rq_seqno;       /* gss seq no. used on req. */
  81         int                     rq_enc_pages_num;
  82         struct page             **rq_enc_pages; /* scratch pages for use by
  83                                                    gss privacy code */
  84         void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
  85
  86         union {
  87                 struct list_head        rq_list;        /* Slot allocation list */
  88                 struct rb_node          rq_recv;        /* Receive queue */
  89         };
  90
  91         struct list_head        rq_xmit;        /* Send queue */
  92         struct list_head        rq_xmit2;       /* Send queue */
  93
  94         void                    *rq_buffer;     /* Call XDR encode buffer */
  95         size_t                  rq_callsize;
  96         void                    *rq_rbuffer;    /* Reply XDR decode buffer */
  97         size_t                  rq_rcvsize;
  98         size_t                  rq_xmit_bytes_sent;     /* total bytes sent */
  99         size_t                  rq_reply_bytes_recvd;   /* total reply bytes */
 100                                                         /* received */
 101
 102         struct xdr_buf          rq_private_buf;         /* The receive buffer
 103                                                          * used in the softirq.
 104                                                          */
 105         unsigned long           rq_majortimeo;  /* major timeout alarm */
 106         unsigned long           rq_timeout;     /* Current timeout value */
 107         ktime_t                 rq_rtt;         /* round-trip time */
 108         unsigned int            rq_retries;     /* # of retries */
 109         unsigned int            rq_connect_cookie;
 110                                                 /* A cookie used to track the
 111                                                    state of the transport
 112                                                    connection */
 113         atomic_t                rq_pin;
 114
 115         /*
 116          * Partial send handling
 117          */
 118         u32                     rq_bytes_sent;  /* Bytes we have sent */
 119
 120         ktime_t                 rq_xtime;       /* transmit time stamp */
 121         int                     rq_ntrans;
 122
 123 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
 124         struct list_head        rq_bc_list;     /* Callback service list */
 125         unsigned long           rq_bc_pa_state; /* Backchannel prealloc state */
 126         struct list_head        rq_bc_pa_list;  /* Backchannel prealloc list */
 127 #endif /* CONFIG_SUNRPC_BACKCHANEL */
 128 };
 129 #define rq_svec                 rq_snd_buf.head
 130 #define rq_slen                 rq_snd_buf.len
 131
 132 struct rpc_xprt_ops {
 133         void            (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
 134         int             (*reserve_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
 135         void            (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
 136         void            (*alloc_slot)(struct rpc_xprt *xprt, struct rpc_task *task);
 137         void            (*free_slot)(struct rpc_xprt *xprt,
 138                                      struct rpc_rqst *req);
 139         void            (*rpcbind)(struct rpc_task *task);
 140         void            (*set_port)(struct rpc_xprt *xprt, unsigned short port);
 141         void            (*connect)(struct rpc_xprt *xprt, struct rpc_task *task);
 142         int             (*buf_alloc)(struct rpc_task *task);
 143         void            (*buf_free)(struct rpc_task *task);
 144         void            (*prepare_request)(struct rpc_rqst *req);
 145         int             (*send_request)(struct rpc_rqst *req);
 146         void            (*wait_for_reply_request)(struct rpc_task *task);
 147         void            (*timer)(struct rpc_xprt *xprt, struct rpc_task *task);
 148         void            (*release_request)(struct rpc_task *task);
 149         void            (*close)(struct rpc_xprt *xprt);
 150         void            (*destroy)(struct rpc_xprt *xprt);
 151         void            (*set_connect_timeout)(struct rpc_xprt *xprt,
 152                                         unsigned long connect_timeout,
 153                                         unsigned long reconnect_timeout);
 154         void            (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
 155         int             (*enable_swap)(struct rpc_xprt *xprt);
 156         void            (*disable_swap)(struct rpc_xprt *xprt);
 157         void            (*inject_disconnect)(struct rpc_xprt *xprt);
 158         int             (*bc_setup)(struct rpc_xprt *xprt,
 159                                     unsigned int min_reqs);
 160         size_t          (*bc_maxpayload)(struct rpc_xprt *xprt);
 161         void            (*bc_free_rqst)(struct rpc_rqst *rqst);
 162         void            (*bc_destroy)(struct rpc_xprt *xprt,
 163                                       unsigned int max_reqs);
 164 };
 165
 166 /*
 167  * RPC transport identifiers
 168  *
 169  * To preserve compatibility with the historical use of raw IP protocol
 170  * id's for transport selection, UDP and TCP identifiers are specified
 171  * with the previous values. No such restriction exists for new transports,
 172  * except that they may not collide with these values (17 and 6,
 173  * respectively).
 174  */
 175 #define XPRT_TRANSPORT_BC       (1 << 31)
 176 enum xprt_transports {
 177         XPRT_TRANSPORT_UDP      = IPPROTO_UDP,
 178         XPRT_TRANSPORT_TCP      = IPPROTO_TCP,
 179         XPRT_TRANSPORT_BC_TCP   = IPPROTO_TCP | XPRT_TRANSPORT_BC,
 180         XPRT_TRANSPORT_RDMA     = 256,
 181         XPRT_TRANSPORT_BC_RDMA  = XPRT_TRANSPORT_RDMA | XPRT_TRANSPORT_BC,
 182         XPRT_TRANSPORT_LOCAL    = 257,
 183 };
 184
 185 struct rpc_xprt {
 186         struct kref             kref;           /* Reference count */
 187         const struct rpc_xprt_ops *ops;         /* transport methods */
 188
 189         const struct rpc_timeout *timeout;      /* timeout parms */
 190         struct sockaddr_storage addr;           /* server address */
 191         size_t                  addrlen;        /* size of server address */
 192         int                     prot;           /* IP protocol */
 193
 194         unsigned long           cong;           /* current congestion */
 195         unsigned long           cwnd;           /* congestion window */
 196
 197         size_t                  max_payload;    /* largest RPC payload size,
 198                                                    in bytes */
 199
 200         struct rpc_wait_queue   binding;        /* requests waiting on rpcbind */
 201         struct rpc_wait_queue   sending;        /* requests waiting to send */
 202         struct rpc_wait_queue   pending;        /* requests in flight */
 203         struct rpc_wait_queue   backlog;        /* waiting for slot */
 204         struct list_head        free;           /* free slots */
 205         unsigned int            max_reqs;       /* max number of slots */
 206         unsigned int            min_reqs;       /* min number of slots */
 207         unsigned int            num_reqs;       /* total slots */
 208         unsigned long           state;          /* transport state */
 209         unsigned char           resvport   : 1; /* use a reserved port */
 210         atomic_t                swapper;        /* we're swapping over this
 211                                                    transport */
 212         unsigned int            bind_index;     /* bind function index */
 213
 214         /*
 215          * Multipath
 216          */
 217         struct list_head        xprt_switch;
 218
 219         /*
 220          * Connection of transports
 221          */
 222         unsigned long           bind_timeout,
 223                                 reestablish_timeout;
 224         unsigned int            connect_cookie; /* A cookie that gets bumped
 225                                                    every time the transport
 226                                                    is reconnected */
 227
 228         /*
 229          * Disconnection of idle transports
 230          */
 231         struct work_struct      task_cleanup;
 232         struct timer_list       timer;
 233         unsigned long           last_used,
 234                                 idle_timeout,
 235                                 connect_timeout,
 236                                 max_reconnect_timeout;
 237
 238         /*
 239          * Send stuff
 240          */
 241         spinlock_t              transport_lock; /* lock transport info */
 242         spinlock_t              reserve_lock;   /* lock slot table */
 243         spinlock_t              queue_lock;     /* send/receive queue lock */
 244         u32                     xid;            /* Next XID value to use */
 245         struct rpc_task *       snd_task;       /* Task blocked in send */
 246
 247         struct list_head        xmit_queue;     /* Send queue */
 248
 249         struct svc_xprt         *bc_xprt;       /* NFSv4.1 backchannel */
 250 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
 251         struct svc_serv         *bc_serv;       /* The RPC service which will */
 252                                                 /* process the callback */
 253         int                     bc_alloc_count; /* Total number of preallocs */
 254         atomic_t                bc_free_slots;
 255         spinlock_t              bc_pa_lock;     /* Protects the preallocated
 256                                                  * items */
 257         struct list_head        bc_pa_list;     /* List of preallocated
 258                                                  * backchannel rpc_rqst's */
 259 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
 260
 261         struct rb_root          recv_queue;     /* Receive queue */
 262
 263         struct {
 264                 unsigned long           bind_count,     /* total number of binds */
 265                                         connect_count,  /* total number of connects */
 266                                         connect_start,  /* connect start timestamp */
 267                                         connect_time,   /* jiffies waiting for connect */
 268                                         sends,          /* how many complete requests */
 269                                         recvs,          /* how many complete requests */
 270                                         bad_xids,       /* lookup_rqst didn't find XID */
 271                                         max_slots;      /* max rpc_slots used */
 272
 273                 unsigned long long      req_u,          /* average requests on the wire */
 274                                         bklog_u,        /* backlog queue utilization */
 275                                         sending_u,      /* send q utilization */
 276                                         pending_u;      /* pend q utilization */
 277         } stat;
 278
 279         struct net              *xprt_net;
 280         const char              *servername;
 281         const char              *address_strings[RPC_DISPLAY_MAX];
 282 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
 283         struct dentry           *debugfs;               /* debugfs directory */
 284         atomic_t                inject_disconnect;
 285 #endif
 286         struct rcu_head         rcu;
 287 };
 288
 289 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
 290 /*
 291  * Backchannel flags
 292  */
 293 #define RPC_BC_PA_IN_USE        0x0001          /* Preallocated backchannel */
 294                                                 /* buffer in use */
 295 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
 296
 297 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
 298 static inline int bc_prealloc(struct rpc_rqst *req)
 299 {
 300         return test_bit(RPC_BC_PA_IN_USE, &req->rq_bc_pa_state);
 301 }
 302 #else
 303 static inline int bc_prealloc(struct rpc_rqst *req)
 304 {
 305         return 0;
 306 }
 307 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
 308
 309 #define XPRT_CREATE_INFINITE_SLOTS      (1U)
 310 #define XPRT_CREATE_NO_IDLE_TIMEOUT     (1U << 1)
 311
 312 struct xprt_create {
 313         int                     ident;          /* XPRT_TRANSPORT identifier */
 314         struct net *            net;
 315         struct sockaddr *       srcaddr;        /* optional local address */
 316         struct sockaddr *       dstaddr;        /* remote peer address */
 317         size_t                  addrlen;
 318         const char              *servername;
 319         struct svc_xprt         *bc_xprt;       /* NFSv4.1 backchannel */
 320         struct rpc_xprt_switch  *bc_xps;
 321         unsigned int            flags;
 322 };
 323
 324 struct xprt_class {
 325         struct list_head        list;
 326         int                     ident;          /* XPRT_TRANSPORT identifier */
 327         struct rpc_xprt *       (*setup)(struct xprt_create *);
 328         struct module           *owner;
 329         char                    name[32];
 330 };
 331
 332 /*
 333  * Generic internal transport functions
 334  */
 335 struct rpc_xprt         *xprt_create_transport(struct xprt_create *args);
 336 void                    xprt_connect(struct rpc_task *task);
 337 void                    xprt_reserve(struct rpc_task *task);
 338 void                    xprt_retry_reserve(struct rpc_task *task);
 339 int                     xprt_reserve_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
 340 int                     xprt_reserve_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
 341 void                    xprt_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task);
 342 void                    xprt_free_slot(struct rpc_xprt *xprt,
 343                                        struct rpc_rqst *req);
 344 void                    xprt_request_prepare(struct rpc_rqst *req);
 345 bool                    xprt_prepare_transmit(struct rpc_task *task);
 346 void                    xprt_request_enqueue_transmit(struct rpc_task *task);
 347 void                    xprt_request_enqueue_receive(struct rpc_task *task);
 348 void                    xprt_request_wait_receive(struct rpc_task *task);
 349 bool                    xprt_request_need_retransmit(struct rpc_task *task);
 350 void                    xprt_transmit(struct rpc_task *task);
 351 void                    xprt_end_transmit(struct rpc_task *task);
 352 int                     xprt_adjust_timeout(struct rpc_rqst *req);
 353 void                    xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
 354 void                    xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
 355 void                    xprt_release(struct rpc_task *task);
 356 struct rpc_xprt *       xprt_get(struct rpc_xprt *xprt);
 357 void                    xprt_put(struct rpc_xprt *xprt);
 358 struct rpc_xprt *       xprt_alloc(struct net *net, size_t size,
 359                                 unsigned int num_prealloc,
 360                                 unsigned int max_req);
 361 void                    xprt_free(struct rpc_xprt *);
 362
 363 static inline int
 364 xprt_enable_swap(struct rpc_xprt *xprt)
 365 {
 366         return xprt->ops->enable_swap(xprt);
 367 }
 368
 369 static inline void
 370 xprt_disable_swap(struct rpc_xprt *xprt)
 371 {
 372         xprt->ops->disable_swap(xprt);
 373 }
 374
 375 /*
 376  * Transport switch helper functions
 377  */
 378 int                     xprt_register_transport(struct xprt_class *type);
 379 int                     xprt_unregister_transport(struct xprt_class *type);
 380 int                     xprt_load_transport(const char *);
 381 void                    xprt_wait_for_reply_request_def(struct rpc_task *task);
 382 void                    xprt_wait_for_reply_request_rtt(struct rpc_task *task);
 383 void                    xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
 384 void                    xprt_wait_for_buffer_space(struct rpc_xprt *xprt);
 385 bool                    xprt_write_space(struct rpc_xprt *xprt);
 386 void                    xprt_adjust_cwnd(struct rpc_xprt *xprt, struct rpc_task *task, int result);
 387 struct rpc_rqst *       xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
 388 void                    xprt_update_rtt(struct rpc_task *task);
 389 void                    xprt_complete_rqst(struct rpc_task *task, int copied);
 390 void                    xprt_pin_rqst(struct rpc_rqst *req);
 391 void                    xprt_unpin_rqst(struct rpc_rqst *req);
 392 void                    xprt_release_rqst_cong(struct rpc_task *task);
 393 bool                    xprt_request_get_cong(struct rpc_xprt *xprt, struct rpc_rqst *req);
 394 void                    xprt_disconnect_done(struct rpc_xprt *xprt);
 395 void                    xprt_force_disconnect(struct rpc_xprt *xprt);
 396 void                    xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie);
 397
 398 bool                    xprt_lock_connect(struct rpc_xprt *, struct rpc_task *, void *);
 399 void                    xprt_unlock_connect(struct rpc_xprt *, void *);
 400
 401 /*
 402  * Reserved bit positions in xprt->state
 403  */
 404 #define XPRT_LOCKED             (0)
 405 #define XPRT_CONNECTED          (1)
 406 #define XPRT_CONNECTING         (2)
 407 #define XPRT_CLOSE_WAIT         (3)
 408 #define XPRT_BOUND              (4)
 409 #define XPRT_BINDING            (5)
 410 #define XPRT_CLOSING            (6)
 411 #define XPRT_CONGESTED          (9)
 412 #define XPRT_CWND_WAIT          (10)
 413 #define XPRT_WRITE_SPACE        (11)
 414
 415 static inline void xprt_set_connected(struct rpc_xprt *xprt)
 416 {
 417         set_bit(XPRT_CONNECTED, &xprt->state);
 418 }
 419
 420 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
 421 {
 422         clear_bit(XPRT_CONNECTED, &xprt->state);
 423 }
 424
 425 static inline int xprt_connected(struct rpc_xprt *xprt)
 426 {
 427         return test_bit(XPRT_CONNECTED, &xprt->state);
 428 }
 429
 430 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
 431 {
 432         return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
 433 }
 434
 435 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
 436 {
 437         return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
 438 }
 439
 440 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
 441 {
 442         smp_mb__before_atomic();
 443         clear_bit(XPRT_CONNECTING, &xprt->state);
 444         smp_mb__after_atomic();
 445 }
 446
 447 static inline int xprt_connecting(struct rpc_xprt *xprt)
 448 {
 449         return test_bit(XPRT_CONNECTING, &xprt->state);
 450 }
 451
 452 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
 453 {
 454         return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
 455 }
 456
 457 static inline void xprt_set_bound(struct rpc_xprt *xprt)
 458 {
 459         test_and_set_bit(XPRT_BOUND, &xprt->state);
 460 }
 461
 462 static inline int xprt_bound(struct rpc_xprt *xprt)
 463 {
 464         return test_bit(XPRT_BOUND, &xprt->state);
 465 }
 466
 467 static inline void xprt_clear_bound(struct rpc_xprt *xprt)
 468 {
 469         clear_bit(XPRT_BOUND, &xprt->state);
 470 }
 471
 472 static inline void xprt_clear_binding(struct rpc_xprt *xprt)
 473 {
 474         smp_mb__before_atomic();
 475         clear_bit(XPRT_BINDING, &xprt->state);
 476         smp_mb__after_atomic();
 477 }
 478
 479 static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
 480 {
 481         return test_and_set_bit(XPRT_BINDING, &xprt->state);
 482 }
 483
 484 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
 485 extern unsigned int rpc_inject_disconnect;
 486 static inline void xprt_inject_disconnect(struct rpc_xprt *xprt)
 487 {
 488         if (!rpc_inject_disconnect)
 489                 return;
 490         if (atomic_dec_return(&xprt->inject_disconnect))
 491                 return;
 492         atomic_set(&xprt->inject_disconnect, rpc_inject_disconnect);
 493         xprt->ops->inject_disconnect(xprt);
 494 }
 495 #else
 496 static inline void xprt_inject_disconnect(struct rpc_xprt *xprt)
 497 {
 498 }
 499 #endif
 500
 501 #endif /* __KERNEL__*/
 502
 503 #endif /* _LINUX_SUNRPC_XPRT_H */