cpython/Modules/_threadmodule.c at 3.3 · 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

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

/* Thread module */

/* Interface to Sjoerd's portable C thread library */

#include "Python.h"

#include "structmember.h" /* offsetof */

#ifndef WITH_THREAD

#error "Error! The rest of Python is not compiled with thread support."

#error "Rerun configure, adding a --with-threads option."

#error "Then run `make clean' followed by `make'."

#endif

#include "pythread.h"

static PyObject *ThreadError;

static long nb_threads = 0;

static PyObject *str_dict;

/* Lock objects */

typedef struct {

PyObject_HEAD

PyThread_type_lock lock_lock;

PyObject *in_weakreflist;

char locked; /* for sanity checking */

} lockobject;

static void

lock_dealloc(lockobject *self)

{

if (self->in_weakreflist != NULL)

PyObject_ClearWeakRefs((PyObject *) self);

if (self->lock_lock != NULL) {

/* Unlock the lock so it's safe to free it */

if (self->locked)

PyThread_release_lock(self->lock_lock);

PyThread_free_lock(self->lock_lock);

}

PyObject_Del(self);

}

/* Helper to acquire an interruptible lock with a timeout. If the lock acquire

* is interrupted, signal handlers are run, and if they raise an exception,

* PY_LOCK_INTR is returned. Otherwise, PY_LOCK_ACQUIRED or PY_LOCK_FAILURE

* are returned, depending on whether the lock can be acquired withing the

* timeout.

static PyLockStatus

acquire_timed(PyThread_type_lock lock, PY_TIMEOUT_T microseconds)

{

PyLockStatus r;

_PyTime_timeval curtime;

_PyTime_timeval endtime;

if (microseconds > 0) {

_PyTime_gettimeofday(&endtime);

endtime.tv_sec += microseconds / (1000 * 1000);

endtime.tv_usec += microseconds % (1000 * 1000);

}

do {

/* first a simple non-blocking try without releasing the GIL */

r = PyThread_acquire_lock_timed(lock, 0, 0);

if (r == PY_LOCK_FAILURE && microseconds != 0) {

Py_BEGIN_ALLOW_THREADS

r = PyThread_acquire_lock_timed(lock, microseconds, 1);

Py_END_ALLOW_THREADS

}

