-
Notifications
You must be signed in to change notification settings - Fork 779
/
LogAccess.cc
1400 lines (1103 loc) · 45.3 KB
/
LogAccess.cc
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
/** @file
This file implements the LogAccess class.
@section license License
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@section description
This file implements the LogAccess class. However, LogAccess is an
abstract base class, providing an interface that logging uses to get
information from a module, such as HTTP or ICP. Each module derives a
specific implementation from this base class (such as LogAccessHttp), and
implements the virtual accessor functions there.
The LogAccess class also defines a set of static functions that are used
to provide support for marshalling and unmarshalling support for the other
LogAccess derived classes.
*/
#include "ts/ink_platform.h"
#include "HTTP.h"
#include "P_Net.h"
#include "P_Cache.h"
#include "I_Machine.h"
#include "LogAccess.h"
#include "LogField.h"
#include "LogFilter.h"
#include "LogUtils.h"
#include "LogFormat.h"
#include "LogObject.h"
#include "LogConfig.h"
#include "LogBuffer.h"
#include "Log.h"
#define LOG_ACCESS_DEFAULT_FIELD(name, impl) \
int LogAccess::name(char *buf) { impl; }
/*-------------------------------------------------------------------------
LogAccess::init
-------------------------------------------------------------------------*/
void
LogAccess::init()
{
if (initialized) {
return;
}
//
// Here is where we would perform any initialization code.
//
initialized = true;
}
/*-------------------------------------------------------------------------
The following functions provide a default implementation for the base
class marshalling routines so that each subsequent LogAccess* class only
has to implement those functions that are to override this default
implementation.
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_plugin_identity_id, DEFAULT_INT_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_plugin_identity_tag, DEFAULT_STR_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_client_host_ip, DEFAULT_IP_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_host_interface_ip, DEFAULT_IP_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_cache_lookup_url_canon, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_host_port, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_auth_user_name, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_text, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_http_method, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_url, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_url_canon, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_unmapped_url_canon, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_unmapped_url_path, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_unmapped_url_host, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_url_path, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_url_scheme, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
This case is special because it really stores 2 ints.
-------------------------------------------------------------------------*/
int
LogAccess::marshal_client_req_http_version(char *buf)
{
if (buf) {
int64_t major = 0;
int64_t minor = 0;
marshal_int(buf, major);
marshal_int((buf + INK_MIN_ALIGN), minor);
}
return (2 * INK_MIN_ALIGN);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_protocol_version, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_header_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_content_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_tcp_reused, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_is_ssl, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_ssl_reused, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_security_protocol, DEFAULT_STR_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_client_security_cipher_suite, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_finish_status_code, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_id, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_uuid, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_resp_content_type, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_resp_squid_len, DEFAULT_INT_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_squid_len, DEFAULT_INT_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_req_squid_len, DEFAULT_INT_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_server_resp_squid_len, DEFAULT_INT_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_cache_resp_squid_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_resp_content_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_resp_status_code, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_resp_header_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_finish_status_code, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_cache_result_code, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_cache_hit_miss, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_req_header_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_req_content_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_req_server_name, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_req_server_ip, DEFAULT_IP_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_req_server_port, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_hierarchy_route, DEFAULT_INT_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_client_retry_after_time, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_proxy_host_name(char *buf)
{
char *str = nullptr;
int len = 0;
Machine *machine = Machine::instance();
if (machine) {
str = machine->hostname;
}
len = LogAccess::strlen(str);
if (buf) {
marshal_str(buf, str, len);
}
return len;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_proxy_host_ip(char *buf)
{
return marshal_ip(buf, &Machine::instance()->ip.sa);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_req_is_ssl, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_server_host_ip, DEFAULT_IP_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_server_host_name, DEFAULT_STR_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_server_resp_status_code, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_server_resp_content_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_server_resp_header_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
This case is special because it really stores 2 ints.
-------------------------------------------------------------------------*/
int
LogAccess::marshal_server_resp_http_version(char *buf)
{
if (buf) {
int64_t major = 0;
int64_t minor = 0;
marshal_int(buf, major);
marshal_int((buf + INK_MIN_ALIGN), minor);
}
return (2 * INK_MIN_ALIGN);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_server_resp_time_ms, DEFAULT_INT_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_server_resp_time_s, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_server_transact_count, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_server_connect_attempts, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_cache_resp_status_code, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_cache_resp_content_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_cache_resp_header_len, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
This case is special because it really stores 2 ints.
-------------------------------------------------------------------------*/
int
LogAccess::marshal_cache_resp_http_version(char *buf)
{
if (buf) {
int64_t major = 0;
int64_t minor = 0;
marshal_int(buf, major);
marshal_int((buf + INK_MIN_ALIGN), minor);
}
return (2 * INK_MIN_ALIGN);
}
LOG_ACCESS_DEFAULT_FIELD(marshal_cache_write_code, DEFAULT_INT_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_cache_write_transform_code, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_transfer_time_ms, DEFAULT_INT_FIELD)
LOG_ACCESS_DEFAULT_FIELD(marshal_transfer_time_s, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_file_size, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_http_header_field(LogField::Container /* container ATS_UNUSED */, char * /* field ATS_UNUSED */, char *buf)
{
DEFAULT_STR_FIELD;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_http_header_field_escapify(LogField::Container /* container ATS_UNUSED */, char * /* field ATS_UNUSED */,
char *buf)
{
DEFAULT_STR_FIELD;
}
LOG_ACCESS_DEFAULT_FIELD(marshal_proxy_host_port, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
The following functions have a non-virtual base-class implementation.
-------------------------------------------------------------------------*/
/*-------------------------------------------------------------------------
LogAccess::marshal_client_req_timestamp_sec
This does nothing because the timestamp is already in the LogEntryHeader.
-------------------------------------------------------------------------*/
LOG_ACCESS_DEFAULT_FIELD(marshal_client_req_timestamp_sec, DEFAULT_INT_FIELD)
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_entry_type(char *buf)
{
if (buf) {
int64_t val = (int64_t)entry_type();
marshal_int(buf, val);
}
return INK_MIN_ALIGN;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_process_uuid(char *buf)
{
int len = round_strlen(TS_UUID_STRING_LEN + 1);
if (buf) {
const char *str = (char *)Machine::instance()->uuid.getString();
marshal_str(buf, str, len);
}
return len;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_config_int_var(char *config_var, char *buf)
{
if (buf) {
int64_t val = (int64_t)REC_ConfigReadInteger(config_var);
marshal_int(buf, val);
}
return INK_MIN_ALIGN;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_config_str_var(char *config_var, char *buf)
{
char *str = nullptr;
str = REC_ConfigReadString(config_var);
int len = LogAccess::strlen(str);
if (buf) {
marshal_str(buf, str, len);
}
ats_free(str);
return len;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_milestone(TSMilestonesType ms, char *buf)
{
DEFAULT_INT_FIELD;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
int
LogAccess::marshal_milestone_diff(TSMilestonesType ms1, TSMilestonesType ms2, char *buf)
{
DEFAULT_INT_FIELD;
}
// To allow for a generic marshal_record function, rather than
// multiple functions (one per data type) we always marshal a record
// as a string of a fixed length. We use a fixed length because the
// marshal_record function can be called with a null *buf to request
// the length of the record, and later with a non-null *buf to
// actually request the record to be inserted in the buffer, and both
// calls should return the same number of characters. If we did not
// enforce a fixed size, this would not necessarily be the case
// because records --statistics in particular-- can potentially change
// between one call and the other.
//
int
LogAccess::marshal_record(char *record, char *buf)
{
const unsigned int max_chars = MARSHAL_RECORD_LENGTH;
if (nullptr == buf) {
return max_chars;
}
const char *record_not_found_msg = "RECORD_NOT_FOUND";
const unsigned int record_not_found_chars = ::strlen(record_not_found_msg) + 1;
char ascii_buf[max_chars];
const char *out_buf;
unsigned int num_chars;
#define LOG_INTEGER RECD_INT
#define LOG_COUNTER RECD_COUNTER
#define LOG_FLOAT RECD_FLOAT
#define LOG_STRING RECD_STRING
RecDataT stype = RECD_NULL;
bool found = false;
if (RecGetRecordDataType(record, &stype) != REC_ERR_OKAY) {
out_buf = "INVALID_RECORD";
num_chars = ::strlen(out_buf) + 1;
} else {
if (LOG_INTEGER == stype || LOG_COUNTER == stype) {
// we assume MgmtInt and MgmtIntCounter are int64_t for the
// conversion below, if this ever changes we should modify
// accordingly
//
ink_assert(sizeof(int64_t) >= sizeof(RecInt) && sizeof(int64_t) >= sizeof(RecCounter));
// so that a 64 bit integer will fit (including sign and eos)
//
ink_assert(max_chars > 21);
int64_t val = (int64_t)(LOG_INTEGER == stype ? REC_readInteger(record, &found) : REC_readCounter(record, &found));
if (found) {
out_buf = int64_to_str(ascii_buf, max_chars, val, &num_chars);
ink_assert(out_buf);
} else {
out_buf = (char *)record_not_found_msg;
num_chars = record_not_found_chars;
}
} else if (LOG_FLOAT == stype) {
// we assume MgmtFloat is at least a float for the conversion below
// (the conversion itself assumes a double because of the %e)
// if this ever changes we should modify accordingly
//
ink_assert(sizeof(double) >= sizeof(RecFloat));
RecFloat val = REC_readFloat(record, &found);
if (found) {
// snprintf does not support "%e" in the format
// and we want to use "%e" because it is the most concise
// notation
num_chars = snprintf(ascii_buf, sizeof(ascii_buf), "%e", val) + 1; // include eos
// the "%e" field above should take 13 characters at most
//
ink_assert(num_chars <= max_chars);
// the following should never be true
//
if (num_chars > max_chars) {
// data does not fit, output asterisks
out_buf = "***";
num_chars = ::strlen(out_buf) + 1;
} else {
out_buf = ascii_buf;
}
} else {
out_buf = (char *)record_not_found_msg;
num_chars = record_not_found_chars;
}
} else if (LOG_STRING == stype) {
out_buf = REC_readString(record, &found);
if (found) {
if (out_buf != nullptr && out_buf[0] != 0) {
num_chars = ::strlen(out_buf) + 1;
if (num_chars > max_chars) {
// truncate string and write ellipsis at the end
memcpy(ascii_buf, out_buf, max_chars - 4);
ascii_buf[max_chars - 1] = 0;
ascii_buf[max_chars - 2] = '.';
ascii_buf[max_chars - 3] = '.';
ascii_buf[max_chars - 4] = '.';
out_buf = ascii_buf;
num_chars = max_chars;
}
} else {
out_buf = "NULL";
num_chars = ::strlen(out_buf) + 1;
}
} else {
out_buf = (char *)record_not_found_msg;
num_chars = record_not_found_chars;
}
} else {
out_buf = "INVALID_MgmtType";
num_chars = ::strlen(out_buf) + 1;
ink_assert(!"invalid MgmtType for requested record");
}
}
ink_assert(num_chars <= max_chars);
memcpy(buf, out_buf, num_chars);
return max_chars;
}
/*-------------------------------------------------------------------------
LogAccess::marshal_str
Copy the given string to the destination buffer, including the trailing
NULL. For binary formatting, we need the NULL to distinguish the end of
the string, and we'll remove it for ascii formatting.
ASSUMES dest IS NOT NULL.
The array pointed to by dest must be at least padded_len in length.
-------------------------------------------------------------------------*/
void
LogAccess::marshal_str(char *dest, const char *source, int padded_len)
{
if (source == nullptr || source[0] == 0 || padded_len == 0) {
source = DEFAULT_STR;
}
ink_strlcpy(dest, source, padded_len);
#ifdef DEBUG
//
// what padded_len should be, if there is no padding, is strlen()+1.
// if not, then we needed to pad and should touch the intermediate
// bytes to avoid UMR errors when the buffer is written.
//
size_t real_len = (::strlen(source) + 1);
while ((int)real_len < padded_len) {
dest[real_len] = '$';
real_len++;
}
#endif
}
/*-------------------------------------------------------------------------
LogAccess::marshal_mem
This is a version of marshal_str that works with unterminated strings.
In this case, we'll copy the buffer and then add a trailing null that
the rest of the system assumes.
-------------------------------------------------------------------------*/
void
LogAccess::marshal_mem(char *dest, const char *source, int actual_len, int padded_len)
{
if (source == nullptr || source[0] == 0 || actual_len == 0) {
source = DEFAULT_STR;
actual_len = DEFAULT_STR_LEN;
ink_assert(actual_len < padded_len);
}
memcpy(dest, source, actual_len);
dest[actual_len] = 0; // add terminating null
#ifdef DEBUG
//
// what len should be, if there is no padding, is strlen()+1.
// if not, then we needed to pad and should touch the intermediate
// bytes to avoid UMR errors when the buffer is written.
//
int real_len = actual_len + 1;
while (real_len < padded_len) {
dest[real_len] = '$';
real_len++;
}
#endif
}
/*-------------------------------------------------------------------------
LogAccess::marshal_ip
Marshal an IP address in a reasonably compact way. If the address isn't
valid (NULL or not IP) then marshal an invalid address record.
-------------------------------------------------------------------------*/
int
LogAccess::marshal_ip(char *dest, sockaddr const *ip)
{
LogFieldIpStorage data;
int len = sizeof(data._ip);
if (nullptr == ip) {
data._ip._family = AF_UNSPEC;
} else if (ats_is_ip4(ip)) {
if (dest) {
data._ip4._family = AF_INET;
data._ip4._addr = ats_ip4_addr_cast(ip);
}
len = sizeof(data._ip4);
} else if (ats_is_ip6(ip)) {
if (dest) {
data._ip6._family = AF_INET6;
data._ip6._addr = ats_ip6_addr_cast(ip);
}
len = sizeof(data._ip6);
} else {
data._ip._family = AF_UNSPEC;
}
if (dest) {
memcpy(dest, &data, len);
}
return INK_ALIGN_DEFAULT(len);
}
int
LogAccess::marshal_version_build_number(char *buf)
{
int len = sizeof(appVersionInfo.BldNumStr);
if (buf) {
marshal_str(buf, appVersionInfo.BldNumStr, len);
}
return len;
}
inline int
LogAccess::unmarshal_with_map(int64_t code, char *dest, int len, Ptr<LogFieldAliasMap> map, const char *msg)
{
long int codeStrLen = 0;
switch (map->asString(code, dest, len, (size_t *)&codeStrLen)) {
case LogFieldAliasMap::INVALID_INT:
if (msg) {
const int bufSize = 64;
char invalidCodeMsg[bufSize];
codeStrLen = snprintf(invalidCodeMsg, 64, "%s(%" PRId64 ")", msg, code);
if (codeStrLen < bufSize && codeStrLen < len) {
ink_strlcpy(dest, invalidCodeMsg, len);
} else {
codeStrLen = -1;
}
} else {
codeStrLen = -1;
}
break;
case LogFieldAliasMap::BUFFER_TOO_SMALL:
codeStrLen = -1;
break;
}
return codeStrLen;
}
/*-------------------------------------------------------------------------
LogAccess::unmarshal_int
Return the integer pointed at by the buffer and advance the buffer
pointer past the int. The int will be converted back to host byte order.
-------------------------------------------------------------------------*/
int64_t
LogAccess::unmarshal_int(char **buf)
{
ink_assert(buf != nullptr);
ink_assert(*buf != nullptr);
int64_t val;
// TODO: this used to do nthol, do we need to worrry? TS-1156.
val = *((int64_t *)(*buf));
*buf += INK_MIN_ALIGN;
return val;
}
/*-------------------------------------------------------------------------
unmarshal_itoa
This routine provides a fast conversion from a binary int to a string.
It returns the number of characters formatted. "dest" must point to the
LAST character of an array large enough to store the complete formatted
number.
-------------------------------------------------------------------------*/
int
LogAccess::unmarshal_itoa(int64_t val, char *dest, int field_width, char leading_char)
{
ink_assert(dest != nullptr);
char *p = dest;
if (val <= 0) {
*p-- = '0';
while (dest - p < field_width) {
*p-- = leading_char;
}
return (int)(dest - p);
}
while (val) {
*p-- = '0' + (val % 10);
val /= 10;
}
while (dest - p < field_width) {
*p-- = leading_char;
}
return (int)(dest - p);
}
/*-------------------------------------------------------------------------
unmarshal_itox
This routine provides a fast conversion from a binary int to a hex string.
It returns the number of characters formatted. "dest" must point to the
LAST character of an array large enough to store the complete formatted
number.
-------------------------------------------------------------------------*/
int
LogAccess::unmarshal_itox(int64_t val, char *dest, int field_width, char leading_char)
{
ink_assert(dest != nullptr);
char *p = dest;
static char table[] = "0123456789abcdef?";
for (int i = 0; i < (int)(sizeof(int64_t) * 2); i++) {
*p-- = table[val & 0xf];
val >>= 4;
}
while (dest - p < field_width) {
*p-- = leading_char;
}
return (int64_t)(dest - p);
}
/*-------------------------------------------------------------------------
LogAccess::unmarshal_int_to_str
Return the string representation of the integer pointed at by buf.
-------------------------------------------------------------------------*/
int
LogAccess::unmarshal_int_to_str(char **buf, char *dest, int len)
{
ink_assert(buf != nullptr);
ink_assert(*buf != nullptr);
ink_assert(dest != nullptr);
char val_buf[128];
int64_t val = unmarshal_int(buf);
int val_len = unmarshal_itoa(val, val_buf + 127);
if (val_len < len) {
memcpy(dest, val_buf + 128 - val_len, val_len);
return val_len;
}
return -1;
}
/*-------------------------------------------------------------------------
LogAccess::unmarshal_int_to_str_hex
Return the string representation (hexadecimal) of the integer pointed at by buf.
-------------------------------------------------------------------------*/
int
LogAccess::unmarshal_int_to_str_hex(char **buf, char *dest, int len)
{
ink_assert(buf != nullptr);
ink_assert(*buf != nullptr);
ink_assert(dest != nullptr);
char val_buf[128];
int64_t val = unmarshal_int(buf);
int val_len = unmarshal_itox(val, val_buf + 127);
if (val_len < len) {
memcpy(dest, val_buf + 128 - val_len, val_len);
return val_len;
}
return -1;
}
/*-------------------------------------------------------------------------
LogAccess::unmarshal_str
Retrieve the string from the location pointed at by the buffer and
advance the pointer past the string. The local strlen function is used
to advance the pointer, thus matching the corresponding strlen that was
used to lay the string into the buffer.
-------------------------------------------------------------------------*/
int
LogAccess::unmarshal_str(char **buf, char *dest, int len, LogSlice *slice)
{
ink_assert(buf != nullptr);
ink_assert(*buf != nullptr);
ink_assert(dest != nullptr);
char *val_buf = *buf;
int val_len = (int)::strlen(val_buf);
*buf += LogAccess::strlen(val_buf); // this is how it was stored
if (slice && slice->m_enable) {
int offset, n;
n = slice->toStrOffset(val_len, &offset);
if (n <= 0) {
return 0;
}
if (n >= len) {
return -1;
}
memcpy(dest, (val_buf + offset), n);
return n;
}
if (val_len < len) {
memcpy(dest, val_buf, val_len);
return val_len;
}
return -1;
}
int
LogAccess::unmarshal_ttmsf(char **buf, char *dest, int len)
{
ink_assert(buf != nullptr);
ink_assert(*buf != nullptr);
ink_assert(dest != nullptr);
int64_t val = unmarshal_int(buf);
float secs = (float)val / 1000;
int val_len = snprintf(dest, len, "%.3f", secs);
return val_len;
}
/*-------------------------------------------------------------------------
LogAccess::unmarshal_http_method
Retrieve the int pointed at by the buffer and treat as an HttpMethod
enumerated type. Then lookup the string representation for that enum and
return the string. Advance the buffer pointer past the enum.
-------------------------------------------------------------------------*/
/*