Skip to content

Commit 2adec07

Browse files
author
Shane Snyder
committed
updated darshan-util docs for daos
1 parent 4d573cb commit 2adec07

File tree

1 file changed

+115
-17
lines changed

1 file changed

+115
-17
lines changed

‎darshan-util/doc/darshan-util.txt‎

Lines changed: 115 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,121 @@ value of 1 MiB for optimal file alignment.
480480
| PNETCDF_VAR_FILE_REC_ID | Darshan file record ID of the file the variable belongs to
481481
|====
482482

483+
.Lustre module (if enabled, for Lustre file systems)
484+
[cols="40%,60%",options="header"]
485+
|====
486+
| counter name | description
487+
| LUSTRE_NUM_COMPONENTS | number of instrumented components in the Lustre layout
488+
| LUSTRE_NUM_STRIPES | number of active stripes in the Lustre layout components
489+
| LUSTRE_COMP*_STRIPE_SIZE | stripe size for this file layout component in bytes
490+
| LUSTRE_COMP*_STRIPE_COUNT | number of OSTs over which the file layout component is striped
491+
| LUSTRE_COMP*_STRIPE_PATTERN | pattern (e.g., raid0, mdt, overstriped) for this file layout component
492+
| LUSTRE_COMP*_FLAGS | captured flags (e.g. init, prefwr, stale) for this file layout component
493+
| LUSTRE_COMP*_EXT_START | starting file extent for this file layout component
494+
| LUSTRE_COMP*_EXT_END | ending file extent for this file layout component (-1 means EOF)
495+
| LUSTRE_COMP*_MIRROR_ID | mirror ID for this file layout component, if mirrors are enabled
496+
| LUSTRE_COMP*_POOL_NAME | Lustre OST pool used for this file layout component
497+
| LUSTRE_COMP*\_OST_ID_* | indices of OSTs over which this file layout component is striped
498+
|====
499+
500+
.DFS (DAOS File System) module (if enabled)
501+
[cols="40%,60%",options="header"]
502+
|====
503+
| counter name | description
504+
| DFS_OPENS | DFS file open operation counts
505+
| DFS_GLOBAL_OPENS | DFS file global open operation (i.e., `dfs_obj_global2local()`) counts
506+
| DFS_LOOKUPS | DFS file lookup operation counts
507+
| DFS_DUPS | DFS file dup operation counts
508+
| DFS_READS | DFS file read operation counts
509+
| DFS_READXS | DFS non-contiguous file read operation counts
510+
| DFS_WRITES | DFS file write operation counts
511+
| DFS_WRITEXS | DFS non-contiguous file write operation counts
512+
| DFS_NB_READS | DFS non-blocking file read operation counts (included in read/readx counts)
513+
| DFS_NB_WRITES | DFS non-blocking file write operation counts (included in write/writex counts)
514+
| DFS_GET_SIZES | DFS file get size operation counts
515+
| DFS_PUNCHES | DFS file punch operation counts
516+
| DFS_REMOVES | DFS file remove operation counts
517+
| DFS_STATS | DFS file stat operation counts
518+
| DFS_BYTES_READ | Total number of bytes that were read from the DFS file
519+
| DFS_BYTES_WRITTEN | Total number of bytes that were written to the DFS file
520+
| DFS_RW_SWITCHES | Number of times that access toggled between read and write in consecutive operations
521+
| DFS_MAX_READ_TIME_SIZE | Size of the slowest DFS read operation
522+
| DFS_MAX_WRITE_TIME_SIZE | Size of the slowest DFS write operation
523+
| DFS_SIZE_READ_* | Histogram of read access sizes at DFS level
524+
| DFS_SIZE_WRITE_* | Histogram of write access sizes at DFS level
525+
| DFS_ACCESS[1-4]_ACCESS | 4 most common DFS access sizes
526+
| DFS_ACCESS[1-4]_COUNT | Count of 4 most common DFS access sizes
527+
| DFS_CHUNK_SIZE | DFS file chunk size
528+
| DFS_FASTEST_RANK | The MPI rank with smallest time spent in DFS I/O (cumulative read, write, and meta times)
529+
| DFS_FASTEST_RANK_BYTES | The number of bytes transferred by the rank with smallest time spent in DFS I/O (cumulative read, write, and meta times)
530+
| DFS_SLOWEST_RANK | The MPI rank with largest time spent in DFS I/O (cumulative read, write, and meta times)
531+
| DFS_SLOWEST_RANK_BYTES | The number of bytes transferred by the rank with the largest time spent in DFS I/O (cumulative read, write, and meta times)
532+
| DFS_F_*_START_TIMESTAMP | Timestamp that the first DFS file open/read/write/close operation began
533+
| DFS_F_*_END_TIMESTAMP | Timestamp that the last DFS file open/read/write/close operation ended
534+
| DFS_F_READ_TIME | Cumulative time spent reading at the DFS level
535+
| DFS_F_WRITE_TIME | Cumulative time spent writing at the DFS level
536+
| DFS_F_META_TIME | Cumulative time spent in open, dup, lookup, get size, punch, release, remove, and stat at the DFS level
537+
| DFS_F_MAX_READ_TIME | Duration of the slowest individual DFS read operation
538+
| DFS_F_MAX_WRITE_TIME | Duration of the slowest individual DFS write operation
539+
| DFS_F_FASTEST_RANK_TIME | The time of the rank which had the smallest amount of time spent in DFS I/O (cumulative read, write, and meta times)
540+
| DFS_F_SLOWEST_RANK_TIME | The time of the rank which had the largest amount of time spent in DFS I/O (cumulative read, write, and meta times)
541+
|====
542+
543+
.DAOS module (if enabled)
544+
[cols="40%,60%",options="header"]
545+
|====
546+
| counter name | description
547+
| DAOS_OBJ_OPENS | DAOS object open operation counts
548+
| DAOS_OBJ_FETCHES | DAOS object fetch operation counts
549+
| DAOS_OBJ_UPDATES | DAOS object update operation counts
550+
| DAOS_OBJ_UPDATES | DAOS object update operation counts
551+
| DAOS_OBJ_PUNCHES | DAOS object punch operation counts
552+
| DAOS_OBJ_DKEY_PUNCHES | DAOS object dkey punch operation counts
553+
| DAOS_OBJ_AKEY_PUNCHES | DAOS object akey punch operation counts
554+
| DAOS_OBJ_DKEY_LISTS | DAOS object dkey list operation counts
555+
| DAOS_OBJ_AKEY_LISTS | DAOS object akey list operation counts
556+
| DAOS_OBJ_RECX_LISTS | DAOS object recx list operation counts
557+
| DAOS_ARRAY_OPENS | DAOS array object open operation counts
558+
| DAOS_ARRAY_READS | DAOS array object read operation counts
559+
| DAOS_ARRAY_WRITES | DAOS array object write operation counts
560+
| DAOS_ARRAY_GET_SIZES | DAOS array object get size operation counts
561+
| DAOS_ARRAY_SET_SIZES | DAOS array object set size operation counts
562+
| DAOS_ARRAY_STATS | DAOS array object stat operation counts
563+
| DAOS_ARRAY_PUNCHES | DAOS array object punch operation counts
564+
| DAOS_ARRAY_DESTROYS | DAOS array object destroy operation counts
565+
| DAOS_KV_OPENS | DAOS kv object open operation counts
566+
| DAOS_KV_GETS | DAOS kv object get operation counts
567+
| DAOS_KV_PUTS | DAOS kv object put operation counts
568+
| DAOS_KV_REMOVES | DAOS kv object remove operation counts
569+
| DAOS_KV_LISTS | DAOS kv object list operation counts
570+
| DAOS_KV_DESTROYS | DAOS kv object destroy operation counts
571+
| DAOS_BYTES_READ | Total number of bytes that were read from the DAOS object
572+
| DAOS_BYTES_WRITTEN | Total number of bytes that were written to the DAOS object
573+
| DAOS_RW_SWITCHES | Number of times that access toggled between read and write in consecutive operations
574+
| DAOS_MAX_READ_TIME_SIZE | Size of the slowest DAOS read operation
575+
| DAOS_MAX_WRITE_TIME_SIZE | Size of the slowest DAOS write operation
576+
| DAOS_SIZE_READ_* | Histogram of read access sizes at DAOS level
577+
| DAOS_SIZE_WRITE_* | Histogram of write access sizes at DAOS level
578+
| DAOS_ACCESS[1-4]_ACCESS | 4 most common DAOS access sizes
579+
| DAOS_ACCESS[1-4]_COUNT | Count of 4 most common DAOS access sizes
580+
| DAOS_OBJ_OTYPE | DAOS object otype ID
581+
| DAOS_ARRAY_CELL_SIZE | For DAOS array objects, the array cell size
582+
| DAOS_ARRAY_CHUNK_SIZE | For DAOS array objects, the array chunk size
583+
| DAOS_FASTEST_RANK | The MPI rank with smallest time spent in DAOS I/O (cumulative read, write, and meta times)
584+
| DAOS_FASTEST_RANK_BYTES | The number of bytes transferred by the rank with smallest time spent in DAOS I/O (cumulative read, write, and meta times)
585+
| DAOS_SLOWEST_RANK | The MPI rank with largest time spent in DAOS I/O (cumulative read, write, and meta times)
586+
| DAOS_SLOWEST_RANK_BYTES | The number of bytes transferred by the rank with the largest time spent in DAOS I/O (cumulative read, write, and meta times)
587+
| DAOS_F_*_START_TIMESTAMP | Timestamp that the first DAOS object open/read/write/close operation began
588+
| DAOS_F_*_END_TIMESTAMP | Timestamp that the last DAOS object open/read/write/close operation ended
589+
| DAOS_F_READ_TIME | Cumulative time spent reading at the DAOS level
590+
| DAOS_F_WRITE_TIME | Cumulative time spent writing at the DAOS level
591+
| DAOS_F_META_TIME | Cumulative time spent in open, punch, list, get size, set size, stat, destroy, and remove at the DAOS level
592+
| DAOS_F_MAX_READ_TIME | Duration of the slowest individual DAOS read operation
593+
| DAOS_F_MAX_WRITE_TIME | Duration of the slowest individual DAOS write operation
594+
| DAOS_F_FASTEST_RANK_TIME | The time of the rank which had the smallest amount of time spent in DAOS I/O (cumulative read, write, and meta times)
595+
| DAOS_F_SLOWEST_RANK_TIME | The time of the rank which had the largest amount of time spent in DAOS I/O (cumulative read, write, and meta times)
596+
|====
597+
483598
===== Heatmap fields
484599

