-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Comment and clean-up some code (#47)
1. Add `BlockingCallsByteBuddyTransformer` and move the advice in it 2. Add `AllowancesByteBuddyTransformer` and move the advice 3. Document ByteBuddy customizations
- Loading branch information
Showing
5 changed files
with
261 additions
and
162 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
128 changes: 128 additions & 0 deletions
128
agent/src/main/java/reactor/blockhound/AllowancesByteBuddyTransformer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /* | ||
| * Copyright (c) 2019-Present Pivotal Software Inc, All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package reactor.blockhound; | ||
|
|
||
| import net.bytebuddy.agent.builder.AgentBuilder; | ||
| import net.bytebuddy.asm.Advice; | ||
| import net.bytebuddy.asm.AsmVisitorWrapper; | ||
| import net.bytebuddy.description.annotation.AnnotationDescription; | ||
| import net.bytebuddy.description.method.ParameterDescription; | ||
| import net.bytebuddy.description.type.TypeDescription; | ||
| import net.bytebuddy.dynamic.DynamicType; | ||
| import net.bytebuddy.utility.JavaModule; | ||
|
|
||
| import java.lang.annotation.Documented; | ||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * This transformer applies {@link AllowAdvice} to every method | ||
| * registered with {@link BlockHound.Builder#allowBlockingCallsInside(String, String)}. | ||
| */ | ||
| class AllowancesByteBuddyTransformer implements AgentBuilder.Transformer { | ||
|
|
||
| private Map<String, Map<String, Boolean>> allowances; | ||
|
|
||
| AllowancesByteBuddyTransformer(Map<String, Map<String, Boolean>> allowances) { | ||
| this.allowances = allowances; | ||
| } | ||
|
|
||
| @Override | ||
| public DynamicType.Builder<?> transform( | ||
| DynamicType.Builder<?> builder, | ||
| TypeDescription typeDescription, | ||
| ClassLoader classLoader, | ||
| JavaModule module | ||
| ) { | ||
| Map<String, Boolean> methods = allowances.get(typeDescription.getName()); | ||
|
|
||
| if (methods == null) { | ||
| return builder; | ||
| } | ||
|
|
||
| AsmVisitorWrapper advice = Advice | ||
| .withCustomMapping() | ||
| .bind(new AllowedArgument.Factory(methods)) | ||
| .to(AllowAdvice.class) | ||
| .on(method -> methods.containsKey(method.getName())); | ||
|
|
||
| return builder.visit(advice); | ||
| } | ||
|
|
||
| @Documented | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @java.lang.annotation.Target(ElementType.PARAMETER) | ||
| @interface AllowedArgument { | ||
|
|
||
| /** | ||
| * Binds advice method's argument annotated with {@link AllowedArgument} | ||
| * to boolean where `true` means "allowed" and `false" means "disallowed" | ||
| */ | ||
| class Factory implements Advice.OffsetMapping.Factory<AllowedArgument> { | ||
|
|
||
| final Map<String, Boolean> methods; | ||
|
|
||
| Factory(Map<String, Boolean> methods) { | ||
| this.methods = methods; | ||
| } | ||
|
|
||
| @Override | ||
| public Class<AllowedArgument> getAnnotationType() { | ||
| return AllowedArgument.class; | ||
| } | ||
|
|
||
| @Override | ||
| public Advice.OffsetMapping make( | ||
| ParameterDescription.InDefinedShape target, | ||
| AnnotationDescription.Loadable<AllowedArgument> annotation, | ||
| AdviceType adviceType | ||
| ) { | ||
| return (instrumentedType, instrumentedMethod, assigner, argumentHandler, sort) -> { | ||
| boolean allowed = methods.get(instrumentedMethod.getName()); | ||
| return Advice.OffsetMapping.Target.ForStackManipulation.of(allowed); | ||
| }; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| static class AllowAdvice { | ||
|
|
||
| @Advice.OnMethodEnter | ||
| static boolean onEnter( | ||
| @AllowancesByteBuddyTransformer.AllowedArgument boolean allowed | ||
| ) { | ||
| Boolean previous = BlockHoundRuntime.IS_ALLOWED.get(); | ||
| if (previous == null || previous == allowed) { | ||
| return allowed; | ||
| } | ||
| BlockHoundRuntime.IS_ALLOWED.set(allowed); | ||
| return previous; | ||
| } | ||
|
|
||
| @Advice.OnMethodExit(onThrowable = Throwable.class) | ||
| static void onExit( | ||
| @Advice.Enter boolean wasAllowed, | ||
| @AllowancesByteBuddyTransformer.AllowedArgument boolean allowed | ||
| ) { | ||
| if (wasAllowed != allowed) { | ||
| BlockHoundRuntime.IS_ALLOWED.set(wasAllowed); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 0 additions & 42 deletions
42
agent/src/main/java/reactor/blockhound/BlockingCallAdvice.java
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.