-
Notifications
You must be signed in to change notification settings - Fork 752
/
Copy pathdmpagent.c
2995 lines (2530 loc) · 86.3 KB
/
dmpagent.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 (c) 1991, 2020 IBM Corp. and others
*
* 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] http://openjdk.java.net/legal/assembly-exception.html
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
*******************************************************************************/
/*
* Note: remove this when portlib supports launching of executables
*/
#ifdef WIN32
#include <windows.h>
#endif
#ifdef J9ZOS390
#include <spawn.h>
#include <errno.h>
#include "atoe.h"
#endif
#ifdef AIXPPC
#include <sys/wait.h>
#include <stdlib.h>
#include <errno.h>
#endif
#if defined(LINUX) || defined(OSX)
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/wait.h>
#endif /* defined(LINUX) || defined(OSX) */
#include "ut_j9dmp.h"
#include "dmpsup.h"
#include "j9dmpnls.h"
#include <string.h>
#include <limits.h>
#include "ute.h"
#include "jvminit.h"
#include "rasdump_internal.h"
#include "j9dump.h"
#include "omrthread.h"
/* Possible command line actions */
enum
{
CREATE_DUMP_AGENT = 0x01,
UPDATE_DUMP_SETTINGS = 0x02,
BOGUS_DUMP_OPTION = 0x04,
REMOVE_DUMP_AGENTS = 0x08,
};
/* Describe known event */
typedef struct J9RASdumpEvent
{
char *name;
char *detail;
UDATA bits;
}\
J9RASdumpEvent;
/* Describe known VM request */
typedef struct J9RASdumpRequest
{
char *name;
char *detail;
UDATA bits;
}\
J9RASdumpRequest;
/* Dump settings */
typedef struct J9RASdumpSettings
{
UDATA eventMask;
char *detailFilter;
UDATA startOnCount;
UDATA stopOnCount;
char *labelTemplate;
char *dumpOptions;
UDATA priority;
UDATA requestMask;
char *subFilter;
}\
J9RASdumpSettings;
/* String cache */
typedef struct J9RASdumpStrings
{
char **table;
U_32 length;
U_32 capacity;
U_32 vmCount;
}\
J9RASdumpStrings;
/* Describe known dump specifications */
typedef struct J9RASdumpSpec
{
char *name;
char *summary;
char *labelTag;
char *labelHint;
char *labelDescription;
J9RASdumpFn dumpFn;
J9RASdumpSettings settings;
}\
J9RASdumpSpec;
typedef struct J9RASprotectedDumpData
{
J9RASdumpAgent *agent;
char *label;
J9RASdumpContext *context;
}\
J9RASprotectedDumpData;
/* Known dump events */
static const J9RASdumpEvent rasDumpEvents[] =
{
{ "gpf", "ON_GP_FAULT", J9RAS_DUMP_ON_GP_FAULT },
{ "user", "ON_USER_SIGNAL", J9RAS_DUMP_ON_USER_SIGNAL },
{ "abort", "ON_ABORT_SIGNAL", J9RAS_DUMP_ON_ABORT_SIGNAL },
{ "vmstart", "ON_VM_STARTUP", J9RAS_DUMP_ON_VM_STARTUP },
{ "vmstop", "ON_VM_SHUTDOWN", J9RAS_DUMP_ON_VM_SHUTDOWN },
{ "load", "ON_CLASS_LOAD", J9RAS_DUMP_ON_CLASS_LOAD },
{ "unload", "ON_CLASS_UNLOAD", J9RAS_DUMP_ON_CLASS_UNLOAD },
{ "throw", "ON_EXCEPTION_THROW", J9RAS_DUMP_ON_EXCEPTION_THROW },
{ "catch", "ON_EXCEPTION_CATCH", J9RAS_DUMP_ON_EXCEPTION_CATCH },
{ "thrstart", "ON_THREAD_START", J9RAS_DUMP_ON_THREAD_START },
{ "blocked", "ON_THREAD_BLOCKED", J9RAS_DUMP_ON_THREAD_BLOCKED },
{ "thrstop", "ON_THREAD_END", J9RAS_DUMP_ON_THREAD_END },
{ "fullgc", "ON_GLOBAL_GC", J9RAS_DUMP_ON_GLOBAL_GC },
{ "uncaught", "ON_EXCEPTION_DESCRIBE", J9RAS_DUMP_ON_EXCEPTION_DESCRIBE },
{ "slow", "ON_SLOW_EXCLUSIVE_ENTER", J9RAS_DUMP_ON_SLOW_EXCLUSIVE_ENTER },
{ "systhrow", "ON_EXCEPTION_SYSTHROW", J9RAS_DUMP_ON_EXCEPTION_SYSTHROW },
{ "traceassert", "ON_TRACE_ASSERT", J9RAS_DUMP_ON_TRACE_ASSERT },
/* J9RAS_DUMP_ON_USER_REQUEST cannot be triggered via the command-line */
{ "allocation", "ON_OBJECT_ALLOCATION", J9RAS_DUMP_ON_OBJECT_ALLOCATION },
{ "corruptcache","ON_CORRUPT_CACHE", J9RAS_DUMP_ON_CORRUPT_CACHE },
{ "excessivegc", "ON_EXCESSIVE_GC", J9RAS_DUMP_ON_EXCESSIVE_GC },
};
#define J9RAS_DUMP_KNOWN_EVENTS ( sizeof(rasDumpEvents) / sizeof(J9RASdumpEvent) )
/* Known VM requests */
static const J9RASdumpRequest rasDumpRequests[] =
{
{ "exclusive", "DO_EXCLUSIVE_VM_ACCESS", J9RAS_DUMP_DO_EXCLUSIVE_VM_ACCESS },
{ "compact", "DO_COMPACT_HEAP", J9RAS_DUMP_DO_COMPACT_HEAP },
{ "prepwalk", "DO_PREPARE_HEAP_FOR_WALK", J9RAS_DUMP_DO_PREPARE_HEAP_FOR_WALK },
{ "serial", "DO_SUSPEND_OTHER_DUMPS", J9RAS_DUMP_DO_SUSPEND_OTHER_DUMPS },
{ "attach", "DO_ATTACH_THREAD", J9RAS_DUMP_DO_ATTACH_THREAD },
{ "preempt", "DO_PREEMPT_THREADS", J9RAS_DUMP_DO_PREEMPT_THREADS }
};
#define J9RAS_DUMP_KNOWN_REQUESTS ( sizeof(rasDumpRequests) / sizeof(J9RASdumpRequest) )
static void updatePercentLastToken(J9JavaVM *vm, char *label);
static omr_error_t makePath (J9JavaVM *vm, char *label);
static char* allocString (J9JavaVM *vm, UDATA numBytes);
static omr_error_t mergeAgent (J9JavaVM *vm, J9RASdumpAgent *agent, const J9RASdumpSettings *settings);
static IDATA fixDumpLabel (J9JavaVM *vm, const J9RASdumpSpec *spec, char **labelPtr, IDATA newLabel);
static UDATA processSettings (J9JavaVM *vm, IDATA kind, char *optionString, J9RASdumpSettings *settings);
static J9RASdumpAgent* findAgent (J9JavaVM *vm, IDATA kind, const J9RASdumpSettings *settings);
static char* scanString (J9JavaVM *vm, const char **cursor);
#if defined(J9ZOS390)
static omr_error_t doCEEDump (J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
#endif /* J9ZOS390 */
static omr_error_t doConsoleDump (J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
static omr_error_t doStackDump (J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
omr_error_t doSilentDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
static J9RASdumpAgent* createAgent (J9JavaVM *vm, IDATA kind, const J9RASdumpSettings *settings);
#if (defined(J9VM_RAS_DUMP_AGENTS))
static UDATA protectedDumpFunction (struct J9PortLibrary *portLibrary, void *userData);
#endif /* J9VM_RAS_DUMP_AGENTS */
static omr_error_t freeAgent (J9JavaVM *vm, J9RASdumpAgent **agentPtr);
#if (defined(J9VM_RAS_DUMP_AGENTS))
static UDATA signalHandler (struct J9PortLibrary* portLibrary, U_32 gpType, void* gpInfo, void* userData);
#endif /* J9VM_RAS_DUMP_AGENTS */
static UDATA scanRequests (J9JavaVM *vm, char **cursor, UDATA *actionPtr);
static omr_error_t doJavaDump (J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
static UDATA scanEvents (J9JavaVM *vm, char **cursor, UDATA *actionPtr);
extern UDATA parseAllocationRange(char *range, UDATA *min, UDATA *max);
static char * scanFilter(J9JavaVM *vm, const J9RASdumpSettings *settings, const char **cursor, UDATA *actionPtr);
omr_error_t doSystemDump (J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
omr_error_t doHeapDump (J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
static omr_error_t doSnapDump (J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
static char scanSign (char **cursor);
omr_error_t doToolDump (J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
static omr_error_t doJitDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
static char * scanSubFilter(J9JavaVM *vm, const J9RASdumpSettings *settings, const char **cursor, UDATA *actionPtr);
static omr_error_t doJavaVMExit(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context);
/* Known dump specifications */
static const J9RASdumpSpec rasDumpSpecs[] =
{
{
"console",
"Basic thread dump to stderr",
"file=",
NULL,
"Output file",
doConsoleDump,
{ J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_USER_SIGNAL,
NULL,
1, 0,
NULL,
NULL,
5,
J9RAS_DUMP_DO_EXCLUSIVE_VM_ACCESS,
NULL }
},
{
"stack",
"Print thread information to stderr",
"file=",
NULL,
"Output file",
doStackDump,
{ J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_USER_SIGNAL,
NULL,
1, 0,
NULL,
NULL,
5,
J9RAS_DUMP_DO_EXCLUSIVE_VM_ACCESS,
NULL }
},
{
"system",
"Capture raw process image",
#if defined(J9ZOS390)
"dsn=",
"JAVA_DUMP_TDUMP_PATTERN",
" Output name",
#else
"file=",
"IBM_COREDIR",
"Output file",
#endif
doSystemDump,
{ J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_ABORT_SIGNAL |
J9RAS_DUMP_ON_TRACE_ASSERT|J9RAS_DUMP_ON_CORRUPT_CACHE,
NULL,
1, 0,
#if defined(J9ZOS390)
#if defined(J9ZOS39064)
"%uid.JVM.%job.D%y%m%d.T%H" "%M" "%S.X&DS",
NULL,
#else
"%uid.JVM.TDUMP.%job.D%y%m%d.T%H" "%M" "%S",
NULL,
#endif
#else
"core.%Y" "%m%d.%H" "%M" "%S.%pid.%seq.dmp",
NULL,
#endif
999,
J9RAS_DUMP_DO_SUSPEND_OTHER_DUMPS,
NULL }
},
{
"tool",
"Run command line program",
"exec=",
"JAVA_DUMP_TOOL",
"Command line (special characters should be escaped)",
doToolDump,
{ J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_USER_SIGNAL,
NULL,
1, 1,
#if defined(WIN32)
"windbg -p %pid -c \".setdll %vmbin\\j9windbg\"",
#elif defined(LINUX) /* defined(WIN32) */
"gdb -p %pid",
#elif defined(AIXPPC) /* defined(WIN32) */
"dbx -a %pid",
#elif defined(J9ZOS390) /* defined(WIN32) */
"dbx -a %pid",
#elif defined(OSX) /* defined(WIN32) */
"lldb -p %pid",
#else /* defined(WIN32) */
NULL,
#endif /* defined(WIN32) */
NULL,
1,
J9RAS_DUMP_DO_SUSPEND_OTHER_DUMPS,
NULL }
},
{
"java",
"Write application summary",
"file=",
#if defined(J9ZOS390)
"_CEE_DMPTARG",
#else
"IBM_JAVACOREDIR",
#endif
"Output file",
doJavaDump,
{ J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_USER_SIGNAL | J9RAS_DUMP_ON_ABORT_SIGNAL |
J9RAS_DUMP_ON_TRACE_ASSERT|J9RAS_DUMP_ON_CORRUPT_CACHE,
NULL,
1, 0,
"javacore.%Y" "%m%d.%H" "%M" "%S.%pid.%seq.txt",
NULL,
400,
J9RAS_DUMP_DO_EXCLUSIVE_VM_ACCESS
#if !defined(J9ZOS390) && !defined(J9ZTPF)
| J9RAS_DUMP_DO_PREEMPT_THREADS
#endif /* !defined(J9ZOS390) && !defined(J9ZTPF) */
, NULL
}
},
{
"heap",
"Capture raw heap image",
"file=",
#if defined(J9ZOS390)
"_CEE_DMPTARG",
#else
"IBM_HEAPDUMPDIR",
#endif
"Output file",
doHeapDump,
{ J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_USER_SIGNAL,
NULL,
1, 0,
"heapdump.%Y" "%m%d.%H" "%M" "%S.%pid.%seq.phd",
"PHD",
500,
J9RAS_DUMP_DO_EXCLUSIVE_VM_ACCESS | J9RAS_DUMP_DO_PREPARE_HEAP_FOR_WALK | J9RAS_DUMP_DO_COMPACT_HEAP,
NULL }
},
{
"snap",
"Take a snap of the trace buffers",
"file=",
#if defined(J9ZOS390)
"_CEE_DMPTARG",
#else
"IBM_COREDIR",
#endif
"Output file",
doSnapDump,
{ J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_ABORT_SIGNAL |
J9RAS_DUMP_ON_TRACE_ASSERT | J9RAS_DUMP_ON_CORRUPT_CACHE,
NULL,
1, 0,
"Snap.%Y" "%m%d.%H" "%M" "%S.%pid.%seq.trc",
NULL,
300,
J9RAS_DUMP_DO_SUSPEND_OTHER_DUMPS,
NULL }
},
#if defined(J9ZOS390)
{
"ceedump",
"Take standard LE dump",
"dsn=",
"JAVA_DUMP_TDUMP_PATTERN",
" Output name",
doCEEDump,
{ J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_USER_SIGNAL,
NULL,
1, 0,
"%uid.JVM.CEEDUMP.%job.D%y%m%d.T%H" "%M" "%S",
NULL,
888,
J9RAS_DUMP_DO_SUSPEND_OTHER_DUMPS,
NULL }
},
#endif
{
"jit",
"Capture JIT diagnostic information",
"file=",
#if defined(J9ZOS390)
"_CEE_DMPTARG",
#else
"IBM_COREDIR",
#endif
"Output file",
doJitDump,
{ J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_ABORT_SIGNAL,
NULL,
1, 0,
"jitdump.%Y" "%m%d.%H" "%M" "%S.%pid.%seq.dmp",
NULL,
200,
J9RAS_DUMP_DO_SUSPEND_OTHER_DUMPS,
NULL }
},
{
"silent",
"Dummy dump agent which does nothing",
"file=",
NULL,
"Output file",
doSilentDump,
{ 0,
NULL,
1, 0,
NULL,
NULL,
5,
0,
NULL }
},
{
"exit",
"Shutdown the JVM",
"",
NULL,
NULL,
doJavaVMExit,
{ 0,
NULL,
1, 0,
NULL,
NULL,
0,
J9RAS_DUMP_DO_SUSPEND_OTHER_DUMPS,
NULL }
}
};
#define J9RAS_DUMP_KNOWN_SPECS ( sizeof(rasDumpSpecs) / sizeof(J9RASdumpSpec) )
const UDATA j9RasDumpKnownSpecs = J9RAS_DUMP_KNOWN_SPECS;
/* Shared strings (to avoid bloat during option processing) */
static J9RASdumpStrings rasDumpStrings = {NULL, 0, 0, 0};
static UDATA rasDumpStringLock = 0;
extern void runJavadump(char *label, J9RASdumpContext *context, J9RASdumpAgent* agent);
extern void runHeapdump(char *label, J9RASdumpContext *context, J9RASdumpAgent* agent);
static void
updatePercentLastToken(J9JavaVM *vm, char *label)
{
PORT_ACCESS_FROM_JAVAVM(vm);
struct J9StringTokens* stringTokens;
/* write the label into the %last token */
if (NULL != vm->j9rasdumpGlobalStorage) {
RasDumpGlobalStorage* dump_storage = (RasDumpGlobalStorage*)vm->j9rasdumpGlobalStorage;
/* lock access to the tokens */
omrthread_monitor_enter(dump_storage->dumpLabelTokensMutex);
stringTokens = dump_storage->dumpLabelTokens;
j9str_set_token(PORTLIB, stringTokens, "last", "%s", label);
/* release access to the tokens */
omrthread_monitor_exit(dump_storage->dumpLabelTokensMutex);
}
}
static omr_error_t
makePath(J9JavaVM *vm, char *label)
{
PORT_ACCESS_FROM_JAVAVM(vm);
char *cursor = label;
char tmp_byte = '*';
IDATA fd;
/* No path specified. */
if (label[0] == '\0') {
return OMR_ERROR_INTERNAL;
}
/* disallow stderr */
if (label[0] == '-' && label[1] == '\0') {
return OMR_ERROR_INTERNAL;
}
/* A directory is not a valid path */
if( label[strlen(label)-1] == DIR_SEPARATOR ) {
return OMR_ERROR_INTERNAL;
}
/* Try to create suggested dump file */
fd = j9file_open(label, EsOpenWrite | EsOpenCreateNew | EsOpenCreateNoTag, 0666);
/* No luck - perhaps path hasn't been created... */
if ( fd == -1 ) {
/* attempt to create intermediate folders */
while ( (cursor = strchr(++cursor, DIR_SEPARATOR)) != NULL ) {
*cursor = '\0';
j9file_mkdir(label);
*cursor = DIR_SEPARATOR;
}
/* Try again */
fd = j9file_open(label, EsOpenWrite | EsOpenCreateNew | EsOpenCreateNoTag, 0666);
}
/* attempt to write a byte to the file */
if (fd >= 0) {
if (j9file_write(fd, &tmp_byte, 1) < 0) {
j9file_close(fd);
j9file_unlink(label);
fd = -1;
}
}
if ( fd == -1 ) {
RasDumpGlobalStorage *dumpGlobal = vm->j9rasdumpGlobalStorage;
char fileName[J9_MAX_DUMP_PATH];
char *pFileName;
/* If failover is disabled (-Xdump:nofailover) then bail out now with an error message */
if (dumpGlobal->noFailover) {
j9nls_printf(PORTLIB, J9NLS_ERROR,
J9NLS_DMP_MAKEPATH_CANNOT_USE_DMP_LABEL,
label,
j9error_last_error_message());
return OMR_ERROR_INTERNAL;
}
/* Issue warning message and carry on to try the failover locations */
j9nls_printf(PORTLIB, J9NLS_WARNING,
J9NLS_DMP_MAKEPATH_CANNOT_USE_DMP_LABEL,
label,
j9error_last_error_message());
/* locate and store the filename */
pFileName = strrchr(label, DIR_SEPARATOR);
if (NULL == pFileName) {
strcpy(fileName, label);
} else {
pFileName++;
strcpy(fileName, pFileName);
}
/* first option is to use TMPDIR, if set */
if ( j9sysinfo_get_env("TMPDIR", label, J9_MAX_DUMP_PATH - strlen(fileName) - 2) == 0 ) {
/* add filename to the path */
strcat(label, DIR_SEPARATOR_STR);
strcat(label, fileName);
/* Try to create default dump file */
fd = j9file_open(label, EsOpenWrite | EsOpenCreateNew | EsOpenCreateNoTag, 0666);
if (fd >= 0) {
/* attempt to write a byte to the file */
if (j9file_write(fd, &tmp_byte, 1) < 0) {
j9file_close(fd);
j9file_unlink(label);
fd = -1;
}
}
}
/* TMPDIR not writable, so default to static temp dir as this is our last option */
if ( fd == -1 ) {
/* add basename */
strcpy(label, J9_TMP_DUMP_NAME);
strcat(label, DIR_SEPARATOR_STR);
strcat(label, fileName);
/* Try to create default dump file */
fd = j9file_open(label, EsOpenWrite | EsOpenCreateNew | EsOpenCreateNoTag, 0666);
if (fd >= 0) {
/* attempt to write a byte to the file */
if (j9file_write(fd, &tmp_byte, 1) < 0) {
j9file_close(fd);
j9file_unlink(label);
fd = -1;
}
}
}
}
/* write the path to the target dump file into the %last token */
updatePercentLastToken(vm, label);
/* avoid leaking handles */
if ( fd != -1 ) {
j9file_close(fd);
j9file_unlink(label);
} else {
return OMR_ERROR_INTERNAL;
}
return OMR_ERROR_NONE;
}
static omr_error_t
doConsoleDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)
{
J9RASdumpQueue *queue;
J9JavaVM *vm = context->javaVM;
PORT_ACCESS_FROM_JAVAVM(vm);
j9tty_err_printf(PORTLIB, "-------- Console dump --------\n");
/* Fatal dumps to stderr default to the old-style gpThreadDump */
if ( (context->eventFlags & J9RAS_DUMP_ON_GP_FAULT) && *label == '-' && FIND_DUMP_QUEUE(vm, queue) ) {
queue->oldFacade->triggerDumpAgents( vm, context->onThread, context->eventFlags, context->eventData );
} else {
J9VMThread *self = context->onThread;
if (label[0] == '-' && label[1] == '\0') {
/* No checks needed, output to stderr. */
} else {
if (makePath(vm, label) == OMR_ERROR_INTERNAL) {
/* Nowhere available to write the dump, we are done, makePath() will have issued error message */
return OMR_ERROR_INTERNAL;
}
}
if (self == NULL){
self = vm->mainThread;
}
/* Label of "-" means stderr */
vm->internalVMFunctions->printThreadInfo(vm, self, *label == '-' ? NULL : label, TRUE);
}
j9tty_err_printf(PORTLIB, "\n^^^^^^^^ Console dump ^^^^^^^^\n");
return OMR_ERROR_NONE;
}
static omr_error_t
doStackDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)
{
J9JavaVM *vm = context->javaVM;
J9VMThread *self = context->onThread;
if (label[0] == '-' && label[1] == '\0') {
/* No checks needed, output to stderr. */
} else {
if (makePath(vm, label) == OMR_ERROR_INTERNAL) {
/* Nowhere available to write the dump, we are done, makePath() will have issued error message */
return OMR_ERROR_INTERNAL;
}
}
if (self == NULL) {
self = vm->mainThread;
}
/* Label of "-" means stderr */
vm->internalVMFunctions->printThreadInfo(vm, self, *label == '-' ? NULL : label, FALSE);
return OMR_ERROR_NONE;
}
omr_error_t
doSilentDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)
{
/* Do nothing */
return OMR_ERROR_NONE;
}
static omr_error_t
doJavaVMExit(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)
{
J9JavaVM *vm = context->javaVM;
J9VMThread *vmThread = vm->internalVMFunctions->currentVMThread(vm);
PORT_ACCESS_FROM_JAVAVM(vm);
if (NULL != context->eventData) {
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_EXIT_SHUTDOWN, context->eventData->detailLength, context->eventData->detailData);
} else {
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_EXIT_SHUTDOWN_UNKNOWN);
}
vm->internalVMFunctions->exitJavaVM(vmThread, 3);
return OMR_ERROR_NONE;
}
static UDATA
protectedUpdateJ9RAS(struct J9PortLibrary *portLibrary, void *userData)
{
J9JavaVM *vm = userData;
J9RAS *rasStruct = vm->j9ras;
PORT_ACCESS_FROM_PORT(portLibrary);
/* Store the current TID in the J9RAS structure */
if (compareAndSwapUDATA(&rasStruct->tid, 0, omrthread_get_ras_tid()) == 0) {
/* this thread got the lock, so can safely store the current millisecond and high-resolution timers */
rasStruct->dumpTimeMillis = j9time_current_time_millis();
rasStruct->dumpTimeNanos = j9time_nano_time();
}
return 0;
}
omr_error_t
doSystemDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)
{
J9JavaVM *vm = context->javaVM;
PORT_ACCESS_FROM_JAVAVM(vm);
const char* cacheDir = NULL;
J9RAS* rasStruct = vm->j9ras;
#if defined(J9VM_OPT_SHARED_CLASSES) && (defined(LINUX) || defined(OSX))
J9SharedClassJavacoreDataDescriptor sharedClassData;
/* set up cacheDir with the Shared Classes Cache file if it is in use. */
if ((NULL != vm->sharedClassConfig) && (NULL != vm->sharedClassConfig->getJavacoreData)) {
if (1 == vm->sharedClassConfig->getJavacoreData(vm, &sharedClassData)) {
/* test for memory mapped file */
if (sharedClassData.shmid == -2) {
cacheDir = sharedClassData.cacheDir;
}
}
}
#endif /* defined(J9VM_OPT_SHARED_CLASSES) && (defined(LINUX) || defined(OSX)) */
reportDumpRequest(privatePortLibrary,context,"System",label);
if ( *label != '-' ) {
UDATA retVal;
#ifndef J9ZOS390
if (makePath(vm, label) == OMR_ERROR_INTERNAL) {
/* Nowhere available to write the dump, we are done, makePath() will have issued error message */
return OMR_ERROR_INTERNAL;
}
#endif
/* set the tid if it is unassigned inside a sig protect, in case vm->j9ras is a bad pointer */
j9sig_protect(
protectedUpdateJ9RAS, vm,
signalHandler, NULL,
J9PORT_SIG_FLAG_MAY_RETURN | J9PORT_SIG_FLAG_SIGALLSYNC,
&retVal);
#ifdef J9ZOS390
retVal = j9dump_create( label, "IEATDUMP", (void*)cacheDir );
#else
retVal = j9dump_create( label, agent->dumpOptions, (void*)cacheDir );
#endif
if ( retVal == 0 ) {
if ( label[0] != '\0' ) {
#if defined(J9ZOS39064)
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_WRITTEN_DUMP_STR_ZOS, "System", label);
#else
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_WRITTEN_DUMP_STR, "System", label);
#endif
Trc_dump_reportDumpEnd_Event2("System", label);
} else {
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_WRITTEN_DUMP_STR, "System", "{unable to determine dump name}");
Trc_dump_reportDumpEnd_Event2("System", "{unable to determine dump name}");
}
} else {
j9nls_printf(PORTLIB, J9NLS_ERROR | J9NLS_STDERR, J9NLS_DMP_ERROR_IN_DUMP_STR, "System", label);
Trc_dump_reportDumpError_Event2("System", label);
}
} else {
j9nls_printf(PORTLIB, J9NLS_ERROR | J9NLS_STDERR, J9NLS_DMP_MISSING_FILENAME_STR);
return OMR_ERROR_INTERNAL;
}
/* If this thread set the TID in the J9RAS structure, reset the timestamps and lastly reset the TID */
if (rasStruct->tid == omrthread_get_ras_tid()) {
rasStruct->dumpTimeMillis = 0;
rasStruct->dumpTimeNanos = 0;
compareAndSwapUDATA(&rasStruct->tid, omrthread_get_ras_tid(), 0);
}
return OMR_ERROR_NONE;
}
/*
* Function: doToolDump - launches a tool command as specified via a -Xdump:tool agent
*
* Parameters:
* agent [in] - dump agent structure
* label [in] - tool command to be executed
* context [in] - dump context (what triggered the dump)
*
* Returns: OMR_ERROR_NONE, OMR_ERROR_INTERNAL
*/
omr_error_t
doToolDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)
{
J9JavaVM *vm = context->javaVM;
PORT_ACCESS_FROM_JAVAVM(vm);
UDATA msec = 400;
IDATA async = FALSE;
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_REQUESTING_DUMP_STR, "Tool", label);
if ( agent->dumpOptions ) {
/* Some tools take longer to run => user-specified pause time */
char *buf = strstr(agent->dumpOptions, "WAIT");
if ( buf ) { buf += 4; scan_udata(&buf, &msec); }
/* Don't wait for the tool to finish? */
async = ( strstr(agent->dumpOptions, "ASYNC") != NULL );
}
/* Spawn process: this really should be moved into portlib... */
if ( *label != '-' ) {
#if defined(WIN32)
{
BOOL retVal;
STARTUPINFOW sinfo;
PROCESS_INFORMATION pinfo;
wchar_t localUnicodePath[J9_MAX_DUMP_PATH];
wchar_t *unicodePath = localUnicodePath;
memset( &sinfo, 0, sizeof(sinfo) );
memset( &pinfo, 0, sizeof(pinfo) );
sinfo.cb = sizeof(sinfo);
/* Copy the tool command line into a unicode string, allocating additional memory if needed */
if (strlen(label) >= J9_MAX_DUMP_PATH) {
unicodePath = j9mem_allocate_memory((strlen(label) + 1) * sizeof(wchar_t), OMRMEM_CATEGORY_VM);
if (!unicodePath) {
return OMR_ERROR_OUT_OF_NATIVE_MEMORY;
}
}
MultiByteToWideChar(OS_ENCODING_CODE_PAGE, OS_ENCODING_MB_FLAGS, label, -1, unicodePath, (int)strlen(label) + 1);
retVal = CreateProcessW(NULL, unicodePath, NULL, NULL, TRUE, 0, NULL, NULL, &sinfo, &pinfo);
if (retVal) {
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_SPAWNED_DUMP_STR, "Tool", pinfo.dwProcessId);
/* Give it a chance to start */
if (async == FALSE) {
WaitForSingleObject(pinfo.hProcess, INFINITE);
}
omrthread_sleep(msec);
/* Clean up unused handles */
CloseHandle(pinfo.hThread);
CloseHandle(pinfo.hProcess);
} else {
j9nls_printf(PORTLIB, J9NLS_ERROR | J9NLS_STDERR, J9NLS_DMP_ERROR_IN_DUMP_STR_RC, "Tool", "CreateProcessW()", GetLastError());
}
if (unicodePath != localUnicodePath) {
j9mem_free_memory(unicodePath);
}
}
#elif (defined(LINUX) && !defined(J9ZTPF)) || defined(AIXPPC) || defined(OSX) /* defined(WIN32) */
{
IDATA retVal;
if ( (retVal = fork()) == 0 ) {
retVal = execl("/bin/sh", "/bin/sh", "-c", label, NULL);
j9nls_printf(PORTLIB, J9NLS_ERROR | J9NLS_STDERR, J9NLS_DMP_ERROR_IN_DUMP_STR_RC, "Tool", "execl()", errno);
exit( (int)retVal );
} else {
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_SPAWNED_DUMP_STR, "Tool", retVal);
/* Give it a chance to start */
if (async == FALSE) {
waitpid(retVal, NULL, 0);
}
omrthread_sleep(msec);
}
}
#elif defined(J9ZOS390) /* defined(WIN32) */
{
const char *argv[] = {"/bin/sh", "-c", NULL, NULL};
extern const char **environ;
IDATA retVal;
struct inheritance inherit;
memset( &inherit, 0, sizeof(inherit) );
/* Set actual command */
argv[2] = label;
/* Use spawn instead of fork on z/OS */
retVal = spawnp("/bin/sh", 0, NULL, &inherit, argv, environ);
if ( retVal == -1) {
j9nls_printf(PORTLIB, J9NLS_ERROR | J9NLS_STDERR, J9NLS_DMP_ERROR_IN_DUMP_STR_RC, "Tool", "spawnp()", errno);
} else {
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_SPAWNED_DUMP_STR, "Tool", retVal);
/* Give it a chance to start */
if (async == FALSE) {
waitpid(retVal, NULL, 0);
}
omrthread_sleep(msec);
}
}
#else /* defined(WIN32) */
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_DUMP_NOT_AVAILABLE_STR, "Tool");
#endif /* defined(WIN32) */
} else {
j9nls_printf(PORTLIB, J9NLS_ERROR | J9NLS_STDERR, J9NLS_DMP_MISSING_EXECUTABLE_STR);
}
return OMR_ERROR_NONE;
}
static omr_error_t
doJavaDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)
{
J9JavaVM *vm = context->javaVM;
if ((0 == strcmp("-", label)) || (0 == j9_cmdla_stricmp(label, J9RAS_STDOUT_NAME))) {
strcpy(label, J9RAS_STDOUT_NAME);
} else if (0 == j9_cmdla_stricmp(label, J9RAS_STDERR_NAME)) {
strcpy(label, J9RAS_STDERR_NAME);
} else {
if (makePath(vm, label) == OMR_ERROR_INTERNAL) {
/* Nowhere available to write the dump, we are done, makePath() will have issued error message */
return OMR_ERROR_INTERNAL;
}
}
runJavadump(label, context, agent);
return OMR_ERROR_NONE;
}
omr_error_t
doHeapDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)
{
J9JavaVM *vm = context->javaVM;
if (makePath(vm, label) == OMR_ERROR_INTERNAL) {
/* Nowhere available to write the dump, we are done, makePath() will have issued error message */
return OMR_ERROR_INTERNAL;
}
runHeapdump(label, context, agent);
return OMR_ERROR_NONE;
}
static omr_error_t
doSnapDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)
{
J9JavaVM *vm = context->javaVM;
PORT_ACCESS_FROM_JAVAVM(vm);
RasGlobalStorage * j9ras = (RasGlobalStorage *)vm->j9rasGlobalStorage;
UtInterface * uteInterface = (UtInterface *)(j9ras ? j9ras->utIntf : NULL);
reportDumpRequest(privatePortLibrary,context,"Snap",label);
/* Is trace running? */
if ( uteInterface && uteInterface->server ) {
char *snapResponse = "";
omr_error_t result = OMR_ERROR_NONE;
/* USER_REQUEST is synchronous to prevent Dump API calls returning before the file is written. (USER_SIGNAL is kill -3)
* J9RAS_DUMP_ON_GP_FAULT, J9RAS_DUMP_ON_ABORT_SIGNAL and J9RAS_DUMP_ON_TRACE_ASSERT are synchronous to prevent us
* starting a thread under those conditions.
*/
I_32 sync = (context->eventFlags & (J9RAS_DUMP_ON_USER_REQUEST | J9RAS_DUMP_ON_GP_FAULT | J9RAS_DUMP_ON_ABORT_SIGNAL | J9RAS_DUMP_ON_TRACE_ASSERT )) != 0;
if (makePath(vm, label) == OMR_ERROR_INTERNAL) {
/* Nowhere available to write the dump, we are done, makePath() will have issued error message */
return OMR_ERROR_INTERNAL;
}
/* Asynchronous request - may return before snap is complete */
result = uteInterface->server->TraceSnapWithPriority(
(context->onThread ? UT_THREAD_FROM_VM_THREAD(context->onThread) : NULL),
label, J9THREAD_PRIORITY_MAX, &snapResponse, sync );
if (OMR_ERROR_NONE == result) {
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_WRITTEN_DUMP_STR, "Snap", snapResponse);
Trc_dump_reportDumpEnd_Event2("Snap", snapResponse);
} else {
j9nls_printf(PORTLIB, J9NLS_ERROR | J9NLS_STDERR, J9NLS_DMP_ERROR_IN_DUMP_STR, "Snap", snapResponse);
Trc_dump_reportDumpError_Event2("Snap", snapResponse);
}
} else {
j9nls_printf(PORTLIB, J9NLS_INFO | J9NLS_STDERR, J9NLS_DMP_DUMP_NOT_AVAILABLE_STR, "Snap");
Trc_dump_reportDumpError_Event2("Snap", "{no trace engine}");
}
return OMR_ERROR_NONE;
}
#ifdef J9ZOS390
static omr_error_t
doCEEDump(J9RASdumpAgent *agent, char *label, J9RASdumpContext *context)