<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Transitional//EN">
<HTML>
<HEAD>
  <!--
    *************************************************************************************
    * Copyright (c) 2005 VERITAS Software Corporation. All rights reserved. *

      For third-party license citations, please see the bottom of this file.
    *************************************************************************************
  -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="TEMPLATEBASE" content="DocCD Manual Pages 1.4">
<meta name="LASTUPDATED" content="06/13/05 11:54:59">
<meta name="PRODUCTNAME" content="VERITAS Software Documentation">
<meta name="FILENAME" content="fsckpt_fbmap.fm">
     
<title>fsckpt_fbmap</title>

</HEAD>

<BODY bgcolor="#FFFFFF" link="#000066" vlink="#0000ff" marginheight="0" topmargin="0">
<basefont=1>

<a name="428160"></a>

<div align="left">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
 <tr>
   <td height="2" border="0" cellspacing="0" cellpadding="0" colspan="2" bgcolor="#000000">
   </td>
 </tr>
 <tr>
   <td height="15" width="50%" border="0" cellspacing="0" cellpadding="0" bgcolor="#cccccc">
    <img src="images/vxsymbol.gif" height="20" width="31" border="0" cellspacing="0" cellpadding="0" align="left">
     
     
   </td>
   <td align="right" width="50%" bgcolor="#cccccc">

<!-- Header Breadcrumbs -->
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">&lt;&nbsp;<a href="fsckpt_createall_vxfs_manpages44_427872.html" title="Previous - fsckpt_createall">Previous</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="fsckpt_fclose_vxfs_manpages46_426433.html" title="Next - fsckpt_fclose">Next</a>
&nbsp;&gt;&nbsp;&nbsp;</font>
   </td>
 </tr>

 <tr>
  <td bgcolor="#CCCCCC" colspan="2" height="15" align="right">
  <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">Product:  
<a href="vxfs_manpages_splashpage_docCD_vxfs_manpages1_103036.vxhd" title="File System Manual Pages for Storage Foundation title page ">File System Manual Pages for Storage Foundation</a>
  &nbsp;&nbsp;
  </font>
  </td>
 </tr>
 <tr>
  <td bgcolor="#CCCCCC" colspan="2" height="15" align="right">
  <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">Manual:  
<a href="man3_titlepage_docCD_vxfs_manpages40_73700.vxhd" title="Library Functions (3) title page ">Library Functions (3)</a>
  &nbsp;&nbsp;
  </font>
  </td>
 </tr>


</table>
</div>

<div align="left">
 <table border="0" width="100%" bgcolor="#FFFFFF">
  <tr>
   <td width="100%" valign="top" bgcolor="#FFFFFF">

<!-- Start Main Topic Content -->
        <a name="startcontent"></a>
	
<h2><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="3" color="#000000"><a name="427107"></a>fsckpt_fbmap</font>
</h2>

        

<h3><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="2" color="#000000">
<a name="427137"></a> NAME</font>
</h3>
<p>
<a name="427142"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">fsckpt_fbmap - retrieve block map from a Storage Checkpointed file </font>
</p>

<h3><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="2" color="#000000">
<a name="427145"></a> SYNOPSIS</font>
</h3>
<br>
<font face="Courier, Courier New, sansserif, sans serif" size="2"><a name="427150"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>#include &lt;fsckpt.h&gt;</b></font>  
</font>
<br>
<font face="Courier, Courier New, sansserif, sans serif" size="2"><a name="427153"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>int fsckpt_fbmap(void *</b></font><em>filehandle</em><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>, ckptoff_t *</b></font><em>off</em><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>, struct c_extent *</b></font><em>cep</em>); 
</font>

<h3><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="2" color="#000000">
<a name="427156"></a> AVAILABILITY</font>
</h3>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427161"></a>VRTSvxfs  </font>
</p>


<h3><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="2" color="#000000">
<a name="427164"></a> DESCRIPTION</font>
</h3>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427169"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_fbmap()</b></font> retrieves the block map from a Storage Checkpoint <em>filehandle</em> at file offset <em>off</em>. The structure <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>c_extent</b></font> pointed to by <em>cep</em> is filled in by this function and contains the following fields: </font>
</p>

