/usr/include/ncbi-vdb/kfs/mmap.h is in libncbi-vdb-dev 2.8.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _h_kfs_mmap_
#define _h_kfs_mmap_
#ifndef _h_kfs_extern_
#include <kfs/extern.h>
#endif
#ifndef _h_klib_defs_
#include <klib/defs.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
* forwards
*/
struct KFile;
/*--------------------------------------------------------------------------
* KMMap
* a memory mapped region
*/
typedef struct KMMap KMMap;
/* AddRef
* Release
* ignores NULL references
*/
KFS_EXTERN rc_t CC KMMapAddRef ( const KMMap *self );
KFS_EXTERN rc_t CC KMMapRelease ( const KMMap *self );
/* Size
* returns size of memory region
*
* "size" [ OUT ] - return parameter for region size
*/
KFS_EXTERN rc_t CC KMMapSize ( const KMMap *self, size_t *size );
/* Position
* returns region starting offset into mapped file
*
* "pos" [ OUT ] - return parameter for file offset
*/
KFS_EXTERN rc_t CC KMMapPosition ( const KMMap *self, uint64_t *pos );
/* Reposition
* shift region to a new position
* may change region size
*
* "pos" [ IN ] - new starting position for region
*
* "size" [ OUT, NULL OKAY ] - optional return parameter
* for resultant region size
*/
KFS_EXTERN rc_t CC KMMapReposition ( const KMMap *self, uint64_t pos, size_t *size );
/* Addr
* returns starting address of memory region
*
* "addr" [ OUT ] - return parameter for memory address
*/
KFS_EXTERN rc_t CC KMMapAddrRead ( const KMMap *self, const void **addr );
KFS_EXTERN rc_t CC KMMapAddrUpdate ( KMMap *self, void **addr );
/* Make
* maps entire file
*
* "f" [ IN ] - file to map.
* a new reference will be added
*/
KFS_EXTERN rc_t CC KMMapMakeRead ( const KMMap **mm, struct KFile const *f );
KFS_EXTERN rc_t CC KMMapMakeUpdate ( KMMap **mm, struct KFile *f );
/* MakeMax
* maps as much of a file as possible
*
* "f" [ IN ] - file to map.
* a new reference will be added
*/
KFS_EXTERN rc_t CC KMMapMakeMaxRead ( const KMMap **mm, struct KFile const *f );
KFS_EXTERN rc_t CC KMMapMakeMaxUpdate ( KMMap **mm, struct KFile *f );
/* MakeRgn
* maps a portion of a file
*
* "f" [ IN ] - file to map
* a new reference will be added
*
* "pos" [ IN ] - starting offset into file
*
* "size" [ IN, DEFAULT ZERO ] - size of resulting region. if 0,
* the size will be interpreted as meaning size of "f" - "pos".
*/
KFS_EXTERN rc_t CC KMMapMakeRgnRead ( const KMMap **mm,
struct KFile const *f, uint64_t pos, size_t size );
KFS_EXTERN rc_t CC KMMapMakeRgnUpdate ( KMMap **mm,
struct KFile *f, uint64_t pos, size_t size );
#ifdef __cplusplus
}
#endif
#endif /* _h_kfs_mmap_ */
|