From e47a391ca48676c5a7e0f4392d023bab9d92fe12 Mon Sep 17 00:00:00 2001 From: Shane Snyder Date: Wed, 18 Mar 2015 14:56:38 -0500 Subject: [PATCH] update docs to mention byte swap functionality --- doc/darshan-modularization.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/darshan-modularization.txt b/doc/darshan-modularization.txt index 0d9eb5b..40a70f6 100644 --- a/doc/darshan-modularization.txt +++ b/doc/darshan-modularization.txt @@ -357,6 +357,12 @@ and store in `moddat_buf`. This function may be repeatedly called to retrieve se from a given Darshan file descriptor. This function returns `1` if `moddat_buf_sz` bytes were read successfully, `0` if no more data is available for this module, and `-1` otherwise. +*NOTE*: Darshan use a reader makes right conversion strategy to rectify endianness issues +between the machine a log was generated on and a machine analyzing the log. Accordingly, +module-specific log utility functions will need to check the `swap_flag` variable of the Darshan +file descriptor to determine if byte swapping is necessary. 32-bit and 64-bit byte swapping +macros (DARSHAN_BSWAP32/DARSHAN_BSWAP64) are provided in `darshan-logutils.h`. + [source,c] void darshan_log_close(darshan_fd fd); -- 2.22.0