Platform.cpp 10.3 KB
Newer Older
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
/* -------------------------------------------------------------------------- *
 *                                   OpenMM                                   *
 * -------------------------------------------------------------------------- *
 * This is part of the OpenMM molecular simulation toolkit originating from   *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org.               *
 *                                                                            *
 * Portions copyright (c) 2008 Stanford University and the Authors.           *
 * Authors: Peter Eastman                                                     *
 * Contributors:                                                              *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
 * copy of this software and associated documentation files (the "Software"), *
 * to deal in the Software without restriction, including without limitation  *
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
 * and/or sell copies of the Software, and to permit persons to whom the      *
 * Software is furnished to do so, subject to the following conditions:       *
 *                                                                            *
 * The above copyright notice and this permission notice shall be included in *
 * all copies or substantial portions of the Software.                        *
 *                                                                            *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
 * THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,    *
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR      *
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE  *
 * USE OR OTHER DEALINGS IN THE SOFTWARE.                                     *
 * -------------------------------------------------------------------------- */

32
#include "openmm/Platform.h"
33
#include "openmm/Context.h"
34
35
36
#include "openmm/OpenMMException.h"
#include "openmm/Kernel.h"
#include "openmm/KernelFactory.h"
37
38
39
40
41
#ifdef WIN32
#include <windows.h>
#include <sstream>
#else
#include <dlfcn.h>
42
#include <dirent.h>
43
#include <cstdlib>
44
#endif
45
#include <set>
46

47
48
#include "ReferencePlatform.h"

49
50
51
using namespace OpenMM;
using namespace std;

52
53
54
55
56
57
58
59
60
61
62
static int registerPlatforms() {

    // Register the Platforms built into the main library.  This should eventually be moved elsewhere.
    
    ReferencePlatform* platform = new ReferencePlatform();
    Platform::registerPlatform(platform);
    return 0;
}

static int platformInitializer = registerPlatforms();

63
64
65
66
67
68
69
70
Platform::~Platform() {
    set<KernelFactory*> uniqueKernelFactories;
    for (map<string, KernelFactory*>::const_iterator iter = kernelFactories.begin(); iter != kernelFactories.end(); ++iter)
        uniqueKernelFactories.insert(iter->second);
    for (set<KernelFactory*>::const_iterator iter = uniqueKernelFactories.begin(); iter != uniqueKernelFactories.end(); ++iter)
        delete *iter;
}

71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
const vector<string>& Platform::getPropertyNames() {
    return platformProperties;
}

const string& Platform::getPropertyValue(const Context& context, const string& property) const {
    throw OpenMMException("getPropertyValue: Illegal property name");
}

void Platform::setPropertyValue(Context& context, const string& property, const string& value) const {
    throw OpenMMException("setPropertyValue: Illegal property name");
}

const string& Platform::getPropertyDefaultValue(const string& property) const {
    map<string, string>::const_iterator value = defaultProperties.find(property);
    if (value == defaultProperties.end())
        throw OpenMMException("getPropertyDefaultValue: Illegal property name");
    return value->second;
}

void Platform::setPropertyDefaultValue(const string& property, const string& value) {
    defaultProperties[property] = value;
}

94
void Platform::contextCreated(ContextImpl& context, const map<string, string>& properties) const {
95
96
}

97
void Platform::contextDestroyed(ContextImpl& context) const {
98
99
}

100
void Platform::registerKernelFactory(const string& name, KernelFactory* factory) {
101
102
103
    kernelFactories[name] = factory;
}

Peter Eastman's avatar
Peter Eastman committed
104
bool Platform::supportsKernels(const vector<string>& kernelNames) const {
105
106
107
108
109
110
    for (int i = 0; i < (int) kernelNames.size(); ++i)
        if (kernelFactories.find(kernelNames[i]) == kernelFactories.end())
            return false;
    return true;
}

111
Kernel Platform::createKernel(const string& name, ContextImpl& context) const {
112
    if (kernelFactories.find(name) == kernelFactories.end())
113
        throw OpenMMException("Called createKernel() on a Platform which does not support the requested kernel");
114
    return Kernel(kernelFactories.find(name)->second->createKernelImpl(name, *this, context));
115
116
}

117
118
119
120
121
122
123
124
125
126
127
128
#ifdef WIN32
static vector<HMODULE>& getPlugins() {
    static vector<HMODULE> plugins;
    return plugins;
}
#else
static vector<void*>& getPlugins() {
    static vector<void*> plugins;
    return plugins;
}
#endif

129
vector<Platform*>& Platform::getPlatforms() {
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
    if (getPlugins().size() > 0) {
        // Initialize plugins before returning the list of platforms.

#ifdef WIN32
        vector<HMODULE> plugins = getPlugins();
        getPlugins().clear();
        for (int i = 0; i < (int) plugins.size(); i++) {
            void (*init)();
            *(void **)(&init) = GetProcAddress(plugins[i], "registerPlatforms");
            if (init != NULL)
                (*init)();
        }
        for (int i = 0; i < (int) plugins.size(); i++) {
            void (*init)();
            *(void **)(&init) = GetProcAddress(plugins[i], "registerKernelFactories");
            if (init != NULL)
                (*init)();
        }
#else
        vector<void*> plugins = getPlugins();
        getPlugins().clear();
        for (int i = 0; i < (int) plugins.size(); i++) {
            void (*init)();
            *(void **)(&init) = dlsym(plugins[i], "registerPlatforms");
            if (init != NULL)
                (*init)();
        }
        for (int i = 0; i < (int) plugins.size(); i++) {
            void (*init)();
            *(void **)(&init) = dlsym(plugins[i], "registerKernelFactories");
            if (init != NULL)
                (*init)();
        }
#endif
    }
165
166
167
168
    static vector<Platform*> platforms;
    return platforms;
}

