components/open-fabrics/libibverbs/patches/004-libibverbs-man-changes-for-no-xrc.patch
changeset 7865 22ec3267b2a3
parent 7864 f11e8d81786a
child 7875 fdce0f6fd2bd
equal deleted inserted replaced
7864:f11e8d81786a 7865:22ec3267b2a3
     1 #This patch was developed both in-house and from outside. We plan to submit it
       
     2 #upstream, but do not yet have a target date for doing so
       
     3 #
       
     4 # HG changeset patch
       
     5 # Parent  3903116dd520bb552df4e8fa55f573d1cb9b9097
       
     6 remove xrc man pages
       
     7 
       
     8 diff -r 3903116dd520 Makefile.am
       
     9 --- a/Makefile.am	Wed Jan 13 09:20:30 2016 -0800
       
    10 +++ b/Makefile.am	Wed Jan 13 09:32:13 2016 -0800
       
    11 @@ -63,8 +63,7 @@
       
    12      man/ibv_query_pkey.3 man/ibv_query_port.3 man/ibv_query_qp.3	\
       
    13      man/ibv_query_srq.3 man/ibv_rate_to_mult.3 man/ibv_reg_mr.3		\
       
    14      man/ibv_req_notify_cq.3 man/ibv_resize_cq.3 man/ibv_rate_to_mbps.3  \
       
    15 -    man/ibv_create_qp_ex.3 man/ibv_create_srq_ex.3 man/ibv_open_xrcd.3  \
       
    16 -    man/ibv_get_srq_num.3 man/ibv_open_qp.3
       
    17 +    man/ibv_open_xrcd.3 man/ibv_open_qp.3
       
    18  
       
    19  DEBIAN = debian/changelog debian/compat debian/control debian/copyright \
       
    20      debian/ibverbs-utils.install debian/libibverbs1.install \
       
    21 diff -r 3903116dd520 Makefile.in
       
    22 --- a/Makefile.in	Wed Jan 13 09:20:30 2016 -0800
       
    23 +++ b/Makefile.in	Wed Jan 13 09:32:13 2016 -0800
       
    24 @@ -494,8 +494,7 @@
       
    25      man/ibv_query_pkey.3 man/ibv_query_port.3 man/ibv_query_qp.3	\
       
    26      man/ibv_query_srq.3 man/ibv_rate_to_mult.3 man/ibv_reg_mr.3		\
       
    27      man/ibv_req_notify_cq.3 man/ibv_resize_cq.3 man/ibv_rate_to_mbps.3  \
       
    28 -    man/ibv_create_qp_ex.3 man/ibv_create_srq_ex.3 man/ibv_open_xrcd.3  \
       
    29 -    man/ibv_get_srq_num.3 man/ibv_open_qp.3
       
    30 +    man/ibv_open_xrcd.3 man/ibv_open_qp.3
       
    31  
       
    32  DEBIAN = debian/changelog debian/compat debian/control debian/copyright \
       
    33      debian/ibverbs-utils.install debian/libibverbs1.install \
       
    34 diff -r 3903116dd520 man/ibv_create_qp_ex.3
       
    35 --- a/man/ibv_create_qp_ex.3	Wed Jan 13 09:20:30 2016 -0800
       
    36 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
       
    37 @@ -1,83 +0,0 @@
       
    38 -.\" -*- nroff -*-
       
    39 -.\"
       
    40 -.TH IBV_CREATE_QP_EX 3 2013-06-26 libibverbs "Libibverbs Programmer's Manual"
       
    41 -.SH "NAME"
       
    42 -ibv_create_qp_ex, ibv_destroy_qp \- create or destroy a queue pair (QP)
       
    43 -.SH "SYNOPSIS"
       
    44 -.nf
       
    45 -.B #include <infiniband/verbs.h>
       
    46 -.sp
       
    47 -.BI "struct ibv_qp *ibv_create_qp_ex(struct ibv_context " "*context" ,
       
    48 -.BI "                                struct ibv_qp_init_attr_ex " "*qp_init_attr" );
       
    49 -.sp
       
    50 -.BI "int ibv_destroy_qp(struct ibv_qp " "*qp" );
       
    51 -.fi
       
    52 -.SH "DESCRIPTION"
       
    53 -.B ibv_create_qp_ex()
       
    54 -creates a queue pair (QP) associated with the protection domain
       
    55 -.I pd\fR.
       
    56 -The argument
       
    57 -.I qp_init_attr_ex
       
    58 -is an ibv_qp_init_attr_ex struct, as defined in <infiniband/verbs.h>.
       
    59 -.PP
       
    60 -.nf
       
    61 -struct ibv_qp_init_attr_ex {
       
    62 -.in +8
       
    63 -void                   *qp_context;     /* Associated context of the QP */
       
    64 -struct ibv_cq          *send_cq;        /* CQ to be associated with the Send Queue (SQ) */
       
    65 -struct ibv_cq          *recv_cq;        /* CQ to be associated with the Receive Queue (RQ) */
       
    66 -struct ibv_srq         *srq;            /* SRQ handle if QP is to be associated with an SRQ, otherwise NULL */
       
    67 -struct ibv_qp_cap       cap;            /* QP capabilities */
       
    68 -enum ibv_qp_type        qp_type;        /* QP Transport Service Type: IBV_QPT_RC, IBV_QPT_UC, IBV_QPT_UD or IBV_QPT_RAW_PACKET */
       
    69 -int                     sq_sig_all;     /* If set, each Work Request (WR) submitted to the SQ generates a completion entry */
       
    70 -uint32_t                comp_mask;	/* Identifies valid fields */
       
    71 -struct ibv_pd          *pd;		/* PD to be associated with the QP */
       
    72 -struct ibv_xrcd        *xrcd;		/* XRC domain to be associated with the target QP */
       
    73 -enum ibv_qp_create_flags create_flags;	/* Creation flags for this QP */
       
    74 -.in -8
       
    75 -};
       
    76 -.sp
       
    77 -.nf
       
    78 -struct ibv_qp_cap {
       
    79 -.in +8
       
    80 -uint32_t                max_send_wr;    /* Requested max number of outstanding WRs in the SQ */
       
    81 -uint32_t                max_recv_wr;    /* Requested max number of outstanding WRs in the RQ */
       
    82 -uint32_t                max_send_sge;   /* Requested max number of scatter/gather (s/g) elements in a WR in the SQ */
       
    83 -uint32_t                max_recv_sge;   /* Requested max number of s/g elements in a WR in the SQ */
       
    84 -uint32_t                max_inline_data;/* Requested max number of data (bytes) that can be posted inline to the SQ, otherwise 0 */
       
    85 -.in -8
       
    86 -};
       
    87 -.fi
       
    88 -.PP
       
    89 -The function
       
    90 -.B ibv_create_qp_ex()
       
    91 -will update the
       
    92 -.I qp_init_attr_ex\fB\fR->cap
       
    93 -struct with the actual \s-1QP\s0 values of the QP that was created;
       
    94 -the values will be greater than or equal to the values requested.
       
    95 -.PP
       
    96 -.B ibv_destroy_qp()
       
    97 -destroys the QP
       
    98 -.I qp\fR.
       
    99 -.SH "RETURN VALUE"
       
   100 -.B ibv_create_qp_ex()
       
   101 -returns a pointer to the created QP, or NULL if the request fails.
       
   102 -Check the QP number (\fBqp_num\fR) in the returned QP.
       
   103 -.PP
       
   104 -.B ibv_destroy_qp()
       
   105 -returns 0 on success, or the value of errno on failure (which indicates the failure reason).
       
   106 -.SH "NOTES"
       
   107 -.PP
       
   108 -The attributes max_recv_wr and max_recv_sge are ignored by
       
   109 -.B ibv_create_qp_ex()
       
   110 -if the QP is to be associated with an SRQ.
       
   111 -.PP
       
   112 -.B ibv_destroy_qp()
       
   113 -fails if the QP is attached to a multicast group.
       
   114 -.SH "SEE ALSO"
       
   115 -.BR ibv_alloc_pd (3),
       
   116 -.BR ibv_modify_qp (3),
       
   117 -.BR ibv_query_qp (3)
       
   118 -.SH "AUTHORS"
       
   119 -.TP
       
   120 -Yishai Hadas <[email protected]>
       
   121 diff -r 3903116dd520 man/ibv_create_srq_ex.3
       
   122 --- a/man/ibv_create_srq_ex.3	Wed Jan 13 09:20:30 2016 -0800
       
   123 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
       
   124 @@ -1,71 +0,0 @@
       
   125 -.\" -*- nroff -*-
       
   126 -.\"
       
   127 -.TH IBV_CREATE_SRQ_EX 3 2013-06-26 libibverbs "Libibverbs Programmer's Manual"
       
   128 -.SH "NAME"
       
   129 -ibv_create_srq_ex, ibv_destroy_srq \- create or destroy a shared receive queue (SRQ)
       
   130 -.SH "SYNOPSIS"
       
   131 -.nf
       
   132 -.B #include <infiniband/verbs.h>
       
   133 -.sp
       
   134 -.BI "struct ibv_srq *ibv_create_srq_ex(struct ibv_context " "*context" ", struct "
       
   135 -.BI "                               ibv_srq_init_attr_ex " "*srq_init_attr_ex" );
       
   136 -.sp
       
   137 -.BI "int ibv_destroy_srq(struct ibv_srq " "*srq" );
       
   138 -.fi
       
   139 -.SH "DESCRIPTION"
       
   140 -.B ibv_create_srq_ex()
       
   141 -creates a shared receive queue (SRQ) supporting both basic and xrc modes.
       
   142 -The argument
       
   143 -.I srq_init_attr_ex
       
   144 -is an ibv_srq_init_attr_ex struct, as defined in <infiniband/verbs.h>.
       
   145 -.PP
       
   146 -.nf
       
   147 -struct ibv_srq_init_attr_ex {
       
   148 -.in +8
       
   149 -void                   *srq_context;    /* Associated context of the SRQ */
       
   150 -struct ibv_srq_attr     attr;           /* SRQ attributes */
       
   151 -uint32_t                comp_mask;      /* Identifies valid fields */
       
   152 -enum ibv_srq_type       srq_type;       /* Basic / XRC */
       
   153 -struct ibv_pd          *pd;             /* PD associated with the SRQ */
       
   154 -struct ibv_xrcd        *xrcd;           /* XRC domain to associate with the SRQ */
       
   155 -struct ibv_cq          *cq;             /* CQ to associate with the SRQ for XRC mode */
       
   156 -.in -8
       
   157 -};
       
   158 -.sp
       
   159 -.nf
       
   160 -struct ibv_srq_attr {
       
   161 -.in +8
       
   162 -uint32_t                max_wr;         /* Requested max number of outstanding work requests (WRs) in the SRQ */
       
   163 -uint32_t                max_sge;        /* Requested max number of scatter elements per WR */
       
   164 -uint32_t                srq_limit;      /* The limit value of the SRQ */
       
   165 -.in -8
       
   166 -};
       
   167 -.fi
       
   168 -.PP
       
   169 -The function
       
   170 -.B ibv_create_srq_ex()
       
   171 -will update the
       
   172 -.I srq_init_attr_ex
       
   173 -struct with the original values of the SRQ that was created; the
       
   174 -values of max_wr and max_sge will be greater than or equal to the
       
   175 -values requested.
       
   176 -.PP
       
   177 -.B ibv_destroy_srq()
       
   178 -destroys the SRQ
       
   179 -.I srq\fR.
       
   180 -.SH "RETURN VALUE"
       
   181 -.B ibv_create_srq_ex()
       
   182 -returns a pointer to the created SRQ, or NULL if the request fails.
       
   183 -.PP
       
   184 -.B ibv_destroy_srq()
       
   185 -returns 0 on success, or the value of errno on failure (which indicates the failure reason).
       
   186 -.SH "NOTES"
       
   187 -.B ibv_destroy_srq()
       
   188 -fails if any queue pair is still associated with this SRQ.
       
   189 -.SH "SEE ALSO"
       
   190 -.BR ibv_alloc_pd (3),
       
   191 -.BR ibv_modify_srq (3),
       
   192 -.BR ibv_query_srq (3)
       
   193 -.SH "AUTHORS"
       
   194 -.TP
       
   195 -Yishai Hadas <[email protected]>
       
   196 diff -r 3903116dd520 man/ibv_get_srq_num.3
       
   197 --- a/man/ibv_get_srq_num.3	Wed Jan 13 09:20:30 2016 -0800
       
   198 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
       
   199 @@ -1,32 +0,0 @@
       
   200 -.\" -*- nroff -*-
       
   201 -.\"
       
   202 -.TH IBV_GET_SRQ_NUM 3 2013-06-26 libibverbs "Libibverbs Programmer's Manual"
       
   203 -.SH "NAME"
       
   204 -ibv_get_srq_num  \- return srq number associated with the given shared receive queue (SRQ)
       
   205 -.SH "SYNOPSIS"
       
   206 -.nf
       
   207 -.B #include <infiniband/verbs.h>
       
   208 -.sp
       
   209 -.BI "int ibv_get_srq_num(struct ibv_srq " "*srq" ,
       
   210 -.BI "                    uint32_t " "*srq_num" );
       
   211 -.fi
       
   212 -.SH "DESCRIPTION"
       
   213 -.B ibv_get_srq_num()
       
   214 -return srq number associated with the given shared receive queue
       
   215 -The argument
       
   216 -.I srq
       
   217 -is an ibv_srq struct, as defined in <infiniband/verbs.h>.
       
   218 -.I srq_num
       
   219 -is an output parameter that holds the returned srq number.
       
   220 -.PP
       
   221 -.nf
       
   222 -.SH "RETURN VALUE"
       
   223 -.B ibv_get_srq_num()
       
   224 -returns 0 on success, or the value of errno on failure (which indicates the failure reason).
       
   225 -.SH "SEE ALSO"
       
   226 -.BR ibv_alloc_pd (3),
       
   227 -.BR ibv_modify_srq (3),
       
   228 -.BR ibv_create_srq_ex (3)
       
   229 -.SH "AUTHORS"
       
   230 -.TP
       
   231 -Yishai Hadas <[email protected]>