include/linux/sunrpc/rpc_rdma.h

   1 /*
   2  * Copyright (c) 2003-2007 Network Appliance, Inc. All rights reserved.
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the BSD-type
   8  * license below:
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  *
  14  *      Redistributions of source code must retain the above copyright
  15  *      notice, this list of conditions and the following disclaimer.
  16  *
  17  *      Redistributions in binary form must reproduce the above
  18  *      copyright notice, this list of conditions and the following
  19  *      disclaimer in the documentation and/or other materials provided
  20  *      with the distribution.
  21  *
  22  *      Neither the name of the Network Appliance, Inc. nor the names of
  23  *      its contributors may be used to endorse or promote products
  24  *      derived from this software without specific prior written
  25  *      permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  */
  39
  40 #ifndef _LINUX_SUNRPC_RPC_RDMA_H
  41 #define _LINUX_SUNRPC_RPC_RDMA_H
  42
  43 #include <linux/types.h>
  44 #include <linux/bitops.h>
  45
  46 #define RPCRDMA_VERSION         1
  47 #define rpcrdma_version         cpu_to_be32(RPCRDMA_VERSION)
  48
  49 struct rpcrdma_segment {
  50         __be32 rs_handle;       /* Registered memory handle */
  51         __be32 rs_length;       /* Length of the chunk in bytes */
  52         __be64 rs_offset;       /* Chunk virtual address or offset */
  53 };
  54
  55 /*
  56  * read chunk(s), encoded as a linked list.
  57  */
  58 struct rpcrdma_read_chunk {
  59         __be32 rc_discrim;      /* 1 indicates presence */
  60         __be32 rc_position;     /* Position in XDR stream */
  61         struct rpcrdma_segment rc_target;
  62 };
  63
  64 /*
  65  * write chunk, and reply chunk.
  66  */
  67 struct rpcrdma_write_chunk {
  68         struct rpcrdma_segment wc_target;
  69 };
  70
  71 /*
  72  * write chunk(s), encoded as a counted array.
  73  */
  74 struct rpcrdma_write_array {
  75         __be32 wc_discrim;      /* 1 indicates presence */
  76         __be32 wc_nchunks;      /* Array count */
  77         struct rpcrdma_write_chunk wc_array[0];
  78 };
  79
  80 struct rpcrdma_msg {
  81         __be32 rm_xid;  /* Mirrors the RPC header xid */
  82         __be32 rm_vers; /* Version of this protocol */
  83         __be32 rm_credit;       /* Buffers requested/granted */
  84         __be32 rm_type; /* Type of message (enum rpcrdma_proc) */
  85         union {
  86
  87                 struct {                        /* no chunks */
  88                         __be32 rm_empty[3];     /* 3 empty chunk lists */
  89                 } rm_nochunks;
  90
  91                 struct {                        /* no chunks and padded */
  92                         __be32 rm_align;        /* Padding alignment */
  93                         __be32 rm_thresh;       /* Padding threshold */
  94                         __be32 rm_pempty[3];    /* 3 empty chunk lists */
  95                 } rm_padded;
  96
  97                 struct {
  98                         __be32 rm_err;
  99                         __be32 rm_vers_low;
 100                         __be32 rm_vers_high;
 101                 } rm_error;
 102
 103                 __be32 rm_chunks[0];    /* read, write and reply chunks */
 104
 105         } rm_body;
 106 };
 107
 108 /*
 109  * Smallest RPC/RDMA header: rm_xid through rm_type, then rm_nochunks
 110  */
 111 #define RPCRDMA_HDRLEN_MIN      (sizeof(__be32) * 7)
 112 #define RPCRDMA_HDRLEN_ERR      (sizeof(__be32) * 5)
 113
 114 enum rpcrdma_errcode {
 115         ERR_VERS = 1,
 116         ERR_CHUNK = 2
 117 };
 118
 119 enum rpcrdma_proc {
 120         RDMA_MSG = 0,           /* An RPC call or reply msg */
 121         RDMA_NOMSG = 1,         /* An RPC call or reply msg - separate body */
 122         RDMA_MSGP = 2,          /* An RPC call or reply msg with padding */
 123         RDMA_DONE = 3,          /* Client signals reply completion */
 124         RDMA_ERROR = 4          /* An RPC RDMA encoding error */
 125 };
 126
 127 #define rdma_msg        cpu_to_be32(RDMA_MSG)
 128 #define rdma_nomsg      cpu_to_be32(RDMA_NOMSG)
 129 #define rdma_msgp       cpu_to_be32(RDMA_MSGP)
 130 #define rdma_done       cpu_to_be32(RDMA_DONE)
 131 #define rdma_error      cpu_to_be32(RDMA_ERROR)
 132
 133 /*
 134  * Private extension to RPC-over-RDMA Version One.
 135  * Message passed during RDMA-CM connection set-up.
 136  *
 137  * Add new fields at the end, and don't permute existing
 138  * fields.
 139  */
 140 struct rpcrdma_connect_private {
 141         __be32                  cp_magic;
 142         u8                      cp_version;
 143         u8                      cp_flags;
 144         u8                      cp_send_size;
 145         u8                      cp_recv_size;
 146 } __packed;
 147
 148 #define rpcrdma_cmp_magic       __cpu_to_be32(0xf6ab0e18)
 149
 150 enum {
 151         RPCRDMA_CMP_VERSION             = 1,
 152         RPCRDMA_CMP_F_SND_W_INV_OK      = BIT(0),
 153 };
 154
 155 static inline u8
 156 rpcrdma_encode_buffer_size(unsigned int size)
 157 {
 158         return (size >> 10) - 1;
 159 }
 160
 161 static inline unsigned int
 162 rpcrdma_decode_buffer_size(u8 val)
 163 {
 164         return ((unsigned int)val + 1) << 10;
 165 }
 166
 167 #endif                          /* _LINUX_SUNRPC_RPC_RDMA_H */