Help us improve by taking our short survey: https://www.hdfgroup.org/website-survey/

| HDF5 Last Updated on 2025-11-11 The HDF5 Field Guide

- Main Page
- Getting started
- User Guide
- Reference Manual
- Cookbook
- Technical Notes
- RFCs
- Specifications
- Glossary
- Full-Text Search
- About

Loading...
Searching...
No Matches
Macros | Functions
H5FDlog.h File Reference
`#include "H5FDpublic.h"`

## Macros
#define | H5FD_LOG (H5OPEN H5FD_LOG_id_g)
#define | H5FD_LOG_ALL
#define | H5FD_LOG_ALLOC 0x00040000
#define | H5FD_LOG_FILE_IO (H5FD_LOG_FILE_READ | H5FD_LOG_FILE_WRITE)
#define | H5FD_LOG_FILE_READ 0x00000010
#define | H5FD_LOG_FILE_WRITE 0x00000020
#define | H5FD_LOG_FLAVOR 0x00000040
#define | H5FD_LOG_FREE 0x00080000
#define | H5FD_LOG_LOC_IO (H5FD_LOG_LOC_READ | H5FD_LOG_LOC_WRITE | H5FD_LOG_LOC_SEEK)
#define | H5FD_LOG_LOC_READ 0x00000002
#define | H5FD_LOG_LOC_SEEK 0x00000008
#define | H5FD_LOG_LOC_WRITE 0x00000004
#define | H5FD_LOG_META_IO (H5FD_LOG_TRUNCATE)
#define | H5FD_LOG_NUM_IO (H5FD_LOG_NUM_READ | H5FD_LOG_NUM_WRITE | H5FD_LOG_NUM_SEEK | H5FD_LOG_NUM_TRUNCATE)
#define | H5FD_LOG_NUM_READ 0x00000080
#define | H5FD_LOG_NUM_SEEK 0x00000200
#define | H5FD_LOG_NUM_TRUNCATE 0x00000400
#define | H5FD_LOG_NUM_WRITE 0x00000100
#define | H5FD_LOG_TIME_CLOSE 0x00020000
#define | H5FD_LOG_TIME_IO
#define | H5FD_LOG_TIME_OPEN 0x00000800
#define | H5FD_LOG_TIME_READ 0x00002000
#define | H5FD_LOG_TIME_SEEK 0x00008000
#define | H5FD_LOG_TIME_STAT 0x00001000
#define | H5FD_LOG_TIME_TRUNCATE 0x00010000
#define | H5FD_LOG_TIME_WRITE 0x00004000
#define | H5FD_LOG_TRUNCATE 0x00000001
#define | H5FD_LOG_VALUE H5_VFD_LOG

## Functions
herr_t | H5Pset_fapl_log (hid_t fapl_id, const char *logfile, unsigned long long flags, size_t buf_size)
| Sets up the logging virtual file driver (H5FD_LOG) for use.

## Macro Definition Documentation

## ◆ H5FD_LOG

#define H5FD_LOG (H5OPEN H5FD_LOG_id_g)

Initializer for the log VFD ID for the log VFD

## ◆ H5FD_LOG_ALL

#define H5FD_LOG_ALL

Value:
(H5FD_LOG_FREE | H5FD_LOG_ALLOC | H5FD_LOG_TIME_IO | H5FD_LOG_NUM_IO | H5FD_LOG_FLAVOR | \
H5FD_LOG_FILE_IO | H5FD_LOG_LOC_IO | H5FD_LOG_META_IO)
H5FD_LOG_FREE
#define H5FD_LOG_FREE
Definition H5FDlog.h:82
H5FD_LOG_META_IO
#define H5FD_LOG_META_IO
Definition H5FDlog.h:34
H5FD_LOG_FILE_IO
#define H5FD_LOG_FILE_IO
Definition H5FDlog.h:48
H5FD_LOG_LOC_IO
#define H5FD_LOG_LOC_IO
Definition H5FDlog.h:42
H5FD_LOG_NUM_IO
#define H5FD_LOG_NUM_IO
Definition H5FDlog.h:60
H5FD_LOG_TIME_IO
#define H5FD_LOG_TIME_IO
Definition H5FDlog.h:76
H5FD_LOG_FLAVOR
#define H5FD_LOG_FLAVOR
Definition H5FDlog.h:50
H5FD_LOG_ALLOC
#define H5FD_LOG_ALLOC
Definition H5FDlog.h:80

Flag for tracking all info

Since
  1.6.0

## ◆ H5FD_LOG_ALLOC

#define H5FD_LOG_ALLOC 0x00040000

Flag for tracking allocation of space in file

Since
  1.6.0

## ◆ H5FD_LOG_FILE_IO

#define H5FD_LOG_FILE_IO (H5FD_LOG_FILE_READ | H5FD_LOG_FILE_WRITE)

Flag for tracking number of times each byte is read/written

Since
  1.6.0

## ◆ H5FD_LOG_FILE_READ

#define H5FD_LOG_FILE_READ 0x00000010

Flag for tracking number of times each byte is read

Since
  1.6.0

## ◆ H5FD_LOG_FILE_WRITE

#define H5FD_LOG_FILE_WRITE 0x00000020

Flag for tracking number of times each byte is written

Since
  1.6.0

## ◆ H5FD_LOG_FLAVOR

#define H5FD_LOG_FLAVOR 0x00000040

