-
Notifications
You must be signed in to change notification settings - Fork 746
/
Copy pathtrcoptions.c
1777 lines (1608 loc) · 55.4 KB
/
trcoptions.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
/*******************************************************************************
* Copyright IBM Corp. and others 1998
*
* This program and the accompanying materials are made available under
* the terms of the Eclipse Public License 2.0 which accompanies this
* distribution and is available at https://www.eclipse.org/legal/epl-2.0/
* or the Apache License, Version 2.0 which accompanies this distribution and
* is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* This Source Code may also be made available under the following
* Secondary Licenses when the conditions for such availability set
* forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
* General Public License, version 2 with the GNU Classpath
* Exception [1] and GNU General Public License, version 2 with the
* OpenJDK Assembly Exception [2].
*
* [1] https://www.gnu.org/software/classpath/license.html
* [2] https://openjdk.org/legal/assembly-exception.html
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
*******************************************************************************/
#include <ctype.h>
#include <stdlib.h>
#include <string.h>
#include "rastrace_internal.h"
#include "trctrigger.h"
#include "omrutil.h"
#include "j9trcnls.h"
typedef omr_error_t (*uteOptionFunction)(UtThreadData **thr,const char * value, BOOLEAN atRuntime);
/**
* Structure representing a UTE option such maximal or debug
*/
struct uteOption {
const char * name;
const int32_t runtimeModifiable;
const uteOptionFunction optionFunction;
};
/* Prototypes for option configuration functions */
static omr_error_t processResetOption(UtThreadData **thr,const char * value, BOOLEAN atRuntime);
static omr_error_t processPropertiesOption(UtThreadData **thr,const char * value, BOOLEAN atRuntime);
static omr_error_t propertyFileOption(const char *value);
static omr_error_t setMinimal(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setMaximal(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setCount(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setPrint(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setNone(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setIprint(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setPlatform(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setExternal(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setException(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setExceptOut(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setStateOut(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setOutput(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
omr_error_t setTrigger(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setBuffers(UtThreadData **thr, const char *value, BOOLEAN atRuntime);
static omr_error_t setSuspendResumeCount(UtThreadData **thr, const char *value, int32_t resume, BOOLEAN atRuntime);
static omr_error_t processSuspendOption(UtThreadData **thr,const char * value, BOOLEAN atRuntime);
static omr_error_t processResumeOption(UtThreadData **thr,const char * value, BOOLEAN atRuntime);
static omr_error_t processSuspendCountOption(UtThreadData **thr,const char * value, BOOLEAN atRuntime);
static int selectComponent(const char *cmd, int32_t *first, char traceType, int32_t setActive, BOOLEAN atRuntime);
static omr_error_t setFatalAssert(UtThreadData **thr, const char * spec, BOOLEAN atRuntime);
static omr_error_t clearFatalAssert(UtThreadData **thr, const char * spec, BOOLEAN atRuntime);
const struct uteOption UTE_OPTIONS[] = {
/* { Keyword, Can be configured at runtime, Configuration function } */
/* These four don't have any action */
{UT_DEBUG_KEYWORD, FALSE, NULL},
{UT_SUFFIX_KEYWORD, FALSE, NULL},
{UT_LIBPATH_KEYWORD, FALSE, NULL},
{UT_FORMAT_KEYWORD, FALSE, NULL},
{UT_RESET_KEYWORD, FALSE, processResetOption},
{UT_PROPERTIES_KEYWORD, FALSE, processPropertiesOption},
{UT_MINIMAL_KEYWORD, TRUE, setMinimal},
{UT_MAXIMAL_KEYWORD, TRUE, setMaximal},
{UT_EXCEPTION_KEYWORD, TRUE, setException},
{UT_COUNT_KEYWORD, TRUE, setCount},
{UT_PRINT_KEYWORD, TRUE, setPrint},
{UT_NONE_KEYWORD, TRUE, setNone},
{UT_IPRINT_KEYWORD, TRUE, setIprint},
{UT_PLATFORM_KEYWORD, FALSE, setPlatform},
{UT_EXTERNAL_KEYWORD, TRUE, setExternal},
{UT_EXCEPT_OUT_KEYWORD, FALSE, setExceptOut},
{UT_STATE_OUT_KEYWORD, FALSE, setStateOut},
{UT_OUTPUT_KEYWORD, FALSE, setOutput},
{UT_BUFFERS_KEYWORD, TRUE, setBuffers}, /* Not all buffers functions are exposed - but are controlled in the set function*/
{UT_TRIGGER_KEYWORD, TRUE, setTrigger},
{UT_SUSPEND_KEYWORD, TRUE, processSuspendOption},
{UT_RESUME_KEYWORD, TRUE, processResumeOption},
{UT_RESUME_COUNT_KEYWORD, TRUE, processResumeOption},
{UT_SUSPEND_COUNT_KEYWORD, TRUE, processSuspendCountOption},
{UT_FATAL_ASSERT_KEYWORD, TRUE, setFatalAssert},
{UT_NO_FATAL_ASSERT_KEYWORD, TRUE, clearFatalAssert},
{UT_SLEEPTIME_KEYWORD, TRUE, setSleepTime},
};
#define NUMBER_OF_UTE_OPTIONS (sizeof(UTE_OPTIONS) / sizeof(struct uteOption))
/*******************************************************************************
* name - addTraceCmd
* description - Internal routine to setup a trace cmd
* parameters - thr, trace command and value
* returns - UTE return code
******************************************************************************/
static omr_error_t
addTraceCmd(UtThreadData **thr, const char *cmd, const char *value, BOOLEAN atRuntime)
{
PORT_ACCESS_FROM_PORT(UT_GLOBAL(portLibrary));
omr_error_t rc = OMR_ERROR_NONE;
size_t valueLen = (NULL == value) ? 0 : strlen(value);
char * str = (char *)j9mem_allocate_memory(strlen(cmd) + valueLen + 2, OMRMEM_CATEGORY_TRACE);
if (NULL != str) {
strcpy(str, cmd);
if (valueLen > 0) {
strcat(str, "=");
strcat(str, value);
}
/* Set the trace state under the global trace lock */
getTraceLock(thr);
rc = setTraceState(str, atRuntime);
freeTraceLock(thr);
j9mem_free_memory(str);
} else {
UT_DBGOUT(1, ("<UT> Out of memory in addTraceCmd\n"));
rc = OMR_ERROR_OUT_OF_NATIVE_MEMORY;
}
return rc;
}
static omr_error_t
parseBufferSize(const char * const str, const int argSize, BOOLEAN atRuntime)
{
/* It's either invalid input or a number with an optional suffix
* Find the position of the first digit and non-digit character.
*/
int32_t newBufferSize = 0;
intptr_t firstNonDigit = -1;
intptr_t firstDigit = -1;
const char * p = str;
for (; '\0' != *p; ++p) {
if (isdigit(*p)) {
if (-1 == firstDigit) {
firstDigit = p - str;
}
} else {
if (-1 == firstNonDigit) {
firstNonDigit = p - str;
}
}
}
/* The only valid place for a non-digit is the final character */
if (firstNonDigit != -1) {
if ((firstNonDigit == (argSize - 1)) && (-1 != firstDigit)) {
int multiplier = 1;
switch (j9_cmdla_toupper(str[argSize - 1])) {
case 'K':
multiplier = 1024;
break;
case 'M':
multiplier = 1024 * 1024;
break;
default:
reportCommandLineError(atRuntime, "Unrecognised suffix %c specified for buffer size", str[argSize - 1]);
return OMR_ERROR_ILLEGAL_ARGUMENT;
}
newBufferSize = atoi(str) * multiplier;
} else {
/* Invalid */
reportCommandLineError(atRuntime, "Invalid option for -Xtrace:buffers - \"%s\"",str);
return OMR_ERROR_ILLEGAL_ARGUMENT;
}
} else {
/* The string contains no non-digits */
newBufferSize = atoi(str);
}
if (newBufferSize < UT_MINIMUM_BUFFERSIZE) {
reportCommandLineError(atRuntime, "Specified buffer size %d bytes is too small. Minimum is %d bytes.", newBufferSize, UT_MINIMUM_BUFFERSIZE);
return OMR_ERROR_ILLEGAL_ARGUMENT;
} else {
UT_GLOBAL(bufferSize) = newBufferSize;
}
return OMR_ERROR_NONE;
}
/*******************************************************************************
* name - setBuffers
* description - Set the buffer size and type
* parameters - thr, string value of the property (nnnk|nnnm[,dynamic]), atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setBuffers(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
char * localBuffer = NULL;
omr_error_t rc = OMR_ERROR_NONE;
const int numberOfArgs = getParmNumber(value);
int i = 0;
PORT_ACCESS_FROM_PORT(UT_GLOBAL(portLibrary));
if (NULL == value) {
reportCommandLineError(atRuntime, "-Xtrace:buffers expects an argument.");
return OMR_ERROR_ILLEGAL_ARGUMENT;
}
localBuffer = (char *)j9mem_allocate_memory(strlen(value) + 1, OMRMEM_CATEGORY_TRACE);
if (NULL == localBuffer) {
UT_DBGOUT(1, ("<UT> Out of memory in setBuffers\n"));
return OMR_ERROR_OUT_OF_NATIVE_MEMORY;
}
for (i = 0; i < numberOfArgs; ++i) {
int argSize = 0;
const char * startOfThisArg = getPositionalParm(i + 1, value, &argSize);
if (0 == argSize) {
reportCommandLineError(atRuntime, "Empty option passed to -Xtrace:buffers");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
goto end;
}
strncpy(localBuffer, startOfThisArg, argSize);
localBuffer[argSize] = '\0';
if (j9_cmdla_stricmp(localBuffer, "DYNAMIC") == 0) {
UT_GLOBAL(dynamicBuffers) = TRUE;
} else if (j9_cmdla_stricmp(localBuffer, "NODYNAMIC") == 0) {
UT_GLOBAL(dynamicBuffers) = FALSE;
} else {
if (!atRuntime) {
rc = parseBufferSize(localBuffer,argSize,atRuntime);
if (rc != OMR_ERROR_NONE) {
goto end;
}
} else {
/* You can't change the buffer size at runtime */
UT_DBGOUT(1, ("<UT> Buffer size cannot be changed at run-time\n"));
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
goto end;
}
}
}
UT_DBGOUT(1, ("<UT> Trace buffer size: %d\n",UT_GLOBAL(bufferSize)));
end:
if (localBuffer != NULL) {
j9mem_free_memory(localBuffer);
}
return rc;
}
/*******************************************************************************
* name - setMinimal
* description - Set the minimal trace options
* parameters - thr, trace options, atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setMinimal(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
return addTraceCmd(thr, UT_MINIMAL_KEYWORD, value, atRuntime);
}
/*******************************************************************************
* name - setMaximal
* description - Set the maximal trace options
* parameters - thr, trace options, atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setMaximal(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
return addTraceCmd(thr, UT_MAXIMAL_KEYWORD, value, atRuntime);
}
/*******************************************************************************
* name - setCount
* description - Set the counter trace options
* parameters - thr, trace options, atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setCount(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
UT_GLOBAL(traceCount) = TRUE;
return addTraceCmd(thr, UT_COUNT_KEYWORD, value, atRuntime);
}
/*******************************************************************************
* name - setPrint
* description - Set the printf trace options
* parameters - thr, trace options, atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setPrint(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
/* UT_GLOBAL(loadFormatFile) = TRUE; */
return addTraceCmd(thr, UT_PRINT_KEYWORD, value, atRuntime);
}
/*******************************************************************************
* name - setNone
* description - Set the "off" trace options
* parameters - thr, trace options, atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setNone(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
omr_error_t rc = OMR_ERROR_NONE;
rc = addTraceCmd(thr, UT_NONE_KEYWORD, value, atRuntime);
if (OMR_ERROR_NONE == rc && NULL == value) {
/* We are clearing all trace (no sub parameters to none)
* so we can delete all trigger actions */
clearAllTriggerActions();
}
return rc;
}
/*******************************************************************************
* name - setIprint
* description - Set the indented printf trace options
* parameters - thr, trace options, atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setIprint(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
/* UT_GLOBAL(loadFormatFile) = TRUE; */
return addTraceCmd(thr, UT_IPRINT_KEYWORD, value, atRuntime);
}
/*******************************************************************************
* name - setPlatform
* description - Set the platform trace options
* parameters - thr, trace options, atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setPlatform(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
if (!UT_GLOBAL(platformTraceStarted)) {
UT_GLOBAL(platformTraceStarted) = TRUE;
}
return addTraceCmd(thr, UT_PLATFORM_KEYWORD, value, atRuntime);
}
/*******************************************************************************
* name - setExternal
* description - Set the external trace options
* parameters - thr, trace options, atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setExternal(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
return addTraceCmd(thr, UT_EXTERNAL_KEYWORD, value, atRuntime);
}
/*******************************************************************************
* name - setException
* description - Set exception trace options
* parameters - thr, trace options, atRuntime
* returns - UTE return code
******************************************************************************/
static omr_error_t
setException(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
return addTraceCmd(thr, UT_EXCEPTION_KEYWORD, value, atRuntime);
}
/*******************************************************************************
* name - setExceptOut
* description - Set the exception trace output filename and options
* parameters - thr, string value of the property
* (filename[,nnnm])
* returns - UTE return code
******************************************************************************/
static omr_error_t
setExceptOut(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
omr_error_t rc = OMR_ERROR_NONE;
const char *p;
int length;
int multiplier;
char str[20];
char instring[256];
PORT_ACCESS_FROM_PORT(UT_GLOBAL(portLibrary));
UT_GLOBAL(extExceptTrace) = TRUE;
/*
* check for and expand %p or %p characters
*/
rc = expandString(instring, value, atRuntime);
/*
* Process filename
*/
if (OMR_ERROR_NONE== rc) {
p = getPositionalParm(1, instring, &length);
if (p != NULL) {
UT_GLOBAL(exceptFilename) = j9mem_allocate_memory(length + 1, OMRMEM_CATEGORY_TRACE );
if (UT_GLOBAL(exceptFilename) != NULL) {
memcpy(UT_GLOBAL(exceptFilename), p, length);
UT_GLOBAL(exceptFilename[length]) = '\0';
UT_DBGOUT(1, ("<UT> Exception filename: %s\n", UT_GLOBAL(exceptFilename)));
} else {
UT_DBGOUT(1, ("<UT> Out of memory handling exception property\n"));
rc = OMR_ERROR_OUT_OF_NATIVE_MEMORY;
}
} else {
reportCommandLineError(atRuntime, "Filename not supplied in exception specification");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
}
/*
* Process file wrap size
*/
if (OMR_ERROR_NONE == rc) {
p = getPositionalParm(2, instring, &length);
if (p != NULL) {
if ((length >= 2) && (length <= 5)) {
if (j9_cmdla_toupper(p[length - 1]) == 'K') {
multiplier = 1024;
} else if (j9_cmdla_toupper(p[length - 1]) == 'M') {
multiplier = 1024 * 1024;
} else {
reportCommandLineError(atRuntime, "Invalid multiplier for exception wrap limit");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
if (OMR_ERROR_NONE == rc) {
memcpy(str, p, length - 1);
str[length] = '\0';
UT_GLOBAL(exceptTraceWrap) = atoi(str) * multiplier;
UT_DBGOUT(1, ("<UT> Trace exception file wrap: %d\n",
UT_GLOBAL(exceptTraceWrap)));
}
} else {
reportCommandLineError(atRuntime, "Length of wrap limit parameter invalid");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
}
}
/*
* That should be it
*/
if (getParmNumber(instring) > 2) {
reportCommandLineError(atRuntime, "Too many keywords in exception specification");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
if (OMR_ERROR_ILLEGAL_ARGUMENT == rc) {
reportCommandLineError(atRuntime, "Usage: exception.output=filename[,nnnn{k|m}]");
}
return rc;
}
/*******************************************************************************
* name - setStateOut
* description - Set the state trace output filename and options
* parameters - thr, string value of the property
* (filename[,nnnm])
* returns - UTE return code
******************************************************************************/
static omr_error_t
setStateOut(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
omr_error_t rc = OMR_ERROR_NONE;
const char *p;
int length;
char instring[256];
/*
* check for and expand %p %d or %t characters
*/
rc = expandString(instring, value, atRuntime);
/*
* Process filename
*/
if (OMR_ERROR_NONE == rc) {
p = getPositionalParm(1, instring, &length);
if (p != NULL) {
/* No-op as state trace has been removed. (But we still need to parse the option.) */
} else {
reportCommandLineError(atRuntime, "Filename not supplied in state.output specification");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
}
/*
* Process file wrap size
*/
if (OMR_ERROR_NONE == rc) {
p = getPositionalParm(2, instring, &length);
if (p != NULL) {
if ((length >= 2) && (length <= 5)) {
if (j9_cmdla_toupper(p[length - 1]) == 'K') {
/* No-op as state trace has been removed. (But we still need to parse the option.) */
} else if (j9_cmdla_toupper(p[length - 1]) == 'M') {
/* No-op as state trace has been removed. (But we still need to parse the option.) */
} else {
reportCommandLineError(atRuntime, "Invalid multiplier for exception wrap limit");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
} else {
reportCommandLineError(atRuntime, "Length of wrap limit parameter invalid");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
}
}
/*
* That should be it
*/
if (getParmNumber(instring) > 2) {
reportCommandLineError(atRuntime, "Too many keywords in state.output specification");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
if (OMR_ERROR_ILLEGAL_ARGUMENT == rc) {
reportCommandLineError(atRuntime, "Usage: state.output=filename[,nnnn{k|m}]");
}
return rc;
}
/*******************************************************************************
* name - setOutput
* description - Set the output filename and options
* parameters - thr, string value of the property
* (filename[,nnnm][,generations]])
* returns - UTE return code
******************************************************************************/
static omr_error_t
setOutput(UtThreadData **thr, const char *value, BOOLEAN atRuntime)
{
omr_error_t rc = OMR_ERROR_NONE;
const char *p;
int length;
int multiplier;
char str[20];
char instring[256];
PORT_ACCESS_FROM_PORT(UT_GLOBAL(portLibrary));
UT_GLOBAL(externalTrace) = TRUE;
/*
* check for and expand %p or %p characters
*/
rc = expandString(instring, value, atRuntime);
/*
* Process filename
*/
if (OMR_ERROR_NONE == rc) {
p = getPositionalParm(1, instring, &length);
if (p != NULL) {
UT_GLOBAL(traceFilename) = j9mem_allocate_memory(length + 1, OMRMEM_CATEGORY_TRACE );
if (UT_GLOBAL(traceFilename) != NULL) {
memcpy(UT_GLOBAL(traceFilename), p, length);
UT_GLOBAL(traceFilename[length]) = '\0';
UT_DBGOUT(1, ("<UT> Output filename: %s\n",
UT_GLOBAL(traceFilename)));
} else {
UT_DBGOUT(1, ("<UT> Out of memory handling output property\n"));
rc = OMR_ERROR_OUT_OF_NATIVE_MEMORY;
}
} else {
reportCommandLineError(atRuntime, "Filename not supplied in output specification");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
}
/*
* Process file wrap size
*/
if (OMR_ERROR_NONE == rc) {
p = getPositionalParm(2, instring, &length);
if (p != NULL) {
if ((length >= 2) && (length <= 5)) {
if (j9_cmdla_toupper(p[length - 1]) == 'K') {
multiplier = 1024;
} else if (j9_cmdla_toupper(p[length - 1]) == 'M') {
multiplier = 1024 * 1024;
} else {
reportCommandLineError(atRuntime, "Invalid multiplier for trace wrap limit");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
if (OMR_ERROR_NONE == rc) {
memcpy(str, p, length - 1);
str[length] = '\0';
UT_GLOBAL(traceWrap) = atoi(str) * multiplier;
UT_DBGOUT(1, ("<UT> Trace file wrap: %d\n", UT_GLOBAL(traceWrap)));
}
} else {
reportCommandLineError(atRuntime, "Length of wrap limit parameter invalid");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
}
}
/*
* Process generations parameter
*/
if (OMR_ERROR_NONE == rc) {
p = getPositionalParm(3, instring, &length);
if (p != NULL) {
if ((length >= 1) && (length <= 2)) {
memcpy(str, p, length);
str[length] = '\0';
UT_GLOBAL(traceGenerations) = atoi(str);
UT_DBGOUT(1, ("<UT> Trace file generations: %d\n",
UT_GLOBAL(traceGenerations)));
if ((UT_GLOBAL(traceGenerations) < 2) ||
(UT_GLOBAL(traceGenerations) >36)) {
reportCommandLineError(atRuntime, "Invalid number of trace generations");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
} else {
if ((UT_GLOBAL(generationChar) =
strchr(UT_GLOBAL(traceFilename), '#')) == NULL) {
reportCommandLineError(atRuntime, "Invalid filename for generation mode,"
" the filename must contain a \"#\"");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
}
} else {
reportCommandLineError(atRuntime, "Length of generation parameter invalid");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
} else {
UT_GLOBAL(traceGenerations) = 1;
}
}
/*
* That should be it
*/
if (getParmNumber(instring) > 3) {
reportCommandLineError(atRuntime, "Too many keywords in output specification");
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
if (OMR_ERROR_ILLEGAL_ARGUMENT == rc) {
reportCommandLineError(atRuntime, "Usage: output=filename[,nnnn{k|m}[,n]]\n");
}
return rc;
}
/*******************************************************************************
* name - setTrigger
* description - Set trigger tracing
* parameters - thr, trigger value, runTime
* returns - UTE return code
*
******************************************************************************/
omr_error_t
setTrigger(UtThreadData **thr, const char *triggerStr, BOOLEAN atRuntime)
{
omr_error_t rc = OMR_ERROR_NONE;
char *clause = NULL;
char *str = NULL;
const char *value = triggerStr;
int32_t done = FALSE;
PORT_ACCESS_FROM_PORT(UT_GLOBAL(portLibrary));
UT_DBGOUT(1, ("<UT> Processing trigger statement: %s\n", value));
/*
* Ignore empty value
*/
if (value == NULL || strlen(value) == 0) {
return rc;
}
/*
* Keep calling getNextBracketedParm until done comes back TRUE
*/
for (; (OMR_ERROR_NONE == rc) && !done;) {
clause = getNextBracketedParm(value, &rc, &done, atRuntime);
if (OMR_ERROR_NONE == rc) {
if (strlen(clause) == 0) {
reportCommandLineError(atRuntime, "Empty clauses not allowed in trigger property.");
rc = OMR_ERROR_INTERNAL;
} else {
char * workingClause;
int32_t disabling = FALSE;
value = value + strlen(clause) + 1;
if (*clause == '!') {
workingClause = clause + 1;
disabling = TRUE;
} else {
workingClause = clause;
}
/*
* Tracepoint ID specified ?
*/
if (0 == j9_cmdla_strnicmp(workingClause, "tpnid{", strlen("tpnid{"))) {
if (strchr(clause, ',') != NULL) {
str = strchr(clause, ',');
str[0] = '}';
str[1] = '\0';
}
rc = addTraceCmd(thr, UT_TRIGGER_KEYWORD, clause, atRuntime);
}
/*
* Group specified ? => map to "all{name}"
*/
if (0 == j9_cmdla_strnicmp(workingClause, "group{", strlen("group{"))) {
if (strchr(clause, ',') != NULL) {
str = strchr(clause, ',');
str[0] = '}';
str[1] = '\0';
}
str = clause + 2;
if (disabling) {
memcpy(str, "!all", 4);
} else {
memcpy(str, "all", 3);
}
rc = addTraceCmd(thr, UT_TRIGGER_KEYWORD, str, atRuntime);
}
}
}
if (clause != NULL) {
j9mem_free_memory(clause);
}
}
/* The code above has set the trace points that need to fire to UT_TRIGGER
* (like setting them UT_MAXIMAL or UT_PRINT).
* Now we need to process the trigger actions so we can look up what to
* do when one of those trace points fires.
*/
if (OMR_ERROR_NONE == rc) {
rc = setTriggerActions(thr, triggerStr, atRuntime);
}
return rc;
}
/*******************************************************************************
* name - setFormat
* description - Set the formatting file path
* parameters - path
* returns - UTE return code
******************************************************************************/
static omr_error_t
setFormat(const char *value)
{
omr_error_t rc = OMR_ERROR_NONE;
PORT_ACCESS_FROM_PORT(UT_GLOBAL(portLibrary));
UT_GLOBAL(traceFormatSpec) = (char *)j9mem_allocate_memory(strlen(value) + 1, OMRMEM_CATEGORY_TRACE );
if (UT_GLOBAL(traceFormatSpec) != NULL) {
strcpy(UT_GLOBAL(traceFormatSpec), value);
} else {
UT_DBGOUT(1, ("<UT> Out of memory for FormatSpecPath\n"));
rc = OMR_ERROR_OUT_OF_NATIVE_MEMORY;
}
return rc;
}
/**************************************************************************
* name - setSuspendResumeCount
* description - This handles the resumecount and suspendcount properties.
* It sets the value initialSuspendResume in UtGlobalData
* This is read by all starting threads and used as their
* initial value for thread suspend/resume. If at any given
* time, it is 0 or greater, trace is enabled for that
* thread.
* parameters - thr, trace options, Resume (TRUE=resume, FALSE=suspend)
* returns - UTE return code
*************************************************************************/
omr_error_t
setSuspendResumeCount(UtThreadData **thr, const char *value, int32_t resume, BOOLEAN atRuntime)
{
omr_error_t rc = OMR_ERROR_NONE;
const char *p = NULL;
int length = 0;
int maxLength = 5;
/*
* check for basic formatting errors
*/
p = getPositionalParm(1, value, &length);
if (getParmNumber(value) != 1) { /* problem if not just the one parm */
rc = OMR_ERROR_INTERNAL;
} else if (length == 0) { /* first (only) parm must be non null */
rc = OMR_ERROR_INTERNAL;
}
if (OMR_ERROR_NONE == rc) { /* max 5 chars long */
if (*p == '+' || *p == '-') { /* but must allow 6 if signed */
maxLength++;
}
if (length > maxLength) {
rc = OMR_ERROR_INTERNAL;
}
}
/*
* If any of the above checks failed, issue message.
*/
if (OMR_ERROR_NONE != rc) {
if (resume) {
reportCommandLineError(atRuntime, "resumecount takes a single integer value from -99999 to +99999");
} else {
reportCommandLineError(atRuntime, "suspendcount takes a single integer value from -99999 to +99999");
}
}
if (OMR_ERROR_NONE == rc) {
/*
* Enforce that users may not use resumecount and suspendcount together !
*/
if (UT_GLOBAL(initialSuspendResume) != 0) {
reportCommandLineError(atRuntime, "resumecount and suspendcount may not both be set.");
rc = OMR_ERROR_INTERNAL;
} else {
/* issues error and sets rc if p points to bad number */
int value = decimalString2Int(p, TRUE, &rc, atRuntime);
if (OMR_ERROR_NONE == rc) {
if (resume) {
UT_GLOBAL(initialSuspendResume) = (0 - value);
} else {
UT_GLOBAL(initialSuspendResume) = (value - 1);
}
}
}
}
/* the current thread (presumably the primordial thread) needs updating too */
(*thr)->suspendResume = UT_GLOBAL(initialSuspendResume);
return rc;
}
/*******************************************************************************
* name - processPropertyFile
* description - Read trace options from the properties file
* parameters - thr, string value of the property (filename)
* returns - UTE return code
******************************************************************************/
static omr_error_t
processPropertyFile(UtThreadData **thr, const char *filename, BOOLEAN atRuntime)
{
intptr_t propFile = 0;
int64_t size = 0;
int i = 0;
omr_error_t rc = OMR_ERROR_NONE;
char *buffer = NULL;
char *p = NULL;
char name[MAX_IMAGE_PATH_LENGTH];
char *separator = DIR_SEPARATOR_STR;
PORT_ACCESS_FROM_PORT(UT_GLOBAL(portLibrary));
/*
* Process properties file, if any
*/
if (filename == NULL || *filename == '\0') {
*name = '\0';
if (UT_GLOBAL(propertyFilePath) != NULL) {
strcat(name, UT_GLOBAL(propertyFilePath));
strcat(name, separator);
}
strcat(name, UT_DEFAULT_PROPERTIES);
} else {
strcpy(name, filename);
}
rc = OMR_ERROR_INTERNAL;
/*
* Open the property file
*/
if ((propFile = j9file_open(name, EsOpenRead | EsOpenText, 0)) < 0) {
reportCommandLineError(atRuntime, "Unable to open properties file %s", name);
} else {
/*
* Get the file size
*/
size = j9file_flength(propFile);
if ( 0 > size ) {
reportCommandLineError(atRuntime, "Unable to determine size of properties file %s", name);
} else {
/*
* Obtain enough memory to hold the file
*/
buffer = (char *)j9mem_allocate_memory((uintptr_t)size + 1, OMRMEM_CATEGORY_TRACE );
if (buffer == NULL) {
UT_DBGOUT(1, ("<UT> Cannot obtain memory to process %s\n", name));
} else {
if ((size = j9file_read(propFile, buffer, (int)size)) == 0) {
reportCommandLineError(atRuntime, "Error reading properties file %s", name);
} else {
buffer[size] = '\0';
twE2A(buffer);
rc = OMR_ERROR_NONE;
}
}
}
j9file_close(propFile);
}
/*
* Transform all CR/LF's to binary zeroes and tabs to blanks
*/
if (rc == OMR_ERROR_NONE) {
*(buffer + size) = '\0';
for (p = buffer; p < (buffer + size); p++) {
if (*p == '\n' ||
*p == '\r') {
*p = '\0';
}
if (*p == '\t') {
*p = ' ';
}
}
/*
* Parse the file a line at a time
*/
for (p = buffer;
(rc == OMR_ERROR_NONE) && (p < (buffer + size));
p += strlen(p) + 1) {
if (*p == '\0') {
continue;
}
UT_DBGOUT(1, ("<UT> Properties file line: %s\n", p));
if (0 == j9_cmdla_strnicmp(p, UT_PROPERTIES_COMMENT, strlen(UT_PROPERTIES_COMMENT))) {
continue;
}
if (0 == j9_cmdla_strnicmp(p, UT_DEBUG_KEYWORD, strlen(UT_DEBUG_KEYWORD))) {
if (strlen(p) > strlen(UT_DEBUG_KEYWORD)) {
p += strlen(UT_DEBUG_KEYWORD);
if (strlen(p) == 2 &&
p[0] == '=' &&
p[1] >= '1' &&
p[1] <= '9') {
UT_GLOBAL(traceDebug) = atoi(p + 1);
} else {
rc = OMR_ERROR_ILLEGAL_ARGUMENT;
}
} else {
UT_GLOBAL(traceDebug) = 9;
}
UT_DBGOUT(1, ("<UT> Debug information requested\n"));
} else if ((0 == j9_cmdla_strnicmp(p, UT_MINIMAL_KEYWORD, strlen(UT_MINIMAL_KEYWORD))) &&
(*(p + strlen(UT_MINIMAL_KEYWORD)) == '=')) {
p += strlen(UT_MINIMAL_KEYWORD) + 1;
rc = setMinimal(thr, p, 0);
} else if ((0 == j9_cmdla_strnicmp(p, UT_MAXIMAL_KEYWORD, strlen(UT_MAXIMAL_KEYWORD))) &&
(*(p + strlen(UT_MAXIMAL_KEYWORD)) == '=')) {
p += strlen(UT_MAXIMAL_KEYWORD) + 1;
rc = setMaximal(thr, p, 0);
} else if ((0 == j9_cmdla_strnicmp(p, UT_COUNT_KEYWORD, strlen(UT_COUNT_KEYWORD))) &&
(*(p + strlen(UT_COUNT_KEYWORD)) == '=')) {
p += strlen(UT_COUNT_KEYWORD) + 1;
rc = setCount(thr, p, 0);
} else if ((0 == j9_cmdla_strnicmp(p, UT_PRINT_KEYWORD, strlen(UT_PRINT_KEYWORD))) &&
(*(p + strlen(UT_PRINT_KEYWORD)) == '=')) {
p += strlen(UT_PRINT_KEYWORD) + 1;
rc = setPrint(thr, p, 0);
} else if ((0 == j9_cmdla_strnicmp(p, UT_NONE_KEYWORD, strlen(UT_NONE_KEYWORD))) &&