cpython/Modules/_interpqueuesmodule.c at 3.15 · 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

/* interpreters module */

/* low-level access to interpreter primitives */

#ifndef Py_BUILD_CORE_BUILTIN

# define Py_BUILD_CORE_MODULE 1

#endif

#include "Python.h"

#include "pycore_crossinterp.h" // _PyXIData_t

#define REGISTERS_HEAP_TYPES

#define HAS_FALLBACK

#define HAS_UNBOUND_ITEMS

#include "_interpreters_common.h"

#undef HAS_UNBOUND_ITEMS

#undef HAS_FALLBACK

#undef REGISTERS_HEAP_TYPES

#define MODULE_NAME _interpqueues

#define MODULE_NAME_STR Py_STRINGIFY(MODULE_NAME)

#define MODINIT_FUNC_NAME RESOLVE_MODINIT_FUNC_NAME(MODULE_NAME)

/*[clinic input]

module _interpqueues

[clinic start generated code]*/

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

#define GLOBAL_MALLOC(TYPE) \

PyMem_RawMalloc(sizeof(TYPE))

#define GLOBAL_FREE(VAR) \

PyMem_RawFree(VAR)

#define XID_IGNORE_EXC 1

#define XID_FREE 2

static int

_release_xid_data(_PyXIData_t *data, int flags)

