darshan.h 4.99 KB
Newer Older
1
/*
Shane Snyder's avatar
Shane Snyder committed
2 3 4
 * Copyright (C) 2015 University of Chicago.
 * See COPYRIGHT notice in top-level directory.
 *
5 6
 */

7 8 9 10 11 12 13
#ifndef __DARSHAN_H
#define __DARSHAN_H

#include <unistd.h>
#include <sys/types.h>
#include <stdint.h>
#include <mpi.h>
14

15
#include "darshan-log-format.h"
16
#include "darshan-common.h"
17

18 19 20 21
/* macros for declaring wrapper functions and calling MPI routines
 * consistently regardless of whether static or dynamic linking is used
 */
#ifdef DARSHAN_PRELOAD
22

23 24 25
#include <dlfcn.h>
#include <stdlib.h>

26 27
#define DARSHAN_FORWARD_DECL(__func,__ret,__args) \
  __ret (*__real_ ## __func)__args = NULL
28

29
#define DARSHAN_DECL(__func) __func
30

31
#define DARSHAN_MPI_CALL(__func) __real_ ## __func
32

33 34
#define MAP_OR_FAIL(__func) \
    if (!(__real_ ## __func)) \
35
    { \
36 37 38
        __real_ ## __func = dlsym(RTLD_NEXT, #__func); \
        if(!(__real_ ## __func)) { \
           fprintf(stderr, "Darshan failed to map symbol: %s\n", #__func); \
39 40 41 42 43 44
           exit(1); \
       } \
    }

#else

45 46
#define DARSHAN_FORWARD_DECL(__name,__ret,__args) \
  extern __ret __real_ ## __name __args;
47 48 49

#define DARSHAN_DECL(__name) __wrap_ ## __name

50
#define DARSHAN_MPI_CALL(__func) __func
51

52
#define MAP_OR_FAIL(__func)
53 54 55

#endif

56 57 58
/* default number of records to attempt to store for each module */
#define DARSHAN_DEF_MOD_REC_COUNT 1024

Shane Snyder's avatar
Shane Snyder committed
59
/* module developers provide the following functions to darshan-core */
60
struct darshan_module_funcs
61
{
62 63 64 65 66
    /* perform any necessary pre-shutdown steps
     *
     * NOTE: this typically includes disabling wrapper functions so
     * darshan-core can shutdown in a consistent state.
     */
67
    void (*begin_shutdown)(void);
68 69 70 71 72 73 74
    /* retrieve module data to write to log file
     *
     * NOTE: module developers can use this function to run collective
     * MPI operations at shutdown time. Typically this functionality
     * has been used to reduce records shared globablly (given in the
     * 'shared_recs' array) into a single data record.
     */
75
    void (*get_output_data)(
76 77 78 79 80
        MPI_Comm mod_comm,  /* MPI communicator to run collectives with */
        darshan_record_id *shared_recs, /* list of shared data record ids */
        int shared_rec_count, /* count of shared data records */
        void** mod_buf, /* output parameter to save module buffer address */
        int* mod_buf_sz /* output parameter to save module buffer size */
81 82 83
    );
    /* shutdown module data structures */
    void (*shutdown)(void);
84 85
};

86 87 88
/*****************************************************
* darshan-core functions exported to darshan modules *
*****************************************************/
89

90 91 92 93 94 95
/* darshan_core_register_module()
 *
 * Register module identifier 'mod_id' with the darshan-core runtime
 * environment, allowing the module to store I/O characterization data.
 * 'funcs' is a pointer to a structure containing each of the function
 * pointers required by darshan-core to shut down the module. The function
96
 * returns the following integers passed in as pointers: 'rank' is the
97 98 99 100
 * MPI rank of the calling process, 'mod_mem_limit' is the maximum amount
 * of memory the module may use, and 'sys_mem_alignment' is the configured
 * memory alignment value Darshan was configured with.
 */
101
void darshan_core_register_module(
102
    darshan_module_id mod_id,
103
    struct darshan_module_funcs *funcs,
104
    int *inout_mod_buf_size,
105
    int *rank,
106
    int *sys_mem_alignment);
107

108 109 110 111 112
/* darshan_core_unregister_module()
 * 
 * Unregisters module identifier 'mod_id' with the darshan-core runtime,
 * removing the given module from the resulting I/O characterization log.
 */
113 114 115
void darshan_core_unregister_module(
    darshan_module_id mod_id);

116
/* darshan_core_gen_record_id()
117 118 119
 *
 *
 */
120
darshan_record_id darshan_core_gen_record_id(
121
    const char *name);
122

123 124
/* darshan_core_register_record()
 *
125 126 127 128 129 130 131 132 133 134 135
 * Register a record with the darshan-core runtime, allowing it to be
 * properly tracked and (potentially) correlated with records from other
 * modules. 'name' is the the name of the Darshan record (e.g., the full
 * file path) and 'len' is the size of the name pointer (string length
 * for string names). 'mod_id' is the identifier of the calling module,
 * 'printable_flag' indicates whether the name is a string, and 
 * 'mod_limit_flag' is set if the calling module is out of memory (to
 * prevent darshan-core from creating new records and to just search
 * through existing records). 'rec_id' is an output pointer storing the
 * correspoing Darshan record identifier and 'file_alignment' is an output
 * pointer storing the file system alignment value for the given record.
136
 */
137
void *darshan_core_register_record(
138
    darshan_record_id rec_id,
139
    const char *name,
140
    darshan_module_id mod_id,
141
    int rec_len,
142
    int *file_alignment);
143

144 145 146 147 148
/* darshan_core_wtime()
 *
 * Returns the elapsed time relative to (roughly) the start of
 * the application.
 */
149
double darshan_core_wtime(void);
150

151 152 153 154 155 156 157 158
/* darshan_core_excluded_path()
 *
 * Returns true (1) if the given file path is in Darshan's list of
 * excluded file paths, false (0) otherwise.
 */
int darshan_core_excluded_path(
    const char * path);

159
#endif /* __DARSHAN_H */