<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="427274"></a><font face="Courier New, Courier, sansserif, sans serif" size="2">ckptoff_t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ce_len;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/*&nbsp;extent&nbsp;length&nbsp;*/</font>
</font>
<br>
<font face="Courier New, Courier, sansserif, sans serif" size="2"><a name="427279"></a><font face="Courier New, Courier, sansserif, sans serif" size="2">unsigned&nbsp;int&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ce_flags;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/*&nbsp;extent&nbsp;flags&nbsp;*/</font>
</font>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427289"></a>where flags are: </font>
</p>

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427293"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>CE_ALLCHANGED</b></font></font>
</p>
<p>
<a name="428293"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">Every extent in the file has changed. </font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427307"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>CE_CHANGED</b></font></font>
</p>
<p>
<a name="428308"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">The extent at offset <em>off</em> has changed. </font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427340"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>CE_HOLE</b></font></font>
</p>
<p>
<a name="428323"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">The extent at offset <em>off</em> is a hole. </font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427372"></a>The information returned by this function can be used to determine the changed sections of a file. After obtaining the changed offset, an application may issue the <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>lseek()</b></font> and <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>read()</b></font> system calls at the specific offset to retrieve the requested data. When a file is completely changed, every offset will return the extent flag <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>CE_ALLCHANGED</b></font>. This can be used as an optimization to avoid unnecessarily repeated <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_fbmap</b></font>() calls. The <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>CE_HOLE</b></font> flag can be used to determine the location of all holes in a sparse file. </font>
</p>

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427543"></a>When the <em>relckpt</em> argument to the <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_fopen()</b></font> function is NULL, the <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_fbmap()</b></font> function returns the extent map of the opened file. This mode is useful for applications to find the holes in sparse files. </font>
</p>

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427633"></a>When the <em>relckpt</em> argument to the <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_fopen()</b></font> function is not NULL, <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_fbmap()</b></font> can determine the extents changed between the current Storage Checkpoint and a relative Storage Checkpoint. The result of such an operation returns the union of all changed blocks between the Storage Checkpoints in question. </font>
</p>

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427741"></a>The relative Storage Checkpoint must be an existing Storage Checkpoint. </font>
</p>

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427753"></a>The file offset specified by the argument <em>off</em> and the extent length specified by the <em>ce_len</em> field of the <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>c_extent</b></font> structure are declared to use the <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>ckptoff_t</b></font> type. This type is platform specific. It is defined as a 64-bit quantity on all platforms that support file offsets larger than two gigabytes, otherwise, it is defined as a 32-bit quantity. </font>
</p>

<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427877"></a>Applications using this function must be compiled accordingly. Some platforms that can handle large files, however, have compilation options that allow an application to define the file offset as a 32-bit quantity. These applications either cannot use this function, or must ensure that they never operate on a Storage Checkpoint that is large file enabled (that is, has <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>CI_LARGEFILES </b></font>set). </font>
</p>


<h3><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="2" color="#000000">
<a name="427979"></a> RETURN VALUES</font>
</h3>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="427984"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_fbmap()</b></font> returns zero on success, non-zero on failure. </font>
</p>


<h3><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="2" color="#000000">
<a name="428006"></a> ERRORS</font>
</h3>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="428012"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>EFAULT</b></font></font>
</p>
<p>
<a name="428350"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">Internal API error. </font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="428026"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>EFBIG</b></font></font>
</p>
<p>
<a name="428365"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">The calling function issued a request with a file offset <em>off</em> past the EOF mark. </font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="428059"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>EINVAL</b></font></font>
</p>
<p>
<a name="428380"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">The function is being used incorrectly or the arguments to the function cannot be validated. This can occur when an application uses an <em>fshandle</em> that was not created by the same process. </font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="428110"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>EIO</b></font></font>
</p>
<p>
<a name="428395"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">An I/O error occurred on the device. </font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="428124"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>ENOENT</b></font></font>
</p>
<p>
<a name="428410"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">The relative Storage Checkpoint was removed. </font>
</p>
<p>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="428138"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>ENOSYS</b></font></font>
</p>
<p>
<a name="428425"></a><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2">The system is not licensed to perform the operation. The API issued a system request with an illegal address. </font>
</p>

<h3><font face="Arial, Helvetica, Geneva, sansserif, sans serif, Verdana" size="2" color="#000000">
<a name="428160"></a> SEE ALSO</font>
</h3>
<blockquote>
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><a name="428165"></a><a href="fsckptadm_vxfs_manpages19_433052.html#429746"><font color="#0000ff"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckptadm </b></font></font></a>(1M), <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>lseek</b></font>(2), <font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>read</b></font>(2), <a href="fsckpt_create_vxfs_manpages43_427620.html#426827"><font color="#0000ff"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_create </b></font></font></a>(3), <a href="fsckpt_createall_vxfs_manpages44_427872.html#426925"><font color="#0000ff"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_createall </b></font></font></a>(3), <a href="fsckpt_fsopen_vxfs_manpages51_426928.html#426463"><font color="#0000ff"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_fsopen </b></font></font></a>(3), <a href="fsckpt_intro_vxfs_manpages54_430826.html#428633"><font color="#0000ff"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="2"><b>fsckpt_intro </b></font></font></a>(3) </font>
</blockquote>

