aboutsummaryrefslogtreecommitdiff
path: root/backends/plugins/elf-provider.cpp
blob: ae728495fae7f07ce3959f2613667d25a8eac381 (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
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $URL$
 * $Id$
 *
 */

#if defined(DYNAMIC_MODULES) //TODO: && defined(ELF loader target)

#include "backends/plugins/elf-provider.h"
#include "backends/plugins/dynamic-plugin.h"
#include "common/fs.h"

#include "backends/plugins/elf-loader.h"

class ELFPlugin : public DynamicPlugin {
protected:
	DLObject *_dlHandle;
	Common::String _filename;

	virtual VoidFunc findSymbol(const char *symbol) {
		void *func;
		bool handleNull;
		if (_dlHandle == NULL) {
			func = NULL;
			handleNull = true;
		} else {
			func = _dlHandle->symbol(symbol);
		}
		if (!func) {
			if (handleNull) {
				warning("Failed loading symbol '%s' from plugin '%s' (Handle is NULL)", symbol, _filename.c_str());
			} else {
				warning("Failed loading symbol '%s' from plugin '%s'", symbol, _filename.c_str());
			}
		}

		// FIXME HACK: This is a HACK to circumvent a clash between the ISO C++
		// standard and POSIX: ISO C++ disallows casting between function pointers
		// and data pointers, but dlsym always returns a void pointer. For details,
		// see e.g. <http://www.trilithium.com/johan/2004/12/problem-with-dlsym/>.
		assert(sizeof(VoidFunc) == sizeof(func));
		VoidFunc tmp;
		memcpy(&tmp, &func, sizeof(VoidFunc));
		return tmp;
	}

public:
	ELFPlugin(const Common::String &filename)
		: _dlHandle(0), _filename(filename) {}

	~ELFPlugin() {
		if (_dlHandle)
			unloadPlugin();
	}

	bool loadPlugin() {
		assert(!_dlHandle);
		DLObject *obj = new DLObject(NULL);
		if (obj->open(_filename.c_str())) {
			_dlHandle = obj;
		} else {
			delete obj;
			_dlHandle = NULL;
		}

		if (!_dlHandle) {
			warning("Failed loading plugin '%s'", _filename.c_str());
			return false;
		}

		bool ret = DynamicPlugin::loadPlugin();

		if (ret && _dlHandle) {
			_dlHandle->discard_symtab();
		}

		return ret;
	}

	void unloadPlugin() {
		DynamicPlugin::unloadPlugin();
		if (_dlHandle) {
			if (_dlHandle == NULL) {
				// FIXME: This check makes no sense, _dlHandle cannot be NULL at this point
				warning("Failed unloading plugin '%s' (Handle is NULL)", _filename.c_str());
			} else if (_dlHandle->close()) {
				delete _dlHandle;
			} else {
				warning("Failed unloading plugin '%s'", _filename.c_str());
				// FIXME: We are leaking _dlHandle here!
				// Any particular reasons why we would want to do that???
			}
			_dlHandle = 0;
		}
	}
};


Plugin* ELFPluginProvider::createPlugin(const Common::FSNode &node) const {
	return new ELFPlugin(node.getPath());
}

bool ELFPluginProvider::isPluginFilename(const Common::FSNode &node) const {
	// Check the plugin suffix
	// FIXME: Do we need these printfs? Should get rid of them eventually.
	Common::String filename = node.getName();
	printf("Testing name %s", filename.c_str());
	if (!filename.hasSuffix(".PLG") && !filename.hasSuffix(".plg") && !filename.hasSuffix(".PLUGIN") && !filename.hasSuffix(".plugin")) {
		printf(" fail.\n");
		return false;
	}

	printf(" success!\n");
	return true;
}

#endif // defined(DYNAMIC_MODULES)