share/man/man3rsm/rsm_memseg_import_connect.3rsm

   1 '\" te
   2 .\"  Copyright (c) 2001 by Sun Microsystems, Inc.  All rights reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH RSM_MEMSEG_IMPORT_CONNECT 3RSM "Jun 8, 2001"
   7 .SH NAME
   8 rsm_memseg_import_connect, rsm_memseg_import_disconnect \- create or break
   9 logical commection between import and export segments
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR... ] \fIfile\fR... -lrsm [ \fIlibrary\fR... ]
  14 #include <rsmapi.h>
  15
  16 \fBint\fR \fBrsm_memseg_import_connect\fR(
  17      \fBrsmapi_controller_handle_t\fR \fIcontroller\fR,
  18      \fBrsm_node_id_t\fR \fInodeid\fR, \fBrsm_memseg_id_t\fR \fIsegment_id\fR,
  19      \fBrsm_permission_t\fR \fIperm\fR, \fBrsm_memseg_import_handle_t *\fR\fImemseg\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBrsm_memseg_import_disconnect\fR(
  25      \fBrsm_memseg_import_handle_t\fR \fImemseg\fR);
  26 .fi
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBrsm_memseg_import_connect()\fR function provides a means of creating an
  32 import segment called \fImemseg\fR and establishing a logical connection with
  33 an export segment identified by the \fIsegment_id\fR on the node specified by
  34 \fInode_id\fR. The controller specified by \fIcontroller\fR must have a
  35 physical connection with the controller (see
  36 \fBrsm_get_interconnect_topology\fR(3RSM)) used while exporting the segment
  37 identified by \fIsegment_id\fR on node specified by \fInode_id\fR. The
  38 \fIperm\fR argument specifies the mode of access that the importer is
  39 requesting for this connection. In the connection process, the mode of access
  40 and the importers userid and groupid are compared with the access permissions
  41 specified by the exporter. If the request mode is not valid, the connection
  42 request is denied. The \fIperm\fR argument is limited to the following octal
  43 values:
  44 .sp
  45 .ne 2
  46 .na
  47 \fB0400\fR
  48 .ad
  49 .RS 8n
  50 read mode
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB0200\fR
  57 .ad
  58 .RS 8n
  59 write mode
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB0600\fR
  66 .ad
  67 .RS 8n
  68 read/write mode
  69 .RE
  70
  71 .sp
  72 .LP
  73 The \fBrsm_memseg_import_disconnect()\fR function breaks the logical connection
  74 between the import segment and the exported segment and deallocates the
  75 resources associated with the import segment handle \fImemseg\fR.
  76 .SH RETURN VALUES
  77 .sp
  78 .LP
  79 Upon successful completion, these functions return 0. Otherwise, an error value
  80 is returned to indicate the error.
  81 .SH ERRORS
  82 .sp
  83 .LP
  84 The \fBrsm_memseg_import_connect()\fR and \fBrsm_memseg_import_disconnect()\fR
  85 functions can return the following errors:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBRSMERR_BAD_SEG_HNDL\fR \fR
  90 .ad
  91 .RS 24n
  92 Invalid segment handle.
  93 .RE
  94
  95 .sp
  96 .LP
  97 The  \fBrsm_memseg_import_connect()\fR function can return the following
  98 errors:
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBRSMERR_BAD_CTLR_HNDL\fR \fR
 103 .ad
 104 .sp .6
 105 .RS 4n
 106 Invalid controller handle.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBRSMERR_CTLR_NOT_PRESENT\fR \fR
 113 .ad
 114 .sp .6
 115 .RS 4n
 116 Controller not present.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBRSMERR_PERM_DENIED\fR \fR
 123 .ad
 124 .sp .6
 125 .RS 4n
 126 Permission denied.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBRSMERR_INSUFFICIENT_MEM\fR \fR
 133 .ad
 134 .sp .6
 135 .RS 4n
 136 Insufficient memory.
 137 .RE
 138
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fBRSMERR_INSUFFICIENT_RESOURCES\fR \fR
 143 .ad
 144 .sp .6
 145 .RS 4n
 146 Insufficient resources.
 147 .RE
 148
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fBRSMERR_SEG_NOT_PUBLISHED_TO_NODE\fR \fR
 153 .ad
 154 .sp .6
 155 .RS 4n
 156 Segment not published to node.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBRSMERR_SEG_NOT_PUBLISHED\fR \fR
 163 .ad
 164 .sp .6
 165 .RS 4n
 166 Segment not published at all.
 167 .RE
 168
 169 .sp
 170 .ne 2
 171 .na
 172 \fB\fBRSMERR_BAD_ADDR\fR \fR
 173 .ad
 174 .sp .6
 175 .RS 4n
 176 Bad address.
 177 .RE
 178
 179 .sp
 180 .ne 2
 181 .na
 182 \fB\fBRSMERR_REMOTE_NODE_UNREACHABLE\fR \fR
 183 .ad
 184 .sp .6
 185 .RS 4n
 186 Remote not not reachable.
 187 .RE
 188
 189 .sp
 190 .ne 2
 191 .na
 192 \fB\fBRSMERR_INTERRUPTED\fR \fR
 193 .ad
 194 .sp .6
 195 .RS 4n
 196 Connection interrupted.
 197 .RE
 198
 199 .sp
 200 .LP
 201 The \fBrsm_memseg_import_disconnect()\fR function can return the following
 202 errors:
 203 .sp
 204 .ne 2
 205 .na
 206 \fB\fBRSMERR_SEG_STILL_MAPPED\fR \fR
 207 .ad
 208 .RS 28n
 209 Segment still mapped, need to unmap before disconnect.
 210 .RE
 211
 212 .sp
 213 .ne 2
 214 .na
 215 \fB\fBRSMERR_POLLFD_IN_USE\fR \fR
 216 .ad
 217 .RS 28n
 218 Poll file descriptor in use.
 219 .RE
 220
 221 .SH ATTRIBUTES
 222 .sp
 223 .LP
 224 See \fBattributes\fR(5) for descriptions of the following attributes:
 225 .sp
 226
 227 .sp
 228 .TS
 229 box;
 230 c | c
 231 l | l .
 232 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 233 _
 234 Interface Stability     Evolving
 235 _
 236 MT-Level        MT-Safe
 237 .TE
 238
 239 .SH SEE ALSO
 240 .sp
 241 .LP
 242 \fBrsm_memseg_import_map\fR(3RSM), \fBattributes\fR(5)