From db8ff8e4ec578d5f90f04355daf30aef61f58e69 Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Mon, 2 May 2011 15:44:00 -0500 Subject: [svn-r20707] Added comments to the H5F_mem_t enumeration in H5Fpublic.h and the corresponding flavors[] array in the log VFD code. --- src/H5FDlog.c | 28 ++++++++++++++++------------ src/H5Fpublic.h | 29 +++++++++++++++++++---------- 2 files changed, 35 insertions(+), 22 deletions(-) diff --git a/src/H5FDlog.c b/src/H5FDlog.c index e9ca89d..8cbf293 100644 --- a/src/H5FDlog.c +++ b/src/H5FDlog.c @@ -30,28 +30,32 @@ #define H5_INTERFACE_INIT_FUNC H5FD_log_init_interface -#include "H5private.h" /* Generic Functions */ -#include "H5Eprivate.h" /* Error handling */ -#include "H5Fprivate.h" /* File access */ -#include "H5FDprivate.h" /* File drivers */ -#include "H5FDlog.h" /* Logging file driver */ -#include "H5FLprivate.h" /* Free Lists */ -#include "H5Iprivate.h" /* IDs */ -#include "H5MMprivate.h" /* Memory management */ -#include "H5Pprivate.h" /* Property lists */ +#include "H5private.h" /* Generic Functions */ +#include "H5Eprivate.h" /* Error handling */ +#include "H5Fprivate.h" /* File access */ +#include "H5FDprivate.h" /* File drivers */ +#include "H5FDlog.h" /* Logging file driver */ +#include "H5FLprivate.h" /* Free Lists */ +#include "H5Iprivate.h" /* IDs */ +#include "H5MMprivate.h" /* Memory management */ +#include "H5Pprivate.h" /* Property lists */ /* The driver identification number, initialized at runtime */ static hid_t H5FD_LOG_g = 0; /* Driver-specific file access properties */ typedef struct H5FD_log_fapl_t { - char *logfile; /* Allocated log file name */ + char *logfile; /* Allocated log file name */ unsigned long long flags; /* Flags for logging behavior */ size_t buf_size; /* Size of buffers for track flavor and number of times each byte is accessed */ } H5FD_log_fapl_t; -/* Define strings for the different file memory types */ -static const char *flavors[]={ /* These are defined in H5FDpublic.h */ +/* Define strings for the different file memory types + * These are defined in the H5F_mem_t enum from H5Fpublic.h + * Note that H5FD_MEM_NOLIST is not listed here since it has + * a negative value. + */ +static const char *flavors[]={ "H5FD_MEM_DEFAULT", "H5FD_MEM_SUPER", "H5FD_MEM_BTREE", diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h index d1effb6..75a3547 100644 --- a/src/H5Fpublic.h +++ b/src/H5Fpublic.h @@ -122,18 +122,27 @@ typedef struct H5F_info2_t { * Types of allocation requests. The values larger than H5FD_MEM_DEFAULT * should not change other than adding new types to the end. These numbers * might appear in files. + * + * Note: please change the log VFD flavors array if you change this + * enumeration. */ typedef enum H5F_mem_t { - H5FD_MEM_NOLIST = -1, /*must be negative*/ - H5FD_MEM_DEFAULT = 0, /*must be zero*/ - H5FD_MEM_SUPER = 1, - H5FD_MEM_BTREE = 2, - H5FD_MEM_DRAW = 3, - H5FD_MEM_GHEAP = 4, - H5FD_MEM_LHEAP = 5, - H5FD_MEM_OHDR = 6, - - H5FD_MEM_NTYPES /*must be last*/ + H5FD_MEM_NOLIST = -1, /* Data should not appear in the free list. + * Must be negative. + */ + H5FD_MEM_DEFAULT = 0, /* Value not yet set. Can also be the + * datatype set in a larger allocation + * that will be suballocated by the library. + * Must be zero. + */ + H5FD_MEM_SUPER = 1, /* Superblock data */ + H5FD_MEM_BTREE = 2, /* B-tree data */ + H5FD_MEM_DRAW = 3, /* Raw data (content of datasets, etc.) */ + H5FD_MEM_GHEAP = 4, /* Global heap data */ + H5FD_MEM_LHEAP = 5, /* Local heap data */ + H5FD_MEM_OHDR = 6, /* Object header data */ + + H5FD_MEM_NTYPES /* Sentinel value - must be last */ } H5F_mem_t; /* Free space section information */ -- cgit v0.12