cpython/Modules/_testbuffer.c at 3.8 · python/cpython · GitHub

History

2894 lines (2440 loc) · 82.2 KB

Raw

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

/* C Extension module to test all aspects of PEP-3118.

Written by Stefan Krah. */

#define PY_SSIZE_T_CLEAN

#include "Python.h"

/* struct module */

static PyObject *structmodule = NULL;

static PyObject *Struct = NULL;

static PyObject *calcsize = NULL;

/* cache simple format string */

static const char *simple_fmt = "B";

static PyObject *simple_format = NULL;

#define SIMPLE_FORMAT(fmt) (fmt == NULL || strcmp(fmt, "B") == 0)

#define FIX_FORMAT(fmt) (fmt == NULL ? "B" : fmt)

/**************************************************************************/

/* NDArray Object */

/**************************************************************************/

static PyTypeObject NDArray_Type;

#define NDArray_Check(v) (Py_TYPE(v) == &NDArray_Type)

#define CHECK_LIST_OR_TUPLE(v) \

if (!PyList_Check(v) && !PyTuple_Check(v)) { \

PyErr_SetString(PyExc_TypeError, \

#v " must be a list or a tuple"); \

return NULL; \

} \

#define PyMem_XFree(v) \

do { if (v) PyMem_Free(v); } while (0)

/* Maximum number of dimensions. */

#define ND_MAX_NDIM (2 * PyBUF_MAX_NDIM)

/* Check for the presence of suboffsets in the first dimension. */

#define HAVE_PTR(suboffsets) (suboffsets && suboffsets[0] >= 0)

/* Adjust ptr if suboffsets are present. */

#define ADJUST_PTR(ptr, suboffsets) \

(HAVE_PTR(suboffsets) ? *((char**)ptr) + suboffsets[0] : ptr)

/* Default: NumPy style (strides), read-only, no var-export, C-style layout */

#define ND_DEFAULT 0x000

/* User configurable flags for the ndarray */

#define ND_VAREXPORT 0x001 /* change layout while buffers are exported */

/* User configurable flags for each base buffer */

#define ND_WRITABLE 0x002 /* mark base buffer as writable */

#define ND_FORTRAN 0x004 /* Fortran contiguous layout */

#define ND_SCALAR 0x008 /* scalar: ndim = 0 */

#define ND_PIL 0x010 /* convert to PIL-style array (suboffsets) */

#define ND_REDIRECT 0x020 /* redirect buffer requests */

#define ND_GETBUF_FAIL 0x040 /* trigger getbuffer failure */

#define ND_GETBUF_UNDEFINED 0x080 /* undefined view.obj */

/* Internal flags for the base buffer */

#define ND_C 0x100 /* C contiguous layout (default) */

#define ND_OWN_ARRAYS 0x200 /* consumer owns arrays */

/* ndarray properties */

#define ND_IS_CONSUMER(nd) \

(((NDArrayObject *)nd)->head == &((NDArrayObject *)nd)->staticbuf)

/* ndbuf->flags properties */

#define ND_C_CONTIGUOUS(flags) (!!(flags&(ND_SCALAR|ND_C)))

#define ND_FORTRAN_CONTIGUOUS(flags) (!!(flags&(ND_SCALAR|ND_FORTRAN)))

#define ND_ANY_CONTIGUOUS(flags) (!!(flags&(ND_SCALAR|ND_C|ND_FORTRAN)))

/* getbuffer() requests */

#define REQ_INDIRECT(flags) ((flags&PyBUF_INDIRECT) == PyBUF_INDIRECT)

#define REQ_C_CONTIGUOUS(flags) ((flags&PyBUF_C_CONTIGUOUS) == PyBUF_C_CONTIGUOUS)

#define REQ_F_CONTIGUOUS(flags) ((flags&PyBUF_F_CONTIGUOUS) == PyBUF_F_CONTIGUOUS)

#define REQ_ANY_CONTIGUOUS(flags) ((flags&PyBUF_ANY_CONTIGUOUS) == PyBUF_ANY_CONTIGUOUS)

#define REQ_STRIDES(flags) ((flags&PyBUF_STRIDES) == PyBUF_STRIDES)

#define REQ_SHAPE(flags) ((flags&PyBUF_ND) == PyBUF_ND)

#define REQ_WRITABLE(flags) (flags&PyBUF_WRITABLE)

#define REQ_FORMAT(flags) (flags&PyBUF_FORMAT)

/* Single node of a list of base buffers. The list is needed to implement

changes in memory layout while exported buffers are active. */

static PyTypeObject NDArray_Type;

struct ndbuf;

typedef struct ndbuf {

struct ndbuf *next;

struct ndbuf *prev;

Py_ssize_t len; /* length of data */

Py_ssize_t offset; /* start of the array relative to data */

char *data; /* raw data */

int flags; /* capabilities of the base buffer */

Py_ssize_t exports; /* number of exports */

Py_buffer base; /* base buffer */

} ndbuf_t;

typedef struct {

PyObject_HEAD

int flags; /* ndarray flags */

ndbuf_t staticbuf; /* static buffer for re-exporting mode */

ndbuf_t *head; /* currently active base buffer */

} NDArrayObject;

static ndbuf_t *

ndbuf_new(Py_ssize_t nitems, Py_ssize_t itemsize, Py_ssize_t offset, int flags)

{

ndbuf_t *ndbuf;

Py_buffer *base;

Py_ssize_t len;

len = nitems * itemsize;

if (offset % itemsize) {

PyErr_SetString(PyExc_ValueError,

"offset must be a multiple of itemsize");

return NULL;

}

if (offset < 0 || offset+itemsize > len) {

PyErr_SetString(PyExc_ValueError, "offset out of bounds");

return NULL;

}

ndbuf = PyMem_Malloc(sizeof *ndbuf);

if (ndbuf == NULL) {

PyErr_NoMemory();

return NULL;

}

ndbuf->next = NULL;

ndbuf->prev = NULL;

ndbuf->len = len;

ndbuf->offset= offset;

ndbuf->data = PyMem_Malloc(len);

if (ndbuf->data == NULL) {

PyErr_NoMemory();

PyMem_Free(ndbuf);

return NULL;

}

ndbuf->flags = flags;

ndbuf->exports = 0;

base = &ndbuf->base;

base->obj = NULL;

base->buf = ndbuf->data;

base->len = len;

base->itemsize = 1;

base->readonly = 0;

base->format = NULL;

base->ndim = 1;

base->shape = NULL;

base->strides = NULL;

base->suboffsets = NULL;

base->internal = ndbuf;

return ndbuf;

}

static void

ndbuf_free(ndbuf_t *ndbuf)

{

Py_buffer *base = &ndbuf->base;

PyMem_XFree(ndbuf->data);

PyMem_XFree(base->format);

PyMem_XFree(base->shape);

PyMem_XFree(base->strides);

PyMem_XFree(base->suboffsets);

PyMem_Free(ndbuf);

}

static void

ndbuf_push(NDArrayObject *nd, ndbuf_t *elt)

{

elt->next = nd->head;

if (nd->head) nd->head->prev = elt;

nd->head = elt;

elt->prev = NULL;

}

static void

ndbuf_delete(NDArrayObject *nd, ndbuf_t *elt)

{

if (elt->prev)

elt->prev->next = elt->next;

else

nd->head = elt->next;

if (elt->next)

elt->next->prev = elt->prev;

ndbuf_free(elt);

}

static void

ndbuf_pop(NDArrayObject *nd)

{

ndbuf_delete(nd, nd->head);

}

static PyObject *

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

{

NDArrayObject *nd;

nd = PyObject_New(NDArrayObject, &NDArray_Type);

if (nd == NULL)

return NULL;

nd->flags = 0;

nd->head = NULL;

return (PyObject *)nd;

}

static void

ndarray_dealloc(NDArrayObject *self)

{

if (self->head) {

if (ND_IS_CONSUMER(self)) {

Py_buffer *base = &self->head->base;

if (self->head->flags & ND_OWN_ARRAYS) {

PyMem_XFree(base->shape);

PyMem_XFree(base->strides);

PyMem_XFree(base->suboffsets);

}

PyBuffer_Release(base);

}

else {

while (self->head)

ndbuf_pop(self);

}

PyObject_Del(self);

}

static int

ndarray_init_staticbuf(PyObject *exporter, NDArrayObject *nd, int flags)

{

Py_buffer *base = &nd->staticbuf.base;

if (PyObject_GetBuffer(exporter, base, flags) < 0)

return -1;

nd->head = &nd->staticbuf;

nd->head->next = NULL;

nd->head->prev = NULL;

nd->head->len = -1;

nd->head->offset = -1;

nd->head->data = NULL;

nd->head->flags = base->readonly ? 0 : ND_WRITABLE;

nd->head->exports = 0;

return 0;

}

static void

init_flags(ndbuf_t *ndbuf)

{

if (ndbuf->base.ndim == 0)

ndbuf->flags |= ND_SCALAR;

if (ndbuf->base.suboffsets)

ndbuf->flags |= ND_PIL;

if (PyBuffer_IsContiguous(&ndbuf->base, 'C'))

ndbuf->flags |= ND_C;

if (PyBuffer_IsContiguous(&ndbuf->base, 'F'))

ndbuf->flags |= ND_FORTRAN;

}

/****************************************************************************/

/* Buffer/List conversions */

/****************************************************************************/

static Py_ssize_t *strides_from_shape(const ndbuf_t *, int flags);

/* Get number of members in a struct: see issue #12740 */

typedef struct {

PyObject_HEAD

Py_ssize_t s_size;

Py_ssize_t s_len;

} PyPartialStructObject;

static Py_ssize_t

get_nmemb(PyObject *s)

{

return ((PyPartialStructObject *)s)->s_len;

}

/* Pack all items into the buffer of 'obj'. The 'format' parameter must be

in struct module syntax. For standard C types, a single item is an integer.

For compound types, a single item is a tuple of integers. */

static int

pack_from_list(PyObject *obj, PyObject *items, PyObject *format,

Py_ssize_t itemsize)

{

PyObject *structobj, *pack_into;

PyObject *args, *offset;

PyObject *item, *tmp;

Py_ssize_t nitems; /* number of items */

Py_ssize_t nmemb; /* number of members in a single item */

Py_ssize_t i, j;

int ret = 0;

assert(PyObject_CheckBuffer(obj));

assert(PyList_Check(items) || PyTuple_Check(items));

structobj = PyObject_CallFunctionObjArgs(Struct, format, NULL);

if (structobj == NULL)

return -1;

nitems = PySequence_Fast_GET_SIZE(items);

nmemb = get_nmemb(structobj);

assert(nmemb >= 1);

pack_into = PyObject_GetAttrString(structobj, "pack_into");

if (pack_into == NULL) {

Py_DECREF(structobj);

return -1;

}

/* nmemb >= 1 */

args = PyTuple_New(2 + nmemb);

if (args == NULL) {

Py_DECREF(pack_into);

Py_DECREF(structobj);

return -1;

}

offset = NULL;

for (i = 0; i < nitems; i++) {

/* Loop invariant: args[j] are borrowed references or NULL. */

PyTuple_SET_ITEM(args, 0, obj);

for (j = 1; j < 2+nmemb; j++)

PyTuple_SET_ITEM(args, j, NULL);

Py_XDECREF(offset);

offset = PyLong_FromSsize_t(i*itemsize);

if (offset == NULL) {

ret = -1;

break;

}

PyTuple_SET_ITEM(args, 1, offset);

item = PySequence_Fast_GET_ITEM(items, i);

if ((PyBytes_Check(item) || PyLong_Check(item) ||

PyFloat_Check(item)) && nmemb == 1) {

PyTuple_SET_ITEM(args, 2, item);

}

else if ((PyList_Check(item) || PyTuple_Check(item)) &&

PySequence_Length(item) == nmemb) {

for (j = 0; j < nmemb; j++) {

tmp = PySequence_Fast_GET_ITEM(item, j);

PyTuple_SET_ITEM(args, 2+j, tmp);

}

else {

PyErr_SetString(PyExc_ValueError,

"mismatch between initializer element and format string");

ret = -1;

break;

}

tmp = PyObject_CallObject(pack_into, args);

if (tmp == NULL) {

ret = -1;

break;

}

Py_DECREF(tmp);

}

Py_INCREF(obj); /* args[0] */

/* args[1]: offset is either NULL or should be dealloc'd */

for (i = 2; i < 2+nmemb; i++) {

tmp = PyTuple_GET_ITEM(args, i);

Py_XINCREF(tmp);

}

Py_DECREF(args);

Py_DECREF(pack_into);

Py_DECREF(structobj);

return ret;

}

/* Pack single element */

static int

pack_single(char *ptr, PyObject *item, const char *fmt, Py_ssize_t itemsize)

{

PyObject *structobj = NULL, *pack_into = NULL, *args = NULL;

PyObject *format = NULL, *mview = NULL, *zero = NULL;

Py_ssize_t i, nmemb;

int ret = -1;

PyObject *x;

if (fmt == NULL) fmt = "B";

format = PyUnicode_FromString(fmt);

if (format == NULL)

goto out;

structobj = PyObject_CallFunctionObjArgs(Struct, format, NULL);

if (structobj == NULL)

goto out;

nmemb = get_nmemb(structobj);

assert(nmemb >= 1);

mview = PyMemoryView_FromMemory(ptr, itemsize, PyBUF_WRITE);

if (mview == NULL)

goto out;

zero = PyLong_FromLong(0);

if (zero == NULL)

goto out;

pack_into = PyObject_GetAttrString(structobj, "pack_into");

if (pack_into == NULL)

goto out;

args = PyTuple_New(2+nmemb);

if (args == NULL)

goto out;

PyTuple_SET_ITEM(args, 0, mview);

PyTuple_SET_ITEM(args, 1, zero);

if ((PyBytes_Check(item) || PyLong_Check(item) ||

PyFloat_Check(item)) && nmemb == 1) {

PyTuple_SET_ITEM(args, 2, item);

}

else if ((PyList_Check(item) || PyTuple_Check(item)) &&

PySequence_Length(item) == nmemb) {

for (i = 0; i < nmemb; i++) {

x = PySequence_Fast_GET_ITEM(item, i);

PyTuple_SET_ITEM(args, 2+i, x);

}

else {

PyErr_SetString(PyExc_ValueError,

"mismatch between initializer element and format string");

goto args_out;

}

x = PyObject_CallObject(pack_into, args);

if (x != NULL) {

Py_DECREF(x);

ret = 0;

}

args_out:

for (i = 0; i < 2+nmemb; i++)

Py_XINCREF(PyTuple_GET_ITEM(args, i));

Py_XDECREF(args);

out:

Py_XDECREF(pack_into);

Py_XDECREF(zero);

Py_XDECREF(mview);

Py_XDECREF(structobj);

Py_XDECREF(format);

return ret;

}

static void

copy_rec(const Py_ssize_t *shape, Py_ssize_t ndim, Py_ssize_t itemsize,

char *dptr, const Py_ssize_t *dstrides, const Py_ssize_t *dsuboffsets,

char *sptr, const Py_ssize_t *sstrides, const Py_ssize_t *ssuboffsets,

char *mem)

{

Py_ssize_t i;

assert(ndim >= 1);

if (ndim == 1) {

if (!HAVE_PTR(dsuboffsets) && !HAVE_PTR(ssuboffsets) &&

dstrides[0] == itemsize && sstrides[0] == itemsize) {

memmove(dptr, sptr, shape[0] * itemsize);

}

else {

char *p;

assert(mem != NULL);

for (i=0, p=mem; i<shape[0]; p+=itemsize, sptr+=sstrides[0], i++) {

char *xsptr = ADJUST_PTR(sptr, ssuboffsets);

memcpy(p, xsptr, itemsize);

}

for (i=0, p=mem; i<shape[0]; p+=itemsize, dptr+=dstrides[0], i++) {

char *xdptr = ADJUST_PTR(dptr, dsuboffsets);

memcpy(xdptr, p, itemsize);

}

return;

}

for (i = 0; i < shape[0]; dptr+=dstrides[0], sptr+=sstrides[0], i++) {

char *xdptr = ADJUST_PTR(dptr, dsuboffsets);

char *xsptr = ADJUST_PTR(sptr, ssuboffsets);

copy_rec(shape+1, ndim-1, itemsize,

xdptr, dstrides+1, dsuboffsets ? dsuboffsets+1 : NULL,

xsptr, sstrides+1, ssuboffsets ? ssuboffsets+1 : NULL,

mem);

}

static int

cmp_structure(Py_buffer *dest, Py_buffer *src)

{

Py_ssize_t i;

if (strcmp(FIX_FORMAT(dest->format), FIX_FORMAT(src->format)) != 0 ||

dest->itemsize != src->itemsize ||

dest->ndim != src->ndim)

return -1;

for (i = 0; i < dest->ndim; i++) {

if (dest->shape[i] != src->shape[i])

return -1;

if (dest->shape[i] == 0)

break;

}

return 0;

}

/* Copy src to dest. Both buffers must have the same format, itemsize,

ndim and shape. Copying is atomic, the function never fails with

a partial copy. */

static int

copy_buffer(Py_buffer *dest, Py_buffer *src)

{

char *mem = NULL;

assert(dest->ndim > 0);

if (cmp_structure(dest, src) < 0) {

PyErr_SetString(PyExc_ValueError,

"ndarray assignment: lvalue and rvalue have different structures");

return -1;

}

if ((dest->suboffsets && dest->suboffsets[dest->ndim-1] >= 0) ||

(src->suboffsets && src->suboffsets[src->ndim-1] >= 0) ||

dest->strides[dest->ndim-1] != dest->itemsize ||

src->strides[src->ndim-1] != src->itemsize) {

mem = PyMem_Malloc(dest->shape[dest->ndim-1] * dest->itemsize);

if (mem == NULL) {

PyErr_NoMemory();

return -1;

}

copy_rec(dest->shape, dest->ndim, dest->itemsize,

dest->buf, dest->strides, dest->suboffsets,

src->buf, src->strides, src->suboffsets,

mem);

PyMem_XFree(mem);

return 0;

}

/* Unpack single element */

static PyObject *

unpack_single(char *ptr, const char *fmt, Py_ssize_t itemsize)

{

PyObject *x, *unpack_from, *mview;

if (fmt == NULL) {

fmt = "B";

itemsize = 1;

}

unpack_from = PyObject_GetAttrString(structmodule, "unpack_from");

if (unpack_from == NULL)

return NULL;

mview = PyMemoryView_FromMemory(ptr, itemsize, PyBUF_READ);

if (mview == NULL) {

Py_DECREF(unpack_from);

return NULL;

}

x = PyObject_CallFunction(unpack_from, "sO", fmt, mview);

Py_DECREF(unpack_from);

Py_DECREF(mview);

if (x == NULL)

return NULL;

if (PyTuple_GET_SIZE(x) == 1) {

PyObject *tmp = PyTuple_GET_ITEM(x, 0);

Py_INCREF(tmp);

Py_DECREF(x);

return tmp;

}

return x;

}

/* Unpack a multi-dimensional matrix into a nested list. Return a scalar

for ndim = 0. */

static PyObject *

unpack_rec(PyObject *unpack_from, char *ptr, PyObject *mview, char *item,

const Py_ssize_t *shape, const Py_ssize_t *strides,

const Py_ssize_t *suboffsets, Py_ssize_t ndim, Py_ssize_t itemsize)

{

PyObject *lst, *x;

Py_ssize_t i;

assert(ndim >= 0);

assert(shape != NULL);

assert(strides != NULL);

if (ndim == 0) {

memcpy(item, ptr, itemsize);

x = PyObject_CallFunctionObjArgs(unpack_from, mview, NULL);

if (x == NULL)

return NULL;

if (PyTuple_GET_SIZE(x) == 1) {

PyObject *tmp = PyTuple_GET_ITEM(x, 0);

Py_INCREF(tmp);

Py_DECREF(x);

return tmp;

}

return x;

}

lst = PyList_New(shape[0]);

if (lst == NULL)

return NULL;

for (i = 0; i < shape[0]; ptr+=strides[0], i++) {

char *nextptr = ADJUST_PTR(ptr, suboffsets);

x = unpack_rec(unpack_from, nextptr, mview, item,

shape+1, strides+1, suboffsets ? suboffsets+1 : NULL,

ndim-1, itemsize);

if (x == NULL) {

Py_DECREF(lst);

return NULL;

}

PyList_SET_ITEM(lst, i, x);

}

return lst;

}

static PyObject *

ndarray_as_list(NDArrayObject *nd)

{

PyObject *structobj = NULL, *unpack_from = NULL;

PyObject *lst = NULL, *mview = NULL;

Py_buffer *base = &nd->head->base;

Py_ssize_t *shape = base->shape;

Py_ssize_t *strides = base->strides;

Py_ssize_t simple_shape[1];

Py_ssize_t simple_strides[1];

char *item = NULL;

PyObject *format;

char *fmt = base->format;

base = &nd->head->base;

if (fmt == NULL) {

PyErr_SetString(PyExc_ValueError,

"ndarray: tolist() does not support format=NULL, use "

"tobytes()");

return NULL;

}

if (shape == NULL) {

assert(ND_C_CONTIGUOUS(nd->head->flags));

assert(base->strides == NULL);

assert(base->ndim <= 1);

shape = simple_shape;

shape[0] = base->len;

strides = simple_strides;

strides[0] = base->itemsize;

}

else if (strides == NULL) {

assert(ND_C_CONTIGUOUS(nd->head->flags));

strides = strides_from_shape(nd->head, 0);

if (strides == NULL)

return NULL;

}

format = PyUnicode_FromString(fmt);

if (format == NULL)

goto out;

structobj = PyObject_CallFunctionObjArgs(Struct, format, NULL);

Py_DECREF(format);

if (structobj == NULL)

goto out;

unpack_from = PyObject_GetAttrString(structobj, "unpack_from");

if (unpack_from == NULL)

goto out;

item = PyMem_Malloc(base->itemsize);

if (item == NULL) {

PyErr_NoMemory();

goto out;

}

mview = PyMemoryView_FromMemory(item, base->itemsize, PyBUF_WRITE);

if (mview == NULL)

goto out;

lst = unpack_rec(unpack_from, base->buf, mview, item,

shape, strides, base->suboffsets,

base->ndim, base->itemsize);

out:

Py_XDECREF(mview);

PyMem_XFree(item);

Py_XDECREF(unpack_from);

Py_XDECREF(structobj);

if (strides != base->strides && strides != simple_strides)

PyMem_XFree(strides);

return lst;

}

/****************************************************************************/

/* Initialize ndbuf */

/****************************************************************************/

State of a new ndbuf during initialization. 'OK' means that initialization

is complete. 'PTR' means that a pointer has been initialized, but the

state of the memory is still undefined and ndbuf->offset is disregarded.

+-----------------+-----------+-------------+----------------+

+-----------------+-----------+-------------+----------------+

| next | OK (NULL) | OK | OK |

+-----------------+-----------+-------------+----------------+

| prev | OK (NULL) | OK | OK |

+-----------------+-----------+-------------+----------------+

| len | OK | OK | OK |

+-----------------+-----------+-------------+----------------+

| offset | OK | OK | OK |

+-----------------+-----------+-------------+----------------+

| data | PTR | OK | OK |

+-----------------+-----------+-------------+----------------+

+-----------------+-----------+-------------+----------------+

| exports | OK (0) | OK | OK |

+-----------------+-----------+-------------+----------------+

| base.obj | OK (NULL) | OK | OK |

+-----------------+-----------+-------------+----------------+

| base.buf | PTR | PTR | OK |

+-----------------+-----------+-------------+----------------+

+-----------------+-----------+-------------+----------------+

| base.itemsize | 1 | OK | OK |

+-----------------+-----------+-------------+----------------+

| base.readonly | 0 | OK | OK |

+-----------------+-----------+-------------+----------------+

| base.format | NULL | OK | OK |

+-----------------+-----------+-------------+----------------+

| base.ndim | 1 | 1 | OK |

+-----------------+-----------+-------------+----------------+

+-----------------+-----------+-------------+----------------+

+-----------------+-----------+-------------+----------------+

+-----------------+-----------+-------------+----------------+

| base.internal | OK | OK | OK |

+-----------------+-----------+-------------+----------------+

static Py_ssize_t

get_itemsize(PyObject *format)

{

PyObject *tmp;

Py_ssize_t itemsize;

tmp = PyObject_CallFunctionObjArgs(calcsize, format, NULL);

if (tmp == NULL)

return -1;

itemsize = PyLong_AsSsize_t(tmp);

Py_DECREF(tmp);

return itemsize;

}

static char *

get_format(PyObject *format)

{

PyObject *tmp;

char *fmt;

tmp = PyUnicode_AsASCIIString(format);

if (tmp == NULL)

return NULL;

fmt = PyMem_Malloc(PyBytes_GET_SIZE(tmp)+1);

if (fmt == NULL) {

PyErr_NoMemory();

Py_DECREF(tmp);

return NULL;

}

strcpy(fmt, PyBytes_AS_STRING(tmp));

Py_DECREF(tmp);

return fmt;

}

static int

init_simple(ndbuf_t *ndbuf, PyObject *items, PyObject *format,

Py_ssize_t itemsize)

{

PyObject *mview;

Py_buffer *base = &ndbuf->base;

int ret;

mview = PyMemoryView_FromBuffer(base);

if (mview == NULL)

return -1;

ret = pack_from_list(mview, items, format, itemsize);

Py_DECREF(mview);

if (ret < 0)

return -1;

base->readonly = !(ndbuf->flags & ND_WRITABLE);

base->itemsize = itemsize;

base->format = get_format(format);

if (base->format == NULL)

return -1;

return 0;

}

static Py_ssize_t *

seq_as_ssize_array(PyObject *seq, Py_ssize_t len, int is_shape)

{

Py_ssize_t *dest;

Py_ssize_t x, i;

/* ndim = len <= ND_MAX_NDIM, so PyMem_New() is actually not needed. */

dest = PyMem_New(Py_ssize_t, len);

if (dest == NULL) {

PyErr_NoMemory();

return NULL;

}

for (i = 0; i < len; i++) {

PyObject *tmp = PySequence_Fast_GET_ITEM(seq, i);

if (!PyLong_Check(tmp)) {

PyErr_Format(PyExc_ValueError,

"elements of %s must be integers",

is_shape ? "shape" : "strides");

PyMem_Free(dest);

return NULL;

}

x = PyLong_AsSsize_t(tmp);

if (PyErr_Occurred()) {

PyMem_Free(dest);

return NULL;

}

if (is_shape && x < 0) {

PyErr_Format(PyExc_ValueError,

"elements of shape must be integers >= 0");

PyMem_Free(dest);

return NULL;

}

dest[i] = x;

}

return dest;

}

static Py_ssize_t *

strides_from_shape(const ndbuf_t *ndbuf, int flags)

{

const Py_buffer *base = &ndbuf->base;

Py_ssize_t *s, i;

s = PyMem_Malloc(base->ndim * (sizeof *s));

if (s == NULL) {

PyErr_NoMemory();

return NULL;

}

if (flags & ND_FORTRAN) {

s[0] = base->itemsize;

for (i = 1; i < base->ndim; i++)

s[i] = s[i-1] * base->shape[i-1];

}

else {

s[base->ndim-1] = base->itemsize;

for (i = base->ndim-2; i >= 0; i--)

s[i] = s[i+1] * base->shape[i+1];

}

return s;

}

/* Bounds check:

len := complete length of allocated memory

offset := start of the array

A single array element is indexed by:

i = indices[0] * strides[0] + indices[1] * strides[1] + ...

imin is reached when all indices[n] combined with positive strides are 0

and all indices combined with negative strides are shape[n]-1, which is

the maximum index for the nth dimension.

imax is reached when all indices[n] combined with negative strides are 0

and all indices combined with positive strides are shape[n]-1.

static int

verify_structure(Py_ssize_t len, Py_ssize_t itemsize, Py_ssize_t offset,

const Py_ssize_t *shape, const Py_ssize_t *strides,

Py_ssize_t ndim)

{

Py_ssize_t imin, imax;

Py_ssize_t n;

assert(ndim >= 0);

if (ndim == 0 && (offset < 0 || offset+itemsize > len))

goto invalid_combination;

for (n = 0; n < ndim; n++)

if (strides[n] % itemsize) {

PyErr_SetString(PyExc_ValueError,

"strides must be a multiple of itemsize");

return -1;

}

for (n = 0; n < ndim; n++)

if (shape[n] == 0)

return 0;

imin = imax = 0;

for (n = 0; n < ndim; n++)

if (strides[n] <= 0)

imin += (shape[n]-1) * strides[n];

else

imax += (shape[n]-1) * strides[n];

if (imin + offset < 0 || imax + offset + itemsize > len)

goto invalid_combination;

return 0;

invalid_combination:

PyErr_SetString(PyExc_ValueError,

"invalid combination of buffer, shape and strides");

return -1;

}

Convert a NumPy-style array to an array using suboffsets to stride in

the first dimension. Requirements: ndim > 0.

Contiguous example

==================

Input:

------

shape = {2, 2, 3};

strides = {6, 3, 1};

suboffsets = NULL;

data = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11};

buf = &data[0]

Output:

-------

shape = {2, 2, 3};

strides = {sizeof(char *), 3, 1};

suboffsets = {0, -1, -1};

data = {p1, p2, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11};

| | ^ ^

`---'---' |

| |

`---------------------'

buf = &data[0]

So, in the example the input resembles the three-dimensional array

char v[2][2][3], while the output resembles an array of two pointers

to two-dimensional arrays: char (*v[2])[2][3].

View remainder of file in raw view

cpython/Modules/_testbuffer.c at 3.8 · python/cpython · GitHub

Uh oh!

Uh oh!

cpython/Modules/_testbuffer.c at 3.8 · python/cpython · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

_testbuffer.c

Latest commit

History

Breadcrumbs

_testbuffer.c

File metadata and controls