{

int ignoreexc = flags & XID_IGNORE_EXC;

PyObject *exc;

if (ignoreexc) {

exc = PyErr_GetRaisedException();

}

int res;

if (flags & XID_FREE) {

res = _PyXIData_ReleaseAndRawFree(data);

}

else {

res = _PyXIData_Release(data);

}

if (res < 0) {

/* The owning interpreter is already destroyed. */

if (ignoreexc) {

// XXX Emit a warning?

PyErr_Clear();

}

if (flags & XID_FREE) {

/* Either way, we free the data. */

}

if (ignoreexc) {

PyErr_SetRaisedException(exc);

}

return res;

}

static PyInterpreterState *

_get_current_interp(void)

{

// PyInterpreterState_Get() aborts if lookup fails, so don't need

// to check the result for NULL.

return PyInterpreterState_Get();

}

static PyObject *

_get_current_module(void)

{

PyObject *name = PyUnicode_FromString(MODULE_NAME_STR);

if (name == NULL) {

return NULL;

}

PyObject *mod = PyImport_GetModule(name);

Py_DECREF(name);

if (mod == NULL) {

return NULL;

}

assert(mod != Py_None);

return mod;

}

struct idarg_int64_converter_data {

// input:

const char *label;

// output:

int64_t id;

};

static int

idarg_int64_converter(PyObject *arg, void *ptr)

{

int64_t id;

struct idarg_int64_converter_data *data = ptr;

const char *label = data->label;

if (label == NULL) {

label = "ID";

}

if (PyIndex_Check(arg)) {

int overflow = 0;

id = PyLong_AsLongLongAndOverflow(arg, &overflow);

if (id == -1 && PyErr_Occurred()) {

return 0;

}

else if (id == -1 && overflow == 1) {

PyErr_Format(PyExc_OverflowError,

"max %s is %lld, got %R", label, INT64_MAX, arg);

return 0;

}

else if (id < 0) {

PyErr_Format(PyExc_ValueError,

"%s must be a non-negative int, got %R", label, arg);

return 0;

}

else {

PyErr_Format(PyExc_TypeError,

"%s must be an int, got %.100s",

label, Py_TYPE(arg)->tp_name);

return 0;

}

data->id = id;

return 1;

}

static int

ensure_highlevel_module_loaded(void)

{

PyObject *highlevel =

PyImport_ImportModule("concurrent.interpreters._queues");

if (highlevel == NULL) {

return -1;

}

Py_DECREF(highlevel);

return 0;

}

/* module state *************************************************************/

typedef struct {

/* external types (added at runtime by interpreters module) */

PyTypeObject *queue_type;

/* QueueError (and its subclasses) */

PyObject *QueueError;

PyObject *QueueNotFoundError;

PyObject *QueueEmpty;

PyObject *QueueFull;

} module_state;

static inline module_state *

get_module_state(PyObject *mod)

{

assert(mod != NULL);

module_state *state = PyModule_GetState(mod);

assert(state != NULL);

return state;

}

static int

traverse_module_state(module_state *state, visitproc visit, void *arg)

{

/* external types */

Py_VISIT(state->queue_type);

/* QueueError */

Py_VISIT(state->QueueError);

Py_VISIT(state->QueueNotFoundError);

Py_VISIT(state->QueueEmpty);

Py_VISIT(state->QueueFull);

return 0;

}

static int

clear_module_state(module_state *state)

{

/* external types */

if (state->queue_type != NULL) {

(void)clear_xid_class(state->queue_type);

}

Py_CLEAR(state->queue_type);

/* QueueError */

Py_CLEAR(state->QueueError);

Py_CLEAR(state->QueueNotFoundError);

Py_CLEAR(state->QueueEmpty);

Py_CLEAR(state->QueueFull);

return 0;

}

/* error codes **************************************************************/

#define ERR_EXCEPTION_RAISED (-1)

// multi-queue errors

#define ERR_QUEUES_ALLOC (-11)

#define ERR_QUEUE_ALLOC (-12)

#define ERR_NO_NEXT_QUEUE_ID (-13)

#define ERR_QUEUE_NOT_FOUND (-14)

// single-queue errors

#define ERR_QUEUE_EMPTY (-21)

#define ERR_QUEUE_FULL (-22)

#define ERR_QUEUE_NEVER_BOUND (-23)

static int ensure_external_exc_types(module_state *);

static int

resolve_module_errcode(module_state *state, int errcode, int64_t qid,

PyObject **p_exctype, PyObject **p_msgobj)

{

PyObject *exctype = NULL;

PyObject *msg = NULL;

switch (errcode) {

case ERR_NO_NEXT_QUEUE_ID:

exctype = state->QueueError;

msg = PyUnicode_FromString("ran out of queue IDs");

break;

case ERR_QUEUE_NOT_FOUND:

exctype = state->QueueNotFoundError;

msg = PyUnicode_FromFormat("queue %" PRId64 " not found", qid);

break;

case ERR_QUEUE_EMPTY:

if (ensure_external_exc_types(state) < 0) {

return -1;

}

exctype = state->QueueEmpty;

msg = PyUnicode_FromFormat("queue %" PRId64 " is empty", qid);

break;

case ERR_QUEUE_FULL:

if (ensure_external_exc_types(state) < 0) {

return -1;

}

exctype = state->QueueFull;

msg = PyUnicode_FromFormat("queue %" PRId64 " is full", qid);

break;

case ERR_QUEUE_NEVER_BOUND:

exctype = state->QueueError;

msg = PyUnicode_FromFormat("queue %" PRId64 " never bound", qid);

break;

default:

PyErr_Format(PyExc_ValueError,

"unsupported error code %d", errcode);

return -1;

}

if (msg == NULL) {

assert(PyErr_Occurred());

return -1;

}

*p_exctype = exctype;

*p_msgobj = msg;

return 0;

}

/* QueueError ***************************************************************/

static int

add_exctype(PyObject *mod, PyObject **p_state_field,

const char *qualname, const char *doc, PyObject *base)

{

#ifndef NDEBUG

const char *dot = strrchr(qualname, '.');

assert(dot != NULL);

const char *name = dot+1;

assert(*p_state_field == NULL);

assert(!PyObject_HasAttrStringWithError(mod, name));

#endif

PyObject *exctype = PyErr_NewExceptionWithDoc(qualname, doc, base, NULL);

if (exctype == NULL) {

return -1;

}

if (PyModule_AddType(mod, (PyTypeObject *)exctype) < 0) {

Py_DECREF(exctype);

return -1;

}

*p_state_field = exctype;

return 0;

}

static int

add_QueueError(PyObject *mod)

{

module_state *state = get_module_state(mod);

#define PREFIX "concurrent.interpreters."

#define ADD_EXCTYPE(NAME, BASE, DOC) \

assert(state->NAME == NULL); \

if (add_exctype(mod, &state->NAME, PREFIX #NAME, DOC, BASE) < 0) { \

return -1; \

}

ADD_EXCTYPE(QueueError, PyExc_RuntimeError,

"Indicates that a queue-related error happened.")

ADD_EXCTYPE(QueueNotFoundError, state->QueueError, NULL)

// QueueEmpty and QueueFull are set by set_external_exc_types().

state->QueueEmpty = NULL;

state->QueueFull = NULL;

#undef ADD_EXCTYPE

#undef PREFIX

return 0;

}

static int

set_external_exc_types(module_state *state,

PyObject *emptyerror, PyObject *fullerror)

{

if (state->QueueEmpty != NULL) {

assert(state->QueueFull != NULL);

Py_CLEAR(state->QueueEmpty);

Py_CLEAR(state->QueueFull);

}

else {

assert(state->QueueFull == NULL);

}

assert(PyObject_IsSubclass(emptyerror, state->QueueError));

assert(PyObject_IsSubclass(fullerror, state->QueueError));

state->QueueEmpty = Py_NewRef(emptyerror);

state->QueueFull = Py_NewRef(fullerror);

return 0;

}

static int

ensure_external_exc_types(module_state *state)

{

if (state->QueueEmpty != NULL) {

assert(state->QueueFull != NULL);

return 0;

}

assert(state->QueueFull == NULL);

// Force the module to be loaded, to register the type.

if (ensure_highlevel_module_loaded() < 0) {

return -1;

}

assert(state->QueueEmpty != NULL);

assert(state->QueueFull != NULL);

return 0;

}

static int

handle_queue_error(int err, PyObject *mod, int64_t qid)

{

if (err == 0) {

assert(!PyErr_Occurred());

return 0;

}

assert(err < 0);

assert((err == -1) == (PyErr_Occurred() != NULL));

module_state *state;

switch (err) {

case ERR_QUEUE_ALLOC: _Py_FALLTHROUGH;

case ERR_QUEUES_ALLOC:

PyErr_NoMemory();

break;

case -1:

return -1;

default:

state = get_module_state(mod);

assert(state->QueueError != NULL);

PyObject *exctype = NULL;

PyObject *msg = NULL;

if (resolve_module_errcode(state, err, qid, &exctype, &msg) < 0) {

return -1;

}

PyObject *exc = PyObject_CallOneArg(exctype, msg);

Py_DECREF(msg);

if (exc == NULL) {

return -1;

}

PyErr_SetObject(exctype, exc);

Py_DECREF(exc);

}

return 1;

}

/* the basic queue **********************************************************/

struct _queueitem;

typedef struct _queueitem {

/* The interpreter that added the item to the queue.

The actual bound interpid is found in item->data.

This is necessary because item->data might be NULL,

meaning the interpreter has been destroyed. */

int64_t interpid;

_PyXIData_t *data;

unboundop_t unboundop;

struct _queueitem *next;

} _queueitem;

static void

_queueitem_init(_queueitem *item,

int64_t interpid, _PyXIData_t *data, unboundop_t unboundop)

{

if (interpid < 0) {

interpid = _get_interpid(data);

}

else {

assert(data == NULL

|| _PyXIData_INTERPID(data) < 0

|| interpid == _PyXIData_INTERPID(data));

}

assert(check_unbound(unboundop));

*item = (_queueitem){

.interpid = interpid,

.data = data,

.unboundop = unboundop,

};

}

static void

_queueitem_clear_data(_queueitem *item)

{

if (item->data == NULL) {

return;

}

// It was allocated in queue_put().

(void)_release_xid_data(item->data, XID_IGNORE_EXC | XID_FREE);

item->data = NULL;

}

static void

_queueitem_clear(_queueitem *item)

{

item->next = NULL;

_queueitem_clear_data(item);

}

static _queueitem *

_queueitem_new(int64_t interpid, _PyXIData_t *data, int unboundop)

{

_queueitem *item = GLOBAL_MALLOC(_queueitem);

if (item == NULL) {

PyErr_NoMemory();

return NULL;

}

_queueitem_init(item, interpid, data, unboundop);

return item;

}

static void

_queueitem_free(_queueitem *item)

{

_queueitem_clear(item);

GLOBAL_FREE(item);

}

static void

_queueitem_free_all(_queueitem *item)

{

while (item != NULL) {

_queueitem *last = item;

item = item->next;

_queueitem_free(last);

}

static void

_queueitem_popped(_queueitem *item,

_PyXIData_t **p_data, unboundop_t *p_unboundop)

{

*p_data = item->data;

*p_unboundop = item->unboundop;

// We clear them here, so they won't be released in _queueitem_clear().

item->data = NULL;

_queueitem_free(item);

}

static int

_queueitem_clear_interpreter(_queueitem *item)

{

assert(item->interpid >= 0);

if (item->data == NULL) {

// Its interpreter was already cleared (or it was never bound).

// For UNBOUND_REMOVE it should have been freed at that time.

assert(item->unboundop != UNBOUND_REMOVE);

return 0;

}

assert(_PyXIData_INTERPID(item->data) == item->interpid);

switch (item->unboundop) {

case UNBOUND_REMOVE:

// The caller must free/clear it.

return 1;

case UNBOUND_ERROR:

case UNBOUND_REPLACE:

// We won't need the cross-interpreter data later

// so we completely throw it away.

_queueitem_clear_data(item);

return 0;

default:

Py_FatalError("not reachable");

return -1;

}

/* the queue */

typedef struct _queue {

Py_ssize_t num_waiters; // protected by global lock

PyThread_type_lock mutex;

int alive;

struct _queueitems {

Py_ssize_t maxsize;

Py_ssize_t count;

_queueitem *first;

_queueitem *last;

} items;

struct _queuedefaults {

xidata_fallback_t fallback;

int unboundop;

} defaults;

} _queue;

static int

_queue_init(_queue *queue, Py_ssize_t maxsize, struct _queuedefaults defaults)

{

assert(check_unbound(defaults.unboundop));

PyThread_type_lock mutex = PyThread_allocate_lock();

if (mutex == NULL) {

return ERR_QUEUE_ALLOC;

}

*queue = (_queue){

.mutex = mutex,

.alive = 1,

.items = {

.maxsize = maxsize,

.defaults = defaults,

};

return 0;

}

static void

_queue_clear(_queue *queue)

{

assert(!queue->alive);

assert(queue->num_waiters == 0);

_queueitem_free_all(queue->items.first);

assert(queue->mutex != NULL);

PyThread_free_lock(queue->mutex);

*queue = (_queue){0};

}

static void _queue_free(_queue *);

static void

_queue_kill_and_wait(_queue *queue)

{

// Mark it as dead.

PyThread_acquire_lock(queue->mutex, WAIT_LOCK);

assert(queue->alive);

queue->alive = 0;

PyThread_release_lock(queue->mutex);

// Wait for all waiters to fail.

while (queue->num_waiters > 0) {

PyThread_acquire_lock(queue->mutex, WAIT_LOCK);

PyThread_release_lock(queue->mutex);

};

}

static void

_queue_mark_waiter(_queue *queue, PyThread_type_lock parent_mutex)

{

if (parent_mutex != NULL) {

PyThread_acquire_lock(parent_mutex, WAIT_LOCK);

queue->num_waiters += 1;

PyThread_release_lock(parent_mutex);

}

else {

// The caller must be holding the parent lock already.

queue->num_waiters += 1;

}

static void

_queue_unmark_waiter(_queue *queue, PyThread_type_lock parent_mutex)

{

if (parent_mutex != NULL) {

PyThread_acquire_lock(parent_mutex, WAIT_LOCK);

queue->num_waiters -= 1;

PyThread_release_lock(parent_mutex);

}

else {

// The caller must be holding the parent lock already.

queue->num_waiters -= 1;

}

static int

_queue_lock(_queue *queue)

{

// The queue must be marked as a waiter already.

PyThread_acquire_lock(queue->mutex, WAIT_LOCK);

if (!queue->alive) {

PyThread_release_lock(queue->mutex);

return ERR_QUEUE_NOT_FOUND;

}

return 0;

}

static void

_queue_unlock(_queue *queue)

{

PyThread_release_lock(queue->mutex);

}

static int

_queue_add(_queue *queue, int64_t interpid, _PyXIData_t *data, int unboundop)

{

int err = _queue_lock(queue);

if (err < 0) {

return err;

}

Py_ssize_t maxsize = queue->items.maxsize;

if (maxsize <= 0) {

maxsize = PY_SSIZE_T_MAX;

}

if (queue->items.count >= maxsize) {

_queue_unlock(queue);

return ERR_QUEUE_FULL;

}

_queueitem *item = _queueitem_new(interpid, data, unboundop);

if (item == NULL) {

_queue_unlock(queue);

return -1;

}

queue->items.count += 1;

if (queue->items.first == NULL) {

queue->items.first = item;

}

else {

queue->items.last->next = item;

}

queue->items.last = item;

_queue_unlock(queue);

return 0;

}

static int

_queue_next(_queue *queue, _PyXIData_t **p_data, int *p_unboundop)

{

int err = _queue_lock(queue);

if (err < 0) {

return err;

}

assert(queue->items.count >= 0);

_queueitem *item = queue->items.first;

if (item == NULL) {

_queue_unlock(queue);

return ERR_QUEUE_EMPTY;

}

queue->items.first = item->next;

if (queue->items.last == item) {

queue->items.last = NULL;

}

queue->items.count -= 1;

_queueitem_popped(item, p_data, p_unboundop);

_queue_unlock(queue);

return 0;

}

static int

_queue_get_maxsize(_queue *queue, Py_ssize_t *p_maxsize)

{

int err = _queue_lock(queue);

if (err < 0) {

return err;

}

*p_maxsize = queue->items.maxsize;

_queue_unlock(queue);

return 0;

}

static int

_queue_is_full(_queue *queue, int *p_is_full)

{

int err = _queue_lock(queue);

if (err < 0) {

return err;

}

assert(queue->items.maxsize <= 0

|| queue->items.count <= queue->items.maxsize);

*p_is_full = queue->items.maxsize > 0

? queue->items.count == queue->items.maxsize

: 0;

_queue_unlock(queue);

return 0;

}

static int

_queue_get_count(_queue *queue, Py_ssize_t *p_count)

{

int err = _queue_lock(queue);

if (err < 0) {

return err;

}

*p_count = queue->items.count;

_queue_unlock(queue);

return 0;

}

static void

_queue_clear_interpreter(_queue *queue, int64_t interpid)

{

int err = _queue_lock(queue);

if (err == ERR_QUEUE_NOT_FOUND) {

// The queue is already destroyed, so there's nothing to clear.

assert(!PyErr_Occurred());

return;

}

assert(err == 0); // There should be no other errors.

_queueitem *prev = NULL;

_queueitem *next = queue->items.first;

while (next != NULL) {

_queueitem *item = next;

next = item->next;

int remove = (item->interpid == interpid)

? _queueitem_clear_interpreter(item)

: 0;

if (remove) {

_queueitem_free(item);

if (prev == NULL) {

queue->items.first = next;

}

else {

prev->next = next;

}

queue->items.count -= 1;

}

else {

prev = item;

}

_queue_unlock(queue);

}

/* external queue references ************************************************/

struct _queueref;

typedef struct _queueref {

struct _queueref *next;

int64_t qid;

Py_ssize_t refcount;

_queue *queue;

} _queueref;

static _queueref *

_queuerefs_find(_queueref *first, int64_t qid, _queueref **pprev)

{

_queueref *prev = NULL;

_queueref *ref = first;

while (ref != NULL) {

if (ref->qid == qid) {

break;

}

prev = ref;

ref = ref->next;

}

if (pprev != NULL) {

*pprev = prev;

}

return ref;

}

static void

_queuerefs_clear(_queueref *head)

{

_queueref *next = head;

while (next != NULL) {

_queueref *ref = next;

next = ref->next;

#ifdef Py_DEBUG

int64_t qid = ref->qid;

fprintf(stderr, "queue %" PRId64 " still exists\n", qid);

#endif

_queue *queue = ref->queue;

GLOBAL_FREE(ref);

_queue_kill_and_wait(queue);

#ifdef Py_DEBUG

if (queue->items.count > 0) {

fprintf(stderr, "queue %" PRId64 " still holds %zd items\n",

qid, queue->items.count);

}

#endif

_queue_free(queue);

}

/* a collection of queues ***************************************************/

typedef struct _queues {

PyThread_type_lock mutex;

_queueref *head;

int64_t count;

int64_t next_id;

} _queues;

static void

_queues_init(_queues *queues, PyThread_type_lock mutex)

{

assert(mutex != NULL);

assert(queues->mutex == NULL);

*queues = (_queues){

.mutex = mutex,

.head = NULL,

.count = 0,

.next_id = 1,

};

}

static void

_queues_fini(_queues *queues, PyThread_type_lock *p_mutex)

{

PyThread_type_lock mutex = queues->mutex;

assert(mutex != NULL);

PyThread_acquire_lock(mutex, WAIT_LOCK);

if (queues->count > 0) {

assert(queues->head != NULL);

_queuerefs_clear(queues->head);

}

*queues = (_queues){0};

PyThread_release_lock(mutex);

*p_mutex = mutex;

}

static int64_t

_queues_next_id(_queues *queues) // needs lock

{

int64_t qid = queues->next_id;

if (qid < 0) {

/* overflow */

return ERR_NO_NEXT_QUEUE_ID;

}

queues->next_id += 1;

return qid;

}

static int

_queues_lookup(_queues *queues, int64_t qid, _queue **res)

{

PyThread_acquire_lock(queues->mutex, WAIT_LOCK);

_queueref *ref = _queuerefs_find(queues->head, qid, NULL);

if (ref == NULL) {

PyThread_release_lock(queues->mutex);

return ERR_QUEUE_NOT_FOUND;

}

assert(ref->queue != NULL);

_queue *queue = ref->queue;

_queue_mark_waiter(queue, NULL);

// The caller must unmark it.

PyThread_release_lock(queues->mutex);

*res = queue;

return 0;

}

static int64_t

_queues_add(_queues *queues, _queue *queue)

{

int64_t qid = -1;

PyThread_acquire_lock(queues->mutex, WAIT_LOCK);

// Create a new ref.

int64_t _qid = _queues_next_id(queues);

if (_qid < 0) {

goto done;

}

_queueref *ref = GLOBAL_MALLOC(_queueref);

if (ref == NULL) {

qid = ERR_QUEUE_ALLOC;

goto done;

}

*ref = (_queueref){

.qid = _qid,

.queue = queue,

};

// Add it to the list.

// We assume that the queue is a new one (not already in the list).

ref->next = queues->head;

queues->head = ref;

queues->count += 1;

qid = _qid;

done:

PyThread_release_lock(queues->mutex);

return qid;

}

static void

_queues_remove_ref(_queues *queues, _queueref *ref, _queueref *prev,

_queue **p_queue)

{

assert(ref->queue != NULL);

if (ref == queues->head) {

queues->head = ref->next;

}

else {

prev->next = ref->next;

}

ref->next = NULL;

queues->count -= 1;

*p_queue = ref->queue;

ref->queue = NULL;

GLOBAL_FREE(ref);

}

static int

_queues_remove(_queues *queues, int64_t qid, _queue **p_queue)

{

PyThread_acquire_lock(queues->mutex, WAIT_LOCK);

_queueref *prev = NULL;

_queueref *ref = _queuerefs_find(queues->head, qid, &prev);

if (ref == NULL) {

PyThread_release_lock(queues->mutex);

return ERR_QUEUE_NOT_FOUND;

}

_queues_remove_ref(queues, ref, prev, p_queue);

PyThread_release_lock(queues->mutex);

return 0;

}

static int

_queues_incref(_queues *queues, int64_t qid)

{

// XXX Track interpreter IDs?

int res = -1;

PyThread_acquire_lock(queues->mutex, WAIT_LOCK);

_queueref *ref = _queuerefs_find(queues->head, qid, NULL);

if (ref == NULL) {

assert(!PyErr_Occurred());

res = ERR_QUEUE_NOT_FOUND;

goto done;

}

ref->refcount += 1;

res = 0;

done:

PyThread_release_lock(queues->mutex);

return res;

}

static int

_queues_decref(_queues *queues, int64_t qid)

{

int res = -1;

View remainder of file in raw view

cpython/Modules/_interpqueuesmodule.c at 3.15 · python/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

_interpqueuesmodule.c

Latest commit

History

Breadcrumbs

_interpqueuesmodule.c

File metadata and controls