usr/src/man/man3ext/read_vtoc.3ext

   1 '\" te
   2 .\" Copyright (c) 2008, 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 READ_VTOC 3EXT "Oct 7, 2008"
   7 .SH NAME
   8 read_vtoc, write_vtoc \- read and write a disk's VTOC
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-ladm\fR [ \fIlibrary\fR ... ]
  13 #include <sys/vtoc.h>
  14
  15 \fBint\fR \fBread_vtoc\fR(\fBint\fR \fIfd\fR, \fBstruct vtoc *\fR\fIvtoc\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBwrite_vtoc\fR(\fBint\fR \fIfd\fR, \fBstruct vtoc *\fR\fIvtoc\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBread_extvtoc\fR(\fBint\fR \fIfd\fR, \fBstruct extvtoc *\fR\fIextvtoc\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBwrite_extvtoc\fR(\fBint\fR \fIfd\fR, \fBstruct extvtoc *\fR\fIextvtoc\fR);
  31 .fi
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBread_vtoc()\fR and \fBread_extvtoc()\fR functions return the VTOC
  37 (volume  table  of contents)  structure  that is stored on  the disk associated
  38 with the open file descriptor \fIfd\fR. On disks larger than 1 TB
  39 \fBread_extvtoc()\fR must be used.
  40 .sp
  41 .LP
  42 The \fBwrite_vtoc()\fR and \fBwrite_extvtoc()\fR function stores the VTOC
  43 structure on the disk associated with the open file descriptor \fIfd\fR. On
  44 disks larger then 1TB \fBwrite_extvtoc()\fR function must be used.
  45 .sp
  46 .LP
  47 The \fIfd\fR argument refers to any slice on a raw disk.
  48 .SH RETURN VALUES
  49 .sp
  50 .LP
  51 Upon successful completion, \fBread_vtoc()\fR and \fBread_extvtoc()\fR return a
  52 positive integer indicating the slice index associated with the open file
  53 descriptor. Otherwise, they return a negative integer indicating one of the
  54 following errors:
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBVT_EIO\fR\fR
  59 .ad
  60 .RS 15n
  61 An I/O error occurred.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBVT_ENOTSUP\fR\fR
  68 .ad
  69 .RS 15n
  70 This operation is not supported on this disk.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBVT_ERROR\fR\fR
  77 .ad
  78 .RS 15n
  79 An unknown error occurred.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBVT_OVERFLOW\fR\fR
  86 .ad
  87 .RS 15n
  88 The caller attempted an operation that is illegal on the disk and may overflow
  89 the fields in the data structure.
  90 .RE
  91
  92 .sp
  93 .LP
  94 Upon successful completion, \fBwrite_vtoc()\fR and \fBwrite_extvtoc()\fR return
  95 0. Otherwise, they return a negative integer indicating one of the following
  96 errors:
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBVT_EINVAL\fR\fR
 101 .ad
 102 .RS 15n
 103 The VTOC contains an incorrect field.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBVT_EIO\fR\fR
 110 .ad
 111 .RS 15n
 112 An I/O error occurred.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBVT_ENOTSUP\fR\fR
 119 .ad
 120 .RS 15n
 121 This operation is not supported on this disk.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBVT_ERROR\fR\fR
 128 .ad
 129 .RS 15n
 130 An unknown error occurred.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBVT_OVERFLOW\fR\fR
 137 .ad
 138 .RS 15n
 139 The caller attempted an operation that is illegal on the disk and may overflow
 140 the fields in the data structure.
 141 .RE
 142
 143 .SH ATTRIBUTES
 144 .sp
 145 .LP
 146 See \fBattributes\fR(5) for descriptions of the following attributes:
 147 .sp
 148
 149 .sp
 150 .TS
 151 box;
 152 c | c
 153 l | l .
 154 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 155 _
 156 MT-Level        Unsafe
 157 .TE
 158
 159 .SH SEE ALSO
 160 .sp
 161 .LP
 162 \fBfmthard\fR(1M), \fBformat\fR(1M), \fBprtvtoc\fR(1M), \fBioctl\fR(2),
 163 \fBefi_alloc_and_init\fR(3EXT), \fBattributes\fR(5), \fBdkio\fR(7I)
 164 .SH BUGS
 165 .sp
 166 .LP
 167 The \fBwrite_vtoc()\fR function cannot write a  \fBVTOC\fR on an unlabeled
 168 disk. Use \fBformat\fR(1M) for this purpose.