H5FDlog.h

00001 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
00002  * Copyright by The HDF Group.                                               *
00003  * Copyright by the Board of Trustees of the University of Illinois.         *
00004  * All rights reserved.                                                      *
00005  *                                                                           *
00006  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
00007  * terms governing use, modification, and redistribution, is contained in    *
00008  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
00009  * of the source code distribution tree; Copyright.html can be found at the  *
00010  * root level of an installed copy of the electronic HDF5 document set and   *
00011  * is linked from the top-level documents page.  It can also be found at     *
00012  * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
00013  * access to either file, you may request a copy from help@hdfgroup.org.     *
00014  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
00015 
00016 /*
00017  * Programmer:  Quincey Koziol <koziol@ncsa.uiuc.edu>
00018  *              Monday, April 17, 2000
00019  *
00020  * Purpose:     The public header file for the log driver.
00021  */
00022 #ifndef H5FDlog_H
00023 #define H5FDlog_H
00024 
00025 #include "H5Ipublic.h"
00026 
00027 #define H5FD_LOG        (H5FD_log_init())
00028 
00029 /* Flags for H5Pset_fapl_log() */
00030 /* Flags for tracking where reads/writes/seeks occur */
00031 #define H5FD_LOG_LOC_READ   0x0001
00032 #define H5FD_LOG_LOC_WRITE  0x0002
00033 #define H5FD_LOG_LOC_SEEK   0x0004
00034 #define H5FD_LOG_LOC_IO     (H5FD_LOG_LOC_READ|H5FD_LOG_LOC_WRITE|H5FD_LOG_LOC_SEEK)
00035 /* Flags for tracking number of times each byte is read/written */
00036 #define H5FD_LOG_FILE_READ  0x0008
00037 #define H5FD_LOG_FILE_WRITE 0x0010
00038 #define H5FD_LOG_FILE_IO    (H5FD_LOG_FILE_READ|H5FD_LOG_FILE_WRITE)
00039 /* Flag for tracking "flavor" (type) of information stored at each byte */
00040 #define H5FD_LOG_FLAVOR     0x0020
00041 /* Flags for tracking total number of reads/writes/seeks */
00042 #define H5FD_LOG_NUM_READ   0x0040
00043 #define H5FD_LOG_NUM_WRITE  0x0080
00044 #define H5FD_LOG_NUM_SEEK   0x0100
00045 #define H5FD_LOG_NUM_IO     (H5FD_LOG_NUM_READ|H5FD_LOG_NUM_WRITE|H5FD_LOG_NUM_SEEK)
00046 /* Flags for tracking time spent in open/read/write/seek/close */
00047 #define H5FD_LOG_TIME_OPEN  0x0200      /* Not implemented yet */
00048 #define H5FD_LOG_TIME_READ  0x0400      /* Not implemented yet */
00049 #define H5FD_LOG_TIME_WRITE 0x0800      /* Partially implemented (need to track total time) */
00050 #define H5FD_LOG_TIME_SEEK  0x1000      /* Partially implemented (need to track total time & track time for seeks during reading) */
00051 #define H5FD_LOG_TIME_CLOSE 0x2000      /* Fully implemented */
00052 #define H5FD_LOG_TIME_IO    (H5FD_LOG_TIME_OPEN|H5FD_LOG_TIME_READ|H5FD_LOG_TIME_WRITE|H5FD_LOG_TIME_SEEK|H5FD_LOG_TIME_CLOSE)
00053 /* Flag for tracking allocation of space in file */
00054 #define H5FD_LOG_ALLOC      0x4000
00055 #define H5FD_LOG_ALL        (H5FD_LOG_ALLOC|H5FD_LOG_TIME_IO|H5FD_LOG_NUM_IO|H5FD_LOG_FLAVOR|H5FD_LOG_FILE_IO|H5FD_LOG_LOC_IO)
00056 
00057 #ifdef __cplusplus
00058 extern "C" {
00059 #endif
00060 
00061 H5_DLL hid_t H5FD_log_init(void);
00062 H5_DLL void H5FD_log_term(void);
00063 H5_DLL herr_t H5Pset_fapl_log(hid_t fapl_id, const char *logfile, unsigned flags, size_t buf_size);
00064 
00065 #ifdef __cplusplus
00066 }
00067 #endif
00068 
00069 #endif