Flag for tracking "flavor" (type) of information stored at each byte

Since
  1.6.0

## ◆ H5FD_LOG_FREE

#define H5FD_LOG_FREE 0x00080000

Flag for tracking release of space in file

Since
  1.10.1

## ◆ H5FD_LOG_LOC_IO

#define H5FD_LOG_LOC_IO (H5FD_LOG_LOC_READ | H5FD_LOG_LOC_WRITE | H5FD_LOG_LOC_SEEK)

Flag for tracking where IO operations occur

Since
  1.6.0

## ◆ H5FD_LOG_LOC_READ

#define H5FD_LOG_LOC_READ 0x00000002

Flag for tracking where reads occur

Since
  1.6.0

## ◆ H5FD_LOG_LOC_SEEK

#define H5FD_LOG_LOC_SEEK 0x00000008

Flag for tracking where seeks occur

Since
  1.6.0

## ◆ H5FD_LOG_LOC_WRITE

#define H5FD_LOG_LOC_WRITE 0x00000004

Flag for tracking where writes occur

Since
  1.6.0

## ◆ H5FD_LOG_META_IO

#define H5FD_LOG_META_IO (H5FD_LOG_TRUNCATE)

Flag for tracking meta IO operations

Since
  1.10.1

## ◆ H5FD_LOG_NUM_IO

#define H5FD_LOG_NUM_IO (H5FD_LOG_NUM_READ | H5FD_LOG_NUM_WRITE | H5FD_LOG_NUM_SEEK | H5FD_LOG_NUM_TRUNCATE)

Flag for tracking total number of IO operations

Since
  1.6.0

## ◆ H5FD_LOG_NUM_READ

#define H5FD_LOG_NUM_READ 0x00000080

Flag for tracking total number of reads

Since
  1.6.0

## ◆ H5FD_LOG_NUM_SEEK

#define H5FD_LOG_NUM_SEEK 0x00000200

Flag for tracking total number of seeks

Since
  1.6.0

## ◆ H5FD_LOG_NUM_TRUNCATE

#define H5FD_LOG_NUM_TRUNCATE 0x00000400

Flag for tracking total number of truncates

Since
  1.8.7

## ◆ H5FD_LOG_NUM_WRITE

#define H5FD_LOG_NUM_WRITE 0x00000100

Flag for tracking total number of writes

Since
  1.6.0

## ◆ H5FD_LOG_TIME_CLOSE

#define H5FD_LOG_TIME_CLOSE 0x00020000

Flag for tracking time spent in close

Since
  1.6.0

## ◆ H5FD_LOG_TIME_IO

#define H5FD_LOG_TIME_IO

Value:
(H5FD_LOG_TIME_OPEN | H5FD_LOG_TIME_STAT | H5FD_LOG_TIME_READ | H5FD_LOG_TIME_WRITE | \
H5FD_LOG_TIME_SEEK | H5FD_LOG_TIME_TRUNCATE | H5FD_LOG_TIME_CLOSE)
H5FD_LOG_TIME_CLOSE
#define H5FD_LOG_TIME_CLOSE
Definition H5FDlog.h:74
H5FD_LOG_TIME_STAT
#define H5FD_LOG_TIME_STAT
Definition H5FDlog.h:64
H5FD_LOG_TIME_TRUNCATE
#define H5FD_LOG_TIME_TRUNCATE
Definition H5FDlog.h:72
H5FD_LOG_TIME_WRITE
#define H5FD_LOG_TIME_WRITE
Definition H5FDlog.h:68
H5FD_LOG_TIME_SEEK
#define H5FD_LOG_TIME_SEEK
Definition H5FDlog.h:70
H5FD_LOG_TIME_OPEN
#define H5FD_LOG_TIME_OPEN
Definition H5FDlog.h:62
H5FD_LOG_TIME_READ
#define H5FD_LOG_TIME_READ
Definition H5FDlog.h:66

Flag for tracking time spent in IO operations

Since
  1.6.0

## ◆ H5FD_LOG_TIME_OPEN

#define H5FD_LOG_TIME_OPEN 0x00000800

Flag for tracking time spent in open

Since
  1.8.7

## ◆ H5FD_LOG_TIME_READ

#define H5FD_LOG_TIME_READ 0x00002000

Flag for tracking time spent in read

Since
  1.8.7

## ◆ H5FD_LOG_TIME_SEEK

#define H5FD_LOG_TIME_SEEK 0x00008000

Flag for tracking time spent in seek

Since
  1.6.0

## ◆ H5FD_LOG_TIME_STAT

#define H5FD_LOG_TIME_STAT 0x00001000

Flag for tracking time spent in stat

Since
  1.8.7

## ◆ H5FD_LOG_TIME_TRUNCATE

#define H5FD_LOG_TIME_TRUNCATE 0x00010000

Flag for tracking time spent in truncate

Since
  1.10.1

## ◆ H5FD_LOG_TIME_WRITE

#define H5FD_LOG_TIME_WRITE 0x00004000

Flag for tracking time spent in write

Since
  1.6.0

## ◆ H5FD_LOG_TRUNCATE

#define H5FD_LOG_TRUNCATE 0x00000001

Flag for tracking truncate operation

Since
  1.10.1

## ◆ H5FD_LOG_VALUE

#define H5FD_LOG_VALUE H5_VFD_LOG

Identifier for the log VFD

Since
  1.14.0