Platform.cpp 8.58 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 {
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
vector<Platform*>& Platform::getPlatforms() {
    static vector<Platform*> platforms;
    return platforms;
}

122
void Platform::registerPlatform(Platform* platform) {
123
    getPlatforms().push_back(platform);
124
125
126
}

int Platform::getNumPlatforms() {
127
    return getPlatforms().size();
128
129
130
}

Platform& Platform::getPlatform(int index) {
131
    return *getPlatforms()[index];
132
133
}

Peter Eastman's avatar
Peter Eastman committed
134
Platform& Platform::findPlatform(const vector<string>& kernelNames) {
135
    Platform* best = 0;
136
    vector<Platform*>& platforms = getPlatforms();
137
138
139
140
141
142
143
144
    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)
145
        throw OpenMMException("No Platform supports all the requested kernels");
146
147
    return *best;
}
148

149
void Platform::loadPluginLibrary(const string& file) {
150
#ifdef WIN32
151
152
    // Tell Windows not to bother the user with ugly error boxes.
    const UINT oldErrorMode = SetErrorMode(SEM_FAILCRITICALERRORS);
153
    HMODULE handle = LoadLibrary(file.c_str());
154
    SetErrorMode(oldErrorMode); // Restore previous error mode.
155
156
157
158
159
160
161
162
163
164
165
	if (handle == NULL) {
		string message;
		stringstream(message) << "Error loading library " << file << ": " << GetLastError();
        throw OpenMMException(message);
	}
#else
    void *handle = dlopen(file.c_str(), RTLD_LAZY | RTLD_GLOBAL);
    if (handle == NULL)
        throw OpenMMException("Error loading library "+file+": "+dlerror());
#endif
}
166

167
vector<string> Platform::loadPluginsFromDirectory(const string& directory) {
168
169
    vector<string> files;
    char dirSeparator;
170
#ifdef WIN32
171
172
    dirSeparator = '\\';
    WIN32_FIND_DATA fileInfo;
173
    string filePattern(directory + dirSeparator + "*.dll");
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
    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;
}
206

Peter Eastman's avatar
Peter Eastman committed
207
const string& Platform::getDefaultPluginsDirectory() {
208
    char* dir = getenv("OPENMM_PLUGIN_DIR");
209
    static string directory;
210
#ifdef _MSC_VER
211
    if (dir != NULL)
212
213
214
215
216
217
218
219
        directory = string(dir);
    else {
        dir = getenv("PROGRAMFILES");
        if (dir == NULL)
            directory = "C:\\\\Program Files\\OpenMM\\lib\\plugins";
        else
            directory = string(dir)+"\\OpenMM\\lib\\plugins";
    }
220
221
#else
    if (dir == NULL)
222
        dir = "/usr/local/openmm/lib/plugins";
Peter Eastman's avatar
Peter Eastman committed
223
    directory = string(dir);
224
#endif
225
    return directory;
226
}
227
228
229
230
231
232
233
234
235

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

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