-
Notifications
You must be signed in to change notification settings - Fork 194
/
Copy pathJPLISAgent.c
1554 lines (1345 loc) · 60.4 KB
/
JPLISAgent.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) 2003, 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* Copyright 2003 Wily Technology, Inc.
*/
#include <jni.h>
#include <jvmti.h>
#include <stdlib.h>
#include <string.h>
#include "JPLISAgent.h"
#include "JPLISAssert.h"
#include "Utilities.h"
#include "Reentrancy.h"
#include "JavaExceptions.h"
#include "EncodingSupport.h"
#include "FileSystemSupport.h" /* For MAXPATHLEN & uintptr_t */
#include "sun_instrument_InstrumentationImpl.h"
/*
* The JPLISAgent manages the initialization all of the Java programming language Agents.
* It also supports the native method bridge between the JPLIS and the JVMTI.
* It maintains a single JVMTI Env that all JPL agents share.
* It parses command line requests and creates individual Java agents.
*/
/*
* private prototypes
*/
/* Allocates an unformatted JPLIS agent data structure. Returns NULL if allocation fails. */
JPLISAgent *
allocateJPLISAgent(jvmtiEnv * jvmtiEnv);
/* Initializes an already-allocated JPLIS agent data structure. */
JPLISInitializationError
initializeJPLISAgent( JPLISAgent * agent,
JavaVM * vm,
jvmtiEnv * jvmtienv);
/* De-allocates a JPLIS agent data structure. Only used in partial-failure cases at startup;
* in normal usage the JPLIS agent lives forever
*/
void
deallocateJPLISAgent( jvmtiEnv * jvmtienv,
JPLISAgent * agent);
/* Does one-time work to interrogate the JVM about capabilities and cache the answers. */
void
checkCapabilities(JPLISAgent * agent);
/* Takes the elements of the command string (agent class name and options string) and
* create java strings for them.
* Returns true if a classname was found. Makes no promises beyond the textual; says nothing about whether
* the class exists or can be loaded.
* If return value is true, sets outputClassname to a non-NULL local JNI reference.
* If return value is true, sets outputOptionsString either to NULL or to a non-NULL local JNI reference.
* If return value is false, neither output parameter is set.
*/
jboolean
commandStringIntoJavaStrings( JNIEnv * jnienv,
const char * classname,
const char * optionsString,
jstring * outputClassname,
jstring * outputOptionsString);
/* Start one Java agent from the supplied parameters.
* Most of the logic lives in a helper function that lives over in Java code--
* we pass parameters out to Java and use our own Java helper to actually
* load the agent and call the premain.
* Returns true if the Java agent class is loaded and the premain/agentmain method completes
* with no exceptions, false otherwise.
*/
jboolean
invokeJavaAgentMainMethod( JNIEnv * jnienv,
jobject instrumentationImpl,
jmethodID agentMainMethod,
jstring className,
jstring optionsString);
/* Once we have loaded the Java agent and called the premain,
* we can release the copies we have been keeping of the command line
* data (agent class name and option strings).
*/
void
deallocateCommandLineData(JPLISAgent * agent);
/*
* Common support for various class list fetchers.
*/
typedef jvmtiError (*ClassListFetcher)
( jvmtiEnv * jvmtiEnv,
jobject classLoader,
jint * classCount,
jclass ** classes);
/* Fetcher that ignores the class loader parameter, and uses the JVMTI to get a list of all classes.
* Returns a jvmtiError according to the underlying JVMTI service.
*/
jvmtiError
getAllLoadedClassesClassListFetcher( jvmtiEnv * jvmtiEnv,
jobject classLoader,
jint * classCount,
jclass ** classes);
/* Fetcher that uses the class loader parameter, and uses the JVMTI to get a list of all classes
* for which the supplied loader is the initiating loader.
* Returns a jvmtiError according to the underlying JVMTI service.
*/
jvmtiError
getInitiatedClassesClassListFetcher( jvmtiEnv * jvmtiEnv,
jobject classLoader,
jint * classCount,
jclass ** classes);
/*
* Common guts for two native methods, which are the same except for the policy for fetching
* the list of classes.
* Either returns a local JNI reference to an array of references to java.lang.Class.
* Can throw, if it does will alter the JNIEnv with an outstanding exception.
*/
jobjectArray
commonGetClassList( JNIEnv * jnienv,
JPLISAgent * agent,
jobject classLoader,
ClassListFetcher fetcher);
/*
* Misc. utilities.
*/
/* Checked exception mapper used by the redefine classes implementation.
* Allows ClassNotFoundException or UnmodifiableClassException; maps others
* to InternalError. Can return NULL in an error case.
*/
jthrowable
redefineClassMapper( JNIEnv * jnienv,
jthrowable throwableToMap);
/* Turns a buffer of jclass * into a Java array whose elements are java.lang.Class.
* Can throw, if it does will alter the JNIEnv with an outstanding exception.
*/
jobjectArray
getObjectArrayFromClasses(JNIEnv* jnienv, jclass* classes, jint classCount);
JPLISEnvironment *
getJPLISEnvironment(jvmtiEnv * jvmtienv) {
JPLISEnvironment * environment = NULL;
jvmtiError jvmtierror = JVMTI_ERROR_NONE;
jvmtierror = (*jvmtienv)->GetEnvironmentLocalStorage(
jvmtienv,
(void**)&environment);
/* can be called from any phase */
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
if (jvmtierror == JVMTI_ERROR_NONE) {
jplis_assert(environment != NULL);
jplis_assert(environment->mJVMTIEnv == jvmtienv);
} else {
environment = NULL;
}
return environment;
}
/*
* OnLoad processing code.
*/
/*
* Creates a new JPLISAgent.
* Returns error if the agent cannot be created and initialized.
* The JPLISAgent* pointed to by agent_ptr is set to the new broker,
* or NULL if an error has occurred.
*/
JPLISInitializationError
createNewJPLISAgent(JavaVM * vm, JPLISAgent **agent_ptr) {
JPLISInitializationError initerror = JPLIS_INIT_ERROR_NONE;
jvmtiEnv * jvmtienv = NULL;
jint jnierror = JNI_OK;
*agent_ptr = NULL;
jnierror = (*vm)->GetEnv( vm,
(void **) &jvmtienv,
JVMTI_VERSION_1_1);
if ( jnierror != JNI_OK ) {
initerror = JPLIS_INIT_ERROR_CANNOT_CREATE_NATIVE_AGENT;
} else {
JPLISAgent * agent = allocateJPLISAgent(jvmtienv);
if ( agent == NULL ) {
initerror = JPLIS_INIT_ERROR_ALLOCATION_FAILURE;
} else {
initerror = initializeJPLISAgent( agent,
vm,
jvmtienv);
if ( initerror == JPLIS_INIT_ERROR_NONE ) {
*agent_ptr = agent;
} else {
deallocateJPLISAgent(jvmtienv, agent);
}
}
/* don't leak envs */
if ( initerror != JPLIS_INIT_ERROR_NONE ) {
jvmtiError jvmtierror = (*jvmtienv)->DisposeEnvironment(jvmtienv);
/* can be called from any phase */
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
}
}
return initerror;
}
/*
* Allocates a JPLISAgent. Returns NULL if it cannot be allocated
*/
JPLISAgent *
allocateJPLISAgent(jvmtiEnv * jvmtienv) {
return (JPLISAgent *) allocate( jvmtienv,
sizeof(JPLISAgent));
}
JPLISInitializationError
initializeJPLISAgent( JPLISAgent * agent,
JavaVM * vm,
jvmtiEnv * jvmtienv) {
jvmtiError jvmtierror = JVMTI_ERROR_NONE;
jvmtiPhase phase;
agent->mJVM = vm;
agent->mNormalEnvironment.mJVMTIEnv = jvmtienv;
agent->mNormalEnvironment.mAgent = agent;
agent->mNormalEnvironment.mIsRetransformer = JNI_FALSE;
agent->mRetransformEnvironment.mJVMTIEnv = NULL; /* NULL until needed */
agent->mRetransformEnvironment.mAgent = agent;
agent->mRetransformEnvironment.mIsRetransformer = JNI_FALSE; /* JNI_FALSE until mJVMTIEnv is set */
agent->mAgentmainCaller = NULL;
agent->mInstrumentationImpl = NULL;
agent->mPremainCaller = NULL;
agent->mTransform = NULL;
agent->mRedefineAvailable = JNI_FALSE; /* assume no for now */
agent->mRedefineAdded = JNI_FALSE;
agent->mNativeMethodPrefixAvailable = JNI_FALSE; /* assume no for now */
agent->mNativeMethodPrefixAdded = JNI_FALSE;
agent->mAgentClassName = NULL;
agent->mOptionsString = NULL;
/* make sure we can recover either handle in either direction.
* the agent has a ref to the jvmti; make it mutual
*/
jvmtierror = (*jvmtienv)->SetEnvironmentLocalStorage(
jvmtienv,
&(agent->mNormalEnvironment));
/* can be called from any phase */
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
/* check what capabilities are available */
checkCapabilities(agent);
/* check phase - if live phase then we don't need the VMInit event */
jvmtierror = (*jvmtienv)->GetPhase(jvmtienv, &phase);
/* can be called from any phase */
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
if (phase == JVMTI_PHASE_LIVE) {
return JPLIS_INIT_ERROR_NONE;
}
if (phase != JVMTI_PHASE_ONLOAD) {
/* called too early or called too late; either way bail out */
return JPLIS_INIT_ERROR_FAILURE;
}
/* now turn on the VMInit event */
if ( jvmtierror == JVMTI_ERROR_NONE ) {
jvmtiEventCallbacks callbacks;
memset(&callbacks, 0, sizeof(callbacks));
callbacks.VMInit = &eventHandlerVMInit;
jvmtierror = (*jvmtienv)->SetEventCallbacks( jvmtienv,
&callbacks,
sizeof(callbacks));
check_phase_ret_blob(jvmtierror, JPLIS_INIT_ERROR_FAILURE);
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
}
if ( jvmtierror == JVMTI_ERROR_NONE ) {
jvmtierror = (*jvmtienv)->SetEventNotificationMode(
jvmtienv,
JVMTI_ENABLE,
JVMTI_EVENT_VM_INIT,
NULL /* all threads */);
check_phase_ret_blob(jvmtierror, JPLIS_INIT_ERROR_FAILURE);
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
}
return (jvmtierror == JVMTI_ERROR_NONE)? JPLIS_INIT_ERROR_NONE : JPLIS_INIT_ERROR_FAILURE;
}
void
deallocateJPLISAgent(jvmtiEnv * jvmtienv, JPLISAgent * agent) {
deallocate(jvmtienv, agent);
}
JPLISInitializationError
recordCommandLineData( JPLISAgent * agent,
const char * agentClassName,
const char * optionsString ) {
JPLISInitializationError initerror = JPLIS_INIT_ERROR_NONE;
char * ourCopyOfAgentClassName = NULL;
char * ourCopyOfOptionsString = NULL;
/* if no actual params, bail out now */
if ((agentClassName == NULL) || (*agentClassName == 0)) {
initerror = JPLIS_INIT_ERROR_AGENT_CLASS_NOT_SPECIFIED;
} else {
ourCopyOfAgentClassName = allocate(jvmti(agent), strlen(agentClassName)+1);
if (ourCopyOfAgentClassName == NULL) {
initerror = JPLIS_INIT_ERROR_ALLOCATION_FAILURE;
} else {
if (optionsString != NULL) {
ourCopyOfOptionsString = allocate(jvmti(agent), strlen(optionsString)+1);
if (ourCopyOfOptionsString == NULL) {
deallocate(jvmti(agent), ourCopyOfAgentClassName);
initerror = JPLIS_INIT_ERROR_ALLOCATION_FAILURE;
}
}
}
}
if (initerror == JPLIS_INIT_ERROR_NONE) {
strcpy(ourCopyOfAgentClassName, agentClassName);
if (optionsString != NULL) {
strcpy(ourCopyOfOptionsString, optionsString);
}
agent->mAgentClassName = ourCopyOfAgentClassName;
agent->mOptionsString = ourCopyOfOptionsString;
}
return initerror;
}
/*
* VMInit processing code.
*/
/*
* If this call fails, the JVM launch will ultimately be aborted,
* so we don't have to be super-careful to clean up in partial failure
* cases.
*/
jboolean
processJavaStart( JPLISAgent * agent,
JNIEnv * jnienv) {
jboolean result;
/*
* OK, Java is up now. We can start everything that needs Java.
*/
/*
* First make our emergency fallback InternalError throwable.
*/
result = initializeFallbackError(jnienv);
jplis_assert(result);
/*
* Now make the InstrumentationImpl instance.
*/
if ( result ) {
result = createInstrumentationImpl(jnienv, agent);
jplis_assert(result);
}
/*
* Then turn off the VMInit handler and turn on the ClassFileLoadHook.
* This way it is on before anyone registers a transformer.
*/
if ( result ) {
result = setLivePhaseEventHandlers(agent);
jplis_assert(result);
}
/*
* Load the Java agent, and call the premain.
*/
if ( result ) {
result = startJavaAgent(agent, jnienv,
agent->mAgentClassName, agent->mOptionsString,
agent->mPremainCaller);
}
/*
* Finally surrender all of the tracking data that we don't need any more.
* If something is wrong, skip it, we will be aborting the JVM anyway.
*/
if ( result ) {
deallocateCommandLineData(agent);
}
return result;
}
jboolean
startJavaAgent( JPLISAgent * agent,
JNIEnv * jnienv,
const char * classname,
const char * optionsString,
jmethodID agentMainMethod) {
jboolean success = JNI_FALSE;
jstring classNameObject = NULL;
jstring optionsStringObject = NULL;
success = commandStringIntoJavaStrings( jnienv,
classname,
optionsString,
&classNameObject,
&optionsStringObject);
if (success) {
success = invokeJavaAgentMainMethod( jnienv,
agent->mInstrumentationImpl,
agentMainMethod,
classNameObject,
optionsStringObject);
}
return success;
}
void
deallocateCommandLineData( JPLISAgent * agent) {
deallocate(jvmti(agent), (void*)agent->mAgentClassName);
deallocate(jvmti(agent), (void*)agent->mOptionsString);
/* zero things out so it is easier to see what is going on */
agent->mAgentClassName = NULL;
agent->mOptionsString = NULL;
}
/*
* Create the java.lang.instrument.Instrumentation instance
* and access information for it (method IDs, etc)
*/
jboolean
createInstrumentationImpl( JNIEnv * jnienv,
JPLISAgent * agent) {
jclass implClass = NULL;
jboolean errorOutstanding = JNI_FALSE;
jobject resultImpl = NULL;
jmethodID premainCallerMethodID = NULL;
jmethodID agentmainCallerMethodID = NULL;
jmethodID transformMethodID = NULL;
jmethodID constructorID = NULL;
jobject localReference = NULL;
/* First find the class of our implementation */
implClass = (*jnienv)->FindClass( jnienv,
JPLIS_INSTRUMENTIMPL_CLASSNAME);
errorOutstanding = checkForAndClearThrowable(jnienv);
errorOutstanding = errorOutstanding || (implClass == NULL);
jplis_assert_msg(!errorOutstanding, "find class on InstrumentationImpl failed");
if ( !errorOutstanding ) {
constructorID = (*jnienv)->GetMethodID( jnienv,
implClass,
JPLIS_INSTRUMENTIMPL_CONSTRUCTOR_METHODNAME,
JPLIS_INSTRUMENTIMPL_CONSTRUCTOR_METHODSIGNATURE);
errorOutstanding = checkForAndClearThrowable(jnienv);
errorOutstanding = errorOutstanding || (constructorID == NULL);
jplis_assert_msg(!errorOutstanding, "find constructor on InstrumentationImpl failed");
}
if ( !errorOutstanding ) {
jlong peerReferenceAsScalar = (jlong)(intptr_t) agent;
localReference = (*jnienv)->NewObject( jnienv,
implClass,
constructorID,
peerReferenceAsScalar,
agent->mRedefineAdded,
agent->mNativeMethodPrefixAdded);
errorOutstanding = checkForAndClearThrowable(jnienv);
errorOutstanding = errorOutstanding || (localReference == NULL);
jplis_assert_msg(!errorOutstanding, "call constructor on InstrumentationImpl failed");
}
if ( !errorOutstanding ) {
resultImpl = (*jnienv)->NewGlobalRef(jnienv, localReference);
errorOutstanding = checkForAndClearThrowable(jnienv);
jplis_assert_msg(!errorOutstanding, "copy local ref to global ref");
}
/* Now look up the method ID for the pre-main caller (we will need this more than once) */
if ( !errorOutstanding ) {
premainCallerMethodID = (*jnienv)->GetMethodID( jnienv,
implClass,
JPLIS_INSTRUMENTIMPL_PREMAININVOKER_METHODNAME,
JPLIS_INSTRUMENTIMPL_PREMAININVOKER_METHODSIGNATURE);
errorOutstanding = checkForAndClearThrowable(jnienv);
errorOutstanding = errorOutstanding || (premainCallerMethodID == NULL);
jplis_assert_msg(!errorOutstanding, "can't find premain invoker methodID");
}
/* Now look up the method ID for the agent-main caller */
if ( !errorOutstanding ) {
agentmainCallerMethodID = (*jnienv)->GetMethodID( jnienv,
implClass,
JPLIS_INSTRUMENTIMPL_AGENTMAININVOKER_METHODNAME,
JPLIS_INSTRUMENTIMPL_AGENTMAININVOKER_METHODSIGNATURE);
errorOutstanding = checkForAndClearThrowable(jnienv);
errorOutstanding = errorOutstanding || (agentmainCallerMethodID == NULL);
jplis_assert_msg(!errorOutstanding, "can't find agentmain invoker methodID");
}
/* Now look up the method ID for the transform method (we will need this constantly) */
if ( !errorOutstanding ) {
transformMethodID = (*jnienv)->GetMethodID( jnienv,
implClass,
JPLIS_INSTRUMENTIMPL_TRANSFORM_METHODNAME,
JPLIS_INSTRUMENTIMPL_TRANSFORM_METHODSIGNATURE);
errorOutstanding = checkForAndClearThrowable(jnienv);
errorOutstanding = errorOutstanding || (transformMethodID == NULL);
jplis_assert_msg(!errorOutstanding, "can't find transform methodID");
}
if ( !errorOutstanding ) {
agent->mInstrumentationImpl = resultImpl;
agent->mPremainCaller = premainCallerMethodID;
agent->mAgentmainCaller = agentmainCallerMethodID;
agent->mTransform = transformMethodID;
}
return !errorOutstanding;
}
jboolean
commandStringIntoJavaStrings( JNIEnv * jnienv,
const char * classname,
const char * optionsString,
jstring * outputClassname,
jstring * outputOptionsString) {
jstring classnameJavaString = NULL;
jstring optionsJavaString = NULL;
jboolean errorOutstanding = JNI_TRUE;
classnameJavaString = (*jnienv)->NewStringUTF(jnienv, classname);
errorOutstanding = checkForAndClearThrowable(jnienv);
jplis_assert_msg(!errorOutstanding, "can't create class name java string");
if ( !errorOutstanding ) {
if ( optionsString != NULL) {
optionsJavaString = (*jnienv)->NewStringUTF(jnienv, optionsString);
errorOutstanding = checkForAndClearThrowable(jnienv);
jplis_assert_msg(!errorOutstanding, "can't create options java string");
}
if ( !errorOutstanding ) {
*outputClassname = classnameJavaString;
*outputOptionsString = optionsJavaString;
}
}
return !errorOutstanding;
}
jboolean
invokeJavaAgentMainMethod( JNIEnv * jnienv,
jobject instrumentationImpl,
jmethodID mainCallingMethod,
jstring className,
jstring optionsString) {
jboolean errorOutstanding = JNI_FALSE;
jplis_assert(mainCallingMethod != NULL);
if ( mainCallingMethod != NULL ) {
(*jnienv)->CallVoidMethod( jnienv,
instrumentationImpl,
mainCallingMethod,
className,
optionsString);
errorOutstanding = checkForThrowable(jnienv);
if ( errorOutstanding ) {
logThrowable(jnienv);
}
checkForAndClearThrowable(jnienv);
}
return !errorOutstanding;
}
jboolean
setLivePhaseEventHandlers( JPLISAgent * agent) {
jvmtiEventCallbacks callbacks;
jvmtiEnv * jvmtienv = jvmti(agent);
jvmtiError jvmtierror;
/* first swap out the handlers (switch from the VMInit handler, which we do not need,
* to the ClassFileLoadHook handler, which is what the agents need from now on)
*/
memset(&callbacks, 0, sizeof(callbacks));
callbacks.ClassFileLoadHook = &eventHandlerClassFileLoadHook;
jvmtierror = (*jvmtienv)->SetEventCallbacks( jvmtienv,
&callbacks,
sizeof(callbacks));
check_phase_ret_false(jvmtierror);
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
if ( jvmtierror == JVMTI_ERROR_NONE ) {
/* turn off VMInit */
jvmtierror = (*jvmtienv)->SetEventNotificationMode(
jvmtienv,
JVMTI_DISABLE,
JVMTI_EVENT_VM_INIT,
NULL /* all threads */);
check_phase_ret_false(jvmtierror);
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
}
if ( jvmtierror == JVMTI_ERROR_NONE ) {
/* turn on ClassFileLoadHook */
jvmtierror = (*jvmtienv)->SetEventNotificationMode(
jvmtienv,
JVMTI_ENABLE,
JVMTI_EVENT_CLASS_FILE_LOAD_HOOK,
NULL /* all threads */);
check_phase_ret_false(jvmtierror);
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
}
return (jvmtierror == JVMTI_ERROR_NONE);
}
/**
* Check if the can_redefine_classes capability is available.
*/
void
checkCapabilities(JPLISAgent * agent) {
jvmtiEnv * jvmtienv = jvmti(agent);
jvmtiCapabilities potentialCapabilities;
jvmtiError jvmtierror;
memset(&potentialCapabilities, 0, sizeof(potentialCapabilities));
jvmtierror = (*jvmtienv)->GetPotentialCapabilities(jvmtienv, &potentialCapabilities);
check_phase_ret(jvmtierror);
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
if ( jvmtierror == JVMTI_ERROR_NONE ) {
if ( potentialCapabilities.can_redefine_classes == 1 ) {
agent->mRedefineAvailable = JNI_TRUE;
}
if ( potentialCapabilities.can_set_native_method_prefix == 1 ) {
agent->mNativeMethodPrefixAvailable = JNI_TRUE;
}
}
}
/**
* Enable native method prefix in one JVM TI environment
*/
void
enableNativeMethodPrefixCapability(jvmtiEnv * jvmtienv) {
jvmtiCapabilities desiredCapabilities;
jvmtiError jvmtierror;
jvmtierror = (*jvmtienv)->GetCapabilities(jvmtienv, &desiredCapabilities);
/* can be called from any phase */
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
desiredCapabilities.can_set_native_method_prefix = 1;
jvmtierror = (*jvmtienv)->AddCapabilities(jvmtienv, &desiredCapabilities);
check_phase_ret(jvmtierror);
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
}
/**
* Add the can_set_native_method_prefix capability
*/
void
addNativeMethodPrefixCapability(JPLISAgent * agent) {
if (agent->mNativeMethodPrefixAvailable && !agent->mNativeMethodPrefixAdded) {
jvmtiEnv * jvmtienv = agent->mNormalEnvironment.mJVMTIEnv;
enableNativeMethodPrefixCapability(jvmtienv);
jvmtienv = agent->mRetransformEnvironment.mJVMTIEnv;
if (jvmtienv != NULL) {
enableNativeMethodPrefixCapability(jvmtienv);
}
agent->mNativeMethodPrefixAdded = JNI_TRUE;
}
}
/**
* Add the can_maintain_original_method_order capability (for testing)
*/
void
addOriginalMethodOrderCapability(JPLISAgent * agent) {
jvmtiEnv * jvmtienv = jvmti(agent);
jvmtiCapabilities desiredCapabilities;
jvmtiError jvmtierror;
jvmtierror = (*jvmtienv)->GetCapabilities(jvmtienv, &desiredCapabilities);
/* can be called from any phase */
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
desiredCapabilities.can_maintain_original_method_order = 1;
jvmtierror = (*jvmtienv)->AddCapabilities(jvmtienv, &desiredCapabilities);
check_phase_ret(jvmtierror);
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
}
/**
* Add the can_redefine_classes capability
*/
void
addRedefineClassesCapability(JPLISAgent * agent) {
jvmtiEnv * jvmtienv = jvmti(agent);
jvmtiCapabilities desiredCapabilities;
jvmtiError jvmtierror;
if (agent->mRedefineAvailable && !agent->mRedefineAdded) {
jvmtierror = (*jvmtienv)->GetCapabilities(jvmtienv, &desiredCapabilities);
/* can be called from any phase */
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
desiredCapabilities.can_redefine_classes = 1;
jvmtierror = (*jvmtienv)->AddCapabilities(jvmtienv, &desiredCapabilities);
check_phase_ret(jvmtierror);
/*
* With mixed premain/agentmain agents then it's possible that the
* capability was potentially available in the onload phase but
* subsequently unavailable in the live phase.
*/
jplis_assert(jvmtierror == JVMTI_ERROR_NONE ||
jvmtierror == JVMTI_ERROR_NOT_AVAILABLE);
if (jvmtierror == JVMTI_ERROR_NONE) {
agent->mRedefineAdded = JNI_TRUE;
}
}
}
/*
* Support for the JVMTI callbacks
*/
void
transformClassFile( JPLISAgent * agent,
JNIEnv * jnienv,
jobject loaderObject,
const char* name,
jclass classBeingRedefined,
jobject protectionDomain,
jint class_data_len,
const unsigned char* class_data,
jint* new_class_data_len,
unsigned char** new_class_data,
jboolean is_retransformer) {
jboolean errorOutstanding = JNI_FALSE;
jstring classNameStringObject = NULL;
jarray classFileBufferObject = NULL;
jarray transformedBufferObject = NULL;
jsize transformedBufferSize = 0;
unsigned char * resultBuffer = NULL;
jboolean shouldRun = JNI_FALSE;
/* only do this if we aren't already in the middle of processing a class on this thread */
shouldRun = tryToAcquireReentrancyToken(
jvmti(agent),
NULL); /* this thread */
if ( shouldRun ) {
/* first marshall all the parameters */
classNameStringObject = (*jnienv)->NewStringUTF(jnienv,
name);
errorOutstanding = checkForAndClearThrowable(jnienv);
jplis_assert_msg(!errorOutstanding, "can't create name string");
if ( !errorOutstanding ) {
classFileBufferObject = (*jnienv)->NewByteArray(jnienv,
class_data_len);
errorOutstanding = checkForAndClearThrowable(jnienv);
jplis_assert_msg(!errorOutstanding, "can't create byte arrau");
}
if ( !errorOutstanding ) {
jbyte * typedBuffer = (jbyte *) class_data; /* nasty cast, dumb JNI interface, const missing */
/* The sign cast is safe. The const cast is dumb. */
(*jnienv)->SetByteArrayRegion( jnienv,
classFileBufferObject,
0,
class_data_len,
typedBuffer);
errorOutstanding = checkForAndClearThrowable(jnienv);
jplis_assert_msg(!errorOutstanding, "can't set byte array region");
}
/* now call the JPL agents to do the transforming */
/* potential future optimization: may want to skip this if there are none */
if ( !errorOutstanding ) {
jplis_assert(agent->mInstrumentationImpl != NULL);
jplis_assert(agent->mTransform != NULL);
transformedBufferObject = (*jnienv)->CallObjectMethod(
jnienv,
agent->mInstrumentationImpl,
agent->mTransform,
loaderObject,
classNameStringObject,
classBeingRedefined,
protectionDomain,
classFileBufferObject,
is_retransformer);
errorOutstanding = checkForAndClearThrowable(jnienv);
jplis_assert_msg(!errorOutstanding, "transform method call failed");
}
/* Finally, unmarshall the parameters (if someone touched the buffer, tell the JVM) */
if ( !errorOutstanding ) {
if ( transformedBufferObject != NULL ) {
transformedBufferSize = (*jnienv)->GetArrayLength( jnienv,
transformedBufferObject);
errorOutstanding = checkForAndClearThrowable(jnienv);
jplis_assert_msg(!errorOutstanding, "can't get array length");
if ( !errorOutstanding ) {
/* allocate the response buffer with the JVMTI allocate call.
* This is what the JVMTI spec says to do for Class File Load hook responses
*/
jvmtiError allocError = (*(jvmti(agent)))->Allocate(jvmti(agent),
transformedBufferSize,
&resultBuffer);
errorOutstanding = (allocError != JVMTI_ERROR_NONE);
jplis_assert_msg(!errorOutstanding, "can't allocate result buffer");
}
if ( !errorOutstanding ) {
(*jnienv)->GetByteArrayRegion( jnienv,
transformedBufferObject,
0,
transformedBufferSize,
(jbyte *) resultBuffer);
errorOutstanding = checkForAndClearThrowable(jnienv);
jplis_assert_msg(!errorOutstanding, "can't get byte array region");
/* in this case, we will not return the buffer to the JVMTI,
* so we need to deallocate it ourselves
*/
if ( errorOutstanding ) {
deallocate( jvmti(agent),
(void*)resultBuffer);
}
}
if ( !errorOutstanding ) {
*new_class_data_len = (transformedBufferSize);
*new_class_data = resultBuffer;
}
}
}
/* release the token */
releaseReentrancyToken( jvmti(agent),
NULL); /* this thread */
}
return;
}
/*
* Misc. internal utilities.
*/
/*
* The only checked exceptions we can throw are ClassNotFoundException and
* UnmodifiableClassException. All others map to InternalError.
*/
jthrowable
redefineClassMapper( JNIEnv * jnienv,
jthrowable throwableToMap) {
jthrowable mappedThrowable = NULL;
jplis_assert(isSafeForJNICalls(jnienv));
jplis_assert(!isUnchecked(jnienv, throwableToMap));
if ( isInstanceofClassName( jnienv,
throwableToMap,
"java/lang/ClassNotFoundException") ) {
mappedThrowable = throwableToMap;
} else {
if ( isInstanceofClassName( jnienv,
throwableToMap,
"java/lang/instrument/UnmodifiableClassException")) {
mappedThrowable = throwableToMap;
} else {
jstring message = NULL;
message = getMessageFromThrowable(jnienv, throwableToMap);
mappedThrowable = createInternalError(jnienv, message);
}
}
jplis_assert(isSafeForJNICalls(jnienv));
return mappedThrowable;
}
jobjectArray
getObjectArrayFromClasses(JNIEnv* jnienv, jclass* classes, jint classCount) {
jclass classArrayClass = NULL;
jobjectArray localArray = NULL;
jint classIndex = 0;
jboolean errorOccurred = JNI_FALSE;
/* get the class array class */
classArrayClass = (*jnienv)->FindClass(jnienv, "java/lang/Class");
errorOccurred = checkForThrowable(jnienv);
if (!errorOccurred) {
jplis_assert_msg(classArrayClass != NULL, "FindClass returned null class");
/* create the array for the classes */
localArray = (*jnienv)->NewObjectArray(jnienv, classCount, classArrayClass, NULL);
errorOccurred = checkForThrowable(jnienv);
if (!errorOccurred) {
jplis_assert_msg(localArray != NULL, "NewObjectArray returned null array");
/* now copy refs to all the classes and put them into the array */
for (classIndex = 0; classIndex < classCount; classIndex++) {
/* put class into array */
(*jnienv)->SetObjectArrayElement(jnienv, localArray, classIndex, classes[classIndex]);
errorOccurred = checkForThrowable(jnienv);
if (errorOccurred) {
localArray = NULL;
break;
}
}
}
}
return localArray;
}
/* Return the environment with the retransformation capability.
* Create it if it doesn't exist.
* Return NULL if it can't be created.
*/
jvmtiEnv *
retransformableEnvironment(JPLISAgent * agent) {
jvmtiEnv * retransformerEnv = NULL;
jint jnierror = JNI_OK;
jvmtiCapabilities desiredCapabilities;
jvmtiEventCallbacks callbacks;
jvmtiError jvmtierror;
if (agent->mRetransformEnvironment.mJVMTIEnv != NULL) {
return agent->mRetransformEnvironment.mJVMTIEnv;
}
jnierror = (*agent->mJVM)->GetEnv( agent->mJVM,
(void **) &retransformerEnv,
JVMTI_VERSION_1_1);
if ( jnierror != JNI_OK ) {
return NULL;
}
jvmtierror = (*retransformerEnv)->GetCapabilities(retransformerEnv, &desiredCapabilities);
jplis_assert(jvmtierror == JVMTI_ERROR_NONE);
desiredCapabilities.can_retransform_classes = 1;
if (agent->mNativeMethodPrefixAdded) {