File: accelerator_base_select.c

package info (click to toggle)
openmpi 5.0.8-9
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 201,680 kB
  • sloc: ansic: 613,078; makefile: 42,350; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (182 lines) | stat: -rw-r--r-- 7,749 bytes parent folder | download | duplicates (2)
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
182
/*
 * Copyright (c) 2004-2010 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2007 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  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) 2012-2015 Los Alamos National Security, LLC.  All rights
 *                         reserved.
 * Copyright (c) 2013-2020 Intel, Inc.  All rights reserved.
 * Copyright (c) 2015-2020 Cisco Systems, Inc.  All rights reserved.
 * Copyright (c) 2020-2022 Amazon.com, Inc. or its affiliates.  All Rights
 * Copyright (c) 2018-2020 Triad National Security, LLC. All rights
 * Copyright (c) 2022      IBM Corporation.  All rights reserved.
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 */

#include "opal_config.h"

#include <string.h>

#include "opal/mca/accelerator/accelerator.h"
#include "opal/mca/accelerator/base/base.h"
#include "opal/class/opal_list.h"
#include "opal/constants.h"
#include "opal/mca/base/base.h"
#include "opal/mca/mca.h"
#include "opal/util/output.h"
#include "opal/util/show_help.h"
#include "opal/util/proc.h"

typedef struct accelerator_list_item_t {
  opal_list_item_t super;
  opal_accelerator_base_component_t *accelerator_component;
  opal_accelerator_base_module_t *accelerator_module;
} accelerator_list_item_t;

static void multiple_accelerators_found_help_message(opal_list_t *components);

int opal_accelerator_base_select(void)
{
    mca_base_component_list_item_t *cli = NULL;
    mca_base_component_t *skip = NULL;
    opal_accelerator_base_component_t *component = NULL;
    opal_accelerator_base_module_t *module = NULL;
    accelerator_list_item_t *ali = NULL, *ali2 = NULL;
    opal_list_t ordered_list, initialized_list;
    opal_list_item_t *item = NULL;

    OBJ_CONSTRUCT(&ordered_list, opal_list_t);
    OBJ_CONSTRUCT(&initialized_list, opal_list_t);

    /* Traverse the list of available components and create a new ordered list with
       the NULL Component on the back of the new list */
    OPAL_LIST_FOREACH(cli, &opal_accelerator_base_framework.framework_components, mca_base_component_list_item_t) {
        ali = (accelerator_list_item_t*) malloc(sizeof(accelerator_list_item_t));
        if (NULL == ali) {
            return OPAL_ERR_OUT_OF_RESOURCE;
        }

        OBJ_CONSTRUCT(ali, opal_list_item_t);
        ali->accelerator_component = (opal_accelerator_base_component_t *) cli->cli_component;

        if (0 == strcmp(cli->cli_component->mca_component_name, "null")) {
            opal_list_append(&ordered_list, (opal_list_item_t*) ali);
        }
        else {
            opal_list_prepend(&ordered_list, (opal_list_item_t*) ali);
        }
    }

    /* Traverse the ordered list of available components and try and initialize every component.
     * Save all initialized components in initialized component list. */
    OPAL_LIST_FOREACH(ali, &ordered_list, accelerator_list_item_t) {
        component = ali->accelerator_component;
        if (NULL == component->accelerator_init) {
            opal_output_verbose(10, opal_accelerator_base_framework.framework_output,
                                 "select: no init function; ignoring component %s",
                                 component->base_version.mca_component_name);
            continue;
        }

        opal_output_verbose(10, opal_accelerator_base_framework.framework_output,
                            "select: initializing %s component %s",
                            component->base_version.mca_type_name,
                            component->base_version.mca_component_name);

        module = component->accelerator_init();

        if (NULL != module) {
            ali2 = (accelerator_list_item_t*) malloc(sizeof(accelerator_list_item_t));
            if (NULL == ali2) {
                return OPAL_ERR_OUT_OF_RESOURCE;
            }

            OBJ_CONSTRUCT(ali2, opal_list_item_t);

            ali2->accelerator_component = ali->accelerator_component;
            ali2->accelerator_module = module;

            opal_list_append(&initialized_list, (opal_list_item_t*) ali2);
        }
    }

    /* There are four possible cases to handle:
     * 1. List empty, someone selected a component with --mca accelerator <component> and it fails to initialize
     * 2. There is 1 component in the list (NULL will always initialize, or someone selected a component)
     * 3. There are 2 components in the list (User Defined, and NULL)
     * 4. There are 3+ components in the list (User Defined1, User Defined 2, ..., NULL)
     *
     * Case 1: Abort and show simple help message
     * Case 2 & 3 can be handled the same way by selecting the first component in the list
     * Case 4: Show help (with a string containing all initialized components) and abort
    */
    if (0 == initialized_list.opal_list_length) {
        opal_show_help("help-accelerator-base.txt", "No Accelerators Found", true);
        /* leaks memory, but doesn't matter b/c ompi is aborting */
        return OPAL_ERR_FATAL;
    } else if (2 >= initialized_list.opal_list_length) {
        ali = (accelerator_list_item_t *) opal_list_get_first(&initialized_list);
        opal_accelerator_base_selected_component = *ali->accelerator_component;
        skip = (mca_base_component_t *) ali->accelerator_component;
        opal_accelerator = *ali->accelerator_module;
    } else {
        multiple_accelerators_found_help_message(&initialized_list);
        /* leaks memory, but doesn't matter b/c ompi is aborting */
        return OPAL_ERR_FATAL;
    }

    opal_output_verbose(10, opal_accelerator_base_framework.framework_output, "selected %s\n",
                        opal_accelerator_base_selected_component.base_version.mca_component_name);

    /* This base function closes, unloads, and removes from the available list all
     * unselected components. The available list will contain only the selected component. */
    mca_base_framework_components_close(&opal_accelerator_base_framework, skip);

    /* Cleanup Lists */
    for (item = opal_list_remove_first(&ordered_list); NULL != item; item = opal_list_remove_first(&ordered_list)) {
        OBJ_DESTRUCT(item);
        free(item);
    }

    for (item = opal_list_remove_first(&initialized_list); NULL != item; item = opal_list_remove_first(&initialized_list)) {
        OBJ_DESTRUCT(item);
        free(item);
    }

    OBJ_DESTRUCT(&ordered_list);
    OBJ_DESTRUCT(&initialized_list);

    return OPAL_SUCCESS;
}

static void multiple_accelerators_found_help_message(opal_list_t *components)
{
    accelerator_list_item_t *ali = NULL;
    int i = 0;
    int list_length = components->opal_list_length;
    /* NULL Terminator + Do not include NULL component in list */
    char* component_names = (char*) malloc(1 + ((list_length - 1) * MCA_BASE_MAX_COMPONENT_NAME_LEN));
    component_names[0] = '\0';

    OPAL_LIST_FOREACH(ali, components, accelerator_list_item_t) {
        strcat(component_names, ali->accelerator_component->base_version.mca_component_name);
        /* Do not include NULL component in list */
        if (++i == list_length - 1) {
            break;
        }
        strcat(component_names, ", ");
    }

    opal_show_help("help-accelerator-base.txt", "Multiple Accelerators Found", true, component_names);
    free(component_names);
}