1/*
2    Copyright (c) 2014 Intel Corporation.  All Rights Reserved.
3
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8      * Redistributions of source code must retain the above copyright
9        notice, this list of conditions and the following disclaimer.
10      * Redistributions in binary form must reproduce the above copyright
11        notice, this list of conditions and the following disclaimer in the
12        documentation and/or other materials provided with the distribution.
13      * Neither the name of Intel Corporation nor the names of its
14        contributors may be used to endorse or promote products derived
15        from this software without specific prior written permission.
16
17    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21    HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*/
29
30
31#ifndef OFFLOAD_ENV_H_INCLUDED
32#define OFFLOAD_ENV_H_INCLUDED
33
34#include <list>
35
36// data structure and routines to parse MIC user environment and pass to MIC
37
38enum MicEnvVarKind
39{
40    c_no_mic,         // not MIC env var
41    c_mic_var,        // for <mic-prefix>_<var>
42    c_mic_card_var,   // for <mic-prefix>_<card-number>_<var>
43    c_mic_card_env    // for <mic-prefix>_<card-number>_ENV
44};
45
46struct MicEnvVar {
47public:
48    MicEnvVar() : prefix(0) {}
49    ~MicEnvVar();
50
51    void analyze_env_var(char *env_var_string);
52    char** create_environ_for_card(int card_num);
53    MicEnvVarKind get_env_var_kind(
54        char *env_var_string,
55        int *card_number,
56        char **env_var_name,
57        int *env_var_name_length,
58        char **env_var_def
59    );
60    void add_env_var(
61        int card_number,
62        char *env_var_name,
63        int env_var_name_length,
64        char *env_var_def
65    );
66
67    void set_prefix(const char *pref) {
68        prefix = (pref && *pref != '\0') ? pref : 0;
69    }
70
71    struct VarValue {
72    public:
73        char* env_var;
74        int   length;
75        char* env_var_value;
76
77        VarValue(char* var, int ln, char* value)
78        {
79            env_var = var;
80            length = ln;
81            env_var_value = value;
82        }
83        ~VarValue();
84    };
85
86    struct CardEnvVars {
87    public:
88
89        int card_number;
90        std::list<struct VarValue*> env_vars;
91
92        CardEnvVars() { card_number = any_card; }
93        CardEnvVars(int num) { card_number = num; }
94        ~CardEnvVars();
95
96        void add_new_env_var(int number, char *env_var, int length,
97                             char *env_var_value);
98        VarValue* find_var(char* env_var_name, int env_var_name_length);
99    };
100    static const int any_card;
101
102private:
103    void         mic_parse_env_var_list(int card_number, char *env_var_def);
104    CardEnvVars* get_card(int number);
105
106    const char *prefix;
107    std::list<struct CardEnvVars *> card_spec_list;
108    CardEnvVars common_vars;
109};
110
111#endif // OFFLOAD_ENV_H_INCLUDED
112