blob: e633fe97e620394c621260c4cac2c07b875234cf [file] [log] [blame]
Guido van Rossum34162a11994-05-23 12:37:57 +00001
2/* dl module */
3
Roger E. Masse0e120321996-12-13 20:33:44 +00004#include "Python.h"
Guido van Rossum34162a11994-05-23 12:37:57 +00005
6#include <dlfcn.h>
7
Neal Norwitz2a30cd02006-07-10 01:18:57 +00008#ifdef __VMS
9#include <unistd.h>
10#endif
11
Guido van Rossum34162a11994-05-23 12:37:57 +000012#ifndef RTLD_LAZY
13#define RTLD_LAZY 1
14#endif
15
Thomas Wouters334fb892000-07-25 12:56:38 +000016typedef void *PyUnivPtr;
Guido van Rossum34162a11994-05-23 12:37:57 +000017typedef struct {
Roger E. Masse0e120321996-12-13 20:33:44 +000018 PyObject_HEAD
19 PyUnivPtr *dl_handle;
Guido van Rossum34162a11994-05-23 12:37:57 +000020} dlobject;
21
Jeremy Hylton938ace62002-07-17 16:30:39 +000022static PyTypeObject Dltype;
Guido van Rossum34162a11994-05-23 12:37:57 +000023
Roger E. Masse0e120321996-12-13 20:33:44 +000024static PyObject *Dlerror;
Guido van Rossum34162a11994-05-23 12:37:57 +000025
Roger E. Masse0e120321996-12-13 20:33:44 +000026static PyObject *
Peter Schneider-Kampc4bc0e02000-07-10 11:56:03 +000027newdlobject(PyUnivPtr *handle)
Guido van Rossum34162a11994-05-23 12:37:57 +000028{
29 dlobject *xp;
Guido van Rossumb18618d2000-05-03 23:44:39 +000030 xp = PyObject_New(dlobject, &Dltype);
Guido van Rossum34162a11994-05-23 12:37:57 +000031 if (xp == NULL)
32 return NULL;
33 xp->dl_handle = handle;
Roger E. Masse0e120321996-12-13 20:33:44 +000034 return (PyObject *)xp;
Guido van Rossum34162a11994-05-23 12:37:57 +000035}
36
37static void
Peter Schneider-Kampc4bc0e02000-07-10 11:56:03 +000038dl_dealloc(dlobject *xp)
Guido van Rossum34162a11994-05-23 12:37:57 +000039{
40 if (xp->dl_handle != NULL)
41 dlclose(xp->dl_handle);
Guido van Rossumb18618d2000-05-03 23:44:39 +000042 PyObject_Del(xp);
Guido van Rossum34162a11994-05-23 12:37:57 +000043}
44
Roger E. Masse0e120321996-12-13 20:33:44 +000045static PyObject *
Neal Norwitzb82d34f2002-03-31 15:43:28 +000046dl_close(dlobject *xp)
Guido van Rossum34162a11994-05-23 12:37:57 +000047{
Guido van Rossum34162a11994-05-23 12:37:57 +000048 if (xp->dl_handle != NULL) {
49 dlclose(xp->dl_handle);
50 xp->dl_handle = NULL;
51 }
Roger E. Masse0e120321996-12-13 20:33:44 +000052 Py_INCREF(Py_None);
53 return Py_None;
Guido van Rossum34162a11994-05-23 12:37:57 +000054}
55
Roger E. Masse0e120321996-12-13 20:33:44 +000056static PyObject *
Peter Schneider-Kampc4bc0e02000-07-10 11:56:03 +000057dl_sym(dlobject *xp, PyObject *args)
Guido van Rossum34162a11994-05-23 12:37:57 +000058{
59 char *name;
Roger E. Masse0e120321996-12-13 20:33:44 +000060 PyUnivPtr *func;
Christian Heimes593daf52008-05-26 12:51:38 +000061 if (PyBytes_Check(args)) {
62 name = PyBytes_AS_STRING(args);
Neal Norwitzb82d34f2002-03-31 15:43:28 +000063 } else {
64 PyErr_Format(PyExc_TypeError, "expected string, found %.200s",
Christian Heimese93237d2007-12-19 02:37:44 +000065 Py_TYPE(args)->tp_name);
Guido van Rossum34162a11994-05-23 12:37:57 +000066 return NULL;
Neal Norwitzb82d34f2002-03-31 15:43:28 +000067 }
Guido van Rossum34162a11994-05-23 12:37:57 +000068 func = dlsym(xp->dl_handle, name);
69 if (func == NULL) {
Roger E. Masse0e120321996-12-13 20:33:44 +000070 Py_INCREF(Py_None);
71 return Py_None;
Guido van Rossum34162a11994-05-23 12:37:57 +000072 }
Roger E. Masse0e120321996-12-13 20:33:44 +000073 return PyInt_FromLong((long)func);
Guido van Rossum34162a11994-05-23 12:37:57 +000074}
75
Roger E. Masse0e120321996-12-13 20:33:44 +000076static PyObject *
Peter Schneider-Kampc4bc0e02000-07-10 11:56:03 +000077dl_call(dlobject *xp, PyObject *args)
Guido van Rossum34162a11994-05-23 12:37:57 +000078{
Roger E. Masse0e120321996-12-13 20:33:44 +000079 PyObject *name;
Fred Drake4747a182000-10-11 21:44:02 +000080 long (*func)(long, long, long, long, long,
81 long, long, long, long, long);
Guido van Rossum34162a11994-05-23 12:37:57 +000082 long alist[10];
83 long res;
Neal Norwitz047f3c72006-06-12 02:06:42 +000084 Py_ssize_t i;
85 Py_ssize_t n = PyTuple_Size(args);
Guido van Rossum34162a11994-05-23 12:37:57 +000086 if (n < 1) {
Roger E. Masse0e120321996-12-13 20:33:44 +000087 PyErr_SetString(PyExc_TypeError, "at least a name is needed");
Guido van Rossum34162a11994-05-23 12:37:57 +000088 return NULL;
89 }
Roger E. Masse0e120321996-12-13 20:33:44 +000090 name = PyTuple_GetItem(args, 0);
Christian Heimes593daf52008-05-26 12:51:38 +000091 if (!PyBytes_Check(name)) {
Roger E. Masse0e120321996-12-13 20:33:44 +000092 PyErr_SetString(PyExc_TypeError,
93 "function name must be a string");
Guido van Rossum34162a11994-05-23 12:37:57 +000094 return NULL;
95 }
Andrew M. Kuchlinga1a690f2001-02-22 15:52:55 +000096 func = (long (*)(long, long, long, long, long,
97 long, long, long, long, long))
Christian Heimes593daf52008-05-26 12:51:38 +000098 dlsym(xp->dl_handle, PyBytes_AsString(name));
Guido van Rossum34162a11994-05-23 12:37:57 +000099 if (func == NULL) {
Roger E. Masse0e120321996-12-13 20:33:44 +0000100 PyErr_SetString(PyExc_ValueError, dlerror());
Guido van Rossum34162a11994-05-23 12:37:57 +0000101 return NULL;
102 }
103 if (n-1 > 10) {
Roger E. Masse0e120321996-12-13 20:33:44 +0000104 PyErr_SetString(PyExc_TypeError,
105 "too many arguments (max 10)");
Guido van Rossum34162a11994-05-23 12:37:57 +0000106 return NULL;
107 }
108 for (i = 1; i < n; i++) {
Roger E. Masse0e120321996-12-13 20:33:44 +0000109 PyObject *v = PyTuple_GetItem(args, i);
110 if (PyInt_Check(v))
111 alist[i-1] = PyInt_AsLong(v);
Christian Heimes593daf52008-05-26 12:51:38 +0000112 else if (PyBytes_Check(v))
113 alist[i-1] = (long)PyBytes_AsString(v);
Roger E. Masse0e120321996-12-13 20:33:44 +0000114 else if (v == Py_None)
Guido van Rossum34162a11994-05-23 12:37:57 +0000115 alist[i-1] = (long) ((char *)NULL);
116 else {
Roger E. Masse0e120321996-12-13 20:33:44 +0000117 PyErr_SetString(PyExc_TypeError,
Guido van Rossum34162a11994-05-23 12:37:57 +0000118 "arguments must be int, string or None");
119 return NULL;
120 }
121 }
122 for (; i <= 10; i++)
123 alist[i-1] = 0;
124 res = (*func)(alist[0], alist[1], alist[2], alist[3], alist[4],
125 alist[5], alist[6], alist[7], alist[8], alist[9]);
Roger E. Masse0e120321996-12-13 20:33:44 +0000126 return PyInt_FromLong(res);
Guido van Rossum34162a11994-05-23 12:37:57 +0000127}
128
Roger E. Masse0e120321996-12-13 20:33:44 +0000129static PyMethodDef dlobject_methods[] = {
Martin v. Löwis43b936d2002-01-17 23:15:58 +0000130 {"call", (PyCFunction)dl_call, METH_VARARGS},
Neal Norwitzb82d34f2002-03-31 15:43:28 +0000131 {"sym", (PyCFunction)dl_sym, METH_O},
132 {"close", (PyCFunction)dl_close, METH_NOARGS},
Roger E. Masse0e120321996-12-13 20:33:44 +0000133 {NULL, NULL} /* Sentinel */
Guido van Rossum34162a11994-05-23 12:37:57 +0000134};
135
Roger E. Masse0e120321996-12-13 20:33:44 +0000136static PyObject *
Peter Schneider-Kampc4bc0e02000-07-10 11:56:03 +0000137dl_getattr(dlobject *xp, char *name)
Guido van Rossum34162a11994-05-23 12:37:57 +0000138{
Roger E. Masse0e120321996-12-13 20:33:44 +0000139 return Py_FindMethod(dlobject_methods, (PyObject *)xp, name);
Guido van Rossum34162a11994-05-23 12:37:57 +0000140}
141
142
Roger E. Masse0e120321996-12-13 20:33:44 +0000143static PyTypeObject Dltype = {
Martin v. Löwis68192102007-07-21 06:55:02 +0000144 PyVarObject_HEAD_INIT(NULL, 0)
Guido van Rossum14648392001-12-08 18:02:58 +0000145 "dl.dl", /*tp_name*/
Guido van Rossum34162a11994-05-23 12:37:57 +0000146 sizeof(dlobject), /*tp_basicsize*/
147 0, /*tp_itemsize*/
148 /* methods */
149 (destructor)dl_dealloc, /*tp_dealloc*/
150 0, /*tp_print*/
151 (getattrfunc)dl_getattr,/*tp_getattr*/
152 0, /*tp_setattr*/
153 0, /*tp_compare*/
154 0, /*tp_repr*/
155 0, /*tp_as_number*/
156 0, /*tp_as_sequence*/
157 0, /*tp_as_mapping*/
158 0, /*tp_hash*/
159};
160
Roger E. Masse0e120321996-12-13 20:33:44 +0000161static PyObject *
Peter Schneider-Kampc4bc0e02000-07-10 11:56:03 +0000162dl_open(PyObject *self, PyObject *args)
Guido van Rossum34162a11994-05-23 12:37:57 +0000163{
164 char *name;
165 int mode;
Roger E. Masse0e120321996-12-13 20:33:44 +0000166 PyUnivPtr *handle;
Martin v. Löwis93227272002-01-01 20:18:30 +0000167 if (sizeof(int) != sizeof(long) ||
168 sizeof(long) != sizeof(char *)) {
169 PyErr_SetString(PyExc_SystemError,
170 "module dl requires sizeof(int) == sizeof(long) == sizeof(char*)");
171 return NULL;
172 }
173
Neal Norwitzb82d34f2002-03-31 15:43:28 +0000174 if (PyArg_ParseTuple(args, "z:open", &name))
Guido van Rossum34162a11994-05-23 12:37:57 +0000175 mode = RTLD_LAZY;
176 else {
Roger E. Masse0e120321996-12-13 20:33:44 +0000177 PyErr_Clear();
Neal Norwitzb82d34f2002-03-31 15:43:28 +0000178 if (!PyArg_ParseTuple(args, "zi:open", &name, &mode))
Guido van Rossum34162a11994-05-23 12:37:57 +0000179 return NULL;
180#ifndef RTLD_NOW
181 if (mode != RTLD_LAZY) {
Roger E. Masse0e120321996-12-13 20:33:44 +0000182 PyErr_SetString(PyExc_ValueError, "mode must be 1");
Guido van Rossum34162a11994-05-23 12:37:57 +0000183 return NULL;
184 }
185#endif
186 }
187 handle = dlopen(name, mode);
188 if (handle == NULL) {
Roger E. Masse0e120321996-12-13 20:33:44 +0000189 PyErr_SetString(Dlerror, dlerror());
Guido van Rossum34162a11994-05-23 12:37:57 +0000190 return NULL;
191 }
Neal Norwitz2a30cd02006-07-10 01:18:57 +0000192#ifdef __VMS
193 /* Under OpenVMS dlopen doesn't do any check, just save the name
194 * for later use, so we have to check if the file is readable,
195 * the name can be a logical or a file from SYS$SHARE.
196 */
197 if (access(name, R_OK)) {
198 char fname[strlen(name) + 20];
199 strcpy(fname, "SYS$SHARE:");
200 strcat(fname, name);
201 strcat(fname, ".EXE");
202 if (access(fname, R_OK)) {
203 dlclose(handle);
204 PyErr_SetString(Dlerror,
205 "File not found or protection violation");
206 return NULL;
207 }
208 }
209#endif
Guido van Rossum34162a11994-05-23 12:37:57 +0000210 return newdlobject(handle);
211}
212
Roger E. Masse0e120321996-12-13 20:33:44 +0000213static PyMethodDef dl_methods[] = {
Neal Norwitzb82d34f2002-03-31 15:43:28 +0000214 {"open", dl_open, METH_VARARGS},
Guido van Rossum34162a11994-05-23 12:37:57 +0000215 {NULL, NULL} /* sentinel */
216};
217
Martin v. Löwisdf23f332000-09-13 16:26:10 +0000218/* From socketmodule.c
219 * Convenience routine to export an integer value.
220 *
221 * Errors are silently ignored, for better or for worse...
222 */
223static void
224insint(PyObject *d, char *name, int value)
225{
226 PyObject *v = PyInt_FromLong((long) value);
227 if (!v || PyDict_SetItemString(d, name, v))
228 PyErr_Clear();
229
230 Py_XDECREF(v);
231}
232
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000233PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000234initdl(void)
Guido van Rossum34162a11994-05-23 12:37:57 +0000235{
Roger E. Masse0e120321996-12-13 20:33:44 +0000236 PyObject *m, *d, *x;
Guido van Rossum34162a11994-05-23 12:37:57 +0000237
Brett Cannon7f874fc2008-05-10 21:20:19 +0000238 if (PyErr_WarnPy3k("the dl module has been removed in "
Brett Cannon7595c1a2008-05-11 01:09:32 +0000239 "Python 3.0; use the ctypes module instead", 2) < 0)
Brett Cannon7f874fc2008-05-10 21:20:19 +0000240 return;
241
Andrew M. Kuchling6efc6e72001-02-27 20:54:23 +0000242 /* Initialize object type */
Christian Heimese93237d2007-12-19 02:37:44 +0000243 Py_TYPE(&Dltype) = &PyType_Type;
Andrew M. Kuchling6efc6e72001-02-27 20:54:23 +0000244
Guido van Rossum34162a11994-05-23 12:37:57 +0000245 /* Create the module and add the functions */
Roger E. Masse0e120321996-12-13 20:33:44 +0000246 m = Py_InitModule("dl", dl_methods);
Neal Norwitz1ac754f2006-01-19 06:09:39 +0000247 if (m == NULL)
248 return;
Guido van Rossum34162a11994-05-23 12:37:57 +0000249
250 /* Add some symbolic constants to the module */
Roger E. Masse0e120321996-12-13 20:33:44 +0000251 d = PyModule_GetDict(m);
Guido van Rossum0cb96de1997-10-01 04:29:29 +0000252 Dlerror = x = PyErr_NewException("dl.error", NULL, NULL);
Roger E. Masse0e120321996-12-13 20:33:44 +0000253 PyDict_SetItemString(d, "error", x);
254 x = PyInt_FromLong((long)RTLD_LAZY);
255 PyDict_SetItemString(d, "RTLD_LAZY", x);
Martin v. Löwisdf23f332000-09-13 16:26:10 +0000256#define INSINT(X) insint(d,#X,X)
Guido van Rossum34162a11994-05-23 12:37:57 +0000257#ifdef RTLD_NOW
Martin v. Löwisdf23f332000-09-13 16:26:10 +0000258 INSINT(RTLD_NOW);
259#endif
260#ifdef RTLD_NOLOAD
261 INSINT(RTLD_NOLOAD);
262#endif
263#ifdef RTLD_GLOBAL
264 INSINT(RTLD_GLOBAL);
265#endif
266#ifdef RTLD_LOCAL
267 INSINT(RTLD_LOCAL);
268#endif
269#ifdef RTLD_PARENT
270 INSINT(RTLD_PARENT);
271#endif
272#ifdef RTLD_GROUP
273 INSINT(RTLD_GROUP);
274#endif
275#ifdef RTLD_WORLD
276 INSINT(RTLD_WORLD);
277#endif
278#ifdef RTLD_NODELETE
279 INSINT(RTLD_NODELETE);
Guido van Rossum34162a11994-05-23 12:37:57 +0000280#endif
Guido van Rossum34162a11994-05-23 12:37:57 +0000281}