169
void Platform::registerPlatform(Platform* platform) {
170
    getPlatforms().push_back(platform);
171
172
173
}

int Platform::getNumPlatforms() {
174
    return getPlatforms().size();
175
176
177
}

Platform& Platform::getPlatform(int index) {
178
    return *getPlatforms()[index];
179
180
}

181
Platform& Platform::getPlatformByName(const string& name) {
182
183
184
185
186
187
    for (int i = 0; i < getNumPlatforms(); i++)
        if (getPlatform(i).getName() == name)
            return getPlatform(i);
    throw OpenMMException("There is no registered Platform called \""+name+"\"");
}

Peter Eastman's avatar
Peter Eastman committed
188
Platform& Platform::findPlatform(const vector<string>& kernelNames) {
189
    Platform* best = 0;
190
    vector<Platform*>& platforms = getPlatforms();
191
192
193
194
195
196
197
198
    double speed = 0.0;
    for (int i = 0; i < (int) platforms.size(); ++i) {
        if (platforms[i]->supportsKernels(kernelNames) && platforms[i]->getSpeed() > speed) {
            best = platforms[i];
            speed = best->getSpeed();
        }
    }
    if (best == 0)
199
        throw OpenMMException("No Platform supports all the requested kernels");
200
201
    return *best;
}
202

203
void Platform::loadPluginLibrary(const string& file) {
204
#ifdef WIN32
205
206
    // Tell Windows not to bother the user with ugly error boxes.
    const UINT oldErrorMode = SetErrorMode(SEM_FAILCRITICALERRORS);
207
    HMODULE handle = LoadLibrary(file.c_str());
208
    SetErrorMode(oldErrorMode); // Restore previous error mode.
209
210
211
    if (handle == NULL) {
        string message;
        stringstream(message) << "Error loading library " << file << ": " << GetLastError();
212
        throw OpenMMException(message);
213
    }
214
215
216
217
218
#else
    void *handle = dlopen(file.c_str(), RTLD_LAZY | RTLD_GLOBAL);
    if (handle == NULL)
        throw OpenMMException("Error loading library "+file+": "+dlerror());
#endif
219
    getPlugins().push_back(handle);
220
}
221

222
vector<string> Platform::loadPluginsFromDirectory(const string& directory) {
223
224
    vector<string> files;
    char dirSeparator;
225
#ifdef WIN32
226
227
    dirSeparator = '\\';
    WIN32_FIND_DATA fileInfo;
228
    string filePattern(directory + dirSeparator + "*.dll");
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
    HANDLE findHandle = FindFirstFile(filePattern.c_str(), &fileInfo);
    if (findHandle != INVALID_HANDLE_VALUE) {
        do {
            if (fileInfo.cFileName[0] != '.')
                files.push_back(string(fileInfo.cFileName));
        } while (FindNextFile(findHandle, &fileInfo));
        FindClose(findHandle);
    }
#else
    dirSeparator = '/';
    DIR* dir;
    struct dirent *entry;
    dir = opendir(directory.c_str());
    if (dir != NULL) {
        while ((entry = readdir(dir)) != NULL) {
            if (entry->d_name[0] != '.')
                files.push_back(string(entry->d_name));
        }
        closedir(dir);
    }
#endif
    vector<string> loadedLibraries;
    for (unsigned int i = 0; i < files.size(); ++i) {
        try {
            Platform::loadPluginLibrary(directory+dirSeparator+files[i]);
            loadedLibraries.push_back(files[i]);
        } catch (OpenMMException ex) {
            // Just ignore it.
        }
    }
    return loadedLibraries;
}
261

Peter Eastman's avatar
Peter Eastman committed
262
const string& Platform::getDefaultPluginsDirectory() {
263
    char* dir = getenv("OPENMM_PLUGIN_DIR");
264
    static string directory;
265
#ifdef _MSC_VER
266
    if (dir != NULL)
267
268
269
270
271
272
273
274
        directory = string(dir);
    else {
        dir = getenv("PROGRAMFILES");
        if (dir == NULL)
            directory = "C:\\\\Program Files\\OpenMM\\lib\\plugins";
        else
            directory = string(dir)+"\\OpenMM\\lib\\plugins";
    }
275
276
#else
    if (dir == NULL)
277
        dir = "/usr/local/openmm/lib/plugins";
Peter Eastman's avatar
Peter Eastman committed
278
    directory = string(dir);
279
#endif
280
    return directory;
281
}
282
283
284
285
286
287
288
289
290

ContextImpl& Platform::getContextImpl(Context& context) const {
    return *context.impl;
}

const ContextImpl& Platform::getContextImpl(const Context& context) const {
    return *context.impl;
}