File: snapc_full_component.c

package info (click to toggle)
openmpi 4.1.0-10
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 126,560 kB
  • sloc: ansic: 685,465; makefile: 42,952; f90: 19,220; sh: 7,002; java: 6,360; perl: 3,524; cpp: 2,227; python: 1,350; lex: 989; fortran: 61; tcl: 12
file content (181 lines) | stat: -rw-r--r-- 7,722 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
 * Copyright (c) 2004-2010 The Trustees of Indiana University.
 *                         All rights reserved.
 * Copyright (c) 2004-2005 The Trustees of the University of Tennessee.
 *                         All rights reserved.
 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
 *                         University of Stuttgart.  All rights reserved.
 * Copyright (c) 2004-2005 The Regents of the University of California.
 *                         All rights reserved.
 * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
 *                         reserved.
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 */

#include "orte_config.h"
#include "opal/util/output.h"

#include "orte/mca/snapc/snapc.h"
#include "orte/mca/snapc/base/base.h"
#include "snapc_full.h"

/*
 * Public string for version number
 */
const char *orte_snapc_full_component_version_string =
"ORTE SNAPC full MCA component version " ORTE_VERSION;

/*
 * Local functionality
 */
static int snapc_full_open(void);
static int snapc_full_close(void);
static int snapc_full_register(void);

bool orte_snapc_full_skip_app   = false;
bool orte_snapc_full_timing_enabled = false;
int orte_snapc_full_progress_meter = 0;
int orte_snapc_full_max_wait_time = 20;

/*
 * Instantiate the public struct with all of our public information
 * and pointer to our public functions in it
 */
orte_snapc_full_component_t mca_snapc_full_component = {
    /* First do the base component stuff */
    {
        /* Handle the general mca_component_t struct containing
         *  meta information about the component itfull
         */
        .base_version = {
            ORTE_SNAPC_BASE_VERSION_2_0_0,
            /* Component name and version */
            .mca_component_name = "full",
            MCA_BASE_MAKE_VERSION(component, ORTE_MAJOR_VERSION, ORTE_MINOR_VERSION,
                                  ORTE_RELEASE_VERSION),

            /* Component open and close functions */
            .mca_open_component = snapc_full_open,
            .mca_close_component = snapc_full_close,
            .mca_query_component = orte_snapc_full_component_query,
            .mca_register_component_params = snapc_full_register,
        },
        .base_data = {
            /* The component is checkpoint ready */
            MCA_BASE_METADATA_PARAM_CHECKPOINT
        },

        .verbose = 0,
        .output_handle = -1,
    }
};

static int snapc_full_register (void)
{
    mca_base_component_t *component = &mca_snapc_full_component.super.base_version;
    /*
     * This should be the last component to ever get used since
     * it doesn't do anything.
      */

    /* Default priority */
    mca_snapc_full_component.super.priority = 20;
    (void) mca_base_component_var_register (component, "priority", "Priority of the SNAPC full component",
                                            MCA_BASE_VAR_TYPE_INT, NULL, 0, 0,
                                            OPAL_INFO_LVL_9,
                                            MCA_BASE_VAR_SCOPE_READONLY,
                                            &mca_snapc_full_component.super.priority);

    mca_snapc_full_component.super.verbose = 0;
    (void) mca_base_component_var_register (component, "verbose",
                                            "Verbose level for the SNAPC full component",
                                            MCA_BASE_VAR_TYPE_INT, NULL, 0, 0,
                                            OPAL_INFO_LVL_9,
                                            MCA_BASE_VAR_SCOPE_LOCAL,
                                            &mca_snapc_full_component.super.verbose);

    orte_snapc_full_skip_app = false;
    (void) mca_base_component_var_register (component, "skip_app",
                                            "Not for general use! For debugging only! Shortcut app level coord. [Default = disabled]",
                                            MCA_BASE_VAR_TYPE_BOOL, NULL, 0, 0,
                                            OPAL_INFO_LVL_9,
                                            MCA_BASE_VAR_SCOPE_LOCAL,
                                            &orte_snapc_full_skip_app);

    orte_snapc_full_timing_enabled = false;
    (void) mca_base_component_var_register (component, "enable_timing",
                                            "Enable timing information. [Default = disabled]",
                                            MCA_BASE_VAR_TYPE_BOOL, NULL, 0, 0,
                                            OPAL_INFO_LVL_9,
                                            MCA_BASE_VAR_SCOPE_LOCAL,
                                            &orte_snapc_full_timing_enabled);

    orte_snapc_full_max_wait_time = 20;
    (void) mca_base_component_var_register (component, "max_wait_time",
                                            "Wait time before orted gives up on checkpoint (seconds)",
                                            MCA_BASE_VAR_TYPE_INT, NULL, 0, 0,
                                            OPAL_INFO_LVL_9,
                                            MCA_BASE_VAR_SCOPE_LOCAL,
                                            &orte_snapc_full_max_wait_time);

    orte_snapc_full_progress_meter = 0;
    (void) mca_base_component_var_register (component, "progress_meter",
                                            "Display Progress every X percentage done. [Default = 0/off]",
                                            MCA_BASE_VAR_TYPE_INT, NULL, 0, 0,
                                            OPAL_INFO_LVL_9,
                                            MCA_BASE_VAR_SCOPE_LOCAL,
                                            &orte_snapc_full_progress_meter);
    orte_snapc_full_progress_meter %= 101;

    return ORTE_SUCCESS;
}

static int snapc_full_open(void)
{
    /* If there is a custom verbose level for this component than use it
     * otherwise take our parents level and output channel
     */
    if ( 0 != mca_snapc_full_component.super.verbose) {
        mca_snapc_full_component.super.output_handle = opal_output_open(NULL);
        opal_output_set_verbosity(mca_snapc_full_component.super.output_handle,
                                  mca_snapc_full_component.super.verbose);
    } else {
        mca_snapc_full_component.super.output_handle = orte_snapc_base_framework.framework_output;
    }

    /* recheck the progress meter (it may have changed between register and open) */
    orte_snapc_full_progress_meter %= 101;

    /*
     * Debug Output
     */
    opal_output_verbose(10, mca_snapc_full_component.super.output_handle,
                        "snapc:full: open()");
    opal_output_verbose(20, mca_snapc_full_component.super.output_handle,
                        "snapc:full: open: priority    = %d",
                        mca_snapc_full_component.super.priority);
    opal_output_verbose(20, mca_snapc_full_component.super.output_handle,
                        "snapc:full: open: verbosity   = %d",
                        mca_snapc_full_component.super.verbose);
    opal_output_verbose(20, mca_snapc_full_component.super.output_handle,
                        "snapc:full: open: max_wait_time  = %d",
                        orte_snapc_full_max_wait_time);
    opal_output_verbose(20, mca_snapc_full_component.super.output_handle,
                        "snapc:full: open: progress_meter = %d",
                        orte_snapc_full_progress_meter);

    return ORTE_SUCCESS;
}

static int snapc_full_close(void)
{
    opal_output_verbose(10, mca_snapc_full_component.super.output_handle,
                        "snapc:full: close()");

    return ORTE_SUCCESS;
}