forked from protocolbuffers/protobuf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
message.c
2099 lines (1862 loc) · 73.8 KB
/
message.c
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
// Protocol Buffers - Google's data interchange format
// Copyright 2023 Google LLC. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file or at
// https://developers.google.com/open-source/licenses/bsd
#include "python/message.h"
#include "python/convert.h"
#include "python/descriptor.h"
#include "python/extension_dict.h"
#include "python/map.h"
#include "python/repeated.h"
#include "upb/base/string_view.h"
#include "upb/message/compare.h"
#include "upb/message/copy.h"
#include "upb/message/message.h"
#include "upb/reflection/def.h"
#include "upb/reflection/message.h"
#include "upb/text/encode.h"
#include "upb/util/required_fields.h"
static const upb_MessageDef* PyUpb_MessageMeta_GetMsgdef(PyObject* cls);
static PyObject* PyUpb_MessageMeta_GetAttr(PyObject* self, PyObject* name);
// -----------------------------------------------------------------------------
// CPythonBits
// -----------------------------------------------------------------------------
// This struct contains a few things that are not exposed directly through the
// limited API, but that we can get at in somewhat more roundabout ways. The
// roundabout ways are slower, so we cache the values here.
//
// These values are valid to cache in a global, even across sub-interpreters,
// because they are not pointers to interpreter state. They are process
// globals that will be the same for any interpreter in this process.
typedef struct {
// For each member, we note the equivalent expression that we could use in the
// full (non-limited) API.
newfunc type_new; // PyTypeObject.tp_new
destructor type_dealloc; // PyTypeObject.tp_dealloc
getattrofunc type_getattro; // PyTypeObject.tp_getattro
setattrofunc type_setattro; // PyTypeObject.tp_setattro
size_t type_basicsize; // sizeof(PyHeapTypeObject)
traverseproc type_traverse; // PyTypeObject.tp_traverse
inquiry type_clear; // PyTypeObject.tp_clear
// While we can refer to PY_VERSION_HEX in the limited API, this will give us
// the version of Python we were compiled against, which may be different
// than the version we are dynamically linked against. Here we want the
// version that is actually running in this process.
long python_version_hex; // PY_VERSION_HEX
} PyUpb_CPythonBits;
// A global containing the values for this process.
PyUpb_CPythonBits cpython_bits;
destructor upb_Pre310_PyType_GetDeallocSlot(PyTypeObject* type_subclass) {
// This is a bit desperate. We need type_dealloc(), but PyType_GetSlot(type,
// Py_tp_dealloc) will return subtype_dealloc(). There appears to be no way
// whatsoever to fetch type_dealloc() through the limited API until Python
// 3.10.
//
// To work around this so we attempt to find it by looking for the offset of
// tp_dealloc in PyTypeObject, then memcpy() it directly. This should always
// work in practice.
//
// Starting with Python 3.10 on you can call PyType_GetSlot() on non-heap
// types. We will be able to replace all this hack with just:
//
// PyType_GetSlot(&PyType_Type, Py_tp_dealloc)
//
destructor subtype_dealloc = PyType_GetSlot(type_subclass, Py_tp_dealloc);
for (size_t i = 0; i < 2000; i += sizeof(uintptr_t)) {
destructor maybe_subtype_dealloc;
memcpy(&maybe_subtype_dealloc, (char*)type_subclass + i,
sizeof(destructor));
if (maybe_subtype_dealloc == subtype_dealloc) {
destructor type_dealloc;
memcpy(&type_dealloc, (char*)&PyType_Type + i, sizeof(destructor));
return type_dealloc;
}
}
assert(false);
return NULL;
}
static bool PyUpb_CPythonBits_Init(PyUpb_CPythonBits* bits) {
PyObject* bases = NULL;
PyTypeObject* type = NULL;
PyObject* size = NULL;
PyObject* sys = NULL;
PyObject* hex_version = NULL;
bool ret = false;
// PyType_GetSlot() only works on heap types, so we cannot use it on
// &PyType_Type directly. Instead we create our own (temporary) type derived
// from PyType_Type: this will inherit all of the slots from PyType_Type, but
// as a heap type it can be queried with PyType_GetSlot().
static PyType_Slot dummy_slots[] = {{0, NULL}};
static PyType_Spec dummy_spec = {
"module.DummyClass", // tp_name
0, // To be filled in by size of base // tp_basicsize
0, // tp_itemsize
Py_TPFLAGS_DEFAULT, // tp_flags
dummy_slots,
};
bases = Py_BuildValue("(O)", &PyType_Type);
if (!bases) goto err;
type = (PyTypeObject*)PyType_FromSpecWithBases(&dummy_spec, bases);
if (!type) goto err;
bits->type_new = PyType_GetSlot(type, Py_tp_new);
bits->type_dealloc = upb_Pre310_PyType_GetDeallocSlot(type);
bits->type_getattro = PyType_GetSlot(type, Py_tp_getattro);
bits->type_setattro = PyType_GetSlot(type, Py_tp_setattro);
bits->type_traverse = PyType_GetSlot(type, Py_tp_traverse);
bits->type_clear = PyType_GetSlot(type, Py_tp_clear);
size = PyObject_GetAttrString((PyObject*)&PyType_Type, "__basicsize__");
if (!size) goto err;
bits->type_basicsize = PyLong_AsLong(size);
if (bits->type_basicsize == -1) goto err;
assert(bits->type_new);
assert(bits->type_dealloc);
assert(bits->type_getattro);
assert(bits->type_setattro);
assert(bits->type_traverse);
assert(bits->type_clear);
#ifndef Py_LIMITED_API
assert(bits->type_new == PyType_Type.tp_new);
assert(bits->type_dealloc == PyType_Type.tp_dealloc);
assert(bits->type_getattro == PyType_Type.tp_getattro);
assert(bits->type_setattro == PyType_Type.tp_setattro);
assert(bits->type_basicsize == sizeof(PyHeapTypeObject));
assert(bits->type_traverse == PyType_Type.tp_traverse);
assert(bits->type_clear == PyType_Type.tp_clear);
#endif
sys = PyImport_ImportModule("sys");
hex_version = PyObject_GetAttrString(sys, "hexversion");
bits->python_version_hex = PyLong_AsLong(hex_version);
ret = true;
err:
Py_XDECREF(bases);
Py_XDECREF(type);
Py_XDECREF(size);
Py_XDECREF(sys);
Py_XDECREF(hex_version);
return ret;
}
// -----------------------------------------------------------------------------
// Message
// -----------------------------------------------------------------------------
// The main message object. The type of the object (PyUpb_Message.ob_type)
// will be an instance of the PyUpb_MessageMeta type (defined below). So the
// chain is:
// FooMessage = MessageMeta(...)
// foo = FooMessage()
//
// Which becomes:
// Object C Struct Type Python type (ob_type)
// ----------------- ----------------- ---------------------
// foo PyUpb_Message FooMessage
// FooMessage PyUpb_MessageMeta message_meta_type
// message_meta_type PyTypeObject 'type' in Python
//
// A message object can be in one of two states: present or non-present. When
// a message is non-present, it stores a reference to its parent, and a write
// to any attribute will trigger the message to become present in its parent.
// The parent may also be non-present, in which case a mutation will trigger a
// chain reaction.
typedef struct PyUpb_Message {
PyObject_HEAD;
PyObject* arena;
uintptr_t def; // Tagged, low bit 1 == upb_FieldDef*, else upb_MessageDef*
union {
// when def is msgdef, the data for this msg.
upb_Message* msg;
// when def is fielddef, owning pointer to parent
struct PyUpb_Message* parent;
} ptr;
PyObject* ext_dict; // Weak pointer to extension dict, if any.
// name->obj dict for non-present msg/map/repeated, NULL if none.
PyUpb_WeakMap* unset_subobj_map;
int version;
} PyUpb_Message;
static PyObject* PyUpb_Message_GetAttr(PyObject* _self, PyObject* attr);
bool PyUpb_Message_IsStub(PyUpb_Message* msg) { return msg->def & 1; }
const upb_FieldDef* PyUpb_Message_GetFieldDef(PyUpb_Message* msg) {
assert(PyUpb_Message_IsStub(msg));
return (void*)(msg->def & ~(uintptr_t)1);
}
static const upb_MessageDef* _PyUpb_Message_GetMsgdef(PyUpb_Message* msg) {
return PyUpb_Message_IsStub(msg)
? upb_FieldDef_MessageSubDef(PyUpb_Message_GetFieldDef(msg))
: (void*)msg->def;
}
const upb_MessageDef* PyUpb_Message_GetMsgdef(PyObject* self) {
return _PyUpb_Message_GetMsgdef((PyUpb_Message*)self);
}
static upb_Message* PyUpb_Message_GetMsg(PyUpb_Message* self) {
assert(!PyUpb_Message_IsStub(self));
return self->ptr.msg;
}
bool PyUpb_Message_TryCheck(PyObject* self) {
PyUpb_ModuleState* state = PyUpb_ModuleState_Get();
PyObject* type = (PyObject*)Py_TYPE(self);
return Py_TYPE(type) == state->message_meta_type;
}
bool PyUpb_Message_Verify(PyObject* self) {
if (!PyUpb_Message_TryCheck(self)) {
PyErr_Format(PyExc_TypeError, "Expected a message object, but got %R.",
self);
return false;
}
return true;
}
// If the message is reified, returns it. Otherwise, returns NULL.
// If NULL is returned, the object is empty and has no underlying data.
upb_Message* PyUpb_Message_GetIfReified(PyObject* _self) {
PyUpb_Message* self = (void*)_self;
return PyUpb_Message_IsStub(self) ? NULL : self->ptr.msg;
}
static PyObject* PyUpb_Message_New(PyObject* cls, PyObject* unused_args,
PyObject* unused_kwargs) {
const upb_MessageDef* msgdef = PyUpb_MessageMeta_GetMsgdef(cls);
const upb_MiniTable* layout = upb_MessageDef_MiniTable(msgdef);
PyUpb_Message* msg = (void*)PyType_GenericAlloc((PyTypeObject*)cls, 0);
msg->def = (uintptr_t)msgdef;
msg->arena = PyUpb_Arena_New();
msg->ptr.msg = upb_Message_New(layout, PyUpb_Arena_Get(msg->arena));
msg->unset_subobj_map = NULL;
msg->ext_dict = NULL;
msg->version = 0;
PyObject* ret = &msg->ob_base;
PyUpb_ObjCache_Add(msg->ptr.msg, ret);
return ret;
}
/*
* PyUpb_Message_LookupName()
*
* Tries to find a field or oneof named `py_name` in the message object `self`.
* The user must pass `f` and/or `o` to indicate whether a field or a oneof name
* is expected. If the name is found and it has an expected type, the function
* sets `*f` or `*o` respectively and returns true. Otherwise returns false
* and sets an exception of type `exc_type` if provided.
*/
static bool PyUpb_Message_LookupName(PyUpb_Message* self, PyObject* py_name,
const upb_FieldDef** f,
const upb_OneofDef** o,
PyObject* exc_type) {
assert(f || o);
Py_ssize_t size;
const char* name = NULL;
if (PyUnicode_Check(py_name)) {
name = PyUnicode_AsUTF8AndSize(py_name, &size);
} else if (PyBytes_Check(py_name)) {
PyBytes_AsStringAndSize(py_name, (char**)&name, &size);
}
if (!name) {
PyErr_Format(exc_type,
"Expected a field name, but got non-string argument %S.",
py_name);
return false;
}
const upb_MessageDef* msgdef = _PyUpb_Message_GetMsgdef(self);
if (!upb_MessageDef_FindByNameWithSize(msgdef, name, size, f, o)) {
if (exc_type) {
PyErr_Format(exc_type, "Protocol message %s has no \"%s\" field.",
upb_MessageDef_Name(msgdef), name);
}
return false;
}
if (!o && !*f) {
if (exc_type) {
PyErr_Format(exc_type, "Expected a field name, but got oneof name %s.",
name);
}
return false;
}
if (!f && !*o) {
if (exc_type) {
PyErr_Format(exc_type, "Expected a oneof name, but got field name %s.",
name);
}
return false;
}
return true;
}
static bool PyUpb_Message_InitMessageMapEntry(PyObject* dst, PyObject* src) {
if (!src || !dst) return false;
PyObject* ok = PyObject_CallMethod(dst, "CopyFrom", "O", src);
if (!ok) return false;
Py_DECREF(ok);
return true;
}
int PyUpb_Message_InitMapAttributes(PyObject* map, PyObject* value,
const upb_FieldDef* f) {
const upb_MessageDef* entry_m = upb_FieldDef_MessageSubDef(f);
const upb_FieldDef* val_f = upb_MessageDef_Field(entry_m, 1);
PyObject* it = NULL;
PyObject* tmp = NULL;
int ret = -1;
if (upb_FieldDef_IsSubMessage(val_f)) {
it = PyObject_GetIter(value);
if (it == NULL) {
PyErr_Format(PyExc_TypeError, "Argument for field %s is not iterable",
upb_FieldDef_FullName(f));
goto err;
}
PyObject* e;
while ((e = PyIter_Next(it)) != NULL) {
PyObject* src = PyObject_GetItem(value, e);
PyObject* dst = PyObject_GetItem(map, e);
Py_DECREF(e);
bool ok = PyUpb_Message_InitMessageMapEntry(dst, src);
Py_XDECREF(src);
Py_XDECREF(dst);
if (!ok) goto err;
}
} else {
tmp = PyObject_CallMethod(map, "update", "O", value);
if (!tmp) goto err;
}
ret = 0;
err:
Py_XDECREF(it);
Py_XDECREF(tmp);
return ret;
}
void PyUpb_Message_EnsureReified(PyUpb_Message* self);
static bool PyUpb_Message_InitMapAttribute(PyObject* _self, PyObject* name,
const upb_FieldDef* f,
PyObject* value) {
PyObject* map = PyUpb_Message_GetAttr(_self, name);
int ok = PyUpb_Message_InitMapAttributes(map, value, f);
Py_DECREF(map);
return ok >= 0;
}
static bool PyUpb_Message_InitRepeatedMessageAttribute(PyObject* _self,
PyObject* repeated,
PyObject* value,
const upb_FieldDef* f) {
PyObject* it = PyObject_GetIter(value);
if (!it) {
PyErr_Format(PyExc_TypeError, "Argument for field %s is not iterable",
upb_FieldDef_FullName(f));
return false;
}
PyObject* e = NULL;
PyObject* m = NULL;
while ((e = PyIter_Next(it)) != NULL) {
if (PyDict_Check(e)) {
m = PyUpb_RepeatedCompositeContainer_Add(repeated, NULL, e);
if (!m) goto err;
} else {
m = PyUpb_RepeatedCompositeContainer_Add(repeated, NULL, NULL);
if (!m) goto err;
PyObject* merged = PyUpb_Message_MergeFrom(m, e);
if (!merged) goto err;
Py_DECREF(merged);
}
Py_DECREF(e);
Py_DECREF(m);
m = NULL;
}
err:
Py_XDECREF(it);
Py_XDECREF(e);
Py_XDECREF(m);
return !PyErr_Occurred(); // Check PyIter_Next() exit.
}
static bool PyUpb_Message_InitRepeatedAttribute(PyObject* _self, PyObject* name,
PyObject* value) {
PyUpb_Message* self = (void*)_self;
const upb_FieldDef* field;
if (!PyUpb_Message_LookupName(self, name, &field, NULL,
PyExc_AttributeError)) {
return false;
}
bool ok = false;
PyObject* repeated = PyUpb_Message_GetFieldValue(_self, field);
PyObject* tmp = NULL;
if (!repeated) goto err;
if (upb_FieldDef_IsSubMessage(field)) {
if (!PyUpb_Message_InitRepeatedMessageAttribute(_self, repeated, value,
field)) {
goto err;
}
} else {
tmp = PyUpb_RepeatedContainer_Extend(repeated, value);
if (!tmp) goto err;
}
ok = true;
err:
Py_XDECREF(repeated);
Py_XDECREF(tmp);
return ok;
}
static PyObject* PyUpb_Message_Clear(PyUpb_Message* self);
static bool PyUpb_Message_InitMessageAttribute(PyObject* _self, PyObject* name,
const upb_FieldDef* field,
PyObject* value) {
PyObject* submsg = PyUpb_Message_GetAttr(_self, name);
if (!submsg) return -1;
assert(!PyErr_Occurred());
bool ok;
if (PyUpb_Message_TryCheck(value)) {
PyObject* tmp = PyUpb_Message_MergeFrom(submsg, value);
ok = tmp != NULL;
Py_XDECREF(tmp);
} else if (PyDict_Check(value)) {
assert(!PyErr_Occurred());
const upb_MessageDef* msgdef = upb_FieldDef_MessageSubDef(field);
if (upb_MessageDef_WellKnownType(msgdef) == kUpb_WellKnown_Struct) {
ok = PyObject_CallMethod(submsg, "_internal_assign", "O", value);
if (!ok && PyDict_Size(value) == 1 &&
PyDict_Contains(value, PyUnicode_FromString("fields"))) {
// Fall back to init as normal message field.
PyErr_Clear();
PyObject* tmp = PyUpb_Message_Clear((PyUpb_Message*)submsg);
Py_DECREF(tmp);
ok = PyUpb_Message_InitAttributes(submsg, NULL, value) >= 0;
}
} else {
ok = PyUpb_Message_InitAttributes(submsg, NULL, value) >= 0;
}
} else {
const upb_MessageDef* msgdef = upb_FieldDef_MessageSubDef(field);
if (upb_MessageDef_WellKnownType(msgdef) != kUpb_WellKnown_Unspecified &&
PyObject_HasAttrString(submsg, "_internal_assign")) {
ok = PyObject_CallMethod(submsg, "_internal_assign", "O", value);
} else {
const upb_MessageDef* m = PyUpb_Message_GetMsgdef(_self);
PyErr_Format(PyExc_TypeError,
"Message must be initialized with a dict: %s",
upb_MessageDef_FullName(m));
ok = false;
}
}
Py_DECREF(submsg);
return ok;
}
static bool PyUpb_Message_InitScalarAttribute(upb_Message* msg,
const upb_FieldDef* f,
PyObject* value,
upb_Arena* arena) {
upb_MessageValue msgval;
assert(!PyErr_Occurred());
if (!PyUpb_PyToUpb(value, f, &msgval, arena)) return false;
upb_Message_SetFieldByDef(msg, f, msgval, arena);
return true;
}
int PyUpb_Message_InitAttributes(PyObject* _self, PyObject* args,
PyObject* kwargs) {
assert(!PyErr_Occurred());
if (args != NULL && PyTuple_Size(args) != 0) {
PyErr_SetString(PyExc_TypeError, "No positional arguments allowed");
return -1;
}
if (kwargs == NULL) return 0;
PyUpb_Message* self = (void*)_self;
Py_ssize_t pos = 0;
PyObject* name;
PyObject* value;
PyUpb_Message_EnsureReified(self);
upb_Message* msg = PyUpb_Message_GetMsg(self);
upb_Arena* arena = PyUpb_Arena_Get(self->arena);
while (PyDict_Next(kwargs, &pos, &name, &value)) {
assert(!PyErr_Occurred());
const upb_FieldDef* f;
assert(!PyErr_Occurred());
if (!PyUpb_Message_LookupName(self, name, &f, NULL, PyExc_ValueError)) {
return -1;
}
if (value == Py_None) continue; // Ignored.
assert(!PyErr_Occurred());
if (upb_FieldDef_IsMap(f)) {
if (!PyUpb_Message_InitMapAttribute(_self, name, f, value)) return -1;
} else if (upb_FieldDef_IsRepeated(f)) {
if (!PyUpb_Message_InitRepeatedAttribute(_self, name, value)) return -1;
} else if (upb_FieldDef_IsSubMessage(f)) {
if (!PyUpb_Message_InitMessageAttribute(_self, name, f, value)) return -1;
} else {
if (!PyUpb_Message_InitScalarAttribute(msg, f, value, arena)) return -1;
}
if (PyErr_Occurred()) return -1;
}
if (PyErr_Occurred()) return -1;
return 0;
}
static int PyUpb_Message_Init(PyObject* _self, PyObject* args,
PyObject* kwargs) {
if (args != NULL && PyTuple_Size(args) != 0) {
PyErr_SetString(PyExc_TypeError, "No positional arguments allowed");
return -1;
}
return PyUpb_Message_InitAttributes(_self, args, kwargs);
}
static PyObject* PyUpb_Message_NewStub(PyObject* parent, const upb_FieldDef* f,
PyObject* arena) {
const upb_MessageDef* sub_m = upb_FieldDef_MessageSubDef(f);
PyObject* cls = PyUpb_Descriptor_GetClass(sub_m);
PyUpb_Message* msg = (void*)PyType_GenericAlloc((PyTypeObject*)cls, 0);
msg->def = (uintptr_t)f | 1;
msg->arena = arena;
msg->ptr.parent = (PyUpb_Message*)parent;
msg->unset_subobj_map = NULL;
msg->ext_dict = NULL;
msg->version = 0;
Py_DECREF(cls);
Py_INCREF(parent);
Py_INCREF(arena);
return &msg->ob_base;
}
static bool PyUpb_Message_IsEmpty(const upb_Message* msg,
const upb_MessageDef* m,
const upb_DefPool* ext_pool) {
if (!msg) return true;
size_t iter = kUpb_Message_Begin;
const upb_FieldDef* f;
upb_MessageValue val;
if (upb_Message_Next(msg, m, ext_pool, &f, &val, &iter)) return false;
return !upb_Message_HasUnknown(msg);
}
static bool PyUpb_Message_IsEqual(PyUpb_Message* m1, PyObject* _m2) {
PyUpb_Message* m2 = (void*)_m2;
if (m1 == m2) return true;
if (!PyObject_TypeCheck(_m2, m1->ob_base.ob_type)) {
return false;
}
const upb_MessageDef* m1_msgdef = _PyUpb_Message_GetMsgdef(m1);
#ifndef NDEBUG
const upb_MessageDef* m2_msgdef = _PyUpb_Message_GetMsgdef(m2);
assert(m1_msgdef == m2_msgdef);
#endif
const upb_Message* m1_msg = PyUpb_Message_GetIfReified((PyObject*)m1);
const upb_Message* m2_msg = PyUpb_Message_GetIfReified(_m2);
const upb_DefPool* symtab = upb_FileDef_Pool(upb_MessageDef_File(m1_msgdef));
const bool e1 = PyUpb_Message_IsEmpty(m1_msg, m1_msgdef, symtab);
const bool e2 = PyUpb_Message_IsEmpty(m2_msg, m1_msgdef, symtab);
if (e1 || e2) return e1 && e2;
const int options = kUpb_CompareOption_IncludeUnknownFields;
return upb_Message_IsEqualByDef(m1_msg, m2_msg, m1_msgdef, options);
}
static const upb_FieldDef* PyUpb_Message_InitAsMsg(PyUpb_Message* m,
upb_Arena* arena) {
const upb_FieldDef* f = PyUpb_Message_GetFieldDef(m);
const upb_MessageDef* m2 = upb_FieldDef_MessageSubDef(f);
m->ptr.msg = upb_Message_New(upb_MessageDef_MiniTable(m2), arena);
m->def = (uintptr_t)m2;
PyUpb_ObjCache_Add(m->ptr.msg, &m->ob_base);
return f;
}
static void PyUpb_Message_SetField(PyUpb_Message* parent, const upb_FieldDef* f,
PyUpb_Message* child, upb_Arena* arena) {
upb_MessageValue msgval = {.msg_val = PyUpb_Message_GetMsg(child)};
upb_Message_SetFieldByDef(PyUpb_Message_GetMsg(parent), f, msgval, arena);
PyUpb_WeakMap_Delete(parent->unset_subobj_map, f);
// Releases a ref previously owned by child->ptr.parent of our child.
Py_DECREF(child);
}
/*
* PyUpb_Message_EnsureReified()
*
* This implements the "expando" behavior of Python protos:
* foo = FooProto()
*
* # The intermediate messages don't really exist, and won't be serialized.
* x = foo.bar.bar.bar.bar.bar.baz
*
* # Now all the intermediate objects are created.
* foo.bar.bar.bar.bar.bar.baz = 5
*
* This function should be called before performing any mutation of a protobuf
* object.
*
* Post-condition:
* PyUpb_Message_IsStub(self) is false
*/
void PyUpb_Message_EnsureReified(PyUpb_Message* self) {
if (!PyUpb_Message_IsStub(self)) return;
upb_Arena* arena = PyUpb_Arena_Get(self->arena);
// This is a non-present message. We need to create a real upb_Message for
// this object and every parent until we reach a present message.
PyUpb_Message* child = self;
PyUpb_Message* parent = self->ptr.parent;
const upb_FieldDef* child_f = PyUpb_Message_InitAsMsg(child, arena);
Py_INCREF(child); // To avoid a special-case in PyUpb_Message_SetField().
do {
PyUpb_Message* next_parent = parent->ptr.parent;
const upb_FieldDef* parent_f = NULL;
if (PyUpb_Message_IsStub(parent)) {
parent_f = PyUpb_Message_InitAsMsg(parent, arena);
}
PyUpb_Message_SetField(parent, child_f, child, arena);
child = parent;
child_f = parent_f;
parent = next_parent;
} while (child_f);
// Releases ref previously owned by child->ptr.parent of our child.
Py_DECREF(child);
self->version++;
}
static void PyUpb_Message_SyncSubobjs(PyUpb_Message* self);
/*
* PyUpb_Message_Reify()
*
* The message equivalent of PyUpb_*Container_Reify(), this transitions
* the wrapper from the unset state (owning a reference on self->ptr.parent) to
* the set state (having a non-owning pointer to self->ptr.msg).
*/
static void PyUpb_Message_Reify(PyUpb_Message* self, const upb_FieldDef* f,
upb_Message* msg) {
assert(f == PyUpb_Message_GetFieldDef(self));
if (!msg) {
const upb_MessageDef* msgdef = PyUpb_Message_GetMsgdef((PyObject*)self);
const upb_MiniTable* layout = upb_MessageDef_MiniTable(msgdef);
msg = upb_Message_New(layout, PyUpb_Arena_Get(self->arena));
}
PyUpb_ObjCache_Add(msg, &self->ob_base);
Py_DECREF(&self->ptr.parent->ob_base);
self->ptr.msg = msg; // Overwrites self->ptr.parent
self->def = (uintptr_t)upb_FieldDef_MessageSubDef(f);
PyUpb_Message_SyncSubobjs(self);
}
/*
* PyUpb_Message_SyncSubobjs()
*
* This operation must be invoked whenever the underlying upb_Message has been
* mutated directly in C. This will attach any newly-present field data
* to previously returned stub wrapper objects.
*
* For example:
* foo = FooMessage()
* sub = foo.submsg # Empty, unset sub-message
*
* # SyncSubobjs() is required to connect our existing 'sub' wrapper to the
* # newly created foo.submsg data in C.
* foo.MergeFrom(FooMessage(submsg={}))
*
* This requires that all of the new sub-objects that have appeared are owned
* by `self`'s arena.
*/
static void PyUpb_Message_SyncSubobjs(PyUpb_Message* self) {
PyUpb_WeakMap* subobj_map = self->unset_subobj_map;
if (!subobj_map) return;
upb_Message* msg = PyUpb_Message_GetMsg(self);
intptr_t iter = PYUPB_WEAKMAP_BEGIN;
const void* key;
PyObject* obj;
// The last ref to this message could disappear during iteration.
// When we call PyUpb_*Container_Reify() below, the container will drop
// its ref on `self`. If that was the last ref on self, the object will be
// deleted, and `subobj_map` along with it. We need it to live until we are
// done iterating.
Py_INCREF(&self->ob_base);
while (PyUpb_WeakMap_Next(subobj_map, &key, &obj, &iter)) {
const upb_FieldDef* f = key;
if (upb_FieldDef_HasPresence(f) && !upb_Message_HasFieldByDef(msg, f))
continue;
upb_MessageValue msgval = upb_Message_GetFieldByDef(msg, f);
PyUpb_WeakMap_DeleteIter(subobj_map, &iter);
if (upb_FieldDef_IsMap(f)) {
if (!msgval.map_val) continue;
PyUpb_MapContainer_Reify(obj, (upb_Map*)msgval.map_val);
} else if (upb_FieldDef_IsRepeated(f)) {
if (!msgval.array_val) continue;
PyUpb_RepeatedContainer_Reify(obj, (upb_Array*)msgval.array_val);
} else {
PyUpb_Message* sub = (void*)obj;
assert(self == sub->ptr.parent);
PyUpb_Message_Reify(sub, f, (upb_Message*)msgval.msg_val);
}
}
Py_DECREF(&self->ob_base);
// TODO: present fields need to be iterated too if they can reach
// a WeakMap.
}
static PyObject* PyUpb_Message_ToString(PyUpb_Message* self) {
if (PyUpb_Message_IsStub(self)) {
return PyUnicode_FromStringAndSize(NULL, 0);
}
upb_Message* msg = PyUpb_Message_GetMsg(self);
const upb_MessageDef* msgdef = _PyUpb_Message_GetMsgdef(self);
const upb_DefPool* symtab = upb_FileDef_Pool(upb_MessageDef_File(msgdef));
char buf[1024];
int options = UPB_TXTENC_SKIPUNKNOWN;
size_t size = upb_TextEncode(msg, msgdef, symtab, options, buf, sizeof(buf));
if (size < sizeof(buf)) {
return PyUnicode_FromStringAndSize(buf, size);
} else {
char* buf2 = malloc(size + 1);
size_t size2 = upb_TextEncode(msg, msgdef, symtab, options, buf2, size + 1);
assert(size == size2);
PyObject* ret = PyUnicode_FromStringAndSize(buf2, size2);
free(buf2);
return ret;
}
}
static PyObject* PyUpb_Message_RichCompare(PyObject* _self, PyObject* other,
int opid) {
PyUpb_Message* self = (void*)_self;
if (opid != Py_EQ && opid != Py_NE) {
Py_INCREF(Py_NotImplemented);
return Py_NotImplemented;
}
const upb_MessageDef* msgdef = _PyUpb_Message_GetMsgdef(self);
upb_WellKnown wkt = upb_MessageDef_WellKnownType(msgdef);
if ((wkt == kUpb_WellKnown_ListValue && PyList_Check(other)) ||
(wkt == kUpb_WellKnown_Struct && PyDict_Check(other))) {
return PyObject_CallMethod(_self, "_internal_compare", "O", other);
}
if (!PyObject_TypeCheck(other, Py_TYPE(self))) {
Py_INCREF(Py_NotImplemented);
return Py_NotImplemented;
}
bool ret = PyUpb_Message_IsEqual(self, other);
if (opid == Py_NE) ret = !ret;
return PyBool_FromLong(ret);
}
void PyUpb_Message_CacheDelete(PyObject* _self, const upb_FieldDef* f) {
PyUpb_Message* self = (void*)_self;
PyUpb_WeakMap_Delete(self->unset_subobj_map, f);
}
void PyUpb_Message_SetConcreteSubobj(PyObject* _self, const upb_FieldDef* f,
upb_MessageValue subobj) {
PyUpb_Message* self = (void*)_self;
PyUpb_Message_EnsureReified(self);
PyUpb_Message_CacheDelete(_self, f);
upb_Message_SetFieldByDef(self->ptr.msg, f, subobj,
PyUpb_Arena_Get(self->arena));
}
static void PyUpb_Message_Dealloc(PyObject* _self) {
PyUpb_Message* self = (void*)_self;
if (PyUpb_Message_IsStub(self)) {
PyUpb_Message_CacheDelete((PyObject*)self->ptr.parent,
PyUpb_Message_GetFieldDef(self));
Py_DECREF(self->ptr.parent);
} else {
PyUpb_ObjCache_Delete(self->ptr.msg);
}
if (self->unset_subobj_map) {
PyUpb_WeakMap_Free(self->unset_subobj_map);
}
Py_DECREF(self->arena);
// We do not use PyUpb_Dealloc() here because Message is a base type and for
// base types there is a bug we have to work around in this case (see below).
PyTypeObject* tp = Py_TYPE(self);
freefunc tp_free = PyType_GetSlot(tp, Py_tp_free);
tp_free(self);
if (cpython_bits.python_version_hex >= 0x03080000) {
// Prior to Python 3.8 there is a bug where deallocating the type here would
// lead to a double-decref: https://bugs.python.org/issue37879
Py_DECREF(tp);
}
}
PyObject* PyUpb_Message_Get(upb_Message* u_msg, const upb_MessageDef* m,
PyObject* arena) {
PyObject* ret = PyUpb_ObjCache_Get(u_msg);
if (ret) return ret;
PyObject* cls = PyUpb_Descriptor_GetClass(m);
// It is not safe to use PyObject_{,GC}_New() due to:
// https://bugs.python.org/issue35810
PyUpb_Message* py_msg = (void*)PyType_GenericAlloc((PyTypeObject*)cls, 0);
py_msg->arena = arena;
py_msg->def = (uintptr_t)m;
py_msg->ptr.msg = u_msg;
py_msg->unset_subobj_map = NULL;
py_msg->ext_dict = NULL;
py_msg->version = 0;
ret = &py_msg->ob_base;
Py_DECREF(cls);
Py_INCREF(arena);
PyUpb_ObjCache_Add(u_msg, ret);
return ret;
}
/* PyUpb_Message_GetStub()
*
* Non-present messages return "stub" objects that point to their parent, but
* will materialize into real upb objects if they are mutated.
*
* Note: we do *not* create stubs for repeated/map fields unless the parent
* is a stub:
*
* msg = TestMessage()
* msg.submessage # (A) Creates a stub
* msg.repeated_foo # (B) Does *not* create a stub
* msg.submessage.repeated_bar # (C) Creates a stub
*
* In case (B) we have some freedom: we could either create a stub, or create
* a reified object with underlying data. It appears that either could work
* equally well, with no observable change to users. There isn't a clear
* advantage to either choice. We choose to follow the behavior of the
* pre-existing C++ behavior for consistency, but if it becomes apparent that
* there would be some benefit to reversing this decision, it should be totally
* within the realm of possibility.
*/
PyObject* PyUpb_Message_GetStub(PyUpb_Message* self,
const upb_FieldDef* field) {
PyObject* _self = (void*)self;
if (!self->unset_subobj_map) {
self->unset_subobj_map = PyUpb_WeakMap_New();
}
PyObject* subobj = PyUpb_WeakMap_Get(self->unset_subobj_map, field);
if (subobj) return subobj;
if (upb_FieldDef_IsMap(field)) {
subobj = PyUpb_MapContainer_NewStub(_self, field, self->arena);
} else if (upb_FieldDef_IsRepeated(field)) {
subobj = PyUpb_RepeatedContainer_NewStub(_self, field, self->arena);
} else {
subobj = PyUpb_Message_NewStub(&self->ob_base, field, self->arena);
}
PyUpb_WeakMap_Add(self->unset_subobj_map, field, subobj);
assert(!PyErr_Occurred());
return subobj;
}
PyObject* PyUpb_Message_GetPresentWrapper(PyUpb_Message* self,
const upb_FieldDef* field) {
assert(!PyUpb_Message_IsStub(self));
upb_MutableMessageValue mutval =
upb_Message_Mutable(self->ptr.msg, field, PyUpb_Arena_Get(self->arena));
if (upb_FieldDef_IsMap(field)) {
return PyUpb_MapContainer_GetOrCreateWrapper(mutval.map, field,
self->arena);
} else {
return PyUpb_RepeatedContainer_GetOrCreateWrapper(mutval.array, field,
self->arena);
}
}
PyObject* PyUpb_Message_GetScalarValue(PyUpb_Message* self,
const upb_FieldDef* field) {
upb_MessageValue val;
if (PyUpb_Message_IsStub(self)) {
// Unset message always returns default values.
val = upb_FieldDef_Default(field);
} else {
val = upb_Message_GetFieldByDef(self->ptr.msg, field);
}
return PyUpb_UpbToPy(val, field, self->arena);
}
/*
* PyUpb_Message_GetFieldValue()
*
* Implements the equivalent of getattr(msg, field), once `field` has
* already been resolved to a `upb_FieldDef*`.
*
* This may involve constructing a wrapper object for the given field, or
* returning one that was previously constructed. If the field is not actually
* set, the wrapper object will be an "unset" object that is not actually
* connected to any C data.
*/
PyObject* PyUpb_Message_GetFieldValue(PyObject* _self,
const upb_FieldDef* field) {
PyUpb_Message* self = (void*)_self;
assert(upb_FieldDef_ContainingType(field) == PyUpb_Message_GetMsgdef(_self));
bool submsg = upb_FieldDef_IsSubMessage(field);
bool seq = upb_FieldDef_IsRepeated(field);
if ((PyUpb_Message_IsStub(self) && (submsg || seq)) ||
(submsg && !seq && !upb_Message_HasFieldByDef(self->ptr.msg, field))) {
return PyUpb_Message_GetStub(self, field);
} else if (seq) {
return PyUpb_Message_GetPresentWrapper(self, field);
} else {
return PyUpb_Message_GetScalarValue(self, field);
}
}
int PyUpb_Message_SetFieldValue(PyObject* _self, const upb_FieldDef* field,
PyObject* value, PyObject* exc) {
PyUpb_Message* self = (void*)_self;
assert(value);
if (upb_FieldDef_IsRepeated(field)) {
PyErr_Format(exc,
"Assignment not allowed to map, or repeated "
"field \"%s\" in protocol message object.",
upb_FieldDef_Name(field));
return -1;
}
PyUpb_Message_EnsureReified(self);
if (upb_FieldDef_IsSubMessage(field)) {
const upb_MessageDef* msgdef = upb_FieldDef_MessageSubDef(field);
if (upb_MessageDef_WellKnownType(msgdef) != kUpb_WellKnown_Unspecified) {
PyObject* sub_message = PyUpb_Message_GetFieldValue(_self, field);
if (PyObject_HasAttrString(sub_message, "_internal_assign")) {
PyObject* ok =
PyObject_CallMethod(sub_message, "_internal_assign", "O", value);
if (!ok) return -1;
Py_DECREF(ok);
return 0;
}
}
PyErr_Format(exc,
"Assignment not allowed to message "
"field \"%s\" in protocol message object.",
upb_FieldDef_Name(field));
return -1;
}
upb_MessageValue val;
upb_Arena* arena = PyUpb_Arena_Get(self->arena);
if (!PyUpb_PyToUpb(value, field, &val, arena)) {
return -1;