485600
Each heatmap module record reports a histogram of the number of bytes read
@@ -505,23 +620,6 @@ execution time.
505620

506621
===== Additional modules
507622

508-
.Lustre module (if enabled, for Lustre file systems)
509-
[cols="40%,60%",options="header"]
510-
|====
511-
| counter name | description
512-
| LUSTRE_NUM_COMPONENTS | number of instrumented components in the Lustre layout
513-
| LUSTRE_NUM_STRIPES | number of active stripes in the Lustre layout components
514-
| LUSTRE_COMP*_STRIPE_SIZE | stripe size for this file layout component in bytes
515-
| LUSTRE_COMP*_STRIPE_COUNT | number of OSTs over which the file layout component is striped
516-
| LUSTRE_COMP*_STRIPE_PATTERN | pattern (e.g., raid0, mdt, overstriped) for this file layout component
517-
| LUSTRE_COMP*_FLAGS | captured flags (e.g. init, prefwr, stale) for this file layout component
518-
| LUSTRE_COMP*_EXT_START | starting file extent for this file layout component
519-
| LUSTRE_COMP*_EXT_END | ending file extent for this file layout component (-1 means EOF)
520-
| LUSTRE_COMP*_MIRROR_ID | mirror ID for this file layout component, if mirrors are enabled
521-
| LUSTRE_COMP*_POOL_NAME | Lustre OST pool used for this file layout component
522-
| LUSTRE_COMP*\_OST_ID_* | indices of OSTs over which this file layout component is striped
523-
|====
524-
525623
.APXC module header record (if enabled, for Cray XC systems)
526624
[cols="40%,60%",options="header"]
527625
|====

0 commit comments

Comments
 (0)