<!-- End Main Topic Content -->

   </td>
  </tr>
 </table>
</div>

<div>
<table border="0" cellspacing="0" cellpadding="0" width="100%">
 <tr>
  <td height="18" border="0" cellspacing="0" cellpadding="0" colspan="2" bgcolor="#FFFFFF">
  </td>
 </tr>
  <td align="left"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">&nbsp;&#94;&nbsp;<a href="fsckpt_fbmap_vxfs_manpages45_428160.html" title="fsckpt_fbmap">Return to Top</a></font>

  </td>
  <td align="right"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">&lt;&nbsp;<a href="fsckpt_createall_vxfs_manpages44_427872.html" title="Previous - fsckpt_createall">Previous</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="fsckpt_fclose_vxfs_manpages46_426433.html" title="Next - fsckpt_fclose">Next</a>
&nbsp;&gt;&nbsp;&nbsp;</font>
  </td>
 <tr>
   <td height="9" border="0" cellspacing="0" cellpadding="0" colspan="2" bgcolor="#FFFFFF">
   </td>
 </tr>

<!-- Footer Breadcrumbs -->
<tr>
<td bgcolor="#FFFFFF" colspan="2" height="15" align="right">
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">Product:  
<a href="vxfs_manpages_splashpage_docCD_vxfs_manpages1_103036.vxhd" title="File System Manual Pages for Storage Foundation title page ">File System Manual Pages for Storage Foundation</a>&nbsp;&nbsp;</font></td>
</tr>

<tr>
<td bgcolor="#FFFFFF" colspan="2" height="15" align="right">
<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="1">Manual:  
<a href="man3_titlepage_docCD_vxfs_manpages40_73700.vxhd" title="Library Functions (3) title page ">Library Functions (3)</a>&nbsp;&nbsp;</font></td>
</tr>


 <tr>
  <td colspan="2" align="left"><font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" color="#000000" align="right" size="-2">
<em>VERITAS Software Corporation
</em></font><br>

<font face="Verdana, Arial, Helvetica, Geneva, sansserif, sans serif" size="-2">www.veritas.com</font><br>
  </td>
 </tr>
</table>
</div>

</BODY>
  <!--
    *************************************************************************************
    * Copyright (c) 2005 VERITAS Software Corporation. All rights reserved. *

    VERITAS, VERITAS SOFTWARE, the VERITAS Logo, and VERITAS Software Documentation 
    are trademarks or registered trademarks of VERITAS Software Corporation 
    or its affiliates in the U.S. and other countries. Other names may be 
    trademarks of their respective owners. 

    Apache Jakarta Lucene:
    Apache Software License
    Version 1.1

    Copyright (c) 2000 The Apache Software Foundation. All rights reserved.

    Redistribution and use in source and binary forms, with or without modification, 
    are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice, this 
    list of conditions and the following disclaimer.

    2. Redistributions in binary form must reproduce the above copyright notice, this 
    list of conditions and the following disclaimer in the documentation and/or other 
    materials provided with the distribution.

    3. The end-user documentation included with the redistribution, if any, must include 
    the following acknowledgment: "This product includes software developed by the Apache 
    Software Foundation (http://www.apache.org/)." Alternately, this acknowledgment may 
    appear in the software itself, if and wherever such third-party acknowledgments 
    normally appear.

    4. The names "Apache" and "Apache Software Foundation" must not be used to endorse or 
    promote products derived from this software without prior written permission. For 
    written permission, please contact apache@apache.org.

    5. Products derived from this software may not be called "Apache", nor may "Apache" 
    appear in their name, without prior written permission of the Apache Software Foundation.

    THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, 
    BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 
    PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION 
    OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 
    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
    OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
    ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    This software consists of voluntary contributions made by many individuals on behalf 
    of the Apache Software Foundation. For more information on the Apache Software Foundation, 
    please see <http://www.apache.org/>. Portions of this software are based upon public domain 
    software originally written at the National Center for Supercomputing Applications, University 
    of Illinois, Urbana-Champaign.
    
    This product includes WebWindow Software developed by Horst Heistermann.
    *************************************************************************************
  -->
</HTML>
