aboutsummaryrefslogtreecommitdiffstats
path: root/host/lib/utils/load_modules.cpp
blob: dbb8d06955e0f2390048b1bef4de25bf86539386 (plain)
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
//
// Copyright 2010 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

#include <uhd/utils/static.hpp>
#include <boost/format.hpp>
#include <boost/foreach.hpp>
#include <boost/algorithm/string.hpp>
#include <boost/filesystem.hpp>
#include <boost/program_options.hpp>
#include <iostream>
#include <stdexcept>

namespace po = boost::program_options;
namespace fs = boost::filesystem;

/***********************************************************************
 * Module Load Function
 **********************************************************************/
#if defined(HAVE_DLFCN_H)
#include <dlfcn.h>
static const std::string env_path_sep = ":";

static void load_module(const std::string &file_name){
    if (dlopen(file_name.c_str(), RTLD_LAZY) == NULL){
        throw std::runtime_error(str(
            boost::format("dlopen failed to load \"%s\"") % file_name
        ));
    }
}

#elif defined(HAVE_WINDOWS_H)
#include <windows.h>
static const std::string env_path_sep = ";";

static void load_module(const std::string &file_name){
    if (LoadLibrary(file_name.c_str()) == NULL){
        throw std::runtime_error(str(
            boost::format("LoadLibrary failed to load \"%s\"") % file_name
        ));
    }
}

#else
static const std::string env_path_sep = ":";

static void load_module(const std::string &file_name){
    throw std::runtime_error(str(
        boost::format("Module loading not supported: Cannot load \"%s\"") % file_name
    ));
}

#endif

/***********************************************************************
 * Load Modules
 **********************************************************************/
/*!
 * Load all modules in a given path.
 * This will recurse into sub-directories.
 * Does not throw, prints to std error.
 * \param path the filesystem path
 */
static void load_path(const fs::path &path){
    if (not fs::exists(path)){
        std::cerr << boost::format("Module path \"%s\" not found.") % path.file_string() << std::endl;
        return;
    }

    //try to load the files in this path
    if (fs::is_directory(path)){
        for(
            fs::directory_iterator dir_itr(path);
            dir_itr != fs::directory_iterator();
            ++dir_itr
        ){
            load_path(dir_itr->path());
        }
        return;
    }

    //its not a directory, try to load it
    try{
        load_module(path.file_string());
    }
    catch(const std::exception &err){
        std::cerr << boost::format("Error: %s") % err.what() << std::endl;
    }
}

//! The string constant for the module path environment variable
static const std::string MODULE_PATH_KEY = "UHD_MODULE_PATH";

/*!
 * Name mapper function for the environment variable parser.
 * Map environment variable names (that we use) to option names.
 * \param the variable name
 * \return the option name or blank string
 */
static std::string name_mapper(const std::string &var_name){
    if (var_name == MODULE_PATH_KEY) return var_name;
    return "";
}

/*!
 * Load all the modules given by the module path enviroment variable.
 * The path variable may be several paths split by path separators.
 */
UHD_STATIC_BLOCK(load_modules){
    //register the options
    std::string env_module_path;
    po::options_description desc("UHD Module Options");
    desc.add_options()
        (MODULE_PATH_KEY.c_str(), po::value<std::string>(&env_module_path)->default_value(""))
    ;

    //parse environment variables
    po::variables_map vm;
    po::store(po::parse_environment(desc, &name_mapper), vm);
    po::notify(vm);

    if (env_module_path == "") return;
    //std::cout << "env_module_path: " << env_module_path << std::endl;

    //split the path at the path separators
    std::vector<std::string> module_paths;
    boost::split(module_paths, env_module_path, boost::is_any_of(env_path_sep));

    //load modules in each path
    BOOST_FOREACH(const std::string &module_path, module_paths){
        load_path(fs::system_complete(fs::path(module_path)));
    }
}