blob: d38c660e77059cc1f5fda41f7de5614851737db9 [file] [log] [blame]
Guido van Rossumf84a5391997-08-15 00:04:24 +00001
Guido van Rossum2e631391996-12-18 18:37:27 +00002#include "Python.h"
Martin v. Löwis688357e2002-04-08 21:28:20 +00003#include "structseq.h"
Guido van Rossum2e631391996-12-18 18:37:27 +00004#include <sys/resource.h>
5#include <sys/time.h>
Guido van Rossum2e631391996-12-18 18:37:27 +00006#include <string.h>
7#include <errno.h>
Martin v. Löwisf26d63b2003-03-30 17:23:49 +00008/* for sysconf */
9#if defined(HAVE_UNISTD_H)
10#include <unistd.h>
11#endif
Guido van Rossum2e631391996-12-18 18:37:27 +000012
Guido van Rossum607b33a1997-08-17 16:24:30 +000013/* On some systems, these aren't in any header file.
14 On others they are, with inconsistent prototypes.
15 We declare the (default) return type, to shut up gcc -Wall;
16 but we can't declare the prototype, to avoid errors
17 when the header files declare it different.
18 Worse, on some Linuxes, getpagesize() returns a size_t... */
Guido van Rossum2e631391996-12-18 18:37:27 +000019
20#define doubletime(TV) ((double)(TV).tv_sec + (TV).tv_usec * 0.000001)
21
22static PyObject *ResourceError;
23
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000024PyDoc_STRVAR(struct_rusage__doc__,
25"struct_rusage: Result from getrusage.\n\n"
26"This object may be accessed either as a tuple of\n"
27" (utime,stime,maxrss,ixrss,idrss,isrss,minflt,majflt,\n"
28" nswap,inblock,oublock,msgsnd,msgrcv,nsignals,nvcsw,nivcsw)\n"
29"or via the attributes ru_utime, ru_stime, ru_maxrss, and so on.");
Martin v. Löwis688357e2002-04-08 21:28:20 +000030
31static PyStructSequence_Field struct_rusage_fields[] = {
32 {"ru_utime", "user time used"},
33 {"ru_stime", "system time used"},
34 {"ru_maxrss", "max. resident set size"},
35 {"ru_ixrss", "shared memory size"},
36 {"ru_idrss", "unshared data size"},
37 {"ru_isrss", "unshared stack size"},
38 {"ru_minflt", "page faults not requiring I/O"},
39 {"ru_majflt", "page faults requiring I/O"},
40 {"ru_nswap", "number of swap outs"},
41 {"ru_inblock", "block input operations"},
42 {"ru_oublock", "block output operations"},
43 {"ru_msgsnd", "IPC messages sent"},
44 {"ru_msgrcv", "IPC messages received"},
45 {"ru_nsignals", "signals received"},
46 {"ru_nvcsw", "voluntary context switches"},
47 {"ru_nivcsw", "involuntary context switches"},
48 {0}
49};
50
51static PyStructSequence_Desc struct_rusage_desc = {
52 "resource.struct_rusage", /* name */
53 struct_rusage__doc__, /* doc */
54 struct_rusage_fields, /* fields */
55 16 /* n_in_sequence */
56};
57
Martin v. Löwis19ab6c92006-04-16 18:55:50 +000058static int initialized;
Martin v. Löwis688357e2002-04-08 21:28:20 +000059static PyTypeObject StructRUsageType;
60
Guido van Rossum2e631391996-12-18 18:37:27 +000061static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +000062resource_getrusage(PyObject *self, PyObject *args)
Guido van Rossum2e631391996-12-18 18:37:27 +000063{
64 int who;
65 struct rusage ru;
Martin v. Löwis688357e2002-04-08 21:28:20 +000066 PyObject *result;
Guido van Rossum2e631391996-12-18 18:37:27 +000067
Guido van Rossum43713e52000-02-29 13:59:29 +000068 if (!PyArg_ParseTuple(args, "i:getrusage", &who))
Guido van Rossum2e631391996-12-18 18:37:27 +000069 return NULL;
70
71 if (getrusage(who, &ru) == -1) {
72 if (errno == EINVAL) {
73 PyErr_SetString(PyExc_ValueError,
74 "invalid who parameter");
75 return NULL;
76 }
77 PyErr_SetFromErrno(ResourceError);
78 return NULL;
79 }
80
Martin v. Löwis688357e2002-04-08 21:28:20 +000081 result = PyStructSequence_New(&StructRUsageType);
82 if (!result)
83 return NULL;
84
85 PyStructSequence_SET_ITEM(result, 0,
86 PyFloat_FromDouble(doubletime(ru.ru_utime)));
87 PyStructSequence_SET_ITEM(result, 1,
88 PyFloat_FromDouble(doubletime(ru.ru_stime)));
89 PyStructSequence_SET_ITEM(result, 2, PyInt_FromLong(ru.ru_maxrss));
90 PyStructSequence_SET_ITEM(result, 3, PyInt_FromLong(ru.ru_ixrss));
91 PyStructSequence_SET_ITEM(result, 4, PyInt_FromLong(ru.ru_idrss));
92 PyStructSequence_SET_ITEM(result, 5, PyInt_FromLong(ru.ru_isrss));
93 PyStructSequence_SET_ITEM(result, 6, PyInt_FromLong(ru.ru_minflt));
94 PyStructSequence_SET_ITEM(result, 7, PyInt_FromLong(ru.ru_majflt));
95 PyStructSequence_SET_ITEM(result, 8, PyInt_FromLong(ru.ru_nswap));
96 PyStructSequence_SET_ITEM(result, 9, PyInt_FromLong(ru.ru_inblock));
97 PyStructSequence_SET_ITEM(result, 10, PyInt_FromLong(ru.ru_oublock));
98 PyStructSequence_SET_ITEM(result, 11, PyInt_FromLong(ru.ru_msgsnd));
99 PyStructSequence_SET_ITEM(result, 12, PyInt_FromLong(ru.ru_msgrcv));
100 PyStructSequence_SET_ITEM(result, 13, PyInt_FromLong(ru.ru_nsignals));
101 PyStructSequence_SET_ITEM(result, 14, PyInt_FromLong(ru.ru_nvcsw));
102 PyStructSequence_SET_ITEM(result, 15, PyInt_FromLong(ru.ru_nivcsw));
103
104 if (PyErr_Occurred()) {
105 Py_DECREF(result);
106 return NULL;
107 }
108
109 return result;
Guido van Rossum2e631391996-12-18 18:37:27 +0000110}
111
112
113static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000114resource_getrlimit(PyObject *self, PyObject *args)
Guido van Rossum2e631391996-12-18 18:37:27 +0000115{
116 struct rlimit rl;
117 int resource;
Guido van Rossum2e631391996-12-18 18:37:27 +0000118
Guido van Rossum43713e52000-02-29 13:59:29 +0000119 if (!PyArg_ParseTuple(args, "i:getrlimit", &resource))
Guido van Rossum2e631391996-12-18 18:37:27 +0000120 return NULL;
121
122 if (resource < 0 || resource >= RLIM_NLIMITS) {
123 PyErr_SetString(PyExc_ValueError,
124 "invalid resource specified");
125 return NULL;
126 }
127
128 if (getrlimit(resource, &rl) == -1) {
129 PyErr_SetFromErrno(ResourceError);
130 return NULL;
131 }
Guido van Rossum763737b1999-01-06 18:44:57 +0000132
133#if defined(HAVE_LONG_LONG)
134 if (sizeof(rl.rlim_cur) > sizeof(long)) {
135 return Py_BuildValue("LL",
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000136 (PY_LONG_LONG) rl.rlim_cur,
137 (PY_LONG_LONG) rl.rlim_max);
Guido van Rossum763737b1999-01-06 18:44:57 +0000138 }
139#endif
Neal Norwitz94a83fd2002-11-02 17:46:24 +0000140 return Py_BuildValue("ll", (long) rl.rlim_cur, (long) rl.rlim_max);
Guido van Rossum2e631391996-12-18 18:37:27 +0000141}
142
143static PyObject *
Peter Schneider-Kamp416d4132000-07-10 12:15:54 +0000144resource_setrlimit(PyObject *self, PyObject *args)
Guido van Rossum2e631391996-12-18 18:37:27 +0000145{
146 struct rlimit rl;
147 int resource;
Guido van Rossum763737b1999-01-06 18:44:57 +0000148 PyObject *curobj, *maxobj;
Guido van Rossum2e631391996-12-18 18:37:27 +0000149
Jeremy Hyltond95efe42002-04-23 20:15:04 +0000150 if (!PyArg_ParseTuple(args, "i(OO):setrlimit",
151 &resource, &curobj, &maxobj))
Guido van Rossum2e631391996-12-18 18:37:27 +0000152 return NULL;
153
154 if (resource < 0 || resource >= RLIM_NLIMITS) {
155 PyErr_SetString(PyExc_ValueError,
156 "invalid resource specified");
157 return NULL;
158 }
159
Guido van Rossum763737b1999-01-06 18:44:57 +0000160#if !defined(HAVE_LARGEFILE_SUPPORT)
161 rl.rlim_cur = PyInt_AsLong(curobj);
Jeremy Hyltond95efe42002-04-23 20:15:04 +0000162 if (rl.rlim_cur == -1 && PyErr_Occurred())
163 return NULL;
Guido van Rossum763737b1999-01-06 18:44:57 +0000164 rl.rlim_max = PyInt_AsLong(maxobj);
Jeremy Hyltond95efe42002-04-23 20:15:04 +0000165 if (rl.rlim_max == -1 && PyErr_Occurred())
166 return NULL;
Guido van Rossum763737b1999-01-06 18:44:57 +0000167#else
168 /* The limits are probably bigger than a long */
169 rl.rlim_cur = PyLong_Check(curobj) ?
170 PyLong_AsLongLong(curobj) : PyInt_AsLong(curobj);
Jeremy Hyltond95efe42002-04-23 20:15:04 +0000171 if (rl.rlim_cur == -1 && PyErr_Occurred())
172 return NULL;
Guido van Rossum763737b1999-01-06 18:44:57 +0000173 rl.rlim_max = PyLong_Check(maxobj) ?
174 PyLong_AsLongLong(maxobj) : PyInt_AsLong(maxobj);
Jeremy Hyltond95efe42002-04-23 20:15:04 +0000175 if (rl.rlim_max == -1 && PyErr_Occurred())
176 return NULL;
Guido van Rossum763737b1999-01-06 18:44:57 +0000177#endif
178
Guido van Rossum2e631391996-12-18 18:37:27 +0000179 rl.rlim_cur = rl.rlim_cur & RLIM_INFINITY;
180 rl.rlim_max = rl.rlim_max & RLIM_INFINITY;
181 if (setrlimit(resource, &rl) == -1) {
182 if (errno == EINVAL)
183 PyErr_SetString(PyExc_ValueError,
184 "current limit exceeds maximum limit");
185 else if (errno == EPERM)
186 PyErr_SetString(PyExc_ValueError,
187 "not allowed to raise maximum limit");
188 else
189 PyErr_SetFromErrno(ResourceError);
190 return NULL;
191 }
192 Py_INCREF(Py_None);
193 return Py_None;
194}
195
196static PyObject *
Georg Brandl96a8c392006-05-29 21:04:52 +0000197resource_getpagesize(PyObject *self, PyObject *unused)
Guido van Rossum2e631391996-12-18 18:37:27 +0000198{
Neal Norwitz1ac3e392003-03-30 20:51:29 +0000199 long pagesize = 0;
Martin v. Löwisf26d63b2003-03-30 17:23:49 +0000200#if defined(HAVE_GETPAGESIZE)
201 pagesize = getpagesize();
202#elif defined(HAVE_SYSCONF)
Martin v. Löwis0cb3c632004-08-12 13:26:56 +0000203#if defined(_SC_PAGE_SIZE)
Martin v. Löwisf26d63b2003-03-30 17:23:49 +0000204 pagesize = sysconf(_SC_PAGE_SIZE);
Martin v. Löwis0cb3c632004-08-12 13:26:56 +0000205#else
206 /* Irix 5.3 has _SC_PAGESIZE, but not _SC_PAGE_SIZE */
207 pagesize = sysconf(_SC_PAGESIZE);
208#endif
Martin v. Löwisf26d63b2003-03-30 17:23:49 +0000209#endif
210 return Py_BuildValue("i", pagesize);
211
Guido van Rossum2e631391996-12-18 18:37:27 +0000212}
213
214/* List of functions */
215
216static struct PyMethodDef
217resource_methods[] = {
Martin v. Löwis43b936d2002-01-17 23:15:58 +0000218 {"getrusage", resource_getrusage, METH_VARARGS},
219 {"getrlimit", resource_getrlimit, METH_VARARGS},
220 {"setrlimit", resource_setrlimit, METH_VARARGS},
Georg Brandl96a8c392006-05-29 21:04:52 +0000221 {"getpagesize", resource_getpagesize, METH_NOARGS},
Guido van Rossum2e631391996-12-18 18:37:27 +0000222 {NULL, NULL} /* sentinel */
223};
224
225
226/* Module initialization */
227
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000228PyMODINIT_FUNC
Andrew M. Kuchlingfda3c3d2001-09-17 16:19:16 +0000229initresource(void)
Guido van Rossum2e631391996-12-18 18:37:27 +0000230{
Neil Schemenauer29ac3cb2002-03-24 22:27:39 +0000231 PyObject *m, *v;
Guido van Rossum2e631391996-12-18 18:37:27 +0000232
233 /* Create the module and add the functions */
234 m = Py_InitModule("resource", resource_methods);
Neal Norwitz1ac754f2006-01-19 06:09:39 +0000235 if (m == NULL)
236 return;
Guido van Rossum2e631391996-12-18 18:37:27 +0000237
238 /* Add some symbolic constants to the module */
Fred Drakecca657b2002-02-14 06:59:26 +0000239 if (ResourceError == NULL) {
240 ResourceError = PyErr_NewException("resource.error",
241 NULL, NULL);
242 }
243 Py_INCREF(ResourceError);
244 PyModule_AddObject(m, "error", ResourceError);
Martin v. Löwis19ab6c92006-04-16 18:55:50 +0000245 if (!initialized)
246 PyStructSequence_InitType(&StructRUsageType,
247 &struct_rusage_desc);
248 Py_INCREF(&StructRUsageType);
Martin v. Löwis688357e2002-04-08 21:28:20 +0000249 PyModule_AddObject(m, "struct_rusage",
250 (PyObject*) &StructRUsageType);
Guido van Rossum2e631391996-12-18 18:37:27 +0000251
252 /* insert constants */
253#ifdef RLIMIT_CPU
Fred Drakecca657b2002-02-14 06:59:26 +0000254 PyModule_AddIntConstant(m, "RLIMIT_CPU", RLIMIT_CPU);
Guido van Rossum2e631391996-12-18 18:37:27 +0000255#endif
256
257#ifdef RLIMIT_FSIZE
Fred Drakecca657b2002-02-14 06:59:26 +0000258 PyModule_AddIntConstant(m, "RLIMIT_FSIZE", RLIMIT_FSIZE);
Guido van Rossum2e631391996-12-18 18:37:27 +0000259#endif
260
261#ifdef RLIMIT_DATA
Fred Drakecca657b2002-02-14 06:59:26 +0000262 PyModule_AddIntConstant(m, "RLIMIT_DATA", RLIMIT_DATA);
Guido van Rossum2e631391996-12-18 18:37:27 +0000263#endif
264
265#ifdef RLIMIT_STACK
Fred Drakecca657b2002-02-14 06:59:26 +0000266 PyModule_AddIntConstant(m, "RLIMIT_STACK", RLIMIT_STACK);
Guido van Rossum2e631391996-12-18 18:37:27 +0000267#endif
268
269#ifdef RLIMIT_CORE
Fred Drakecca657b2002-02-14 06:59:26 +0000270 PyModule_AddIntConstant(m, "RLIMIT_CORE", RLIMIT_CORE);
Guido van Rossum2e631391996-12-18 18:37:27 +0000271#endif
272
273#ifdef RLIMIT_NOFILE
Fred Drakecca657b2002-02-14 06:59:26 +0000274 PyModule_AddIntConstant(m, "RLIMIT_NOFILE", RLIMIT_NOFILE);
Guido van Rossum2e631391996-12-18 18:37:27 +0000275#endif
276
277#ifdef RLIMIT_OFILE
Fred Drakecca657b2002-02-14 06:59:26 +0000278 PyModule_AddIntConstant(m, "RLIMIT_OFILE", RLIMIT_OFILE);
Guido van Rossum2e631391996-12-18 18:37:27 +0000279#endif
280
281#ifdef RLIMIT_VMEM
Fred Drakecca657b2002-02-14 06:59:26 +0000282 PyModule_AddIntConstant(m, "RLIMIT_VMEM", RLIMIT_VMEM);
Guido van Rossum2e631391996-12-18 18:37:27 +0000283#endif
284
285#ifdef RLIMIT_AS
Fred Drakecca657b2002-02-14 06:59:26 +0000286 PyModule_AddIntConstant(m, "RLIMIT_AS", RLIMIT_AS);
Guido van Rossum2e631391996-12-18 18:37:27 +0000287#endif
288
289#ifdef RLIMIT_RSS
Fred Drakecca657b2002-02-14 06:59:26 +0000290 PyModule_AddIntConstant(m, "RLIMIT_RSS", RLIMIT_RSS);
Guido van Rossum2e631391996-12-18 18:37:27 +0000291#endif
292
293#ifdef RLIMIT_NPROC
Fred Drakecca657b2002-02-14 06:59:26 +0000294 PyModule_AddIntConstant(m, "RLIMIT_NPROC", RLIMIT_NPROC);
Guido van Rossum2e631391996-12-18 18:37:27 +0000295#endif
296
297#ifdef RLIMIT_MEMLOCK
Fred Drakecca657b2002-02-14 06:59:26 +0000298 PyModule_AddIntConstant(m, "RLIMIT_MEMLOCK", RLIMIT_MEMLOCK);
Guido van Rossum2e631391996-12-18 18:37:27 +0000299#endif
300
Martin v. Löwis43fd99c2006-09-16 17:36:37 +0000301#ifdef RLIMIT_SBSIZE
302 PyModule_AddIntConstant(m, "RLIMIT_SBSIZE", RLIMIT_SBSIZE);
303#endif
304
Guido van Rossum2e631391996-12-18 18:37:27 +0000305#ifdef RUSAGE_SELF
Fred Drakecca657b2002-02-14 06:59:26 +0000306 PyModule_AddIntConstant(m, "RUSAGE_SELF", RUSAGE_SELF);
Guido van Rossum2e631391996-12-18 18:37:27 +0000307#endif
308
Guido van Rossumebd05eb1997-12-09 19:35:48 +0000309#ifdef RUSAGE_CHILDREN
Fred Drakecca657b2002-02-14 06:59:26 +0000310 PyModule_AddIntConstant(m, "RUSAGE_CHILDREN", RUSAGE_CHILDREN);
Guido van Rossum2e631391996-12-18 18:37:27 +0000311#endif
312
313#ifdef RUSAGE_BOTH
Fred Drakecca657b2002-02-14 06:59:26 +0000314 PyModule_AddIntConstant(m, "RUSAGE_BOTH", RUSAGE_BOTH);
Guido van Rossum2e631391996-12-18 18:37:27 +0000315#endif
Neil Schemenauer29ac3cb2002-03-24 22:27:39 +0000316
317#if defined(HAVE_LONG_LONG)
318 if (sizeof(RLIM_INFINITY) > sizeof(long)) {
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000319 v = PyLong_FromLongLong((PY_LONG_LONG) RLIM_INFINITY);
Neil Schemenauer29ac3cb2002-03-24 22:27:39 +0000320 } else
321#endif
322 {
323 v = PyInt_FromLong((long) RLIM_INFINITY);
324 }
325 if (v) {
326 PyModule_AddObject(m, "RLIM_INFINITY", v);
327 }
Martin v. Löwis19ab6c92006-04-16 18:55:50 +0000328 initialized = 1;
Guido van Rossum2e631391996-12-18 18:37:27 +0000329}