/
def.c
1146 lines (967 loc) · 34.2 KB
/
def.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 2008 Google Inc. All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#include "def.h"
#include <php.h>
// This is not self-contained: it must be after other Zend includes.
#include <Zend/zend_exceptions.h>
#include "names.h"
#include "php-upb.h"
#include "protobuf.h"
static void CheckUpbStatus(const upb_status* status, const char* msg) {
if (!upb_ok(status)) {
zend_error(E_ERROR, "%s: %s\n", msg, upb_status_errmsg(status));
}
}
static void FieldDescriptor_FromFieldDef(zval *val, const upb_fielddef *f);
// We use this for objects that should not be created directly from PHP.
static zend_object *CreateHandler_ReturnNull(zend_class_entry *class_type) {
return NULL; // Nobody should call this.
}
// -----------------------------------------------------------------------------
// EnumValueDescriptor
// -----------------------------------------------------------------------------
typedef struct {
zend_object std;
const char *name;
int32_t number;
} EnumValueDescriptor;
zend_class_entry *EnumValueDescriptor_class_entry;
static zend_object_handlers EnumValueDescriptor_object_handlers;
/*
* EnumValueDescriptor_Make()
*
* Function to create an EnumValueDescriptor object from C.
*/
static void EnumValueDescriptor_Make(zval *val, const char *name,
int32_t number) {
EnumValueDescriptor *intern = emalloc(sizeof(EnumValueDescriptor));
zend_object_std_init(&intern->std, EnumValueDescriptor_class_entry);
intern->std.handlers = &EnumValueDescriptor_object_handlers;
intern->name = name;
intern->number = number;
// Skip object_properties_init(), we don't allow derived classes.
ZVAL_OBJ(val, &intern->std);
}
/*
* EnumValueDescriptor::getName()
*
* Returns the name for this enum value.
*/
PHP_METHOD(EnumValueDescriptor, getName) {
EnumValueDescriptor *intern = (EnumValueDescriptor*)Z_OBJ_P(getThis());
RETURN_STRING(intern->name);
}
/*
* EnumValueDescriptor::getNumber()
*
* Returns the number for this enum value.
*/
PHP_METHOD(EnumValueDescriptor, getNumber) {
EnumValueDescriptor *intern = (EnumValueDescriptor*)Z_OBJ_P(getThis());
RETURN_LONG(intern->number);
}
static zend_function_entry EnumValueDescriptor_methods[] = {
PHP_ME(EnumValueDescriptor, getName, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(EnumValueDescriptor, getNumber, arginfo_void, ZEND_ACC_PUBLIC)
ZEND_FE_END
};
// -----------------------------------------------------------------------------
// EnumDescriptor
// -----------------------------------------------------------------------------
typedef struct {
zend_object std;
const upb_enumdef *enumdef;
} EnumDescriptor;
zend_class_entry *EnumDescriptor_class_entry;
static zend_object_handlers EnumDescriptor_object_handlers;
void EnumDescriptor_FromClassEntry(zval *val, zend_class_entry *ce) {
// To differentiate enums from classes, we pointer-tag the class entry.
void* key = (void*)((uintptr_t)ce | 1);
PBPHP_ASSERT(key != ce);
if (ce == NULL) {
ZVAL_NULL(val);
return;
}
if (!ObjCache_Get(key, val)) {
const upb_enumdef *e = NameMap_GetEnum(ce);
if (!e) {
ZVAL_NULL(val);
return;
}
EnumDescriptor* ret = emalloc(sizeof(EnumDescriptor));
zend_object_std_init(&ret->std, EnumDescriptor_class_entry);
ret->std.handlers = &EnumDescriptor_object_handlers;
ret->enumdef = e;
ObjCache_Add(key, &ret->std);
// Prevent this from ever being collected (within a request).
GC_ADDREF(&ret->std);
ZVAL_OBJ(val, &ret->std);
}
}
void EnumDescriptor_FromEnumDef(zval *val, const upb_enumdef *m) {
if (!m) {
ZVAL_NULL(val);
} else {
char *classname =
GetPhpClassname(upb_enumdef_file(m), upb_enumdef_fullname(m));
zend_string *str = zend_string_init(classname, strlen(classname), 0);
zend_class_entry *ce = zend_lookup_class(str); // May autoload the class.
zend_string_release (str);
if (!ce) {
zend_error(E_ERROR, "Couldn't load generated class %s", classname);
}
free(classname);
EnumDescriptor_FromClassEntry(val, ce);
}
}
/*
* EnumDescriptor::getValue()
*
* Returns an EnumValueDescriptor for this index. Note: we are not looking
* up by numeric enum value, but by the index in the list of enum values.
*/
PHP_METHOD(EnumDescriptor, getValue) {
EnumDescriptor *intern = (EnumDescriptor*)Z_OBJ_P(getThis());
zend_long index;
zval ret;
if (zend_parse_parameters(ZEND_NUM_ARGS(), "l", &index) == FAILURE) {
zend_error(E_USER_ERROR, "Expect integer for index.\n");
return;
}
int field_num = upb_enumdef_numvals(intern->enumdef);
if (index < 0 || index >= field_num) {
zend_error(E_USER_ERROR, "Cannot get element at %ld.\n", index);
return;
}
upb_enum_iter iter;
int i;
for(upb_enum_begin(&iter, intern->enumdef), i = 0;
!upb_enum_done(&iter) && i < index;
upb_enum_next(&iter), i++);
EnumValueDescriptor_Make(&ret, upb_enum_iter_name(&iter),
upb_enum_iter_number(&iter));
RETURN_ZVAL(&ret, 0, 1);
}
/*
* EnumDescriptor::getValueCount()
*
* Returns the number of values in this enum.
*/
PHP_METHOD(EnumDescriptor, getValueCount) {
EnumDescriptor *intern = (EnumDescriptor*)Z_OBJ_P(getThis());
RETURN_LONG(upb_enumdef_numvals(intern->enumdef));
}
/*
* EnumDescriptor::getPublicDescriptor()
*
* Returns this EnumDescriptor. Unlike the pure-PHP descriptor, we do not
* have two separate EnumDescriptor classes. We use a single class for both
* the public and private descriptor.
*/
PHP_METHOD(EnumDescriptor, getPublicDescriptor) {
RETURN_ZVAL(getThis(), 1, 0);
}
static zend_function_entry EnumDescriptor_methods[] = {
PHP_ME(EnumDescriptor, getPublicDescriptor, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(EnumDescriptor, getValueCount, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(EnumDescriptor, getValue, arginfo_void, ZEND_ACC_PUBLIC)
ZEND_FE_END
};
// -----------------------------------------------------------------------------
// Oneof
// -----------------------------------------------------------------------------
typedef struct {
zend_object std;
const upb_oneofdef *oneofdef;
} OneofDescriptor;
zend_class_entry *OneofDescriptor_class_entry;
static zend_object_handlers OneofDescriptor_object_handlers;
static void OneofDescriptor_FromOneofDef(zval *val, const upb_oneofdef *o) {
if (o == NULL) {
ZVAL_NULL(val);
return;
}
if (!ObjCache_Get(o, val)) {
OneofDescriptor* ret = emalloc(sizeof(OneofDescriptor));
zend_object_std_init(&ret->std, OneofDescriptor_class_entry);
ret->std.handlers = &OneofDescriptor_object_handlers;
ret->oneofdef = o;
ObjCache_Add(o, &ret->std);
// Prevent this from ever being collected (within a request).
GC_ADDREF(&ret->std);
ZVAL_OBJ(val, &ret->std);
}
}
/*
* OneofDescriptor::getName()
*
* Returns the name of this oneof.
*/
PHP_METHOD(OneofDescriptor, getName) {
OneofDescriptor *intern = (OneofDescriptor*)Z_OBJ_P(getThis());
RETURN_STRING(upb_oneofdef_name(intern->oneofdef));
}
/*
* OneofDescriptor::getField()
*
* Returns a field from this oneof. The given index must be in the range
* [0, getFieldCount() - 1].
*/
PHP_METHOD(OneofDescriptor, getField) {
OneofDescriptor *intern = (OneofDescriptor*)Z_OBJ_P(getThis());
zend_long index;
zval ret;
if (zend_parse_parameters(ZEND_NUM_ARGS(), "l", &index) == FAILURE) {
zend_error(E_USER_ERROR, "Expect integer for index.\n");
return;
}
int field_num = upb_oneofdef_numfields(intern->oneofdef);
if (index < 0 || index >= field_num) {
zend_error(E_USER_ERROR, "Cannot get element at %ld.\n", index);
return;
}
upb_oneof_iter iter;
int i;
for(upb_oneof_begin(&iter, intern->oneofdef), i = 0;
!upb_oneof_done(&iter) && i < index;
upb_oneof_next(&iter), i++);
const upb_fielddef *field = upb_oneof_iter_field(&iter);
FieldDescriptor_FromFieldDef(&ret, field);
RETURN_ZVAL(&ret, 1, 0);
}
/*
* OneofDescriptor::getFieldCount()
*
* Returns the number of fields in this oneof.
*/
PHP_METHOD(OneofDescriptor, getFieldCount) {
OneofDescriptor *intern = (OneofDescriptor*)Z_OBJ_P(getThis());
RETURN_LONG(upb_oneofdef_numfields(intern->oneofdef));
}
static zend_function_entry OneofDescriptor_methods[] = {
PHP_ME(OneofDescriptor, getName, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(OneofDescriptor, getField, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(OneofDescriptor, getFieldCount, arginfo_void, ZEND_ACC_PUBLIC)
ZEND_FE_END
};
// -----------------------------------------------------------------------------
// FieldDescriptor
// -----------------------------------------------------------------------------
typedef struct {
zend_object std;
const upb_fielddef *fielddef;
} FieldDescriptor;
zend_class_entry *FieldDescriptor_class_entry;
static zend_object_handlers FieldDescriptor_object_handlers;
static void FieldDescriptor_FromFieldDef(zval *val, const upb_fielddef *f) {
if (f == NULL) {
ZVAL_NULL(val);
return;
}
if (!ObjCache_Get(f, val)) {
FieldDescriptor* ret = emalloc(sizeof(FieldDescriptor));
zend_object_std_init(&ret->std, FieldDescriptor_class_entry);
ret->std.handlers = &FieldDescriptor_object_handlers;
ret->fielddef = f;
ObjCache_Add(f, &ret->std);
// Prevent this from ever being collected (within a request).
GC_ADDREF(&ret->std);
ZVAL_OBJ(val, &ret->std);
}
}
upb_fieldtype_t to_fieldtype(upb_descriptortype_t type) {
switch (type) {
#define CASE(descriptor_type, type) \
case UPB_DESCRIPTOR_TYPE_##descriptor_type: \
return UPB_TYPE_##type;
CASE(FLOAT, FLOAT);
CASE(DOUBLE, DOUBLE);
CASE(BOOL, BOOL);
CASE(STRING, STRING);
CASE(BYTES, BYTES);
CASE(MESSAGE, MESSAGE);
CASE(GROUP, MESSAGE);
CASE(ENUM, ENUM);
CASE(INT32, INT32);
CASE(INT64, INT64);
CASE(UINT32, UINT32);
CASE(UINT64, UINT64);
CASE(SINT32, INT32);
CASE(SINT64, INT64);
CASE(FIXED32, UINT32);
CASE(FIXED64, UINT64);
CASE(SFIXED32, INT32);
CASE(SFIXED64, INT64);
#undef CONVERT
}
zend_error(E_ERROR, "Unknown field type.");
return 0;
}
/*
* FieldDescriptor::getName()
*
* Returns the name of this field.
*/
PHP_METHOD(FieldDescriptor, getName) {
FieldDescriptor *intern = (FieldDescriptor*)Z_OBJ_P(getThis());
RETURN_STRING(upb_fielddef_name(intern->fielddef));
}
/*
* FieldDescriptor::getNumber()
*
* Returns the number of this field.
*/
PHP_METHOD(FieldDescriptor, getNumber) {
FieldDescriptor *intern = (FieldDescriptor*)Z_OBJ_P(getThis());
RETURN_LONG(upb_fielddef_number(intern->fielddef));
}
/*
* FieldDescriptor::getLabel()
*
* Returns the label of this field as an integer.
*/
PHP_METHOD(FieldDescriptor, getLabel) {
FieldDescriptor *intern = (FieldDescriptor*)Z_OBJ_P(getThis());
RETURN_LONG(upb_fielddef_label(intern->fielddef));
}
/*
* FieldDescriptor::getType()
*
* Returns the type of this field as an integer.
*/
PHP_METHOD(FieldDescriptor, getType) {
FieldDescriptor *intern = (FieldDescriptor*)Z_OBJ_P(getThis());
RETURN_LONG(upb_fielddef_descriptortype(intern->fielddef));
}
/*
* FieldDescriptor::isMap()
*
* Returns true if this field is a map.
*/
PHP_METHOD(FieldDescriptor, isMap) {
FieldDescriptor *intern = (FieldDescriptor*)Z_OBJ_P(getThis());
RETURN_BOOL(upb_fielddef_ismap(intern->fielddef));
}
/*
* FieldDescriptor::getEnumType()
*
* Returns the EnumDescriptor for this field, which must be an enum.
*/
PHP_METHOD(FieldDescriptor, getEnumType) {
FieldDescriptor *intern = (FieldDescriptor*)Z_OBJ_P(getThis());
const upb_enumdef *e = upb_fielddef_enumsubdef(intern->fielddef);
zval ret;
if (!e) {
zend_throw_exception_ex(NULL, 0,
"Cannot get enum type for non-enum field '%s'",
upb_fielddef_name(intern->fielddef));
return;
}
EnumDescriptor_FromEnumDef(&ret, e);
RETURN_ZVAL(&ret, 1, 0);
}
/*
* FieldDescriptor::getMessageType()
*
* Returns the Descriptor for this field, which must be a message.
*/
PHP_METHOD(FieldDescriptor, getMessageType) {
FieldDescriptor *intern = (FieldDescriptor*)Z_OBJ_P(getThis());
Descriptor* desc = Descriptor_GetFromFieldDef(intern->fielddef);
zval ret;
if (!desc) {
zend_throw_exception_ex(
NULL, 0, "Cannot get message type for non-message field '%s'",
upb_fielddef_name(intern->fielddef));
return;
}
ZVAL_OBJ(&ret, &desc->std);
RETURN_ZVAL(&ret, 1, 0);
}
static zend_function_entry FieldDescriptor_methods[] = {
PHP_ME(FieldDescriptor, getName, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(FieldDescriptor, getNumber, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(FieldDescriptor, getLabel, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(FieldDescriptor, getType, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(FieldDescriptor, isMap, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(FieldDescriptor, getEnumType, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(FieldDescriptor, getMessageType, arginfo_void, ZEND_ACC_PUBLIC)
ZEND_FE_END
};
// -----------------------------------------------------------------------------
// Descriptor
// -----------------------------------------------------------------------------
zend_class_entry *Descriptor_class_entry;
static zend_object_handlers Descriptor_object_handlers;
static void Descriptor_destructor(zend_object* obj) {
// We don't really need to do anything here, we don't allow this to be
// collected before the end of the request.
}
// C Functions from def.h //////////////////////////////////////////////////////
// These are documented in the header file.
void Descriptor_FromClassEntry(zval *val, zend_class_entry *ce) {
if (ce == NULL) {
ZVAL_NULL(val);
return;
}
if (!ObjCache_Get(ce, val)) {
const upb_msgdef *msgdef = NameMap_GetMessage(ce);
if (!msgdef) {
ZVAL_NULL(val);
return;
}
Descriptor* ret = emalloc(sizeof(Descriptor));
zend_object_std_init(&ret->std, Descriptor_class_entry);
ret->std.handlers = &Descriptor_object_handlers;
ret->class_entry = ce;
ret->msgdef = msgdef;
ObjCache_Add(ce, &ret->std);
// Prevent this from ever being collected (within a request).
GC_ADDREF(&ret->std);
ZVAL_OBJ(val, &ret->std);
}
}
Descriptor* Descriptor_GetFromClassEntry(zend_class_entry *ce) {
zval desc;
Descriptor_FromClassEntry(&desc, ce);
if (Z_TYPE_P(&desc) == IS_NULL) {
return NULL;
} else {
return (Descriptor*)Z_OBJ_P(&desc);
}
}
Descriptor* Descriptor_GetFromMessageDef(const upb_msgdef *m) {
if (m) {
if (upb_msgdef_mapentry(m)) {
// A bit of a hack, since map entries don't have classes.
Descriptor* ret = emalloc(sizeof(Descriptor));
zend_object_std_init(&ret->std, Descriptor_class_entry);
ret->std.handlers = &Descriptor_object_handlers;
ret->class_entry = NULL;
ret->msgdef = m;
// Prevent this from ever being collected (within a request).
GC_ADDREF(&ret->std);
return ret;
}
char *classname =
GetPhpClassname(upb_msgdef_file(m), upb_msgdef_fullname(m));
zend_string *str = zend_string_init(classname, strlen(classname), 0);
zend_class_entry *ce = zend_lookup_class(str); // May autoload the class.
zend_string_release (str);
if (!ce) {
zend_error(E_ERROR, "Couldn't load generated class %s", classname);
}
free(classname);
return Descriptor_GetFromClassEntry(ce);
} else {
return NULL;
}
}
Descriptor* Descriptor_GetFromFieldDef(const upb_fielddef *f) {
return Descriptor_GetFromMessageDef(upb_fielddef_msgsubdef(f));
}
/*
* Descriptor::getPublicDescriptor()
*
* Returns this EnumDescriptor. Unlike the pure-PHP descriptor, we do not
* have two separate EnumDescriptor classes. We use a single class for both
* the public and private descriptor.
*/
PHP_METHOD(Descriptor, getPublicDescriptor) {
RETURN_ZVAL(getThis(), 1, 0);
}
/*
* Descriptor::getFullName()
*
* Returns the full name for this message type.
*/
PHP_METHOD(Descriptor, getFullName) {
Descriptor *intern = (Descriptor*)Z_OBJ_P(getThis());
RETURN_STRING(upb_msgdef_fullname(intern->msgdef));
}
/*
* Descriptor::getField()
*
* Returns a FieldDescriptor for the given index, which must be in the range
* [0, getFieldCount()-1].
*/
PHP_METHOD(Descriptor, getField) {
Descriptor *intern = (Descriptor*)Z_OBJ_P(getThis());
int count = upb_msgdef_numfields(intern->msgdef);
zval ret;
zend_long index;
if (zend_parse_parameters(ZEND_NUM_ARGS(), "l", &index) == FAILURE) {
zend_error(E_USER_ERROR, "Expect integer for index.\n");
return;
}
if (index < 0 || index >= count) {
zend_error(E_USER_ERROR, "Cannot get element at %ld.\n", index);
return;
}
upb_msg_field_iter iter;
int i;
for(upb_msg_field_begin(&iter, intern->msgdef), i = 0;
!upb_msg_field_done(&iter) && i < index;
upb_msg_field_next(&iter), i++);
const upb_fielddef *field = upb_msg_iter_field(&iter);
FieldDescriptor_FromFieldDef(&ret, field);
RETURN_ZVAL(&ret, 1, 0);
}
/*
* Descriptor::getFieldCount()
*
* Returns the number of fields in this message.
*/
PHP_METHOD(Descriptor, getFieldCount) {
Descriptor *intern = (Descriptor*)Z_OBJ_P(getThis());
RETURN_LONG(upb_msgdef_numfields(intern->msgdef));
}
/*
* Descriptor::getOneofDecl()
*
* Returns a OneofDescriptor for the given index, which must be in the range
* [0, getOneofDeclCount()].
*/
PHP_METHOD(Descriptor, getOneofDecl) {
Descriptor *intern = (Descriptor*)Z_OBJ_P(getThis());
zend_long index;
zval ret;
if (zend_parse_parameters(ZEND_NUM_ARGS(), "l", &index) == FAILURE) {
zend_error(E_USER_ERROR, "Expect integer for index.\n");
return;
}
int field_num = upb_msgdef_numoneofs(intern->msgdef);
if (index < 0 || index >= field_num) {
zend_error(E_USER_ERROR, "Cannot get element at %ld.\n", index);
return;
}
upb_msg_oneof_iter iter;
int i;
for(upb_msg_oneof_begin(&iter, intern->msgdef), i = 0;
!upb_msg_oneof_done(&iter) && i < index;
upb_msg_oneof_next(&iter), i++);
const upb_oneofdef *oneof = upb_msg_iter_oneof(&iter);
OneofDescriptor_FromOneofDef(&ret, oneof);
RETURN_ZVAL(&ret, 1, 0);
}
/*
* Descriptor::getOneofDeclCount()
*
* Returns the number of oneofs in this message.
*/
PHP_METHOD(Descriptor, getOneofDeclCount) {
Descriptor *intern = (Descriptor*)Z_OBJ_P(getThis());
RETURN_LONG(upb_msgdef_numoneofs(intern->msgdef));
}
/*
* Descriptor::getClass()
*
* Returns the name of the PHP class for this message.
*/
PHP_METHOD(Descriptor, getClass) {
Descriptor *intern = (Descriptor*)Z_OBJ_P(getThis());
const char* classname = ZSTR_VAL(intern->class_entry->name);
RETURN_STRING(classname);
}
static zend_function_entry Descriptor_methods[] = {
PHP_ME(Descriptor, getClass, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(Descriptor, getFullName, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(Descriptor, getField, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(Descriptor, getFieldCount, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(Descriptor, getOneofDecl, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(Descriptor, getOneofDeclCount, arginfo_void, ZEND_ACC_PUBLIC)
PHP_ME(Descriptor, getPublicDescriptor, arginfo_void, ZEND_ACC_PUBLIC)
ZEND_FE_END
};
// -----------------------------------------------------------------------------
// DescriptorPool
// -----------------------------------------------------------------------------
typedef struct DescriptorPool {
zend_object std;
upb_symtab *symtab;
} DescriptorPool;
zend_class_entry *DescriptorPool_class_entry;
static zend_object_handlers DescriptorPool_object_handlers;
static DescriptorPool *GetPool(const zval* this_ptr) {
return (DescriptorPool*)Z_OBJ_P(this_ptr);
}
/**
* Object handler to create an DescriptorPool.
*/
static zend_object* DescriptorPool_create(zend_class_entry *class_type) {
DescriptorPool *intern = emalloc(sizeof(DescriptorPool));
zend_object_std_init(&intern->std, class_type);
intern->std.handlers = &DescriptorPool_object_handlers;
intern->symtab = upb_symtab_new();
// Skip object_properties_init(), we don't allow derived classes.
return &intern->std;
}
/**
* Object handler to free an DescriptorPool.
*/
static void DescriptorPool_destructor(zend_object* obj) {
DescriptorPool* intern = (DescriptorPool*)obj;
if (intern->symtab) {
upb_symtab_free(intern->symtab);
}
intern->symtab = NULL;
zend_object_std_dtor(&intern->std);
}
void DescriptorPool_CreateWithSymbolTable(zval *zv, upb_symtab *symtab) {
ZVAL_OBJ(zv, DescriptorPool_create(DescriptorPool_class_entry));
if (symtab) {
DescriptorPool *intern = GetPool(zv);
upb_symtab_free(intern->symtab);
intern->symtab = symtab;
}
}
upb_symtab *DescriptorPool_Steal(zval *zv) {
DescriptorPool *intern = GetPool(zv);
upb_symtab *ret = intern->symtab;
intern->symtab = NULL;
return ret;
}
upb_symtab *DescriptorPool_GetSymbolTable() {
DescriptorPool *intern = GetPool(get_generated_pool());
return intern->symtab;
}
/*
* DescriptorPool::getGeneratedPool()
*
* Returns the generated DescriptorPool.
*/
PHP_METHOD(DescriptorPool, getGeneratedPool) {
zval ret;
ZVAL_COPY(&ret, get_generated_pool());
RETURN_ZVAL(&ret, 0, 1);
}
/*
* DescriptorPool::getDescriptorByClassName()
*
* Returns a Descriptor object for the given PHP class name.
*/
PHP_METHOD(DescriptorPool, getDescriptorByClassName) {
char *classname = NULL;
zend_long classname_len;
zend_class_entry *ce;
zend_string *str;
zval ret;
if (zend_parse_parameters(ZEND_NUM_ARGS(), "s", &classname, &classname_len) ==
FAILURE) {
return;
}
str = zend_string_init(classname, strlen(classname), 0);
ce = zend_lookup_class(str); // May autoload the class.
zend_string_release (str);
if (!ce) {
RETURN_NULL();
}
Descriptor_FromClassEntry(&ret, ce);
RETURN_ZVAL(&ret, 1, 0);
}
/*
* DescriptorPool::getEnumDescriptorByClassName()
*
* Returns a EnumDescriptor object for the given PHP class name.
*/
PHP_METHOD(DescriptorPool, getEnumDescriptorByClassName) {
char *classname = NULL;
zend_long classname_len;
zend_class_entry *ce;
zend_string *str;
zval ret;
if (zend_parse_parameters(ZEND_NUM_ARGS(), "s", &classname, &classname_len) ==
FAILURE) {
return;
}
str = zend_string_init(classname, strlen(classname), 0);
ce = zend_lookup_class(str); // May autoload the class.
zend_string_release (str);
if (!ce) {
RETURN_NULL();
}
EnumDescriptor_FromClassEntry(&ret, ce);
RETURN_ZVAL(&ret, 1, 0);
}
/*
* DescriptorPool::getEnumDescriptorByProtoName()
*
* Returns a Descriptor object for the given protobuf message name.
*/
PHP_METHOD(DescriptorPool, getDescriptorByProtoName) {
DescriptorPool *intern = GetPool(getThis());
char *protoname = NULL;
zend_long protoname_len;
const upb_msgdef *m;
if (zend_parse_parameters(ZEND_NUM_ARGS(), "s", &protoname, &protoname_len) ==
FAILURE) {
return;
}
if (*protoname == '.') protoname++;
m = upb_symtab_lookupmsg(intern->symtab, protoname);
if (m) {
zval ret;
ZVAL_OBJ(&ret, &Descriptor_GetFromMessageDef(m)->std);
RETURN_ZVAL(&ret, 1, 0);
} else {
RETURN_NULL();
}
}
/*
* depends_on_descriptor()
*
* Returns true if this FileDescriptorProto depends on descriptor.proto.
*/
bool depends_on_descriptor(const google_protobuf_FileDescriptorProto* file) {
const upb_strview *deps;
upb_strview name = upb_strview_makez("google/protobuf/descriptor.proto");
size_t i, n;
deps = google_protobuf_FileDescriptorProto_dependency(file, &n);
for (i = 0; i < n; i++) {
if (upb_strview_eql(deps[i], name)) {
return true;
}
}
return false;
}
/*
* add_name_mappings()
*
* Adds the messages and enums in this file to the NameMap.
*/
static void add_name_mappings(const upb_filedef *file) {
size_t i;
for (i = 0; i < upb_filedef_msgcount(file); i++) {
NameMap_AddMessage(upb_filedef_msg(file, i));
}
for (i = 0; i < upb_filedef_enumcount(file); i++) {
NameMap_AddEnum(upb_filedef_enum(file, i));
}
}
static void add_descriptor(DescriptorPool *pool,
const google_protobuf_FileDescriptorProto *file) {
upb_strview name = google_protobuf_FileDescriptorProto_name(file);
upb_status status;
const upb_filedef *file_def;
upb_status_clear(&status);
if (upb_symtab_lookupfile2(pool->symtab, name.data, name.size)) {
// Already added.
fprintf(stderr, "WARNING: file was already added\n");
return;
}
// The PHP code generator currently special-cases descriptor.proto. It
// doesn't add it as a dependency even if the proto file actually does
// depend on it.
if (depends_on_descriptor(file)) {
google_protobuf_FileDescriptorProto_getmsgdef(pool->symtab);
}
file_def = upb_symtab_addfile(pool->symtab, file, &status);
CheckUpbStatus(&status, "Unable to load descriptor");
add_name_mappings(file_def);
}
/*
* add_descriptor()
*
* Adds the given descriptor data to this DescriptorPool.
*/
static void add_descriptor_set(DescriptorPool *pool, const char *data,
int data_len, upb_arena *arena) {
size_t i, n;
google_protobuf_FileDescriptorSet *set;
const google_protobuf_FileDescriptorProto* const* files;
set = google_protobuf_FileDescriptorSet_parse(data, data_len, arena);
if (!set) {
zend_error(E_ERROR, "Failed to parse binary descriptor\n");
return;
}
files = google_protobuf_FileDescriptorSet_file(set, &n);
for (i = 0; i < n; i++) {
const google_protobuf_FileDescriptorProto* file = files[i];
add_descriptor(pool, file);
}
}
bool DescriptorPool_HasFile(const char *filename) {
DescriptorPool *intern = GetPool(get_generated_pool());
return upb_symtab_lookupfile(intern->symtab, filename) != NULL;
}
void DescriptorPool_AddDescriptor(const char *filename, const char *data,
int size) {
upb_arena *arena = upb_arena_new();
const google_protobuf_FileDescriptorProto *file =
google_protobuf_FileDescriptorProto_parse(data, size, arena);
if (!file) {
zend_error(E_ERROR, "Failed to parse binary descriptor for %s\n", filename);
return;
}
add_descriptor(GetPool(get_generated_pool()), file);
upb_arena_free(arena);
}
/*
* DescriptorPool::internalAddGeneratedFile()
*
* Adds the given descriptor data to this DescriptorPool.
*/
PHP_METHOD(DescriptorPool, internalAddGeneratedFile) {
DescriptorPool *intern = GetPool(getThis());
char *data = NULL;
zend_long data_len;
zend_bool use_nested_submsg = false;
upb_arena *arena;
if (zend_parse_parameters(ZEND_NUM_ARGS(), "s|b", &data, &data_len,
&use_nested_submsg) != SUCCESS) {
return;
}
arena = upb_arena_new();
add_descriptor_set(intern, data, data_len, arena);
upb_arena_free(arena);