cpython/Modules/resource.c at main · python/cpython · GitHub

Repository navigation

History

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

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

165

166

167

168

169

170

171

172

173

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

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

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

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

#ifndef Py_BUILD_CORE_BUILTIN

# define Py_BUILD_CORE_MODULE 1

#endif

#include "Python.h"

#include <errno.h> // errno

#include <string.h>

#include <sys/resource.h> // getrusage()

#include <unistd.h> // getpagesize()

/* On some systems, these aren't in any header file.

On others they are, with inconsistent prototypes.

We declare the (default) return type, to shut up gcc -Wall;

but we can't declare the prototype, to avoid errors

when the header files declare it different.

Worse, on some Linuxes, getpagesize() returns a size_t... */

#define doubletime(TV) ((double)(TV).tv_sec + (TV).tv_usec * 0.000001)

/*[clinic input]

module resource

[clinic start generated code]*/

/*[clinic end generated code: output=da39a3ee5e6b4b0d input=e89d38ed52609d7c]*/

#include "clinic/resource.c.h"

PyDoc_STRVAR(struct_rusage__doc__,

"struct_rusage: Result from getrusage.\n\n"

"This object may be accessed either as a tuple of\n"

" (utime,stime,maxrss,ixrss,idrss,isrss,minflt,majflt,\n"

" nswap,inblock,oublock,msgsnd,msgrcv,nsignals,nvcsw,nivcsw)\n"

"or via the attributes ru_utime, ru_stime, ru_maxrss, and so on.");

static PyStructSequence_Field struct_rusage_fields[] = {

{"ru_utime", "user time used"},

{"ru_stime", "system time used"},

{"ru_maxrss", "max. resident set size"},

{"ru_ixrss", "shared memory size"},

{"ru_idrss", "unshared data size"},

{"ru_isrss", "unshared stack size"},

{"ru_minflt", "page faults not requiring I/O"},

{"ru_majflt", "page faults requiring I/O"},

{"ru_nswap", "number of swap outs"},

{"ru_inblock", "block input operations"},

{"ru_oublock", "block output operations"},

{"ru_msgsnd", "IPC messages sent"},

{"ru_msgrcv", "IPC messages received"},

{"ru_nsignals", "signals received"},

{"ru_nvcsw", "voluntary context switches"},

{"ru_nivcsw", "involuntary context switches"},

{0}

};

static PyStructSequence_Desc struct_rusage_desc = {

"resource.struct_rusage", /* name */

struct_rusage__doc__, /* doc */

struct_rusage_fields, /* fields */

16 /* n_in_sequence */

};

typedef struct {

PyTypeObject *StructRUsageType;

} resourcemodulestate;

static inline resourcemodulestate*

get_resource_state(PyObject *module)

{

void *state = PyModule_GetState(module);

assert(state != NULL);

return (resourcemodulestate *)state;

}

static struct PyModuleDef resourcemodule;

#ifdef HAVE_GETRUSAGE

/*[clinic input]

resource.getrusage

who: int

[clinic start generated code]*/

static PyObject *

resource_getrusage_impl(PyObject *module, int who)

/*[clinic end generated code: output=8fad2880ba6a9843 input=5c857bcc5b9ccb1b]*/

{

struct rusage ru;

PyObject *result;

if (getrusage(who, &ru) == -1) {

if (errno == EINVAL) {

PyErr_SetString(PyExc_ValueError,

"invalid who parameter");

return NULL;

}

PyErr_SetFromErrno(PyExc_OSError);

return NULL;

}

result = PyStructSequence_New(

get_resource_state(module)->StructRUsageType);

if (!result)

return NULL;

PyStructSequence_SetItem(result, 0,

PyFloat_FromDouble(doubletime(ru.ru_utime)));

PyStructSequence_SetItem(result, 1,

PyFloat_FromDouble(doubletime(ru.ru_stime)));

PyStructSequence_SetItem(result, 2, PyLong_FromLong(ru.ru_maxrss));

PyStructSequence_SetItem(result, 3, PyLong_FromLong(ru.ru_ixrss));

PyStructSequence_SetItem(result, 4, PyLong_FromLong(ru.ru_idrss));

PyStructSequence_SetItem(result, 5, PyLong_FromLong(ru.ru_isrss));

PyStructSequence_SetItem(result, 6, PyLong_FromLong(ru.ru_minflt));

PyStructSequence_SetItem(result, 7, PyLong_FromLong(ru.ru_majflt));

PyStructSequence_SetItem(result, 8, PyLong_FromLong(ru.ru_nswap));

PyStructSequence_SetItem(result, 9, PyLong_FromLong(ru.ru_inblock));

PyStructSequence_SetItem(result, 10, PyLong_FromLong(ru.ru_oublock));

PyStructSequence_SetItem(result, 11, PyLong_FromLong(ru.ru_msgsnd));

PyStructSequence_SetItem(result, 12, PyLong_FromLong(ru.ru_msgrcv));

PyStructSequence_SetItem(result, 13, PyLong_FromLong(ru.ru_nsignals));

PyStructSequence_SetItem(result, 14, PyLong_FromLong(ru.ru_nvcsw));

PyStructSequence_SetItem(result, 15, PyLong_FromLong(ru.ru_nivcsw));

if (PyErr_Occurred()) {

Py_DECREF(result);

return NULL;

}

return result;

}

