-
Notifications
You must be signed in to change notification settings - Fork 175
Expand file tree
/
Copy pathserializer.c
More file actions
2177 lines (1900 loc) · 81.1 KB
/
serializer.c
File metadata and controls
2177 lines (1900 loc) · 81.1 KB
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 <Zend/zend_string.h>
#include <inttypes.h>
#include <php.h>
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
#include <ext/standard/php_string.h>
#include "zend_hash.h"
#include "zend_portability.h"
#include "zend_variables.h"
#include <components-rs/ddtrace.h>
#include <components-rs/sidecar.h>
#include <components-rs/ddtrace.h>
// comment to prevent clang from reordering these headers
#include <SAPI.h>
#include <exceptions/exceptions.h>
#include <json/json.h>
#include "process_tags.h"
#ifndef _WIN32
#include <stdatomic.h>
#else
#include <components/atomic_win32_polyfill.h>
#include <synchapi.h>
#endif
#include <vendor/mpack/mpack.h>
#include <zai_string/string.h>
#include <sandbox/sandbox.h>
#include <ext/standard/url.h>
#include "compat_string.h"
#include "ddtrace.h"
#include "engine_api.h"
#include "engine_hooks.h"
#include "git.h"
#include "ip_extraction.h"
#include <components/log/log.h>
#include "priority_sampling/priority_sampling.h"
#include "span.h"
#include "uri_normalization.h"
#include "user_request.h"
#include "ddshared.h"
#include "zend_hrtime.h"
#include "trace_source.h"
#include "exception_serialize.h"
#include "sidecar.h"
#include "span_stats.h"
#include "trace_filter.h"
ZEND_EXTERN_MODULE_GLOBALS(ddtrace);
extern void (*profiling_notify_trace_finished)(uint64_t local_root_span_id,
zai_str span_type,
zai_str resource);
static void mpack_write_utf8_lossy_cstr(mpack_writer_t *writer, const char *str, size_t len) {
if (get_global_DD_TRACE_SIDECAR_TRACE_SENDER()) {
char *strippedStr = ddtrace_strip_invalid_utf8(str, &len);
if (strippedStr) {
mpack_write_str(writer, strippedStr, len);
ddtrace_drop_rust_string(strippedStr, len);
return;
}
}
mpack_write_str(writer, str, len);
}
#define MAX_ID_BUFSIZ 40 // 3.4e^38 = 39 chars + 1 terminator
#define KEY_TRACE_ID "trace_id"
#define KEY_SPAN_ID "span_id"
#define KEY_PARENT_ID "parent_id"
#define KEY_META_STRUCT "meta_struct"
static int msgpack_write_zval(mpack_writer_t *writer, zval *trace, int level);
static void serialize_meta_struct(mpack_writer_t *writer, zval *trace);
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;
bool is_meta_struct = false;
if (is_assoc == 1) {
char num_str_buf[MAX_ID_BUFSIZ], *key;
size_t len;
if (string_key) {
key = ZSTR_VAL(string_key);
len = ZSTR_LEN(string_key);
} else {
key = num_str_buf;
len = sprintf(num_str_buf, ZEND_LONG_FMT, num_key);
}
mpack_write_utf8_lossy_cstr(writer, key, len);
// 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;
}
if (level <= 3 &&
(0 == strcmp(KEY_META_STRUCT, key))) {
is_meta_struct = true;
}
}
// Writing the value
if (zval_string_as_uint64) {
mpack_write_u64(writer, strtoull(Z_STRVAL_P(tmp), NULL, 10));
} else if(is_meta_struct) {
serialize_meta_struct(writer, tmp);
} 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_utf8_lossy_cstr(writer, Z_STRVAL_P(trace), Z_STRLEN_P(trace));
break;
default:
LOG(WARN, "Serialize values must be of type array, string, int, float, bool or null");
mpack_writer_flag_error(writer, mpack_error_type);
return 0;
}
return 1;
}
static void serialize_meta_struct(mpack_writer_t *writer, zval *meta_struct) {
zval *tmp;
zend_string *string_key;
HashTable *ht = Z_ARRVAL_P(meta_struct);
mpack_start_map(writer, zend_hash_num_elements(ht));
ZEND_HASH_FOREACH_STR_KEY_VAL_IND(ht, string_key, tmp) {
if (!string_key) {
continue;
}
mpack_write_cstr(writer, ZSTR_VAL(string_key));
mpack_write_bin(writer, Z_STRVAL_P(tmp), Z_STRLEN_P(tmp));
}
ZEND_HASH_FOREACH_END();
mpack_finish_map(writer);
}
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;
}
}
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;
}
}
typedef struct dd_error_info {
zend_string *type;
zend_string *msg;
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.msg) {
zval tmp = ddtrace_zval_zstr(zend_string_copy(error.msg));
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.msg ? SUCCESS : FAILURE;
}
static void dd_add_header_to_meta(zend_array *meta, const char *type, zend_string *lowerheader,
zend_string *headerval) {
zval *header_config = zend_hash_find(get_DD_TRACE_HEADER_TAGS(), lowerheader);
if (header_config != NULL && Z_TYPE_P(header_config) == IS_STRING) {
zend_string *header_config_str = Z_STR_P(header_config);
zend_string *headertag;
if (ZSTR_LEN(header_config_str) == 0) {
for (char *ptr = ZSTR_VAL(lowerheader); *ptr; ++ptr) {
if ((*ptr < 'a' || *ptr > 'z') && *ptr != '-' && (*ptr < '0' || *ptr > '9')) {
*ptr = '_';
}
}
headertag = zend_strpprintf(0, "http.%s.headers.%s", type, ZSTR_VAL(lowerheader));
} else {
headertag = zend_string_copy(header_config_str);
}
zval headerzv;
ZVAL_STR_COPY(&headerzv, headerval);
zend_hash_update(meta, headertag, &headerzv);
zend_string_release(headertag);
}
}
static void dd_add_header_to_rust_span(ddog_SpanBytes *span, const char *type, zend_string *lowerheader,
zend_string *headerval) {
zval *header_config = zend_hash_find(get_DD_TRACE_HEADER_TAGS(), lowerheader);
if (header_config != NULL && Z_TYPE_P(header_config) == IS_STRING) {
zend_string *header_config_str = Z_STR_P(header_config);
zend_string *headertag;
if (ZSTR_LEN(header_config_str) == 0) {
for (char *ptr = ZSTR_VAL(lowerheader); *ptr; ++ptr) {
if ((*ptr < 'a' || *ptr > 'z') && *ptr != '-' && (*ptr < '0' || *ptr > '9')) {
*ptr = '_';
}
}
headertag = zend_strpprintf(0, "http.%s.headers.%s", type, ZSTR_VAL(lowerheader));
} else {
headertag = zend_string_copy(header_config_str);
}
ddog_add_span_meta_zstr(span, headertag, headerval);
zend_string_release(headertag);
}
}
static void normalize_with_underscores(zend_string *str) {
for (char *ptr = ZSTR_VAL(str); *ptr; ++ptr) {
// Replace non-alphanumeric/dashes by underscores
if ((*ptr < 'a' || *ptr > 'z')
&& (*ptr < 'A' || *ptr > 'Z')
&& (*ptr < '0' || *ptr > '9')
&& *ptr != '-') {
*ptr = '_';
}
}
}
static void dd_add_post_fields_to_meta(zend_array *meta, const char *type, zend_string *postkey, zend_string *postval) {
zend_string *posttag = zend_strpprintf(0, "http.%s.post.%s", type, ZSTR_VAL(postkey));
zval postzv;
ZVAL_STR_COPY(&postzv, postval);
zend_hash_update(meta, posttag, &postzv);
zend_string_release(posttag);
}
static void dd_add_post_fields_to_meta_recursive(zend_array *meta, const char *type, zend_string *postkey,
zval *postval, zend_array* post_whitelist,
bool is_prefixed) {
if (Z_TYPE_P(postval) == IS_ARRAY) {
zend_ulong index;
zend_string *key;
zval *val;
ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(postval), index, key, val) {
if (key) {
zend_string *copy_key = zend_string_dup(key, 0);
normalize_with_underscores(copy_key);
if (ZSTR_LEN(postkey) == 0) {
dd_add_post_fields_to_meta_recursive(meta, type, copy_key, val, post_whitelist,
is_prefixed || zend_hash_exists(post_whitelist, copy_key));
} else {
// If the current postkey is not the empty string, we want to add a '.' to the beginning of the key
zend_string *newkey = zend_strpprintf(0, "%s.%s", ZSTR_VAL(postkey), ZSTR_VAL(copy_key));
dd_add_post_fields_to_meta_recursive(meta, type, newkey, val, post_whitelist,
is_prefixed || zend_hash_exists(post_whitelist, newkey));
zend_string_release(newkey);
}
zend_string_release(copy_key);
} else {
// Use numeric index if there isn't a string key
zend_string *newkey = zend_strpprintf(0, "%s." ZEND_LONG_FMT, ZSTR_VAL(postkey), index);
dd_add_post_fields_to_meta_recursive(meta, type, newkey, val, post_whitelist,
is_prefixed || zend_hash_exists(post_whitelist, newkey));
zend_string_release(newkey);
}
}
ZEND_HASH_FOREACH_END();
} else {
if (is_prefixed) { // The postkey is in the whitelist or is prefixed by a key in the whitelist
// we want to add it to the meta as is
zend_string *ztr_postval = zval_get_string(postval);
dd_add_post_fields_to_meta(meta, type, postkey, ztr_postval);
zend_string_release(ztr_postval);
} else if (post_whitelist) {
zend_string *str;
zend_ulong numkey;
zend_hash_get_current_key(post_whitelist, &str, &numkey);
if (str && zend_string_equals_literal(str, "*")) { // '*' is a wildcard for the whitelist
// Here, both the postkey and postval are strings, so we can concatenate them into "<postkey>=<postval>"
zend_string *postvalstr = zval_get_string(postval);
zend_string *postvalconcat = zend_strpprintf(0, "%s=%s", ZSTR_VAL(postkey), ZSTR_VAL(postvalstr));
zend_string_release(postvalstr);
// Match it with the regex to redact if needed
if (zai_match_regex(get_DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP(), postvalconcat)) {
zend_string *replacement = zend_string_init(ZEND_STRL("<redacted>"), 0);
dd_add_post_fields_to_meta(meta, type, postkey, replacement);
zend_string_release(replacement);
} else {
dd_add_post_fields_to_meta(meta, type, postkey, postvalstr);
}
zend_string_release(postvalconcat);
} else { // No wildcard and the postkey isn't in the whitelist
// Always use "<redacted>" as the value
zend_string *replacement = zend_string_init(ZEND_STRL("<redacted>"), 0);
dd_add_post_fields_to_meta(meta, type, postkey, replacement);
zend_string_release(replacement);
}
} else { // No whitelist, so we always use "<redacted>" as the value
zend_string *replacement = zend_string_init(ZEND_STRL("<redacted>"), 0);
dd_add_post_fields_to_meta(meta, type, postkey, replacement);
zend_string_release(replacement);
}
}
}
void ddtrace_set_global_span_properties(ddtrace_span_data *span) {
zend_array *meta = ddtrace_property_array(&span->property_meta);
zend_array *global_tags = get_DD_TAGS();
zend_string *global_key;
zval *global_val;
zval *prop_env = &span->property_env;
zval *prop_version = &span->property_version;
ZEND_HASH_FOREACH_STR_KEY_VAL(global_tags, global_key, global_val) {
if ((zend_string_equals_literal(global_key, "env") && Z_TYPE_P(prop_env) == IS_STRING && Z_STRLEN_P(prop_env) > 0) ||
(zend_string_equals_literal(global_key, "version") && Z_TYPE_P(prop_version) == IS_STRING && Z_STRLEN_P(prop_version) > 0) ||
zend_string_equals_literal(global_key, "service")) {
continue;
}
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_ptr_dtor(&span->property_id);
ZVAL_STR(&span->property_id, ddtrace_span_id_as_string(span->span_id));
}
static const char *dd_get_req_uri(zend_array *_server) {
const char *uri = NULL;
if (_server) {
zval *req_uri = zend_hash_str_find(_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(zend_array *_server) {
const char *query_string = NULL;
if (_server) {
zval *query_str = zend_hash_str_find(_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(zend_array *_server) {
const char *uri = dd_get_req_uri(_server);
if (!uri) {
return ZSTR_EMPTY_ALLOC();
}
zval *https = zend_hash_str_find(_server, ZEND_STRL("HTTPS"));
bool is_https = https && i_zend_is_true(https);
zval *host_zv;
if ((!(host_zv = zend_hash_str_find(_server, ZEND_STRL("HTTP_HOST"))) &&
!(host_zv = zend_hash_str_find(_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_str)ZAI_STR_NEW(question_mark + 1, strlen(uri) - uri_len - 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) ? "?" : "", ZSTR_VAL(query_string));
zend_string_release(query_string);
return url;
}
static zend_string *dd_get_user_agent(zend_array *_server) {
if (_server) {
zval *user_agent = zend_hash_str_find(_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();
}
static zend_string *dd_get_referrer_host(zend_array *_server) {
if (_server) {
zval *referer = zend_hash_str_find(_server, ZEND_STRL("HTTP_REFERER"));
if (referer && Z_TYPE_P(referer) == IS_STRING) {
php_url *url = php_url_parse(Z_STRVAL_P(referer));
if (url && url->host) {
#if PHP_VERSION_ID >= 70300
zend_string *host_str = zend_string_init(ZSTR_VAL(url->host), ZSTR_LEN(url->host), 0);
#else
zend_string *host_str = zend_string_init(url->host, strlen(url->host), 0);
#endif
php_url_free(url);
return host_str;
}
if (url) {
php_url_free(url);
}
}
}
return ZSTR_EMPTY_ALLOC();
}
static bool dd_set_mapped_peer_service(ddog_SpanBytes *span, zend_string *peer_service) {
zend_array *peer_service_mapping = get_DD_TRACE_PEER_SERVICE_MAPPING();
if (zend_hash_num_elements(peer_service_mapping) == 0 || !peer_service) {
return false;
}
zval* mapped_service_zv = zend_hash_find(peer_service_mapping, peer_service);
if (mapped_service_zv) {
zend_string *mapped_service = zval_get_string(mapped_service_zv);
ddog_add_str_span_meta_zstr(span, "peer.service.remapped_from", peer_service);
ddog_add_str_span_meta_zstr(span, "peer.service", mapped_service);
zend_string_release(mapped_service);
return true;
}
return false;
}
void ddtrace_update_root_id_properties(ddtrace_root_span_data *span) {
zval zv;
ZVAL_STR(&zv, ddtrace_trace_id_as_hex_string(span->trace_id));
ddtrace_assign_variable(&span->property_trace_id, &zv);
if (span->parent_id) {
ZVAL_STR(&zv, ddtrace_span_id_as_string(span->parent_id));
} else {
ZVAL_UNDEF(&zv);
}
ddtrace_assign_variable(&span->property_parent_id, &zv);
}
struct superglob_equiv {
zend_array *server;
zend_array *post;
};
static void dd_set_entrypoint_root_span_props(struct superglob_equiv *data, ddtrace_root_span_data *span) {
zend_array *meta = ddtrace_property_array(&span->property_meta);
if (data->server){
zend_string *http_url = dd_build_req_url(data->server);
if (ZSTR_LEN(http_url) > 0) {
zval http_url_zv;
ZVAL_STR(&http_url_zv, http_url);
zend_hash_str_add_new(meta, ZEND_STRL("http.url"), &http_url_zv);
}
}
const char *method = SG(request_info).request_method;
// run-tests.php sets the env var REQUEST_METHOD, which ends up in $_SERVER
// To avoid having dozens of tests failing, ignore REQUEST_METHOD if such an env var exists
static int has_env_req_method;
if (!has_env_req_method) {
has_env_req_method = getenv("REQUEST_METHOD") ? 1 : -1;
}
if (!method && data->server && has_env_req_method == -1) {
zval *method_zv = zend_hash_str_find(data->server, ZEND_STRL("REQUEST_METHOD"));
if (method_zv && Z_TYPE_P(method_zv) == IS_STRING) {
method = Z_STRVAL_P(method_zv);
}
}
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);
// Mark HTTP server entry spans with span.kind=server for client-side stats aggregation.
// Only add if not already set (e.g. by an OTel or framework integration).
zval span_kind_server;
ZVAL_STRING(&span_kind_server, "server");
if (!zend_hash_str_add(meta, ZEND_STRL("span.kind"), &span_kind_server)) {
zval_ptr_dtor(&span_kind_server);
}
if (get_DD_TRACE_URL_AS_RESOURCE_NAMES_ENABLED()) {
const char *uri = dd_get_req_uri(data->server);
zval *prop_resource = &span->property_resource;
zval_ptr_dtor(prop_resource);
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(data->server);
if (query_str) {
query_string = zai_filter_query_string((zai_str)ZAI_STR_FROM_CSTR(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) ? "?" : "", ZSTR_VAL(query_string)));
zend_string_release(query_string);
zend_string_release(normalized);
zend_string_release(path);
} else {
ZVAL_COPY(prop_resource, &http_method);
}
}
}
if (get_DD_TRACE_CLIENT_IP_ENABLED() && data->server) {
zval server_zv;
ZVAL_ARR(&server_zv, data->server);
ddtrace_extract_ip_from_headers(&server_zv, meta);
}
zend_string *user_agent = dd_get_user_agent(data->server);
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);
}
zend_string *referrer_host = dd_get_referrer_host(data->server);
if (referrer_host && ZSTR_LEN(referrer_host) > 0) {
zval http_referrer_host;
ZVAL_STR(&http_referrer_host, referrer_host);
zend_hash_str_add_new(meta, ZEND_STRL("http.referrer_hostname"), &http_referrer_host);
}
if (data->server) {
zend_string *headername;
zval *headerval;
ZEND_HASH_FOREACH_STR_KEY_VAL_IND(data->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 (data->post && zend_hash_num_elements(get_DD_TRACE_HTTP_POST_DATA_PARAM_ALLOWED())) {
zval post_zv;
ZVAL_ARR(&post_zv, data->post);
zend_string *empty = ZSTR_EMPTY_ALLOC();
dd_add_post_fields_to_meta_recursive(meta, "request", empty, &post_zv, get_DD_TRACE_HTTP_POST_DATA_PARAM_ALLOWED(), false);
zend_string_release(empty);
}
}
void ddtrace_inherit_span_properties(ddtrace_span_data *span, ddtrace_span_data *parent) {
zval *prop_service = &span->property_service;
zval_ptr_dtor(prop_service);
ZVAL_COPY_DEREF(prop_service, &parent->property_service);
zval *prop_type = &span->property_type;
zval_ptr_dtor(prop_type);
ZVAL_COPY_DEREF(prop_type, &parent->property_type);
zval *prop_baggage = &span->property_baggage, *prop_parent_baggage = &parent->property_baggage;
zval_ptr_dtor(prop_baggage);
ZVAL_COPY_DEREF(prop_baggage, prop_parent_baggage);
zend_array *parent_meta = ddtrace_property_array(&parent->property_meta);
zval *prop_version = &span->property_version;
zval_ptr_dtor(prop_version);
zval *version;
if ((version = zend_hash_str_find(parent_meta, ZEND_STRL("version")))) {
zval old = *version;
ddtrace_convert_to_string(version, version);
zval_ptr_dtor(&old);
} else {
version = &parent->property_version;
}
ZVAL_COPY_DEREF(prop_version, version);
zval *prop_env = &span->property_env;
zval_ptr_dtor(prop_env);
zval *env;
if ((env = zend_hash_str_find(parent_meta, ZEND_STRL("env")))) {
zval old = *env;
ddtrace_convert_to_string(env, env);
zval_ptr_dtor(&old);
} else {
env = &parent->property_env;
}
ZVAL_COPY_DEREF(prop_env, env);
}
zend_string *ddtrace_default_service_name(void) {
if (strcmp(sapi_module.name, "cli") != 0) {
return zend_string_init(ZEND_STRL("web.request"), 0);
}
const char *script_name;
if (SG(request_info).argc > 0 && (script_name = SG(request_info).argv[0]) && script_name[0] != '\0') {
return php_basename(script_name, strlen(script_name), NULL, 0);
} else {
return zend_string_init(ZEND_STRL("cli.command"), 0);
}
}
zend_string *ddtrace_active_service_name(void) {
ddtrace_span_data *span = ddtrace_active_span();
if (span) {
return ddtrace_convert_to_str(&span->property_service);
}
zend_string *ini_service = get_DD_SERVICE();
if (ZSTR_LEN(ini_service)) {
return zend_string_copy(ini_service);
}
return ddtrace_default_service_name();
}
void ddtrace_set_root_span_properties(ddtrace_root_span_data *span) {
ddtrace_update_root_id_properties(span);
span->sampling_rule.rule = INT32_MAX;
zend_array *meta = ddtrace_property_array(&span->property_meta);
zend_array *metrics = ddtrace_property_array(&span->property_metrics);
zend_hash_copy(meta, &DDTRACE_G(root_span_tags_preset), (copy_ctor_func_t)zval_add_ref);
/* 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.
*/
zend_string *encoded_id = zend_string_alloc(36, false);
ddtrace_format_runtime_id((uint8_t(*)[36])&ZSTR_VAL(encoded_id));
ZSTR_VAL(encoded_id)[36] = '\0';
zval zv;
ZVAL_STR(&zv, encoded_id);
zend_hash_str_add_new(meta, ZEND_STRL("runtime-id"), &zv);
if (ddtrace_span_is_entrypoint_root(&span->span)) {
struct superglob_equiv data = {0};
{
zval *_server_zv = &PG(http_globals)[TRACK_VARS_SERVER];
if (Z_TYPE_P(_server_zv) == IS_ARRAY || zend_is_auto_global_str(ZEND_STRL("_SERVER"))) {
data.server = Z_ARRVAL_P(_server_zv);
}
}
{
zval *_post_zv = &PG(http_globals)[TRACK_VARS_POST];
if (Z_TYPE_P(_post_zv) == IS_ARRAY || zend_is_auto_global_str(ZEND_STRL("_POST"))) {
data.post = Z_ARRVAL_P(_post_zv);
}
}
dd_set_entrypoint_root_span_props(&data, span);
}
if (get_DD_TRACE_REPORT_HOSTNAME()) {
if (ZSTR_LEN(get_DD_HOSTNAME())) {
zval hostname_zv;
ZVAL_STR_COPY(&hostname_zv, get_DD_HOSTNAME());
zend_hash_str_add_new(meta, ZEND_STRL("_dd.hostname"), &hostname_zv);
} else {
#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_root_span_data *parent_root = span->stack->parent_stack->root_span;
if (parent_root) {
ddtrace_inherit_span_properties(&span->span, &parent_root->span);
ZVAL_COPY_DEREF(&span->property_origin, &parent_root->property_origin);
} else {
zval *prop_type = &span->property_type;
zval *prop_name = &span->property_name;
zval *prop_service = &span->property_service;
zval *prop_env = &span->property_env;
zval *prop_version = &span->property_version;
if (strcmp(sapi_module.name, "cli") == 0) {
zval_ptr_dtor(prop_type);
ZVAL_STR(prop_type, zend_string_init(ZEND_STRL("cli"), 0));
} else {
zval_ptr_dtor(prop_type);
ZVAL_STR(prop_type, zend_string_init(ZEND_STRL("web"), 0));
}
zval_ptr_dtor(prop_name);
ZVAL_STR(prop_name, ddtrace_default_service_name());
zval_ptr_dtor(prop_service);
ZVAL_STR_COPY(prop_service, ZSTR_LEN(get_DD_SERVICE()) ? get_DD_SERVICE() : Z_STR_P(prop_name));
zend_string *version = get_DD_VERSION();
if (ZSTR_LEN(version) > 0) { // non-empty
zval_ptr_dtor(prop_version);
ZVAL_STR_COPY(prop_version, version);
}
zend_string *env = get_DD_ENV();
if (ZSTR_LEN(env) > 0) { // non-empty
zval_ptr_dtor(prop_env);
ZVAL_STR_COPY(prop_env, env);
}
if (DDTRACE_G(dd_origin)) {
ZVAL_STR_COPY(&span->property_origin, DDTRACE_G(dd_origin));
}
if (DDTRACE_G(tracestate)) {
ZVAL_STR_COPY(&span->property_tracestate, DDTRACE_G(tracestate));
}
SEPARATE_ARRAY(&span->property_propagated_tags);
zend_hash_copy(Z_ARR(span->property_propagated_tags), &DDTRACE_G(propagated_root_span_tags), zval_add_ref);
SEPARATE_ARRAY(&span->property_tracestate_tags);
zend_hash_copy(Z_ARR(span->property_tracestate_tags), &DDTRACE_G(tracestate_unknown_dd_keys), zval_add_ref);
SEPARATE_ARRAY(&span->property_baggage);
zend_hash_copy(Z_ARR(span->property_baggage), &DDTRACE_G(baggage), zval_add_ref);
if (DDTRACE_G(propagated_priority_sampling) != DDTRACE_PRIORITY_SAMPLING_UNSET) {
ZVAL_LONG(&span->property_propagated_sampling_priority, DDTRACE_G(propagated_priority_sampling));
}
if (DDTRACE_G(default_priority_sampling) != DDTRACE_PRIORITY_SAMPLING_UNKNOWN) {
ddtrace_set_priority_sampling_on_span(span, DDTRACE_G(default_priority_sampling), DD_MECHANISM_MANUAL);
}
if (DDTRACE_G(asm_event_emitted)) {
span->asm_event_emitted = DDTRACE_G(asm_event_emitted);
DDTRACE_G(asm_event_emitted) = false; // we attach this to the first root span after the asm event was detected (if there was none while emitted)
}
ddtrace_integration *web_integration = &ddtrace_integrations[DDTRACE_INTEGRATION_WEB];
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);
}
if (get_DD_TRACE_GIT_METADATA_ENABLED()) {
ddtrace_inject_git_metadata(&span->property_git_metadata);
}
}
zval pid;
ZVAL_DOUBLE(&pid, (double)getpid());
zend_hash_str_add_new(metrics, ZEND_STRL("process_id"), &pid);
}
static void _dd_serialize_json(zend_array *arr, smart_str *buf, int options) {
zval zv;
ZVAL_ARR(&zv, arr);
zai_json_encode(buf, &zv, options);
smart_str_0(buf);
}
static void dd_serialize_array_recursively(ddog_SpanBytes *target, zend_string *str, zval *value, bool convert_to_double) {
ZVAL_DEREF(value);
if (Z_TYPE_P(value) == IS_ARRAY || Z_TYPE_P(value) == IS_OBJECT) {
zend_array *arr;
if (Z_TYPE_P(value) == IS_OBJECT) {
#if PHP_VERSION_ID >= 70400
arr = zend_get_properties_for(value, ZEND_PROP_PURPOSE_JSON);
#else
arr = Z_OBJPROP_P(value);
#endif
} else {
arr = Z_ARR_P(value);
}
if (zend_hash_num_elements(arr) && !GC_IS_RECURSIVE(arr)) {
GC_PROTECT_RECURSION(arr);
zval *val;
zend_string *str_key;
zend_ulong num_key;
ZEND_HASH_FOREACH_KEY_VAL_IND(arr, num_key, str_key, val) {
zend_string *key;
if (str_key) {
if (ZSTR_VAL(str_key)[0] == '\0' && ZSTR_LEN(str_key) > 0) {
// Skip protected and private members
continue;
}
key = zend_strpprintf(0, "%.*s.%.*s", (int)ZSTR_LEN(str), ZSTR_VAL(str), (int)ZSTR_LEN(str_key), ZSTR_VAL(str_key));
} else {
key = zend_strpprintf(0, "%.*s." ZEND_LONG_FMT, (int)ZSTR_LEN(str), ZSTR_VAL(str), num_key);
}
dd_serialize_array_recursively(target, key, val, convert_to_double);
zend_string_release(key);
} ZEND_HASH_FOREACH_END();
GC_UNPROTECT_RECURSION(arr);
} else if (convert_to_double) {
ddog_add_span_metrics_zstr(target, str, 0.0);
} else {
ddog_add_zstr_span_meta_str(target, str, "");
}
#if PHP_VERSION_ID >= 70400
if (Z_TYPE_P(value) == IS_OBJECT) {
zend_release_properties(arr);
}
#endif
} else if (convert_to_double) {
ddog_add_span_metrics_zstr(target, str, zval_get_double(value));
} else {
zval val_as_string;
ddtrace_convert_to_string(&val_as_string, value);
ddog_add_span_meta_zstr(target, str, Z_STR_P(&val_as_string));
zval_ptr_dtor(&val_as_string);
}
}
static void dd_serialize_array_meta_recursively(ddog_SpanBytes *target, zend_string *str, zval *value) {
dd_serialize_array_recursively(target, str, value, false);
}
static void dd_serialize_array_metrics_recursively(ddog_SpanBytes *target, zend_string *str, zval *value) {