This repository was archived by the owner on Mar 17, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathserializer.c
1548 lines (1320 loc) · 56.1 KB
/
serializer.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
#include <Zend/zend.h>
#include <Zend/zend_builtin_functions.h>
#include <Zend/zend_exceptions.h>
#include <Zend/zend_interfaces.h>
#include <Zend/zend_smart_str.h>
#include <Zend/zend_types.h>
#include <inttypes.h>
#include <php.h>
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
#include <ext/standard/php_string.h>
// comment to prevent clang from reordering these headers
#include <SAPI.h>
#include <exceptions/exceptions.h>
#include <stdatomic.h>
#include <zai_string/string.h>
#include "arrays.h"
#include "compat_string.h"
#include "ddtrace.h"
#include "engine_api.h"
#include "engine_hooks.h"
#include "logging.h"
#include "mpack/mpack.h"
#include "priority_sampling/priority_sampling.h"
#include "runtime.h"
#include "signalfx/json_writer.h"
#include "span.h"
#include "uri_normalization.h"
ZEND_EXTERN_MODULE_GLOBALS(ddtrace);
extern void (*profiling_notify_trace_finished)(uint64_t local_root_span_id,
zai_string_view span_type,
zai_string_view resource);
#define MAX_ID_BUFSIZ 21 // 1.8e^19 = 20 chars + 1 terminator
#define KEY_TRACE_ID "trace_id"
#define KEY_SPAN_ID "span_id"
#define KEY_PARENT_ID "parent_id"
static int msgpack_write_zval(mpack_writer_t *writer, zval *trace, int level);
static int write_hash_table(mpack_writer_t *writer, HashTable *ht, int level) {
zval *tmp;
zend_string *string_key;
zend_long num_key;
bool is_assoc = 0;
#if PHP_VERSION_ID >= 80100
is_assoc = !zend_array_is_list(ht);
#else
Bucket *bucket;
ZEND_HASH_FOREACH_BUCKET(ht, bucket) { is_assoc = is_assoc || bucket->key != NULL; }
ZEND_HASH_FOREACH_END();
#endif
if (is_assoc) {
mpack_start_map(writer, zend_hash_num_elements(ht));
} else {
mpack_start_array(writer, zend_hash_num_elements(ht));
}
ZEND_HASH_FOREACH_KEY_VAL_IND(ht, num_key, string_key, tmp) {
// Writing the key, if associative
bool zval_string_as_uint64 = false;
if (is_assoc == 1) {
char num_str_buf[MAX_ID_BUFSIZ], *key;
if (string_key) {
key = ZSTR_VAL(string_key);
} else {
key = num_str_buf;
sprintf(num_str_buf, ZEND_LONG_FMT, num_key);
}
mpack_write_cstr(writer, key);
// If the key is trace_id, span_id or parent_id then strings have to be converted to uint64 when packed.
if (level <= 3 &&
(0 == strcmp(KEY_TRACE_ID, key) || 0 == strcmp(KEY_SPAN_ID, key) || 0 == strcmp(KEY_PARENT_ID, key))) {
zval_string_as_uint64 = true;
}
}
// Writing the value
if (zval_string_as_uint64) {
mpack_write_u64(writer, strtoull(Z_STRVAL_P(tmp), NULL, 10));
} else if (msgpack_write_zval(writer, tmp, level) != 1) {
return 0;
}
}
ZEND_HASH_FOREACH_END();
if (is_assoc) {
mpack_finish_map(writer);
} else {
mpack_finish_array(writer);
}
return 1;
}
static int msgpack_write_zval(mpack_writer_t *writer, zval *trace, int level) {
if (Z_TYPE_P(trace) == IS_REFERENCE) {
trace = Z_REFVAL_P(trace);
}
switch (Z_TYPE_P(trace)) {
case IS_ARRAY:
if (write_hash_table(writer, Z_ARRVAL_P(trace), level + 1) != 1) {
return 0;
}
break;
case IS_DOUBLE:
mpack_write_double(writer, Z_DVAL_P(trace));
break;
case IS_LONG:
mpack_write_int(writer, Z_LVAL_P(trace));
break;
case IS_NULL:
mpack_write_nil(writer);
break;
case IS_TRUE:
case IS_FALSE:
mpack_write_bool(writer, Z_TYPE_P(trace) == IS_TRUE);
break;
case IS_STRING:
mpack_write_cstr(writer, Z_STRVAL_P(trace));
break;
default:
ddtrace_log_debug("Serialize values must be of type array, string, int, float, bool or null");
return 0;
break;
}
return 1;
}
int ddtrace_serialize_simple_array_into_c_string(zval *trace, char **data_p, size_t *size_p) {
// encode to memory buffer
char *data;
size_t size;
mpack_writer_t writer;
mpack_writer_init_growable(&writer, &data, &size);
if (msgpack_write_zval(&writer, trace, 0) != 1) {
mpack_writer_destroy(&writer);
free(data);
return 0;
}
// finish writing
if (mpack_writer_destroy(&writer) != mpack_ok) {
free(data);
return 0;
}
if (data_p && size_p) {
*data_p = data;
*size_p = size;
return 1;
} else {
return 0;
}
}
static int json_write_zval(json_writer_s *writer, zval *trace, bool force_associative);
// SIGNALFX: JSON equivalent for msgpack write_hash_table, additionally it does
// not change trace/span IDs to number types as is done for msgpack
static int json_write_hash_table(json_writer_s *writer, HashTable *ht, bool force_associative) {
zval *tmp;
zend_string *string_key;
zend_long num_key;
bool is_assoc = 0;
#if PHP_VERSION_ID >= 80100
is_assoc = !zend_array_is_list(ht);
#else
Bucket *bucket;
ZEND_HASH_FOREACH_BUCKET(ht, bucket) { is_assoc = is_assoc || bucket->key != NULL; }
ZEND_HASH_FOREACH_END();
#endif
if (force_associative) {
is_assoc = true;
}
if (is_assoc) {
json_writer_object_begin(writer);
} else {
json_writer_array_begin(writer);
}
bool is_first = true;
ZEND_HASH_FOREACH_KEY_VAL_IND(ht, num_key, string_key, tmp) {
if (is_first) {
is_first = false;
} else {
json_writer_element_separator(writer);
}
bool known_associative_value = false;
// Writing the key, if associative
if (is_assoc == 1) {
char num_str_buf[MAX_ID_BUFSIZ], *key;
if (string_key) {
key = ZSTR_VAL(string_key);
if (strcmp(key, "tags") == 0) {
known_associative_value = true;
}
} else {
key = num_str_buf;
sprintf(num_str_buf, ZEND_LONG_FMT, num_key);
}
json_writer_utf8(writer, key);
json_writer_key_value_separator(writer);
}
// Writing the value
if (json_write_zval(writer, tmp, known_associative_value) != 1) {
return 0;
}
}
ZEND_HASH_FOREACH_END();
if (is_assoc) {
json_writer_object_end(writer);
} else {
json_writer_array_end(writer);
}
return 1;
}
// SIGNALFX: JSON equivalent for msgpack msgpack_write_zval
static int json_write_zval(json_writer_s *writer, zval *trace, bool force_associative) {
if (Z_TYPE_P(trace) == IS_REFERENCE) {
trace = Z_REFVAL_P(trace);
}
switch (Z_TYPE_P(trace)) {
case IS_ARRAY:
if (json_write_hash_table(writer, Z_ARRVAL_P(trace), force_associative) != 1) {
return 0;
}
break;
case IS_DOUBLE:
json_writer_double(writer, Z_DVAL_P(trace));
break;
case IS_LONG:
json_writer_i64(writer, Z_LVAL_P(trace));
break;
case IS_NULL:
json_writer_null(writer);
break;
case IS_TRUE:
case IS_FALSE:
json_writer_bool(writer, Z_TYPE_P(trace) == IS_TRUE);
break;
case IS_STRING:
json_writer_utf8(writer, Z_STRVAL_P(trace));
break;
default:
ddtrace_log_debug("Serialize values must be of type array, string, int, float, bool or null");
return 0;
break;
}
return 1;
}
// SIGNALFX: JSON equivalent for ddtrace_serialize_simple_array_into_c_string
int ddtrace_serialize_simple_array_into_c_string_json(zval *trace, char **data_p, size_t *size_p) {
// encode to memory buffer
char *data;
size_t size;
json_writer_s writer;
json_writer_initialize(&writer);
if (json_write_zval(&writer, trace, false) != 1) {
json_writer_destroy(&writer);
return 0;
}
bool written = json_writer_complete(&writer, &data, &size);
json_writer_destroy(&writer);
if (!written) {
return 0;
}
if (data_p && size_p) {
*data_p = data;
*size_p = size;
return 1;
} else {
return 0;
}
}
int ddtrace_serialize_simple_array(zval *trace, zval *retval) {
// encode to memory buffer
char *data;
size_t size;
if (ddtrace_serialize_simple_array_into_c_string(trace, &data, &size)) {
ZVAL_STRINGL(retval, data, size);
free(data);
return 1;
} else {
return 0;
}
}
static void _add_assoc_zval_copy(zval *el, const char *name, zval *prop) {
zval value;
ZVAL_COPY(&value, prop);
add_assoc_zval(el, (name), &value);
}
typedef zend_result (*add_tag_fn_t)(void *context, ddtrace_string key, ddtrace_string value);
#if PHP_VERSION_ID < 70100
#define ZEND_STR_LINE "line"
#define ZEND_STR_FILE "file"
#define ZEND_STR_PREVIOUS "previous"
#endif
static zend_result dd_exception_to_error_msg(zend_object *exception, void *context, add_tag_fn_t add_tag) {
zend_string *msg = zai_exception_message(exception);
zend_long line = zval_get_long(ZAI_EXCEPTION_PROPERTY(exception, ZEND_STR_LINE));
zend_string *file = ddtrace_convert_to_str(ZAI_EXCEPTION_PROPERTY(exception, ZEND_STR_FILE));
char *error_text, *status_line;
zend_bool caught = SG(sapi_headers).http_response_code >= 500;
if (caught) {
if (SG(sapi_headers).http_status_line) {
asprintf(&status_line, " (%s)", SG(sapi_headers).http_status_line);
} else {
asprintf(&status_line, " (%d)", SG(sapi_headers).http_response_code);
}
}
int error_len = asprintf(&error_text, "%s %s%s%s%.*s in %s:" ZEND_LONG_FMT, caught ? "Caught" : "Uncaught",
ZSTR_VAL(exception->ce->name), caught ? status_line : "", ZSTR_LEN(msg) > 0 ? ": " : "",
(int)ZSTR_LEN(msg), ZSTR_VAL(msg), ZSTR_VAL(file), line);
if (caught) {
free(status_line);
}
ddtrace_string key = DDTRACE_STRING_LITERAL("error.message");
ddtrace_string value = {error_text, error_len};
zend_result result = add_tag(context, key, value);
zend_string_release(file);
free(error_text);
return result;
}
static zend_result dd_exception_to_error_type(zend_object *exception, void *context, add_tag_fn_t add_tag) {
ddtrace_string value, key = DDTRACE_STRING_LITERAL("error.type");
if (instanceof_function(exception->ce, ddtrace_ce_fatal_error)) {
zval *code = ZAI_EXCEPTION_PROPERTY(exception, ZEND_STR_CODE);
const char *error_type_string = "{unknown error}";
if (Z_TYPE_P(code) == IS_LONG) {
switch (Z_LVAL_P(code)) {
case E_ERROR:
error_type_string = "E_ERROR";
break;
case E_CORE_ERROR:
error_type_string = "E_CORE_ERROR";
break;
case E_COMPILE_ERROR:
error_type_string = "E_COMPILE_ERROR";
break;
case E_USER_ERROR:
error_type_string = "E_USER_ERROR";
break;
default:
ddtrace_assert_log_debug(
"Unhandled error type in DDTrace\\FatalError; is a fatal error case missing?");
}
} else {
ddtrace_assert_log_debug("Exception was a DDTrace\\FatalError but failed to get an exception code");
}
value = ddtrace_string_cstring_ctor((char *)error_type_string);
} else {
zend_string *type_name = exception->ce->name;
value.ptr = ZSTR_VAL(type_name);
value.len = ZSTR_LEN(type_name);
}
return add_tag(context, key, value);
}
static zend_result dd_exception_trace_to_error_stack(zend_string *trace, void *context, add_tag_fn_t add_tag) {
ddtrace_string key = DDTRACE_STRING_LITERAL("error.stack");
ddtrace_string value = {ZSTR_VAL(trace), ZSTR_LEN(trace)};
zend_result result = add_tag(context, key, value);
zend_string_release(trace);
return result;
}
// Guarantees that add_tag will only be called once per tag, will stop trying to add tags if one fails.
static zend_result ddtrace_exception_to_meta(zend_object *exception, void *context, add_tag_fn_t add_meta) {
zend_object *exception_root = exception;
zend_string *full_trace = zai_get_trace_without_args_from_exception(exception);
zval *previous = ZAI_EXCEPTION_PROPERTY(exception, ZEND_STR_PREVIOUS);
while (Z_TYPE_P(previous) == IS_OBJECT && !Z_IS_RECURSIVE_P(previous) &&
instanceof_function(Z_OBJCE_P(previous), zend_ce_throwable)) {
zend_string *trace_string = zai_get_trace_without_args_from_exception(Z_OBJ_P(previous));
zend_string *msg = zai_exception_message(exception);
zend_long line = zval_get_long(ZAI_EXCEPTION_PROPERTY(exception, ZEND_STR_LINE));
zend_string *file = ddtrace_convert_to_str(ZAI_EXCEPTION_PROPERTY(exception, ZEND_STR_FILE));
zend_string *complete_trace =
zend_strpprintf(0, "%s\n\nNext %s%s%s in %s:" ZEND_LONG_FMT "\nStack trace:\n%s", ZSTR_VAL(trace_string),
ZSTR_VAL(exception->ce->name), ZSTR_LEN(msg) ? ": " : "", ZSTR_VAL(msg), ZSTR_VAL(file),
line, ZSTR_VAL(full_trace));
zend_string_release(trace_string);
zend_string_release(full_trace);
zend_string_release(file);
full_trace = complete_trace;
Z_PROTECT_RECURSION_P(previous);
exception = Z_OBJ_P(previous);
previous = ZAI_EXCEPTION_PROPERTY(exception, ZEND_STR_PREVIOUS);
}
previous = ZAI_EXCEPTION_PROPERTY(exception_root, ZEND_STR_PREVIOUS);
while (Z_TYPE_P(previous) == IS_OBJECT && !Z_IS_RECURSIVE_P(previous) &&
instanceof_function(Z_OBJCE_P(previous), zend_ce_throwable)) {
Z_UNPROTECT_RECURSION_P(previous);
previous = ZAI_EXCEPTION_PROPERTY(Z_OBJ_P(previous), ZEND_STR_PREVIOUS);
}
bool success = dd_exception_to_error_msg(exception, context, add_meta) == SUCCESS &&
dd_exception_to_error_type(exception, context, add_meta) == SUCCESS &&
dd_exception_trace_to_error_stack(full_trace, context, add_meta) == SUCCESS;
return success ? SUCCESS : FAILURE;
}
typedef struct dd_error_info {
zend_string *type;
zend_string *message;
zend_string *stack;
} dd_error_info;
static zend_string *dd_error_type(int code) {
const char *error_type = "{unknown error}";
// mask off flags such as E_DONT_BAIL
code &= E_ALL;
switch (code) {
case E_ERROR:
error_type = "E_ERROR";
break;
case E_CORE_ERROR:
error_type = "E_CORE_ERROR";
break;
case E_COMPILE_ERROR:
error_type = "E_COMPILE_ERROR";
break;
case E_USER_ERROR:
error_type = "E_USER_ERROR";
break;
}
return zend_string_init(error_type, strlen(error_type), 0);
}
static zend_string *dd_fatal_error_stack(void) {
zval stack = {0};
zend_fetch_debug_backtrace(&stack, 0, DEBUG_BACKTRACE_IGNORE_ARGS, 0);
zend_string *error_stack = NULL;
if (Z_TYPE(stack) == IS_ARRAY) {
error_stack = zai_get_trace_without_args(Z_ARR(stack));
}
zval_ptr_dtor(&stack);
return error_stack;
}
static int dd_fatal_error_to_meta(zend_array *meta, dd_error_info error) {
if (error.type) {
zval tmp = ddtrace_zval_zstr(zend_string_copy(error.type));
zend_symtable_str_update(meta, ZEND_STRL("error.type"), &tmp);
}
if (error.message) {
zval tmp = ddtrace_zval_zstr(zend_string_copy(error.message));
zend_symtable_str_update(meta, ZEND_STRL("error.message"), &tmp);
}
if (error.stack) {
zval tmp = ddtrace_zval_zstr(zend_string_copy(error.stack));
zend_symtable_str_update(meta, ZEND_STRL("error.stack"), &tmp);
}
return error.type && error.message ? SUCCESS : FAILURE;
}
static zend_result dd_add_meta_array(void *context, ddtrace_string key, ddtrace_string value) {
zval *meta = context, tmp = ddtrace_zval_stringl(value.ptr, value.len);
// meta array takes ownership of tmp
return zend_symtable_str_update(Z_ARR_P(meta), key.ptr, key.len, &tmp) != NULL ? SUCCESS : FAILURE;
}
static void dd_add_header_to_meta(zend_array *meta, const char *type, zend_string *lowerheader,
zend_string *headerval) {
// SIGNALFX: request headers also added based on SFX configuration option
bool add_dd_tag = zend_hash_exists(get_DD_TRACE_HEADER_TAGS(), lowerheader);
bool add_sfx_tag = strcmp(type, "request") == 0 &&
zend_hash_exists(get_SIGNALFX_CAPTURE_REQUEST_HEADERS(), lowerheader);
if (add_dd_tag || add_sfx_tag) {
for (char *ptr = ZSTR_VAL(lowerheader); *ptr; ++ptr) {
if ((*ptr < 'a' || *ptr > 'z') && *ptr != '-' && (*ptr < '0' || *ptr > '9')) {
*ptr = '_';
}
}
}
if (add_dd_tag) {
zend_string *headertag = zend_strpprintf(0, "http.%s.headers.%s", type, ZSTR_VAL(lowerheader));
zval headerzv;
ZVAL_STR_COPY(&headerzv, headerval);
zend_hash_update(meta, headertag, &headerzv);
zend_string_release(headertag);
}
if (add_sfx_tag) {
zend_string *headertag = zend_strpprintf(0, "http.request.header.%s", ZSTR_VAL(lowerheader));
zval headerzv;
ZVAL_STR_COPY(&headerzv, headerval);
zend_hash_update(meta, headertag, &headerzv);
zend_string_release(headertag);
}
}
void ddtrace_set_global_span_properties(ddtrace_span_data *span) {
zend_array *meta = ddtrace_spandata_property_meta(span);
zval value;
zend_string *version = get_DD_VERSION();
if (ZSTR_LEN(version) > 0) { // non-empty
ZVAL_STR_COPY(&value, version);
zend_hash_str_add_new(meta, ZEND_STRL("version"), &value);
}
zend_string *env = get_DD_ENV();
if (ZSTR_LEN(env) > 0) { // non-empty
ZVAL_STR_COPY(&value, env);
zend_hash_str_add_new(meta, ZEND_STRL("env"), &value);
}
if (DDTRACE_G(dd_origin)) {
ZVAL_STR_COPY(&value, DDTRACE_G(dd_origin));
zend_hash_str_add_new(meta, ZEND_STRL("_dd.origin"), &value);
}
zend_array *global_tags = get_DD_TAGS();
zend_string *global_key;
zval *global_val;
ZEND_HASH_FOREACH_STR_KEY_VAL(global_tags, global_key, global_val) {
if (zend_hash_add(meta, global_key, global_val)) {
Z_TRY_ADDREF_P(global_val);
}
}
ZEND_HASH_FOREACH_END();
zend_string *tag_key;
zval *tag_value;
ZEND_HASH_FOREACH_STR_KEY_VAL(DDTRACE_G(additional_global_tags), tag_key, tag_value) {
if (zend_hash_add(meta, tag_key, tag_value)) {
Z_TRY_ADDREF_P(tag_value);
}
}
ZEND_HASH_FOREACH_END();
ZVAL_STR(ddtrace_spandata_property_id(span), zend_strpprintf(DD_TRACE_MAX_ID_LEN, "%" PRIu64, span->span_id));
}
static const char *dd_get_req_uri() {
const char *uri = NULL;
zval *_server = &PG(http_globals)[TRACK_VARS_SERVER];
if (Z_TYPE_P(_server) == IS_ARRAY || zend_is_auto_global_str(ZEND_STRL("_SERVER"))) {
zval *req_uri = zend_hash_str_find(Z_ARRVAL_P(_server), ZEND_STRL("REQUEST_URI"));
if (req_uri && Z_TYPE_P(req_uri) == IS_STRING) {
uri = Z_STRVAL_P(req_uri);
}
}
if (!uri) {
uri = SG(request_info).request_uri;
}
return uri;
}
static const char *dd_get_query_string() {
const char *query_string = NULL;
zval *_server = &PG(http_globals)[TRACK_VARS_SERVER];
if (Z_TYPE_P(_server) == IS_ARRAY || zend_is_auto_global_str(ZEND_STRL("_SERVER"))) {
zval *query_str = zend_hash_str_find(Z_ARRVAL_P(_server), ZEND_STRL("QUERY_STRING"));
if (query_str && Z_TYPE_P(query_str) == IS_STRING) {
query_string = Z_STRVAL_P(query_str);
}
}
if (!query_string) {
query_string = SG(request_info).query_string;
}
return query_string;
}
static zend_string *dd_build_req_url() {
zval *_server = &PG(http_globals)[TRACK_VARS_SERVER];
const char *uri = dd_get_req_uri();
if (!uri) {
return ZSTR_EMPTY_ALLOC();
}
zend_bool is_https = zend_hash_str_exists(Z_ARRVAL_P(_server), ZEND_STRL("HTTPS"));
zval *host_zv;
if ((!(host_zv = zend_hash_str_find(Z_ARRVAL_P(_server), ZEND_STRL("HTTP_HOST"))) &&
!(host_zv = zend_hash_str_find(Z_ARRVAL_P(_server), ZEND_STRL("SERVER_NAME")))) ||
Z_TYPE_P(host_zv) != IS_STRING) {
return ZSTR_EMPTY_ALLOC();
}
int uri_len;
char *question_mark = strchr(uri, '?');
zend_string *query_string = ZSTR_EMPTY_ALLOC();
if (question_mark) {
uri_len = question_mark - uri;
query_string = zai_filter_query_string(
(zai_string_view){.len = strlen(uri) - uri_len - 1, .ptr = question_mark + 1},
get_DD_TRACE_HTTP_URL_QUERY_PARAM_ALLOWED(), get_DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP());
} else {
uri_len = strlen(uri);
}
zend_string *url =
zend_strpprintf(0, "http%s://%s%.*s%s%.*s", is_https ? "s" : "", Z_STRVAL_P(host_zv), uri_len, uri,
ZSTR_LEN(query_string) ? "?" : "", (int)ZSTR_LEN(query_string), ZSTR_VAL(query_string));
zend_string_release(query_string);
return url;
}
static zend_string *dd_get_user_agent() {
zval *_server = &PG(http_globals)[TRACK_VARS_SERVER];
if (Z_TYPE_P(_server) == IS_ARRAY || zend_is_auto_global_str(ZEND_STRL("_SERVER"))) {
zval *user_agent = zend_hash_str_find(Z_ARRVAL_P(_server), ZEND_STRL("HTTP_USER_AGENT"));
if (user_agent && Z_TYPE_P(user_agent) == IS_STRING) {
return Z_STR_P(user_agent);
}
}
return ZSTR_EMPTY_ALLOC();
}
// SIGNALFX: function to add component tag to root span
static void signalfx_set_meta_component(zend_array *meta, const char *component, size_t component_length) {
zval component_zv;
ZVAL_STR(&component_zv, zend_string_init(component, component_length, 0));
zend_hash_str_add_new(meta, ZEND_STRL("component"), &component_zv);
}
static void signalfx_set_meta_env_vars(zend_array *meta) {
zend_array *var_names = get_SIGNALFX_CAPTURE_ENV_VARS();
zend_string *var_name_zstr;
ZEND_HASH_FOREACH_STR_KEY(var_names, var_name_zstr) {
if (var_name_zstr == NULL) {
continue;
}
const char* var_name = ZSTR_VAL(var_name_zstr);
const char* value = getenv(var_name);
if (value != NULL) {
char tag_name[256];
snprintf(tag_name, sizeof(tag_name), "php.env.%s", var_name);
for (char* c = tag_name; *c; ++c) {
*c = tolower(*c);
}
zval zvalue;
zend_string* value_str = zend_string_init(value, strlen(value), 0);
ZVAL_STR_COPY(&zvalue, value_str);
zend_hash_str_add_new(meta, tag_name, strlen(tag_name), &zvalue);
zend_string_release(value_str);
}
} ZEND_HASH_FOREACH_END();
}
// SIGNALFX: set autoroot properties
void signalfx_set_autoroot_properties(ddtrace_span_data *span) {
zend_array *meta = ddtrace_spandata_property_meta(span);
signalfx_set_meta_component(meta, ZEND_STRL("web.request"));
signalfx_set_meta_env_vars(meta);
}
void ddtrace_set_root_span_properties(ddtrace_span_data *span) {
zend_array *meta = ddtrace_spandata_property_meta(span);
zend_hash_copy(meta, &DDTRACE_G(root_span_tags_preset), (copy_ctor_func_t)zval_add_ref);
datadog_php_uuid runtime_id = ddtrace_profiling_runtime_id();
if (!datadog_php_uuid_is_nil(runtime_id)) {
zend_string *encoded_id = zend_string_alloc(36, false);
/* Compilers rightfully complain about array bounds due to the struct
* hack if we write straight to the char storage. Saving the char* to a
* temporary avoids the warning without a performance penalty.
*/
char *tmp = ZSTR_VAL(encoded_id);
datadog_php_uuid_encode36(runtime_id, tmp);
ZSTR_VAL(encoded_id)[36] = '\0';
zval zv;
ZVAL_STR(&zv, encoded_id);
zend_hash_str_add_new(meta, ZEND_STRL("runtime-id"), &zv);
}
zval http_url;
ZVAL_STR(&http_url, dd_build_req_url());
if (Z_STRLEN(http_url)) {
zend_hash_str_add_new(meta, ZEND_STRL("http.url"), &http_url);
}
const char *method = SG(request_info).request_method;
if (method) {
zval http_method;
ZVAL_STR(&http_method, zend_string_init(method, strlen(method), 0));
zend_hash_str_add_new(meta, ZEND_STRL("http.method"), &http_method);
if (get_DD_TRACE_URL_AS_RESOURCE_NAMES_ENABLED()) {
const char *uri = dd_get_req_uri();
zval *prop_resource = ddtrace_spandata_property_resource(span);
if (uri) {
zend_string *path = zend_string_init(uri, strlen(uri), 0);
zend_string *normalized = ddtrace_uri_normalize_incoming_path(path);
zend_string *query_string = ZSTR_EMPTY_ALLOC();
const char *query_str = dd_get_query_string();
if (query_str) {
query_string =
zai_filter_query_string((zai_string_view){.len = strlen(query_str), .ptr = query_str},
get_DD_TRACE_RESOURCE_URI_QUERY_PARAM_ALLOWED(),
get_DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP());
}
ZVAL_STR(prop_resource, zend_strpprintf(0, "%s %s%s%.*s", method, ZSTR_VAL(normalized),
ZSTR_LEN(query_string) ? "?" : "", (int)ZSTR_LEN(query_string),
ZSTR_VAL(query_string)));
zend_string_release(query_string);
zend_string_release(normalized);
zend_string_release(path);
} else {
ZVAL_COPY(prop_resource, &http_method);
}
}
}
zend_string *user_agent = dd_get_user_agent();
if (user_agent && ZSTR_LEN(user_agent) > 0) {
zval http_useragent;
ZVAL_STR_COPY(&http_useragent, user_agent);
zend_hash_str_add_new(meta, ZEND_STRL("http.useragent"), &http_useragent);
}
zval *prop_type = ddtrace_spandata_property_type(span);
zval *prop_name = ddtrace_spandata_property_name(span);
if (strcmp(sapi_module.name, "cli") == 0) {
ZVAL_STR(prop_type, zend_string_init(ZEND_STRL("cli"), 0));
const char *script_name;
ZVAL_STR(prop_name,
(SG(request_info).argc > 0 && (script_name = SG(request_info).argv[0]) && script_name[0] != '\0')
? php_basename(script_name, strlen(script_name), NULL, 0)
: zend_string_init(ZEND_STRL("cli.command"), 0));
} else {
ZVAL_STR(prop_type, zend_string_init(ZEND_STRL("web"), 0));
ZVAL_STR(prop_name, zend_string_init(ZEND_STRL("web.request"), 0));
}
zval *prop_service = ddtrace_spandata_property_service(span);
ZVAL_STR_COPY(prop_service, ZSTR_LEN(get_DD_SERVICE()) ? get_DD_SERVICE() : Z_STR_P(prop_name));
if (Z_TYPE(PG(http_globals)[TRACK_VARS_SERVER]) == IS_ARRAY || zend_is_auto_global_str(ZEND_STRL("_SERVER"))) {
zend_string *headername;
zval *headerval;
ZEND_HASH_FOREACH_STR_KEY_VAL_IND(Z_ARR(PG(http_globals)[TRACK_VARS_SERVER]), headername, headerval) {
ZVAL_DEREF(headerval);
if (Z_TYPE_P(headerval) == IS_STRING && headername && ZSTR_LEN(headername) > 5 &&
memcmp(ZSTR_VAL(headername), "HTTP_", 5) == 0) {
zend_string *lowerheader = zend_string_init(ZSTR_VAL(headername) + 5, ZSTR_LEN(headername) - 5, 0);
for (char *ptr = ZSTR_VAL(lowerheader); *ptr; ++ptr) {
if (*ptr >= 'A' && *ptr <= 'Z') {
*ptr -= 'A' - 'a';
} else if (*ptr == '_') {
*ptr = '-';
}
}
dd_add_header_to_meta(meta, "request", lowerheader, Z_STR_P(headerval));
zend_string_release(lowerheader);
}
}
ZEND_HASH_FOREACH_END();
}
if (get_DD_TRACE_REPORT_HOSTNAME()) {
#ifndef HOST_NAME_MAX
#define HOST_NAME_MAX 255
#endif
zend_string *hostname = zend_string_alloc(HOST_NAME_MAX, 0);
if (gethostname(ZSTR_VAL(hostname), HOST_NAME_MAX + 1)) {
zend_string_release(hostname);
} else {
hostname = zend_string_truncate(hostname, strlen(ZSTR_VAL(hostname)), 0);
zval hostname_zv;
ZVAL_STR(&hostname_zv, hostname);
zend_hash_str_add_new(meta, ZEND_STRL("_dd.hostname"), &hostname_zv);
}
}
ddtrace_integration *web_integration = &ddtrace_integrations[DDTRACE_INTEGRATION_WEB];
zend_array *metrics = ddtrace_spandata_property_metrics(span);
if (get_DD_TRACE_ANALYTICS_ENABLED() || web_integration->is_analytics_enabled()) {
zval sample_rate;
ZVAL_DOUBLE(&sample_rate, web_integration->get_sample_rate());
zend_hash_str_add_new(metrics, ZEND_STRL("_dd1.sr.eausr"), &sample_rate);
}
zval pid;
ZVAL_DOUBLE(&pid, (double)getpid());
zend_hash_str_add_new(metrics, ZEND_STRL("process_id"), &pid);
}
static void _serialize_meta(zval *el, ddtrace_span_data *span) {
bool top_level_span = span->parent_id == DDTRACE_G(distributed_parent_trace_id);
zval meta_zv, *meta = ddtrace_spandata_property_meta_zval(span);
array_init(&meta_zv);
ZVAL_DEREF(meta);
if (Z_TYPE_P(meta) == IS_ARRAY) {
zend_string *str_key;
zval *orig_val, val_as_string;
ZEND_HASH_FOREACH_STR_KEY_VAL_IND(Z_ARRVAL_P(meta), str_key, orig_val) {
if (str_key) {
ddtrace_convert_to_string(&val_as_string, orig_val);
add_assoc_zval(&meta_zv, ZSTR_VAL(str_key), &val_as_string);
}
}
ZEND_HASH_FOREACH_END();
}
meta = &meta_zv;
zval *exception_zv = ddtrace_spandata_property_exception(span);
if (Z_TYPE_P(exception_zv) == IS_OBJECT && instanceof_function(Z_OBJCE_P(exception_zv), zend_ce_throwable)) {
ddtrace_exception_to_meta(Z_OBJ_P(exception_zv), meta, dd_add_meta_array);
}
if (top_level_span) {
if (SG(sapi_headers).http_response_code) {
add_assoc_str(meta, "http.status_code", zend_long_to_str(SG(sapi_headers).http_response_code));
if (SG(sapi_headers).http_response_code >= 500) {
zval zv = {0}, *value;
if ((value = zend_hash_str_add(Z_ARR_P(meta), ZEND_STRL("error.type"), &zv))) {
ZVAL_STR(value, zend_string_init(ZEND_STRL("Internal Server Error"), 0));
}
}
}
zend_llist_position pos;
zend_llist *sapi_headers = &SG(sapi_headers).headers;
for (sapi_header_struct *h = (sapi_header_struct *)zend_llist_get_first_ex(sapi_headers, &pos); h;
h = (sapi_header_struct *)zend_llist_get_next_ex(sapi_headers, &pos)) {
if (!h->header_len) {
next_header:
continue;
}
zend_string *lowerheader = zend_string_alloc(h->header_len, 0);
char *lowerptr = ZSTR_VAL(lowerheader), *header = h->header, *end = header + h->header_len;
for (; *header != ':'; ++header, ++lowerptr) {
if (header >= end) {
zend_string_release(lowerheader);
goto next_header;
}
*lowerptr = (char)(*header >= 'A' && *header <= 'Z' ? *header - ('A' - 'a') : *header);
}
// not actually RFC 7230 compliant (not allowing whitespace there), but most clients accept it. Handle it.
while (lowerptr > ZSTR_VAL(lowerheader) && isspace(lowerptr[-1])) {
--lowerptr;
}
*lowerptr = 0;
lowerheader = zend_string_truncate(lowerheader, lowerptr - ZSTR_VAL(lowerheader), 0);
if (header + 1 < end) {
++header;
}
while (header < end && isspace(*header)) {
++header;
}
while (end > header && isspace(end[-1])) {
--end;
}
zend_string *headerval = zend_string_init(header, end - header, 0);
dd_add_header_to_meta(Z_ARR_P(meta), "response", lowerheader, headerval);
zend_string_release(headerval);
zend_string_release(lowerheader);
}
}
zend_bool error = ddtrace_hash_find_ptr(Z_ARR_P(meta), ZEND_STRL("error.message")) ||
ddtrace_hash_find_ptr(Z_ARR_P(meta), ZEND_STRL("error.type"));
if (error) {
add_assoc_long(el, "error", 1);
}
if (zend_array_count(Z_ARRVAL_P(meta))) {
add_assoc_zval(el, "meta", meta);
} else {
zval_ptr_dtor(meta);
}
}
static bool dd_rule_matches(zval *pattern, zend_string* value) {
if (Z_TYPE_P(pattern) != IS_STRING) {
return false;
}
char *p = Z_STRVAL_P(pattern);
char *s = ZSTR_VAL(value);
int wildcards = 0;
while (*p) {
if (*(p++) == '*') {
++wildcards;
}
}
p = Z_STRVAL_P(pattern);
ALLOCA_FLAG(use_heap)
char **backtrack_points = do_alloca(wildcards * 2 * sizeof(char *), use_heap);
int backtrack_idx = 0;
while (*p) {
if (!*s) {
while (*p == '*') {
++p;
}
free_alloca(backtrack_points, use_heap);
return !*p;
}
if (*s == *p || *p == '.') {
++s, ++p;
} else if (*p == '*') {
backtrack_points[backtrack_idx++] = ++p;
backtrack_points[backtrack_idx++] = s;
} else {
do {
if (backtrack_idx > 0) {
backtrack_idx -= 2;
p = backtrack_points[backtrack_idx];
s = ++backtrack_points[backtrack_idx + 1];
} else {
free_alloca(backtrack_points, use_heap);
return false;
}
} while (!*s);
backtrack_idx += 2;
}
}
free_alloca(backtrack_points, use_heap);
return true;
}
static HashTable dd_span_sampling_limiters;
#if ZTS
static pthread_rwlock_t dd_span_sampling_limiter_lock;
#endif