#endif

static int

py2rlim(PyObject *obj, rlim_t *out)

{

obj = PyNumber_Index(obj);

if (obj == NULL) {

return -1;

}

int neg = PyLong_IsNegative(obj);

assert(neg >= 0);

Py_ssize_t bytes = PyLong_AsNativeBytes(obj, out, sizeof(*out),

Py_ASNATIVEBYTES_NATIVE_ENDIAN |

Py_ASNATIVEBYTES_UNSIGNED_BUFFER);

Py_DECREF(obj);

if (bytes < 0) {

return -1;

}

else if (neg && *out == RLIM_INFINITY && bytes <= (Py_ssize_t)sizeof(*out)) {

if (PyErr_WarnEx(PyExc_DeprecationWarning,

"Use RLIM_INFINITY instead of negative limit value.", 1))

{

return -1;

}

else if (neg) {

PyErr_SetString(PyExc_ValueError,

"Cannot convert negative int");

return -1;

}

else if (bytes > (Py_ssize_t)sizeof(*out)) {

PyErr_SetString(PyExc_OverflowError,

"Python int too large to convert to C rlim_t");

return -1;

}

return 0;

}

static int

py2rlimit(PyObject *limits, struct rlimit *rl_out)

{

PyObject *curobj, *maxobj;

limits = PySequence_Tuple(limits);

if (!limits)

/* Here limits is a borrowed reference */

return -1;

if (PyTuple_Size(limits) != 2) {

PyErr_SetString(PyExc_ValueError,

"expected a tuple of 2 integers");

goto error;

}

curobj = PyTuple_GetItem(limits, 0); // borrowed

maxobj = PyTuple_GetItem(limits, 1); // borrowed

if (py2rlim(curobj, &rl_out->rlim_cur) < 0 ||

py2rlim(maxobj, &rl_out->rlim_max) < 0)

{

goto error;

}

Py_DECREF(limits);

return 0;

error:

Py_DECREF(limits);

return -1;

}

static PyObject*

rlim2py(rlim_t value)

{

return PyLong_FromUnsignedNativeBytes(&value, sizeof(value), -1);

}

static PyObject*

rlimit2py(struct rlimit rl)

{

PyObject *cur = rlim2py(rl.rlim_cur);

if (cur == NULL) {

return NULL;

}

PyObject *max = rlim2py(rl.rlim_max);

return Py_BuildValue("NN", cur, max);

}

/*[clinic input]

resource.getrlimit

resource: int

[clinic start generated code]*/

static PyObject *

resource_getrlimit_impl(PyObject *module, int resource)

/*[clinic end generated code: output=98327b25061ffe39 input=a697cb0004cb3c36]*/

{

struct rlimit rl;

if (resource < 0 || resource >= RLIM_NLIMITS) {

PyErr_SetString(PyExc_ValueError,

"invalid resource specified");

return NULL;

}

if (getrlimit(resource, &rl) == -1) {

PyErr_SetFromErrno(PyExc_OSError);

return NULL;

}

return rlimit2py(rl);

}

/*[clinic input]

resource.setrlimit

resource: int

limits: object

[clinic start generated code]*/

static PyObject *

resource_setrlimit_impl(PyObject *module, int resource, PyObject *limits)

/*[clinic end generated code: output=4e82ec3f34d013d1 input=6235a6ce23b4ca75]*/

{

struct rlimit rl;

if (resource < 0 || resource >= RLIM_NLIMITS) {

PyErr_SetString(PyExc_ValueError,

"invalid resource specified");

return NULL;

}

if (PySys_Audit("resource.setrlimit", "iO", resource,

limits ? limits : Py_None) < 0) {

return NULL;

}

if (py2rlimit(limits, &rl) < 0) {

return NULL;

}

if (setrlimit(resource, &rl) == -1) {

if (errno == EINVAL)

PyErr_SetString(PyExc_ValueError,

"current limit exceeds maximum limit");

else if (errno == EPERM)

PyErr_SetString(PyExc_ValueError,

"not allowed to raise maximum limit");

else

PyErr_SetFromErrno(PyExc_OSError);

return NULL;

}

Py_RETURN_NONE;

}

#ifdef HAVE_PRLIMIT

/*[clinic input]

resource.prlimit

pid: pid_t

resource: int

limits: object = None

[clinic start generated code]*/

static PyObject *

resource_prlimit_impl(PyObject *module, pid_t pid, int resource,

PyObject *limits)

/*[clinic end generated code: output=6ebc49ff8c3a816e input=54bb69c9585e33bf]*/

{

struct rlimit old_limit, new_limit;

int retval;

if (resource < 0 || resource >= RLIM_NLIMITS) {

PyErr_SetString(PyExc_ValueError,

"invalid resource specified");

return NULL;

}

if (PySys_Audit("resource.prlimit", "iiO", pid, resource,

limits ? limits : Py_None) < 0) {

return NULL;

}

if (limits != Py_None) {

if (py2rlimit(limits, &new_limit) < 0) {

return NULL;

}

retval = prlimit(pid, resource, &new_limit, &old_limit);

}

else {

retval = prlimit(pid, resource, NULL, &old_limit);

}

if (retval == -1) {

if (errno == EINVAL) {

PyErr_SetString(PyExc_ValueError,

"current limit exceeds maximum limit");

} else {

PyErr_SetFromErrno(PyExc_OSError);

}

return NULL;

}

return rlimit2py(old_limit);

}

#endif /* HAVE_PRLIMIT */

/*[clinic input]

resource.getpagesize -> int

[clinic start generated code]*/

static int

resource_getpagesize_impl(PyObject *module)

/*[clinic end generated code: output=9ba93eb0f3d6c3a9 input=546545e8c1f42085]*/

{

long pagesize = 0;

#if defined(HAVE_GETPAGESIZE)

pagesize = getpagesize();

#elif defined(HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)

pagesize = sysconf(_SC_PAGE_SIZE);

#else

# error "unsupported platform: resource.getpagesize()"

#endif

return pagesize;

}

/* List of functions */

static struct PyMethodDef

resource_methods[] = {

RESOURCE_GETRUSAGE_METHODDEF

RESOURCE_GETRLIMIT_METHODDEF

RESOURCE_PRLIMIT_METHODDEF

RESOURCE_SETRLIMIT_METHODDEF

RESOURCE_GETPAGESIZE_METHODDEF

{NULL, NULL} /* sentinel */

};

/* Module initialization */

static int

resource_exec(PyObject *module)

{

resourcemodulestate *state = get_resource_state(module);

#define ADD_INT(module, value) \

do { \

if (PyModule_AddIntConstant(module, #value, value) < 0) { \

return -1; \

} \

} while (0)

/* Add some symbolic constants to the module */

if (PyModule_AddObjectRef(module, "error", PyExc_OSError) < 0) {

return -1;

}

state->StructRUsageType = PyStructSequence_NewType(&struct_rusage_desc);

if (state->StructRUsageType == NULL) {

return -1;

}

if (PyModule_AddType(module, state->StructRUsageType) < 0) {

return -1;

}

/* insert constants */

#ifdef RLIMIT_CPU

ADD_INT(module, RLIMIT_CPU);

#endif

#ifdef RLIMIT_FSIZE

ADD_INT(module, RLIMIT_FSIZE);

#endif

#ifdef RLIMIT_DATA

ADD_INT(module, RLIMIT_DATA);

#endif

#ifdef RLIMIT_STACK

ADD_INT(module, RLIMIT_STACK);

#endif

#ifdef RLIMIT_CORE

ADD_INT(module, RLIMIT_CORE);

#endif

#ifdef RLIMIT_NOFILE

ADD_INT(module, RLIMIT_NOFILE);

#endif

#ifdef RLIMIT_OFILE

ADD_INT(module, RLIMIT_OFILE);

#endif

#ifdef RLIMIT_VMEM

ADD_INT(module, RLIMIT_VMEM);

#endif

#ifdef RLIMIT_AS

ADD_INT(module, RLIMIT_AS);

#endif

#ifdef RLIMIT_RSS

ADD_INT(module, RLIMIT_RSS);

#endif

#ifdef RLIMIT_NPROC

ADD_INT(module, RLIMIT_NPROC);

#endif

#ifdef RLIMIT_MEMLOCK

ADD_INT(module, RLIMIT_MEMLOCK);

#endif

#ifdef RLIMIT_SBSIZE

ADD_INT(module, RLIMIT_SBSIZE);

#endif

/* Linux specific */

#ifdef RLIMIT_MSGQUEUE

ADD_INT(module, RLIMIT_MSGQUEUE);

#endif

#ifdef RLIMIT_NICE

ADD_INT(module, RLIMIT_NICE);

#endif

#ifdef RLIMIT_RTPRIO

ADD_INT(module, RLIMIT_RTPRIO);

#endif

#ifdef RLIMIT_RTTIME

ADD_INT(module, RLIMIT_RTTIME);

#endif

#ifdef RLIMIT_SIGPENDING

ADD_INT(module, RLIMIT_SIGPENDING);

#endif

/* target */

#ifdef RUSAGE_SELF

ADD_INT(module, RUSAGE_SELF);

#endif

#ifdef RUSAGE_CHILDREN

ADD_INT(module, RUSAGE_CHILDREN);

#endif

#ifdef RUSAGE_BOTH

ADD_INT(module, RUSAGE_BOTH);

#endif

#ifdef RUSAGE_THREAD

ADD_INT(module, RUSAGE_THREAD);

#endif

/* FreeBSD specific */

#ifdef RLIMIT_SWAP

ADD_INT(module, RLIMIT_SWAP);

#endif

#ifdef RLIMIT_SBSIZE

ADD_INT(module, RLIMIT_SBSIZE);

#endif

#ifdef RLIMIT_NPTS

ADD_INT(module, RLIMIT_NPTS);

#endif

#ifdef RLIMIT_KQUEUES

ADD_INT(module, RLIMIT_KQUEUES);

#endif

#ifdef RLIMIT_NTHR

ADD_INT(module, RLIMIT_NTHR);

#endif

#ifdef RLIMIT_THREADS

ADD_INT(module, RLIMIT_THREADS);

#endif

#ifdef RLIMIT_UMTXP

ADD_INT(module, RLIMIT_UMTXP);

#endif

#ifdef RLIMIT_PIPEBUF

ADD_INT(module, RLIMIT_PIPEBUF);

#endif

if (PyModule_Add(module, "RLIM_INFINITY", rlim2py(RLIM_INFINITY)) < 0) {

return -1;

}

#ifdef RLIM_SAVED_CUR

if (PyModule_Add(module, "RLIM_SAVED_CUR", rlim2py(RLIM_SAVED_CUR)) < 0) {

return -1;

}

#endif

#ifdef RLIM_SAVED_MAX

if (PyModule_Add(module, "RLIM_SAVED_MAX", rlim2py(RLIM_SAVED_MAX)) < 0) {

return -1;

}

#endif

return 0;

#undef ADD_INT

}

static struct PyModuleDef_Slot resource_slots[] = {

_Py_ABI_SLOT,

{Py_mod_exec, resource_exec},

{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},

{Py_mod_gil, Py_MOD_GIL_NOT_USED},

{0, NULL}

};

static int

resourcemodule_traverse(PyObject *m, visitproc visit, void *arg) {

Py_VISIT(get_resource_state(m)->StructRUsageType);

return 0;

}

static int

resourcemodule_clear(PyObject *m) {

Py_CLEAR(get_resource_state(m)->StructRUsageType);

return 0;

}

static void

resourcemodule_free(void *m) {

resourcemodule_clear((PyObject *)m);

}

static struct PyModuleDef resourcemodule = {

PyModuleDef_HEAD_INIT,

.m_name = "resource",

.m_size = sizeof(resourcemodulestate),

.m_methods = resource_methods,

.m_slots = resource_slots,

.m_traverse = resourcemodule_traverse,

.m_clear = resourcemodule_clear,

.m_free = resourcemodule_free,

};

PyMODINIT_FUNC

PyInit_resource(void)

{

return PyModuleDef_Init(&resourcemodule);

}

cpython/Modules/resource.c at main · python/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

resource.c

Latest commit

History

Breadcrumbs

resource.c

File metadata and controls