-
Notifications
You must be signed in to change notification settings - Fork 153
/
nb_type.cpp
1365 lines (1129 loc) · 43.9 KB
/
nb_type.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
/*
src/nb_type.cpp: libnanobind functionality for binding classes
Copyright (c) 2022 Wenzel Jakob
All rights reserved. Use of this source code is governed by a
BSD-style license that can be found in the LICENSE file.
*/
#include "nb_internals.h"
#if defined(_MSC_VER)
# pragma warning(disable: 4706) // assignment within conditional expression
#endif
NAMESPACE_BEGIN(NB_NAMESPACE)
NAMESPACE_BEGIN(detail)
static PyObject **nb_dict_ptr(PyObject *self) {
PyTypeObject *tp = Py_TYPE(self);
#if !defined(Py_LIMITED_API)
return (PyObject **) ((uint8_t *) self + tp->tp_dictoffset);
#else
return (PyObject **) ((uint8_t *) self + nb_type_data(tp)->dictoffset);
#endif
}
static int inst_clear(PyObject *self) {
PyObject *&dict = *nb_dict_ptr(self);
Py_CLEAR(dict);
return 0;
}
static int inst_traverse(PyObject *self, visitproc visit, void *arg) {
PyObject *&dict = *nb_dict_ptr(self);
if (dict)
Py_VISIT(dict);
#if PY_VERSION_HEX >= 0x03090000
Py_VISIT(Py_TYPE(self));
#endif
return 0;
}
static int inst_init(PyObject *self, PyObject *, PyObject *) {
const type_data *t = nb_type_data(Py_TYPE(self));
PyErr_Format(PyExc_TypeError, "%s: no constructor defined!", t->name);
return -1;
}
/// Allocate memory for a nb_type instance with internal or external storage
PyObject *inst_new_impl(PyTypeObject *tp, void *value) {
bool gc = PyType_HasFeature(tp, Py_TPFLAGS_HAVE_GC);
const type_data *t = nb_type_data(tp);
size_t align = (size_t) t->align;
nb_inst *self;
if (!gc) {
size_t size = sizeof(nb_inst);
if (!value) {
// Internal storage: space for the object and padding for alignment
size += t->size;
if (align > sizeof(void *))
size += align - sizeof(void *);
}
self = (nb_inst *) PyObject_Malloc(size);
if (!self)
return PyErr_NoMemory();
memset(self, 0, sizeof(nb_inst));
PyObject_Init((PyObject *) self, tp);
} else {
self = (nb_inst *) PyType_GenericAlloc(tp, 0);
}
if (!value) {
// Compute suitably aligned instance payload pointer
uintptr_t payload = (uintptr_t) (self + 1);
payload = (payload + align - 1) / align * align;
// Encode offset to aligned payload
self->offset = (int32_t) ((intptr_t) payload - (intptr_t) self);
self->direct = true;
self->internal = true;
value = (void *) payload;
} else {
// Compute offset to instance value
int32_t offset = (int32_t) ((intptr_t) value - (intptr_t) self);
if ((intptr_t) self + offset == (intptr_t) value) {
// Offset *is* representable as 32 bit value
self->offset = offset;
self->direct = true;
} else {
if (!gc) {
// Offset *not* representable, allocate extra memory for a pointer
nb_inst *self_2 =
(nb_inst *) PyObject_Realloc(self, sizeof(nb_inst) + sizeof(void *));
if (!self_2) {
PyObject_Free(self);
return PyErr_NoMemory();
}
self = self_2;
}
*(void **) (self + 1) = value;
self->offset = (int32_t) sizeof(nb_inst);
self->direct = false;
}
self->internal = false;
}
// Update hash table that maps from C++ to Python instance
auto [it, success] = internals_get().inst_c2p.try_emplace(
std::pair<void *, std::type_index>(value, *t->type),
self);
if (!success)
fail("nanobind::detail::inst_new(): duplicate object!");
return (PyObject *) self;
}
// Allocate a new instance with co-located storage
PyObject *inst_new(PyTypeObject *type, PyObject *, PyObject *) {
return inst_new_impl(type, nullptr);
}
static void inst_dealloc(PyObject *self) {
PyTypeObject *tp = Py_TYPE(self);
const type_data *t = nb_type_data(tp);
bool gc = PyType_HasFeature(tp, Py_TPFLAGS_HAVE_GC);
if (gc)
PyObject_GC_UnTrack(self);
if (t->flags & (uint32_t) type_flags::has_dynamic_attr) {
PyObject *&dict = *nb_dict_ptr(self);
Py_CLEAR(dict);
}
nb_inst *inst = (nb_inst *) self;
void *p = inst_ptr(inst);
if (inst->destruct) {
if (t->flags & (uint32_t) type_flags::is_destructible) {
if (t->flags & (uint32_t) type_flags::has_destruct)
t->destruct(p);
} else {
fail("nanobind::detail::inst_dealloc(\"%s\"): attempted to call "
"the destructor of a non-destructible type!", t->name);
}
}
if (inst->cpp_delete) {
if (t->align <= (uint32_t) __STDCPP_DEFAULT_NEW_ALIGNMENT__)
operator delete(p);
else
operator delete(p, std::align_val_t(t->align));
}
nb_internals &internals = internals_get();
if (inst->clear_keep_alive) {
auto it = internals.keep_alive.find(self);
if (it == internals.keep_alive.end())
fail("nanobind::detail::inst_dealloc(\"%s\"): inconsistent "
"keep_alive information", t->name);
keep_alive_set ref_set = std::move(it.value());
internals.keep_alive.erase(it);
for (keep_alive_entry e: ref_set) {
if (!e.deleter)
Py_DECREF((PyObject *) e.data);
else
e.deleter(e.data);
}
}
// Update hash table that maps from C++ to Python instance
auto it = internals.inst_c2p.find(
std::pair<void *, std::type_index>(p, *t->type));
if (it == internals.inst_c2p.end())
fail("nanobind::detail::inst_dealloc(\"%s\"): attempted to delete "
"an unknown instance (%p)!", t->name, p);
internals.inst_c2p.erase(it);
if (gc) {
#if defined(Py_LIMITED_API)
static freefunc tp_free =
(freefunc) PyType_GetSlot(tp, Py_tp_free);
#else
freefunc tp_free = tp->tp_free;
#endif
tp_free(self);
} else {
PyObject_Free(self);
}
Py_DECREF(tp);
}
void nb_type_dealloc(PyObject *o) {
type_data *t = nb_type_data((PyTypeObject *) o);
if (t->type && (t->flags & (uint32_t) type_flags::is_python_type) == 0) {
nb_internals &internals = internals_get();
auto it = internals.type_c2p.find(std::type_index(*t->type));
if (it == internals.type_c2p.end())
fail("nanobind::detail::nb_type_dealloc(\"%s\"): could not "
"find type!", t->name);
internals.type_c2p.erase(it);
}
if (t->flags & (uint32_t) type_flags::has_implicit_conversions) {
free(t->implicit);
free(t->implicit_py);
}
if (t->flags & (uint32_t) type_flags::has_supplement)
free(t->supplement);
free((char *) t->name);
#if defined(Py_LIMITED_API)
static destructor tp_dealloc =
(destructor) PyType_GetSlot(&PyType_Type, Py_tp_dealloc);
#else
destructor tp_dealloc = PyType_Type.tp_dealloc;
#endif
tp_dealloc(o);
}
/// Called when a C++ type is extended from within Python
int nb_type_init(PyObject *self, PyObject *args, PyObject *kwds) {
if (NB_TUPLE_GET_SIZE(args) != 3) {
PyErr_SetString(PyExc_RuntimeError,
"nb_type_init(): invalid number of arguments!");
return -1;
}
PyObject *bases = NB_TUPLE_GET_ITEM(args, 1);
if (!PyTuple_CheckExact(bases) || NB_TUPLE_GET_SIZE(bases) != 1) {
PyErr_SetString(PyExc_RuntimeError,
"nb_type_init(): invalid number of bases!");
return -1;
}
PyObject *base = NB_TUPLE_GET_ITEM(bases, 0);
if (!PyType_Check(base)) {
PyErr_SetString(PyExc_RuntimeError, "nb_type_init(): expected a base type object!");
return -1;
}
type_data *t_b = nb_type_data((PyTypeObject *) base);
if (t_b->flags & (uint32_t) type_flags::is_final) {
PyErr_Format(PyExc_TypeError, "The type '%s' prohibits subclassing!",
t_b->name);
return -1;
}
#if defined(Py_LIMITED_API)
static initproc tp_init =
(initproc) PyType_GetSlot(&PyType_Type, Py_tp_init);
#else
initproc tp_init = PyType_Type.tp_init;
#endif
int rv = tp_init(self, args, kwds);
if (rv)
return rv;
type_data *t = nb_type_data((PyTypeObject *) self);
*t = *t_b;
t->flags |= (uint32_t) type_flags::is_python_type;
t->flags &= ~((uint32_t) type_flags::has_implicit_conversions |
(uint32_t) type_flags::has_supplement);
PyObject *name = nb_type_name((PyTypeObject *) self);
t->name = NB_STRDUP(PyUnicode_AsUTF8AndSize(name, nullptr));
Py_DECREF(name);
t->type_py = (PyTypeObject *) self;
t->base = t_b->type;
t->base_py = t_b->type_py;
t->implicit = nullptr;
t->implicit_py = nullptr;
t->supplement = nullptr;
return 0;
}
/// Called when a C++ type is bound via nb::class_<>
PyObject *nb_type_new(const type_data *t) noexcept {
bool is_signed_enum = t->flags & (uint32_t) type_flags::is_signed_enum,
is_unsigned_enum = t->flags & (uint32_t) type_flags::is_unsigned_enum,
is_arithmetic = t->flags & (uint32_t) type_flags::is_arithmetic,
is_enum = is_signed_enum || is_unsigned_enum,
has_scope = t->flags & (uint32_t) type_flags::has_scope,
has_doc = t->flags & (uint32_t) type_flags::has_doc,
has_base = t->flags & (uint32_t) type_flags::has_base,
has_base_py = t->flags & (uint32_t) type_flags::has_base_py,
has_type_slots = t->flags & (uint32_t) type_flags::has_type_slots,
has_supplement = t->flags & (uint32_t) type_flags::has_supplement,
has_dynamic_attr = t->flags & (uint32_t) type_flags::has_dynamic_attr,
intrusive_ptr = t->flags & (uint32_t) type_flags::intrusive_ptr;
nb_internals &internals = internals_get();
str name(t->name), qualname = name;
object modname;
PyObject *mod = nullptr;
if (has_scope) {
has_scope = t->scope != nullptr;
if (has_scope) {
if (PyModule_Check(t->scope)) {
mod = t->scope;
modname = getattr(t->scope, "__name__", handle());
} else {
modname = getattr(t->scope, "__module__", handle());
object scope_qualname = getattr(t->scope, "__qualname__", handle());
if (scope_qualname.is_valid())
qualname = steal<str>(
PyUnicode_FromFormat("%U.%U", scope_qualname.ptr(), name.ptr()));
}
}
}
if (modname.is_valid())
name = steal<str>(
PyUnicode_FromFormat("%U.%U", modname.ptr(), name.ptr()));
constexpr size_t ptr_size = sizeof(void *);
size_t basicsize = sizeof(nb_inst) + t->size;
if (t->align > ptr_size)
basicsize += t->align - ptr_size;
PyObject *base = nullptr;
if (has_base_py) {
if (has_base)
fail("nanobind::detail::nb_type_new(\"%s\"): multiple base types "
"specified!", t->name);
base = (PyObject *) t->base_py;
} else if (has_base) {
auto it = internals.type_c2p.find(std::type_index(*t->base));
if (it == internals.type_c2p.end())
fail("nanobind::detail::nb_type_new(\"%s\"): base type \"%s\" not "
"known to nanobind!", t->name, type_name(t->base));
base = (PyObject *) it->second->type_py;
}
type_data *tb = nullptr;
if (base) {
// Check if the base type already has dynamic attributes
tb = nb_type_data((PyTypeObject *) base);
if (tb->flags & (uint32_t) type_flags::has_dynamic_attr)
has_dynamic_attr = true;
/* Handle a corner case (base class larger than derived class)
which can arise when extending trampoline base classes */
size_t base_basicsize = sizeof(nb_inst) + tb->size;
if (tb->align > ptr_size)
base_basicsize += tb->align - ptr_size;
if (base_basicsize > basicsize)
basicsize = base_basicsize;
}
char *name_copy = NB_STRDUP(name.c_str());
constexpr size_t nb_enum_max_slots = 22,
nb_type_max_slots = 10,
nb_extra_slots = 80,
nb_total_slots = nb_enum_max_slots +
nb_type_max_slots +
nb_extra_slots + 1;
PyMemberDef members[2] { };
PyType_Slot slots[nb_total_slots], *s = slots;
PyType_Spec spec = {
/* .name = */ name_copy,
/* .basicsize = */ (int) basicsize,
/* .itemsize = */ 0,
/* .flags = */ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
/* .slots = */ slots
};
if (base)
*s++ = { Py_tp_base, (void *) base };
*s++ = { Py_tp_init, (void *) inst_init };
*s++ = { Py_tp_new, (void *) inst_new };
*s++ = { Py_tp_dealloc, (void *) inst_dealloc };
if (has_doc)
*s++ = { Py_tp_doc, (void *) t->doc };
if (has_type_slots) {
size_t i = 0;
while (t->type_slots[i].slot) {
if (i == nb_extra_slots)
fail("nanobind::detail::nb_type_new(\"%s\"): ran out of type "
"slots!", t->name);
*s++ = t->type_slots[i++];
}
}
if (is_enum)
nb_enum_prepare(&s, is_arithmetic);
bool has_traverse = false;
for (PyType_Slot *ts = slots; ts != s; ++ts) {
if (ts->slot == Py_tp_traverse)
has_traverse = true;
}
if (has_dynamic_attr) {
// realign to sizeof(void*), add one pointer
basicsize = (basicsize + ptr_size - 1) / ptr_size * ptr_size;
basicsize += ptr_size;
members[0] = PyMemberDef{ "__dictoffset__", T_PYSSIZET,
(Py_ssize_t) (basicsize - ptr_size), READONLY,
nullptr };
*s++ = { Py_tp_members, (void *) members };
// Install GC traverse and clear routines if not inherited/overridden
if (!has_traverse) {
*s++ = { Py_tp_traverse, (void *) inst_traverse };
*s++ = { Py_tp_clear, (void *) inst_clear };
has_traverse = true;
}
spec.basicsize = (int) basicsize;
}
if (has_traverse && (!base || (PyType_GetFlags((PyTypeObject *) base) &
Py_TPFLAGS_HAVE_GC) == 0))
spec.flags |= Py_TPFLAGS_HAVE_GC;
*s++ = { 0, nullptr };
PyTypeObject *metaclass = internals.nb_type;
#if PY_VERSION_HEX >= 0x030C0000
// Life is good, PyType_FromMetaclass() is available
PyObject *result = PyType_FromMetaclass(metaclass, mod, &spec, base);
if (!result) {
python_error err;
fail("nanobind::detail::nb_type_new(\"%s\"): type construction failed: %s!", t->name, err.what());
}
#else
/* The fallback code below is cursed. It provides an alternative when
PyType_FromMetaclass() is not available (i.e., on Python < 3.12). It
calls PyType_FromSpec() to create a tentative type, copies its contents
into a larger type with a different metaclass, then lets the original
type expire. This approach is incompatible with stable ABI builds. */
(void) mod;
PyObject *temp = PyType_FromSpec(&spec);
if (!temp) {
python_error err;
fail("nanobind::detail::nb_type_new(\"%s\"): type construction failed: %s!", t->name, err.what());
}
PyHeapTypeObject *temp_ht = (PyHeapTypeObject *) temp;
PyTypeObject *temp_tp = &temp_ht->ht_type;
Py_INCREF (temp_ht->ht_name);
Py_INCREF (temp_ht->ht_qualname);
Py_XINCREF(temp_ht->ht_slots);
Py_INCREF (temp_tp->tp_base);
#if PY_VERSION_HEX >= 0x03090000
Py_XINCREF(temp_ht->ht_module);
#endif
char *tp_doc = nullptr;
if (temp_tp->tp_doc) {
size_t size = strlen(temp_tp->tp_doc) + 1;
tp_doc = (char *) PyObject_Malloc(size);
memcpy(tp_doc, temp_tp->tp_doc, size);
}
const char *tp_name = PyUnicode_AsUTF8AndSize(temp_ht->ht_name, nullptr);
PyObject *result = PyType_GenericAlloc(metaclass, Py_SIZE(temp_tp));
if (!temp || !result)
fail("nanobind::detail::nb_type_new(\"%s\"): type construction failed!",
t->name);
PyHeapTypeObject *ht = (PyHeapTypeObject *) result;
PyTypeObject *tp = &ht->ht_type;
ht->ht_name = temp_ht->ht_name;
ht->ht_qualname = temp_ht->ht_qualname;
ht->ht_slots = temp_ht->ht_slots;
#if PY_VERSION_HEX >= 0x03090000
ht->ht_module = temp_ht->ht_module;
#endif
tp->tp_name = tp_name;
tp->tp_doc = tp_doc;
tp->tp_basicsize = temp_tp->tp_basicsize;
tp->tp_itemsize = temp_tp->tp_itemsize;
tp->tp_vectorcall_offset = temp_tp->tp_vectorcall_offset;
tp->tp_weaklistoffset = temp_tp->tp_weaklistoffset;
tp->tp_dictoffset = temp_tp->tp_dictoffset;
tp->tp_vectorcall = temp_tp->tp_vectorcall;
tp->tp_flags = spec.flags | Py_TPFLAGS_HEAPTYPE;
PyAsyncMethods *am = tp->tp_as_async = &ht->as_async;
PyNumberMethods *nb = tp->tp_as_number = &ht->as_number;
PySequenceMethods *sq = tp->tp_as_sequence = &ht->as_sequence;
PyMappingMethods *mp = tp->tp_as_mapping = &ht->as_mapping;
PyBufferProcs *bf = tp->tp_as_buffer = &ht->as_buffer;
#define CASE(tp, name) \
case Py_##tp##_##name: \
tp->tp##_##name = (decltype(tp->tp##_##name)) ts->pfunc; \
break;
for (PyType_Slot *ts = slots; ts != s; ++ts) {
switch (ts->slot) {
CASE(tp, dealloc)
CASE(tp, getattr)
CASE(tp, setattr)
CASE(tp, repr)
CASE(tp, hash)
CASE(tp, call)
CASE(tp, str)
CASE(tp, getattro)
CASE(tp, setattro)
CASE(tp, traverse)
CASE(tp, clear)
CASE(tp, richcompare)
CASE(tp, iter)
CASE(tp, iternext)
CASE(tp, methods)
CASE(tp, getset)
CASE(tp, base)
CASE(tp, descr_get)
CASE(tp, descr_set)
CASE(tp, init)
CASE(tp, alloc)
CASE(tp, new)
CASE(tp, free)
CASE(tp, is_gc)
CASE(tp, del)
CASE(tp, finalize)
#if PY_VERSION_HEX < 0x03090000
# define Py_bf_getbuffer 1
# define Py_bf_releasebuffer 2
#endif
CASE(bf, getbuffer)
CASE(bf, releasebuffer)
CASE(mp, ass_subscript)
CASE(mp, length)
CASE(mp, subscript)
CASE(nb, absolute)
CASE(nb, add)
CASE(nb, and)
CASE(nb, bool)
CASE(nb, divmod)
CASE(nb, float)
CASE(nb, floor_divide)
CASE(nb, index)
CASE(nb, inplace_add)
CASE(nb, inplace_and)
CASE(nb, inplace_floor_divide)
CASE(nb, inplace_lshift)
CASE(nb, inplace_multiply)
CASE(nb, inplace_or)
CASE(nb, inplace_power)
CASE(nb, inplace_remainder)
CASE(nb, inplace_rshift)
CASE(nb, inplace_subtract)
CASE(nb, inplace_true_divide)
CASE(nb, inplace_xor)
CASE(nb, int)
CASE(nb, invert)
CASE(nb, lshift)
CASE(nb, multiply)
CASE(nb, negative)
CASE(nb, or)
CASE(nb, positive)
CASE(nb, power)
CASE(nb, remainder)
CASE(nb, rshift)
CASE(nb, subtract)
CASE(nb, true_divide)
CASE(nb, xor)
CASE(nb, matrix_multiply)
CASE(nb, inplace_matrix_multiply)
CASE(sq, ass_item)
CASE(sq, concat)
CASE(sq, contains)
CASE(sq, inplace_concat)
CASE(sq, inplace_repeat)
CASE(sq, item)
CASE(sq, length)
CASE(sq, repeat)
CASE(am, await)
CASE(am, aiter)
CASE(am, anext)
#if PY_VERSION_HEX >= 0x030A0000
CASE(am, send)
#endif
}
}
if (temp_tp->tp_members) {
tp->tp_members = (PyMemberDef*)((char *)tp + Py_TYPE(tp)->tp_basicsize);
std::memcpy(tp->tp_members, temp_tp->tp_members, tp->tp_itemsize * Py_SIZE(temp_tp));
}
#if PY_VERSION_HEX < 0x03090000
if (has_dynamic_attr)
tp->tp_dictoffset = (Py_ssize_t) (basicsize - ptr_size);
#endif
PyType_Ready(tp);
Py_DECREF(temp);
#endif
type_data *to = nb_type_data((PyTypeObject *) result);
*to = *t;
if (!has_scope)
to->flags &= ~(uint32_t) type_flags::has_scope;
if (!intrusive_ptr && tb &&
(tb->flags & (uint32_t) type_flags::intrusive_ptr)) {
to->flags |= (uint32_t) type_flags::intrusive_ptr;
to->set_self_py = tb->set_self_py;
}
to->name = name_copy;
to->type_py = (PyTypeObject *) result;
if (has_supplement) {
if (!to->supplement)
fail("nanobind::detail::nb_type_new(\"%s\"): supplemental data "
"allocation failed!", t->name);
} else {
to->supplement = nullptr;
}
if (has_dynamic_attr) {
to->flags |= (uint32_t) type_flags::has_dynamic_attr;
#if defined(Py_LIMITED_API)
to->dictoffset = (Py_ssize_t) (basicsize - ptr_size);
#endif
}
if (has_scope)
setattr(t->scope, t->name, result);
setattr(result, "__qualname__", qualname.ptr());
if (modname.is_valid())
setattr(result, "__module__", modname.ptr());
// Update hash table that maps from std::type_info to Python type
auto [it, success] =
internals.type_c2p.try_emplace(std::type_index(*t->type), to);
if (!success)
fail("nanobind::detail::nb_type_new(\"%s\"): type was already "
"registered!", t->name);
return result;
}
/// Encapsulates the implicit conversion part of nb_type_get()
static NB_NOINLINE bool nb_type_get_implicit(PyObject *src,
const std::type_info *cpp_type_src,
const type_data *dst_type,
nb_internals &internals,
cleanup_list *cleanup, void **out) noexcept {
if (dst_type->implicit && cpp_type_src) {
const std::type_info **it = dst_type->implicit;
const std::type_info *v;
while ((v = *it++)) {
if (v == cpp_type_src || *v == *cpp_type_src)
goto found;
}
it = dst_type->implicit;
while ((v = *it++)) {
auto it2 = internals.type_c2p.find(std::type_index(*v));
if (it2 != internals.type_c2p.end() &&
PyType_IsSubtype(Py_TYPE(src), it2->second->type_py))
goto found;
}
}
if (dst_type->implicit_py) {
bool (**it)(PyTypeObject *, PyObject *, cleanup_list *) noexcept =
dst_type->implicit_py;
bool (*v2)(PyTypeObject *, PyObject *, cleanup_list *) noexcept;
while ((v2 = *it++)) {
if (v2(dst_type->type_py, src, cleanup))
goto found;
}
}
return false;
found:
PyObject *result;
#if PY_VERSION_HEX < 0x03090000
PyObject *args = PyTuple_New(1);
if (!args) {
PyErr_Clear();
return false;
}
Py_INCREF(src);
NB_TUPLE_SET_ITEM(args, 0, src);
result = PyObject_CallObject((PyObject *) dst_type->type_py, args);
Py_DECREF(args);
#else
PyObject *args[2] = { nullptr, src };
result = PyObject_Vectorcall((PyObject *) dst_type->type_py, args + 1,
NB_VECTORCALL_ARGUMENTS_OFFSET + 1, nullptr);
#endif
if (result) {
cleanup->append(result);
*out = inst_ptr((nb_inst *) result);
return true;
} else {
PyErr_Clear();
if (internals.print_implicit_cast_warnings) {
#if !defined(Py_LIMITED_API)
const char *name = Py_TYPE(src)->tp_name;
#else
PyObject *name_py = nb_inst_name(src);
const char *name = PyUnicode_AsUTF8AndSize(name_py, nullptr);
#endif
// Can't use PyErr_Warn*() if conversion failed due to a stack overflow
fprintf(stderr,
"nanobind: implicit conversion from type '%s' to type '%s' "
"failed!\n", name, dst_type->name);
#if defined(_WIN32)
fflush(stderr);
#endif
#if defined(Py_LIMITED_API)
Py_DECREF(name_py);
#endif
}
return false;
}
}
// Attempt to retrieve a pointer to a C++ instance
bool nb_type_get(const std::type_info *cpp_type, PyObject *src, uint8_t flags,
cleanup_list *cleanup, void **out) noexcept {
// Convert None -> nullptr
if (src == Py_None) {
*out = nullptr;
return true;
}
nb_internals &internals = internals_get();
PyTypeObject *src_type = Py_TYPE(src);
const std::type_info *cpp_type_src = nullptr;
const PyTypeObject *metaclass = Py_TYPE((PyObject *) src_type);
const bool src_is_nb_type = metaclass == internals.nb_type;
type_data *dst_type = nullptr;
// If 'src' is a nanobind-bound type
if (src_is_nb_type) {
type_data *t = nb_type_data(src_type);
cpp_type_src = t->type;
// Check if the source / destination typeid are an exact match
bool valid = cpp_type == cpp_type_src || *cpp_type == *cpp_type_src;
// If not, look up the Python type and check the inheritance chain
if (!valid) {
auto it = internals.type_c2p.find(std::type_index(*cpp_type));
if (it != internals.type_c2p.end()) {
dst_type = it->second;
valid = PyType_IsSubtype(src_type, dst_type->type_py);
}
}
// Success, return the pointer if the instance is correctly initialized
if (valid) {
nb_inst *inst = (nb_inst *) src;
if (!inst->ready &&
(flags & (uint8_t) cast_flags::construct) == 0) {
PyErr_WarnFormat(PyExc_RuntimeWarning, 1,
"nanobind: attempted to access an "
"uninitialized instance of type '%s'!\n",
t->name);
return false;
}
*out = inst_ptr(inst);
return true;
}
}
// Try an implicit conversion as last resort (if possible & requested)
if ((flags & (uint16_t) cast_flags::convert) && cleanup) {
if (!src_is_nb_type) {
auto it = internals.type_c2p.find(std::type_index(*cpp_type));
if (it != internals.type_c2p.end())
dst_type = it->second;
}
if (dst_type &&
(dst_type->flags & (uint32_t) type_flags::has_implicit_conversions))
return nb_type_get_implicit(src, cpp_type_src, dst_type, internals,
cleanup, out);
}
return false;
}
static PyObject *keep_alive_callback(PyObject *self, PyObject *const *args,
Py_ssize_t nargs) {
if (nargs != 1 || !PyWeakref_CheckRefExact(args[0]))
fail("nanobind::detail::keep_alive_callback(): invalid input!");
Py_DECREF(args[0]); // self
Py_DECREF(self); // patient
Py_INCREF(Py_None);
return Py_None;
}
static PyMethodDef keep_alive_callback_def = {
"keep_alive_callback",
(PyCFunction) (void *) keep_alive_callback,
METH_FASTCALL,
"Implementation detail of nanobind::detail::keep_alive"
};
void keep_alive(PyObject *nurse, PyObject *patient) {
if (!patient || !nurse || nurse == Py_None || patient == Py_None)
return;
nb_internals &internals = internals_get();
PyTypeObject *metaclass = Py_TYPE((PyObject *) Py_TYPE(nurse));
if (metaclass == internals.nb_type) {
// Populate nanobind-internal data structures
keep_alive_set &keep_alive = internals.keep_alive[nurse];
auto [it, success] = keep_alive.emplace(patient);
if (success) {
Py_INCREF(patient);
((nb_inst *) nurse)->clear_keep_alive = true;
} else {
if (it->deleter)
fail("nanobind::detail::keep_alive(): internal error: entry "
"has a deletion callback!");
}
} else {
PyObject *callback =
PyCFunction_New(&keep_alive_callback_def, patient);
PyObject *weakref = PyWeakref_NewRef(nurse, callback);
if (!weakref) {
Py_DECREF(callback);
PyErr_Clear();
raise("nanobind::detail::keep_alive(): could not create a weak "
"reference! Likely, the 'nurse' argument you specified is not "
"a weak-referenceable type!");
}
if (!callback)
fail("nanobind::detail::keep_alive(): callback creation failed!");
// Increase patient reference count, leak weak reference
Py_INCREF(patient);
Py_DECREF(callback);
}
}
void keep_alive(PyObject *nurse, void *payload,
void (*callback)(void *) noexcept) noexcept {
if (!nurse)
fail("nanobind::detail::keep_alive(): nurse==nullptr!");
PyTypeObject *metaclass = Py_TYPE((PyObject *) Py_TYPE(nurse));
nb_internals &internals = internals_get();
if (metaclass == internals.nb_type) {
keep_alive_set &keep_alive = internals.keep_alive[nurse];
auto [it, success] = keep_alive.emplace(payload, callback);
if (!success)
raise("keep_alive(): the given 'payload' pointer was already registered!");
((nb_inst *) nurse)->clear_keep_alive = true;
} else {
PyObject *patient = capsule_new(payload, nullptr, callback);
keep_alive(nurse, patient);
Py_DECREF(patient);
}
}
static PyObject *nb_type_put_common(void *value, type_data *t, rv_policy rvp,
cleanup_list *cleanup,
bool *is_new) noexcept {
// The reference_internals RVP needs a self pointer, give up if unavailable
if (rvp == rv_policy::reference_internal && (!cleanup || !cleanup->self()))
return nullptr;
const bool intrusive = t->flags & (uint32_t) type_flags::intrusive_ptr;
if (intrusive)
rvp = rv_policy::take_ownership;
const bool store_in_obj = rvp == rv_policy::copy || rvp == rv_policy::move;
nb_inst *inst =
(nb_inst *) inst_new_impl(t->type_py, store_in_obj ? nullptr : value);
if (!inst)
return nullptr;
if (is_new)
*is_new = true;
void *new_value = inst_ptr(inst);
if (rvp == rv_policy::move) {
if (t->flags & (uint32_t) type_flags::is_move_constructible) {
if (t->flags & (uint32_t) type_flags::has_move) {
try {
t->move(new_value, value);
} catch (...) {
Py_DECREF(inst);
return nullptr;
}
} else {
memcpy(new_value, value, t->size);
memset(value, 0, t->size);
}
} else {
if (t->flags & (uint32_t) type_flags::is_copy_constructible) {
rvp = rv_policy::copy;
} else {
fail("nanobind::detail::nb_type_put(\"%s\"): attempted to move "
"an instance that is neither copy- nor move-constructible!",
t->name);
}
}
}
if (rvp == rv_policy::copy) {
if (t->flags & (uint32_t) type_flags::is_copy_constructible) {
if (t->flags & (uint32_t) type_flags::has_copy) {
try {
t->copy(new_value, value);
} catch (...) {
Py_DECREF(inst);
return nullptr;
}
} else {
memcpy(new_value, value, t->size);
}
} else {
fail("nanobind::detail::nb_type_put(\"%s\"): attempted to copy "
"an instance that is not copy-constructible!", t->name);
}
}
inst->destruct = rvp != rv_policy::reference && rvp != rv_policy::reference_internal;
inst->cpp_delete = rvp == rv_policy::take_ownership;
inst->ready = true;
if (rvp == rv_policy::reference_internal)
keep_alive((PyObject *) inst, cleanup->self());
if (intrusive)
t->set_self_py(new_value, (PyObject *) inst);
return (PyObject *) inst;
}
PyObject *nb_type_put(const std::type_info *cpp_type,