if (r == PY_LOCK_INTR) {

/* Run signal handlers if we were interrupted. Propagate

* exceptions from signal handlers, such as KeyboardInterrupt, by

* passing up PY_LOCK_INTR. */

if (Py_MakePendingCalls() < 0) {

return PY_LOCK_INTR;

}

/* If we're using a timeout, recompute the timeout after processing

* signals, since those can take time. */

if (microseconds > 0) {

_PyTime_gettimeofday(&curtime);

microseconds = ((endtime.tv_sec - curtime.tv_sec) * 1000000 +

(endtime.tv_usec - curtime.tv_usec));

/* Check for negative values, since those mean block forever.

if (microseconds <= 0) {

r = PY_LOCK_FAILURE;

}

} while (r == PY_LOCK_INTR); /* Retry if we were interrupted. */

return r;

}

static PyObject *

lock_PyThread_acquire_lock(lockobject *self, PyObject *args, PyObject *kwds)

{

char *kwlist[] = {"blocking", "timeout", NULL};

int blocking = 1;

double timeout = -1;

PY_TIMEOUT_T microseconds;

PyLockStatus r;

if (!PyArg_ParseTupleAndKeywords(args, kwds, "|id:acquire", kwlist,

&blocking, &timeout))

return NULL;

if (!blocking && timeout != -1) {

PyErr_SetString(PyExc_ValueError, "can't specify a timeout "

"for a non-blocking call");

return NULL;

}

if (timeout < 0 && timeout != -1) {

PyErr_SetString(PyExc_ValueError, "timeout value must be "

"strictly positive");

return NULL;

}

if (!blocking)

microseconds = 0;

else if (timeout == -1)

microseconds = -1;

else {

timeout *= 1e6;

if (timeout >= (double) PY_TIMEOUT_MAX) {

PyErr_SetString(PyExc_OverflowError,

"timeout value is too large");

return NULL;

}

microseconds = (PY_TIMEOUT_T) timeout;

}

r = acquire_timed(self->lock_lock, microseconds);

if (r == PY_LOCK_INTR) {

return NULL;

}

if (r == PY_LOCK_ACQUIRED)

self->locked = 1;

return PyBool_FromLong(r == PY_LOCK_ACQUIRED);

}

PyDoc_STRVAR(acquire_doc,

"acquire([wait]) -> bool\n\

(acquire_lock() is an obsolete synonym)\n\

\n\

Lock the lock. Without argument, this blocks if the lock is already\n\

locked (even by the same thread), waiting for another thread to release\n\

the lock, and return True once the lock is acquired.\n\

With an argument, this will only block if the argument is true,\n\

and the return value reflects whether the lock is acquired.\n\

The blocking operation is interruptible.");

static PyObject *

lock_PyThread_release_lock(lockobject *self)

{

/* Sanity check: the lock must be locked */

if (!self->locked) {

PyErr_SetString(ThreadError, "release unlocked lock");

return NULL;

}

PyThread_release_lock(self->lock_lock);

self->locked = 0;

Py_INCREF(Py_None);

return Py_None;

}

PyDoc_STRVAR(release_doc,

"release()\n\

(release_lock() is an obsolete synonym)\n\

\n\

Release the lock, allowing another thread that is blocked waiting for\n\

the lock to acquire the lock. The lock must be in the locked state,\n\

but it needn't be locked by the same thread that unlocks it.");

static PyObject *

lock_locked_lock(lockobject *self)

{

return PyBool_FromLong((long)self->locked);

}

PyDoc_STRVAR(locked_doc,

"locked() -> bool\n\

(locked_lock() is an obsolete synonym)\n\

\n\

Return whether the lock is in the locked state.");

static PyMethodDef lock_methods[] = {

{"acquire_lock", (PyCFunction)lock_PyThread_acquire_lock,

METH_VARARGS | METH_KEYWORDS, acquire_doc},

{"acquire", (PyCFunction)lock_PyThread_acquire_lock,

METH_VARARGS | METH_KEYWORDS, acquire_doc},

{"release_lock", (PyCFunction)lock_PyThread_release_lock,

METH_NOARGS, release_doc},

{"release", (PyCFunction)lock_PyThread_release_lock,

METH_NOARGS, release_doc},

{"locked_lock", (PyCFunction)lock_locked_lock,

METH_NOARGS, locked_doc},

{"locked", (PyCFunction)lock_locked_lock,

METH_NOARGS, locked_doc},

{"__enter__", (PyCFunction)lock_PyThread_acquire_lock,

METH_VARARGS | METH_KEYWORDS, acquire_doc},

{"__exit__", (PyCFunction)lock_PyThread_release_lock,

METH_VARARGS, release_doc},

{NULL, NULL} /* sentinel */

};

static PyTypeObject Locktype = {

PyVarObject_HEAD_INIT(&PyType_Type, 0)

"_thread.lock", /*tp_name*/

sizeof(lockobject), /*tp_size*/

0, /*tp_itemsize*/

/* methods */

(destructor)lock_dealloc, /*tp_dealloc*/

0, /*tp_print*/

0, /*tp_getattr*/

0, /*tp_setattr*/

0, /*tp_reserved*/

0, /*tp_repr*/

0, /*tp_as_number*/

0, /*tp_as_sequence*/

0, /*tp_as_mapping*/

0, /*tp_hash*/

0, /*tp_call*/

0, /*tp_str*/

0, /*tp_getattro*/

0, /*tp_setattro*/

0, /*tp_as_buffer*/

Py_TPFLAGS_DEFAULT, /*tp_flags*/

0, /*tp_doc*/

0, /*tp_traverse*/

0, /*tp_clear*/

0, /*tp_richcompare*/

offsetof(lockobject, in_weakreflist), /*tp_weaklistoffset*/

0, /*tp_iter*/

0, /*tp_iternext*/

lock_methods, /*tp_methods*/

};

/* Recursive lock objects */

typedef struct {

PyObject_HEAD

PyThread_type_lock rlock_lock;

long rlock_owner;

unsigned long rlock_count;

PyObject *in_weakreflist;

} rlockobject;

static void

rlock_dealloc(rlockobject *self)

{

assert(self->rlock_lock);

if (self->in_weakreflist != NULL)

PyObject_ClearWeakRefs((PyObject *) self);

/* Unlock the lock so it's safe to free it */

if (self->rlock_count > 0)

PyThread_release_lock(self->rlock_lock);

PyThread_free_lock(self->rlock_lock);

Py_TYPE(self)->tp_free(self);

}

static PyObject *

rlock_acquire(rlockobject *self, PyObject *args, PyObject *kwds)

{

char *kwlist[] = {"blocking", "timeout", NULL};

int blocking = 1;

double timeout = -1;

PY_TIMEOUT_T microseconds;

long tid;

PyLockStatus r = PY_LOCK_ACQUIRED;

if (!PyArg_ParseTupleAndKeywords(args, kwds, "|id:acquire", kwlist,

&blocking, &timeout))

return NULL;

if (!blocking && timeout != -1) {

PyErr_SetString(PyExc_ValueError, "can't specify a timeout "

"for a non-blocking call");

return NULL;

}

if (timeout < 0 && timeout != -1) {

PyErr_SetString(PyExc_ValueError, "timeout value must be "

"strictly positive");

return NULL;

}

if (!blocking)

microseconds = 0;

else if (timeout == -1)

microseconds = -1;

else {

timeout *= 1e6;

if (timeout >= (double) PY_TIMEOUT_MAX) {

PyErr_SetString(PyExc_OverflowError,

"timeout value is too large");

return NULL;

}

microseconds = (PY_TIMEOUT_T) timeout;

}

tid = PyThread_get_thread_ident();

if (self->rlock_count > 0 && tid == self->rlock_owner) {

unsigned long count = self->rlock_count + 1;

if (count <= self->rlock_count) {

PyErr_SetString(PyExc_OverflowError,

"Internal lock count overflowed");

return NULL;

}

self->rlock_count = count;

Py_RETURN_TRUE;

}

r = acquire_timed(self->rlock_lock, microseconds);

if (r == PY_LOCK_ACQUIRED) {

assert(self->rlock_count == 0);

self->rlock_owner = tid;

self->rlock_count = 1;

}

else if (r == PY_LOCK_INTR) {

return NULL;

}

return PyBool_FromLong(r == PY_LOCK_ACQUIRED);

}

PyDoc_STRVAR(rlock_acquire_doc,

"acquire(blocking=True) -> bool\n\

\n\

Lock the lock. `blocking` indicates whether we should wait\n\

for the lock to be available or not. If `blocking` is False\n\

and another thread holds the lock, the method will return False\n\

immediately. If `blocking` is True and another thread holds\n\

the lock, the method will wait for the lock to be released,\n\

take it and then return True.\n\

(note: the blocking operation is interruptible.)\n\

\n\

In all other cases, the method will return True immediately.\n\

Precisely, if the current thread already holds the lock, its\n\

internal counter is simply incremented. If nobody holds the lock,\n\

the lock is taken and its internal counter initialized to 1.");

static PyObject *

rlock_release(rlockobject *self)

{

long tid = PyThread_get_thread_ident();

if (self->rlock_count == 0 || self->rlock_owner != tid) {

PyErr_SetString(PyExc_RuntimeError,

"cannot release un-acquired lock");

return NULL;

}

if (--self->rlock_count == 0) {

self->rlock_owner = 0;

PyThread_release_lock(self->rlock_lock);

}

Py_RETURN_NONE;

}

PyDoc_STRVAR(rlock_release_doc,

"release()\n\

\n\

Release the lock, allowing another thread that is blocked waiting for\n\

the lock to acquire the lock. The lock must be in the locked state,\n\

and must be locked by the same thread that unlocks it; otherwise a\n\

`RuntimeError` is raised.\n\

\n\

Do note that if the lock was acquire()d several times in a row by the\n\

current thread, release() needs to be called as many times for the lock\n\

to be available for other threads.");

static PyObject *

rlock_acquire_restore(rlockobject *self, PyObject *arg)

{

long owner;

unsigned long count;

int r = 1;

if (!PyArg_ParseTuple(arg, "kl:_acquire_restore", &count, &owner))

return NULL;

if (!PyThread_acquire_lock(self->rlock_lock, 0)) {

Py_BEGIN_ALLOW_THREADS

r = PyThread_acquire_lock(self->rlock_lock, 1);

Py_END_ALLOW_THREADS

}

if (!r) {

PyErr_SetString(ThreadError, "couldn't acquire lock");

return NULL;

}

assert(self->rlock_count == 0);

self->rlock_owner = owner;

self->rlock_count = count;

Py_RETURN_NONE;

}

PyDoc_STRVAR(rlock_acquire_restore_doc,

"_acquire_restore(state) -> None\n\

\n\

For internal use by `threading.Condition`.");

static PyObject *

rlock_release_save(rlockobject *self)

{

long owner;

unsigned long count;

if (self->rlock_count == 0) {

PyErr_SetString(PyExc_RuntimeError,

"cannot release un-acquired lock");

return NULL;

}

owner = self->rlock_owner;

count = self->rlock_count;

self->rlock_count = 0;

self->rlock_owner = 0;

PyThread_release_lock(self->rlock_lock);

return Py_BuildValue("kl", count, owner);

}

PyDoc_STRVAR(rlock_release_save_doc,

"_release_save() -> tuple\n\

\n\

For internal use by `threading.Condition`.");

static PyObject *

rlock_is_owned(rlockobject *self)

{

long tid = PyThread_get_thread_ident();

if (self->rlock_count > 0 && self->rlock_owner == tid) {

Py_RETURN_TRUE;

}

Py_RETURN_FALSE;

}

PyDoc_STRVAR(rlock_is_owned_doc,

"_is_owned() -> bool\n\

\n\

For internal use by `threading.Condition`.");

static PyObject *

rlock_new(PyTypeObject *type, PyObject *args, PyObject *kwds)

{

rlockobject *self;

self = (rlockobject *) type->tp_alloc(type, 0);

if (self != NULL) {

self->rlock_lock = PyThread_allocate_lock();

if (self->rlock_lock == NULL) {

type->tp_free(self);

PyErr_SetString(ThreadError, "can't allocate lock");

return NULL;

}

self->in_weakreflist = NULL;

self->rlock_owner = 0;

self->rlock_count = 0;

}

return (PyObject *) self;

}

static PyObject *

rlock_repr(rlockobject *self)

{

return PyUnicode_FromFormat("<%s owner=%ld count=%lu>",

Py_TYPE(self)->tp_name, self->rlock_owner, self->rlock_count);

}

static PyMethodDef rlock_methods[] = {

{"acquire", (PyCFunction)rlock_acquire,

METH_VARARGS | METH_KEYWORDS, rlock_acquire_doc},

{"release", (PyCFunction)rlock_release,

METH_NOARGS, rlock_release_doc},

{"_is_owned", (PyCFunction)rlock_is_owned,

METH_NOARGS, rlock_is_owned_doc},

{"_acquire_restore", (PyCFunction)rlock_acquire_restore,

METH_O, rlock_acquire_restore_doc},

{"_release_save", (PyCFunction)rlock_release_save,

METH_NOARGS, rlock_release_save_doc},

{"__enter__", (PyCFunction)rlock_acquire,

METH_VARARGS | METH_KEYWORDS, rlock_acquire_doc},

{"__exit__", (PyCFunction)rlock_release,

METH_VARARGS, rlock_release_doc},

{NULL, NULL} /* sentinel */

};

static PyTypeObject RLocktype = {

PyVarObject_HEAD_INIT(&PyType_Type, 0)

"_thread.RLock", /*tp_name*/

sizeof(rlockobject), /*tp_size*/

0, /*tp_itemsize*/

/* methods */

(destructor)rlock_dealloc, /*tp_dealloc*/

0, /*tp_print*/

0, /*tp_getattr*/

0, /*tp_setattr*/

0, /*tp_reserved*/

(reprfunc)rlock_repr, /*tp_repr*/

0, /*tp_as_number*/

0, /*tp_as_sequence*/

0, /*tp_as_mapping*/

0, /*tp_hash*/

0, /*tp_call*/

0, /*tp_str*/

0, /*tp_getattro*/

0, /*tp_setattro*/

0, /*tp_as_buffer*/

Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */

0, /*tp_doc*/

0, /*tp_traverse*/

0, /*tp_clear*/

0, /*tp_richcompare*/

offsetof(rlockobject, in_weakreflist), /*tp_weaklistoffset*/

0, /*tp_iter*/

0, /*tp_iternext*/

rlock_methods, /*tp_methods*/

0, /* tp_members */

0, /* tp_getset */

0, /* tp_base */

0, /* tp_dict */

0, /* tp_descr_get */

0, /* tp_descr_set */

0, /* tp_dictoffset */

0, /* tp_init */

PyType_GenericAlloc, /* tp_alloc */

rlock_new /* tp_new */

};

static lockobject *

newlockobject(void)

{

lockobject *self;

self = PyObject_New(lockobject, &Locktype);

if (self == NULL)

return NULL;

self->lock_lock = PyThread_allocate_lock();

self->locked = 0;

self->in_weakreflist = NULL;

if (self->lock_lock == NULL) {

Py_DECREF(self);

PyErr_SetString(ThreadError, "can't allocate lock");

return NULL;

}

return self;

}

/* Thread-local objects */

#include "structmember.h"

/* Quick overview:

We need to be able to reclaim reference cycles as soon as possible

(both when a thread is being terminated, or a thread-local object

becomes unreachable from user data). Constraints:

- it must not be possible for thread-state dicts to be involved in

reference cycles (otherwise the cyclic GC will refuse to consider

objects referenced from a reachable thread-state dict, even though

local_dealloc would clear them)

- the death of a thread-state dict must still imply destruction of the

corresponding local dicts in all thread-local objects.

Our implementation uses small "localdummy" objects in order to break

the reference chain. These trivial objects are hashable (using the

default scheme of identity hashing) and weakrefable.

Each thread-state holds a separate localdummy for each local object

(as a /strong reference/),

and each thread-local object holds a dict mapping /weak references/

of localdummies to local dicts.

Therefore:

- only the thread-state dict holds a strong reference to the dummies

- only the thread-local object holds a strong reference to the local dicts

- only outside objects (application- or library-level) hold strong

references to the thread-local objects

- as soon as a thread-state dict is destroyed, the weakref callbacks of all

dummies attached to that thread are called, and destroy the corresponding

local dicts from thread-local objects

- as soon as a thread-local object is destroyed, its local dicts are

destroyed and its dummies are manually removed from all thread states

- the GC can do its work correctly when a thread-local object is dangling,

without any interference from the thread-state dicts

As an additional optimization, each localdummy holds a borrowed reference

to the corresponding localdict. This borrowed reference is only used

by the thread-local object which has created the localdummy, which should

guarantee that the localdict still exists when accessed.

typedef struct {

PyObject_HEAD

PyObject *localdict; /* Borrowed reference! */

PyObject *weakreflist; /* List of weak references to self */

} localdummyobject;

static void

localdummy_dealloc(localdummyobject *self)

{

if (self->weakreflist != NULL)

PyObject_ClearWeakRefs((PyObject *) self);

Py_TYPE(self)->tp_free((PyObject*)self);

}

static PyTypeObject localdummytype = {

PyVarObject_HEAD_INIT(NULL, 0)

/* tp_name */ "_thread._localdummy",

/* tp_basicsize */ sizeof(localdummyobject),

/* tp_itemsize */ 0,

/* tp_dealloc */ (destructor)localdummy_dealloc,

/* tp_print */ 0,

/* tp_getattr */ 0,

/* tp_setattr */ 0,

/* tp_reserved */ 0,

/* tp_repr */ 0,

/* tp_as_number */ 0,

/* tp_as_sequence */ 0,

/* tp_as_mapping */ 0,

/* tp_hash */ 0,

/* tp_call */ 0,

/* tp_str */ 0,

/* tp_getattro */ 0,

/* tp_setattro */ 0,

/* tp_as_buffer */ 0,

/* tp_flags */ Py_TPFLAGS_DEFAULT,

/* tp_doc */ "Thread-local dummy",

/* tp_traverse */ 0,

/* tp_clear */ 0,

/* tp_richcompare */ 0,

/* tp_weaklistoffset */ offsetof(localdummyobject, weakreflist)

};

typedef struct {

PyObject_HEAD

PyObject *key;

PyObject *args;

PyObject *kw;

PyObject *weakreflist; /* List of weak references to self */

/* A {localdummy weakref -> localdict} dict */

PyObject *dummies;

/* The callback for weakrefs to localdummies */

PyObject *wr_callback;

} localobject;

/* Forward declaration */

static PyObject *_ldict(localobject *self);

static PyObject *_localdummy_destroyed(PyObject *meth_self, PyObject *dummyweakref);

/* Create and register the dummy for the current thread.

Returns a borrowed reference of the corresponding local dict */

static PyObject *

_local_create_dummy(localobject *self)

{

PyObject *tdict, *ldict = NULL, *wr = NULL;

localdummyobject *dummy = NULL;

int r;

tdict = PyThreadState_GetDict();

if (tdict == NULL) {

PyErr_SetString(PyExc_SystemError,

"Couldn't get thread-state dictionary");

goto err;

}

ldict = PyDict_New();

if (ldict == NULL)

goto err;

dummy = (localdummyobject *) localdummytype.tp_alloc(&localdummytype, 0);

if (dummy == NULL)

goto err;

dummy->localdict = ldict;

wr = PyWeakref_NewRef((PyObject *) dummy, self->wr_callback);

if (wr == NULL)

goto err;

/* As a side-effect, this will cache the weakref's hash before the

dummy gets deleted */

r = PyDict_SetItem(self->dummies, wr, ldict);

if (r < 0)

goto err;

Py_CLEAR(wr);

r = PyDict_SetItem(tdict, self->key, (PyObject *) dummy);

if (r < 0)

goto err;

Py_CLEAR(dummy);

Py_DECREF(ldict);

return ldict;

err:

Py_XDECREF(ldict);

Py_XDECREF(wr);

Py_XDECREF(dummy);

return NULL;

}

static PyObject *

local_new(PyTypeObject *type, PyObject *args, PyObject *kw)

{

localobject *self;

PyObject *wr;

static PyMethodDef wr_callback_def = {

"_localdummy_destroyed", (PyCFunction) _localdummy_destroyed, METH_O

};

if (type->tp_init == PyBaseObject_Type.tp_init

&& ((args && PyObject_IsTrue(args))

|| (kw && PyObject_IsTrue(kw)))) {

PyErr_SetString(PyExc_TypeError,

"Initialization arguments are not supported");

return NULL;

}

self = (localobject *)type->tp_alloc(type, 0);

if (self == NULL)

return NULL;

Py_XINCREF(args);

self->args = args;

Py_XINCREF(kw);

self->kw = kw;

self->key = PyUnicode_FromFormat("thread.local.%p", self);

if (self->key == NULL)

goto err;

self->dummies = PyDict_New();

if (self->dummies == NULL)

goto err;

/* We use a weak reference to self in the callback closure

in order to avoid spurious reference cycles */

wr = PyWeakref_NewRef((PyObject *) self, NULL);

if (wr == NULL)

goto err;

self->wr_callback = PyCFunction_New(&wr_callback_def, wr);

Py_DECREF(wr);

if (self->wr_callback == NULL)

goto err;

if (_local_create_dummy(self) == NULL)

goto err;

return (PyObject *)self;

err:

Py_DECREF(self);

return NULL;

}

static int

local_traverse(localobject *self, visitproc visit, void *arg)

{

Py_VISIT(self->args);

Py_VISIT(self->kw);

Py_VISIT(self->dummies);

return 0;

}

static int

local_clear(localobject *self)

{

PyThreadState *tstate;

Py_CLEAR(self->args);

Py_CLEAR(self->kw);

Py_CLEAR(self->dummies);

Py_CLEAR(self->wr_callback);

/* Remove all strong references to dummies from the thread states */

if (self->key

&& (tstate = PyThreadState_Get())

&& tstate->interp) {

for(tstate = PyInterpreterState_ThreadHead(tstate->interp);

tstate;

tstate = PyThreadState_Next(tstate))

if (tstate->dict &&

PyDict_GetItem(tstate->dict, self->key))

PyDict_DelItem(tstate->dict, self->key);

}

return 0;

}

static void

local_dealloc(localobject *self)

{

/* Weakrefs must be invalidated right now, otherwise they can be used

from code called below, which is very dangerous since Py_REFCNT(self) == 0 */

if (self->weakreflist != NULL)

PyObject_ClearWeakRefs((PyObject *) self);

PyObject_GC_UnTrack(self);

local_clear(self);

Py_XDECREF(self->key);

Py_TYPE(self)->tp_free((PyObject*)self);

}

/* Returns a borrowed reference to the local dict, creating it if necessary */

static PyObject *

_ldict(localobject *self)

{

PyObject *tdict, *ldict, *dummy;

tdict = PyThreadState_GetDict();

if (tdict == NULL) {

PyErr_SetString(PyExc_SystemError,

"Couldn't get thread-state dictionary");

return NULL;

}

dummy = PyDict_GetItem(tdict, self->key);

if (dummy == NULL) {

ldict = _local_create_dummy(self);

if (ldict == NULL)

return NULL;

if (Py_TYPE(self)->tp_init != PyBaseObject_Type.tp_init &&

Py_TYPE(self)->tp_init((PyObject*)self,

self->args, self->kw) < 0) {

/* we need to get rid of ldict from thread so

we create a new one the next time we do an attr

access */

PyDict_DelItem(tdict, self->key);

return NULL;

}

else {

assert(Py_TYPE(dummy) == &localdummytype);

ldict = ((localdummyobject *) dummy)->localdict;

}

return ldict;

}

static int

local_setattro(localobject *self, PyObject *name, PyObject *v)

{

PyObject *ldict;

int r;

ldict = _ldict(self);

if (ldict == NULL)

return -1;

r = PyObject_RichCompareBool(name, str_dict, Py_EQ);

if (r == 1) {

PyErr_Format(PyExc_AttributeError,

"'%.50s' object attribute '%U' is read-only",

Py_TYPE(self)->tp_name, name);

return -1;

}

if (r == -1)

return -1;

return _PyObject_GenericSetAttrWithDict((PyObject *)self, name, v, ldict);

}

static PyObject *local_getattro(localobject *, PyObject *);

static PyTypeObject localtype = {

PyVarObject_HEAD_INIT(NULL, 0)

/* tp_name */ "_thread._local",

/* tp_basicsize */ sizeof(localobject),

/* tp_itemsize */ 0,

/* tp_dealloc */ (destructor)local_dealloc,

/* tp_print */ 0,

/* tp_getattr */ 0,

/* tp_setattr */ 0,

/* tp_reserved */ 0,

/* tp_repr */ 0,

/* tp_as_number */ 0,

/* tp_as_sequence */ 0,

/* tp_as_mapping */ 0,

/* tp_hash */ 0,

/* tp_call */ 0,

/* tp_str */ 0,

/* tp_getattro */ (getattrofunc)local_getattro,

/* tp_setattro */ (setattrofunc)local_setattro,

/* tp_as_buffer */ 0,

/* tp_flags */ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE

| Py_TPFLAGS_HAVE_GC,

/* tp_doc */ "Thread-local data",

/* tp_traverse */ (traverseproc)local_traverse,

/* tp_clear */ (inquiry)local_clear,

/* tp_richcompare */ 0,

/* tp_weaklistoffset */ offsetof(localobject, weakreflist),

/* tp_iter */ 0,

/* tp_iternext */ 0,

/* tp_methods */ 0,

/* tp_members */ 0,

/* tp_getset */ 0,

/* tp_base */ 0,

/* tp_dict */ 0, /* internal use */

/* tp_descr_get */ 0,

/* tp_descr_set */ 0,

/* tp_dictoffset */ 0,

/* tp_init */ 0,

/* tp_alloc */ 0,

/* tp_new */ local_new,

/* tp_free */ 0, /* Low-level free-mem routine */

/* tp_is_gc */ 0, /* For PyObject_IS_GC */

};

static PyObject *

local_getattro(localobject *self, PyObject *name)

{

PyObject *ldict, *value;

int r;

ldict = _ldict(self);

if (ldict == NULL)

return NULL;

r = PyObject_RichCompareBool(name, str_dict, Py_EQ);

if (r == 1) {

Py_INCREF(ldict);

return ldict;

}

if (r == -1)

return NULL;

if (Py_TYPE(self) != &localtype)

/* use generic lookup for subtypes */

return _PyObject_GenericGetAttrWithDict((PyObject *)self, name, ldict);

/* Optimization: just look in dict ourselves */

value = PyDict_GetItem(ldict, name);

if (value == NULL)

/* Fall back on generic to get __class__ and __dict__ */

return _PyObject_GenericGetAttrWithDict((PyObject *)self, name, ldict);

Py_INCREF(value);

return value;

}

/* Called when a dummy is destroyed. */

static PyObject *

_localdummy_destroyed(PyObject *localweakref, PyObject *dummyweakref)

{

PyObject *obj;

localobject *self;

assert(PyWeakref_CheckRef(localweakref));

obj = PyWeakref_GET_OBJECT(localweakref);

if (obj == Py_None)

Py_RETURN_NONE;

Py_INCREF(obj);

assert(PyObject_TypeCheck(obj, &localtype));

/* If the thread-local object is still alive and not being cleared,

remove the corresponding local dict */

self = (localobject *) obj;

if (self->dummies != NULL) {

PyObject *ldict;

ldict = PyDict_GetItem(self->dummies, dummyweakref);

if (ldict != NULL) {

PyDict_DelItem(self->dummies, dummyweakref);

}

if (PyErr_Occurred())

PyErr_WriteUnraisable(obj);

}

Py_DECREF(obj);

Py_RETURN_NONE;

}

/* Module functions */

struct bootstate {

PyInterpreterState *interp;

PyObject *func;

PyObject *args;

PyObject *keyw;

PyThreadState *tstate;

};

static void

t_bootstrap(void *boot_raw)

{

struct bootstate *boot = (struct bootstate *) boot_raw;

PyThreadState *tstate;

PyObject *res;

tstate = boot->tstate;

tstate->thread_id = PyThread_get_thread_ident();

_PyThreadState_Init(tstate);

PyEval_AcquireThread(tstate);

nb_threads++;

res = PyEval_CallObjectWithKeywords(

boot->func, boot->args, boot->keyw);

if (res == NULL) {

if (PyErr_ExceptionMatches(PyExc_SystemExit))

PyErr_Clear();

else {

PyObject *file;

PyObject *exc, *value, *tb;

View remainder of file in raw view

cpython/Modules/_threadmodule.c at 3.3 · python/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

_threadmodule.c

Latest commit

History

Breadcrumbs

_threadmodule.c

File metadata and controls