usr/src/man/man3dat/dat_srq_resize.3dat

   1 '\" te
   2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH DAT_SRQ_RESIZE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_srq_resize \- modify the size of the shared receive queue
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <\fBdat/udat.h\fR>
  15
  16 DAT_RETURN
  17     dat_srq_resize (
  18     IN      DAT_SRQ_HANDLE      srq_handle,
  19     IN      DAT_COUNT           srq_max_recv_dto
  20     )
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIsrq_handle\fR\fR
  28 .ad
  29 .RS 20n
  30 A handle for an instance of the SRQ.
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIsrq_max_recv_dto\fR\fR
  37 .ad
  38 .RS 20n
  39 The new maximum number of Recv DTOs that Shared Receive Queue must hold.
  40 .RE
  41
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 The \fBdat_srq_resize()\fR function modifies the size of the queue of SRQ.
  46 .sp
  47 .LP
  48 Resizing of Shared Receive Queue should not cause any incoming messages on any
  49 of the EPs that use the SRQ to be lost. If the number of outstanding Recv
  50 buffers on the SRQ is larger then the requested \fIsrq_max_recv_dto\fR, the
  51 operation returns \fBDAT_INVALID_STATE\fR and do not change SRQ. This includes
  52 not just the buffers on the SRQ but all outstanding Receive buffers that had
  53 been posted to the SRQ and whose completions have not reaped yet. Thus, the
  54 outstanding buffers include the buffers on SRQ, the buffers posted to SRQ at
  55 are at SRQ associated EPs, and the buffers posted to SRQ for which completions
  56 have been generated but not yet reaped by Consumer from recv_evds of the EPs
  57 that use the SRQ.
  58 .sp
  59 .LP
  60 If the requested \fIsrq_max_recv_dto\fR is below the SRQ low watermark, the
  61 operation returns \fBDAT_INVALID_STATE\fR and does not change SRQ.
  62 .SH RETURN VALUES
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBDAT_SUCCESS\fR\fR
  67 .ad
  68 .RS 30n
  69 The operation was successful.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBDAT_INVALID_HANDLE\fR\fR
  76 .ad
  77 .RS 30n
  78 The \fIsrq_handle\fR argument is an invalid DAT handle.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBDAT_INVALID_PARAMETER\fR\fR
  85 .ad
  86 .RS 30n
  87 The \fIsrq_max_recv_dto\fR argument is invalid.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
  94 .ad
  95 .RS 30n
  96 The operation failed due to resource limitations.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBDAT_INVALID_STATE\fR\fR
 103 .ad
 104 .RS 30n
 105 Invalid state. Either the number of entries on the SRQ exceeds the requested
 106 SRQ queue length or the requested SRQ queue length is smaller than the SRQ low
 107 watermark.
 108 .RE
 109
 110 .SH USAGE
 111 .sp
 112 .LP
 113 The \fBdat_srq_resize()\fR function is required not to lose any buffers. Thus,
 114 it cannot shrink below the outstanding number of Recv buffers on SRQ. There is
 115 no requirement to shrink the SRQ to return \fBDAT_SUCCESS\fR.
 116 .sp
 117 .LP
 118 The quality of the implementation determines how closely to the
 119 Consumer-requested value the Provider shrinks the SRQ. For example, the
 120 Provider can shrink the SRQ to the Consumer-requested value and if the
 121 requested value is smaller than the outstanding buffers on SRQ, return
 122 \fBDAT_INVALID_STATE\fR; or the Provider can shrink to some value larger than
 123 that requested by the Consumer but below current SRQ size; or the Provider does
 124 not change the SRQ size and still returns \fBDAT_SUCCESS\fR.
 125 .SH ATTRIBUTES
 126 .sp
 127 .LP
 128 See \fBattributes\fR(5) for descriptions of the following attributes:
 129 .sp
 130
 131 .sp
 132 .TS
 133 box;
 134 c | c
 135 l | l .
 136 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 137 _
 138 Interface Stability     Standard: uDAPL, 1.2
 139 _
 140 MT-Level        Unsafe
 141 .TE
 142
 143 .SH SEE ALSO
 144 .sp
 145 .LP
 146 \fBdat_srq_create\fR(3DAT), \fBdat_srq_free\fR(3DAT),
 147 \fBdat_srq_post_recv\fR(3DAT), \fBdat_srq_query\fR(3DAT),
 148 \fBdat_srq_set_lw\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)