core/src/main/java/com/taobao/arthas/core/advisor/Enhancer.java [68:332]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - public class Enhancer implements ClassFileTransformer { private static final Logger logger = LoggerFactory.getLogger(Enhancer.class); private final AdviceListener listener; private final boolean isTracing; private final boolean skipJDKTrace; private final Matcher classNameMatcher; private final Matcher classNameExcludeMatcher; private final Matcher methodNameMatcher; private final EnhancerAffect affect; private Set> matchingClasses = null; private static final ClassLoader selfClassLoader = Enhancer.class.getClassLoader(); // 被增强的类的缓存 private final static Map/* Class */, Object> classBytesCache = new WeakHashMap, Object>(); private static SpyImpl spyImpl = new SpyImpl(); static { SpyAPI.setSpy(spyImpl); } /** * @param adviceId 通知编号 * @param isTracing 可跟踪方法调用 * @param skipJDKTrace 是否忽略对JDK内部方法的跟踪 * @param matchingClasses 匹配中的类 * @param methodNameMatcher 方法名匹配 * @param affect 影响统计 */ public Enhancer(AdviceListener listener, boolean isTracing, boolean skipJDKTrace, Matcher classNameMatcher, Matcher classNameExcludeMatcher, Matcher methodNameMatcher) { this.listener = listener; this.isTracing = isTracing; this.skipJDKTrace = skipJDKTrace; this.classNameMatcher = classNameMatcher; this.classNameExcludeMatcher = classNameExcludeMatcher; this.methodNameMatcher = methodNameMatcher; this.affect = new EnhancerAffect(); affect.setListenerId(listener.id()); } @Override public byte[] transform(final ClassLoader inClassLoader, String className, Class classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException { try { // 检查classloader能否加载到 SpyAPI，如果不能，则放弃增强 try { if (inClassLoader != null) { inClassLoader.loadClass(SpyAPI.class.getName()); } } catch (Throwable e) { logger.error("the classloader can not load SpyAPI, ignore it. classloader: {}, className: {}", inClassLoader.getClass().getName(), className, e); return null; } // 这里要再次过滤一次，为啥？因为在transform的过程中，有可能还会再诞生新的类 // 所以需要将之前需要转换的类集合传递下来，再次进行判断 if (matchingClasses != null && !matchingClasses.contains(classBeingRedefined)) { return null; } //keep origin class reader for bytecode optimizations, avoiding JVM metaspace OOM. ClassNode classNode = new ClassNode(Opcodes.ASM9); ClassReader classReader = AsmUtils.toClassNode(classfileBuffer, classNode); // remove JSR https://github.com/alibaba/arthas/issues/1304 classNode = AsmUtils.removeJSRInstructions(classNode); // 生成增强字节码 DefaultInterceptorClassParser defaultInterceptorClassParser = new DefaultInterceptorClassParser(); final List interceptorProcessors = new ArrayList(); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyInterceptor1.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyInterceptor2.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyInterceptor3.class)); if (this.isTracing) { if (!this.skipJDKTrace) { interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceInterceptor1.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceInterceptor2.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceInterceptor3.class)); } else { interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceExcludeJDKInterceptor1.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceExcludeJDKInterceptor2.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceExcludeJDKInterceptor3.class)); } } List matchedMethods = new ArrayList(); for (MethodNode methodNode : classNode.methods) { if (!isIgnore(methodNode, methodNameMatcher)) { matchedMethods.add(methodNode); } } // https://github.com/alibaba/arthas/issues/1690 if (AsmUtils.isEnhancerByCGLIB(className)) { for (MethodNode methodNode : matchedMethods) { if (AsmUtils.isConstructor(methodNode)) { AsmUtils.fixConstructorExceptionTable(methodNode); } } } // 用于检查是否已插入了 spy函数，如果已有则不重复处理 GroupLocationFilter groupLocationFilter = new GroupLocationFilter(); LocationFilter enterFilter = new InvokeContainLocationFilter(Type.getInternalName(SpyAPI.class), "atEnter", LocationType.ENTER); LocationFilter existFilter = new InvokeContainLocationFilter(Type.getInternalName(SpyAPI.class), "atExit", LocationType.EXIT); LocationFilter exceptionFilter = new InvokeContainLocationFilter(Type.getInternalName(SpyAPI.class), "atExceptionExit", LocationType.EXCEPTION_EXIT); groupLocationFilter.addFilter(enterFilter); groupLocationFilter.addFilter(existFilter); groupLocationFilter.addFilter(exceptionFilter); LocationFilter invokeBeforeFilter = new InvokeCheckLocationFilter(Type.getInternalName(SpyAPI.class), "atBeforeInvoke", LocationType.INVOKE); LocationFilter invokeAfterFilter = new InvokeCheckLocationFilter(Type.getInternalName(SpyAPI.class), "atInvokeException", LocationType.INVOKE_COMPLETED); LocationFilter invokeExceptionFilter = new InvokeCheckLocationFilter(Type.getInternalName(SpyAPI.class), "atInvokeException", LocationType.INVOKE_EXCEPTION_EXIT); groupLocationFilter.addFilter(invokeBeforeFilter); groupLocationFilter.addFilter(invokeAfterFilter); groupLocationFilter.addFilter(invokeExceptionFilter); for (MethodNode methodNode : matchedMethods) { if (AsmUtils.isNative(methodNode)) { logger.info("ignore native method: {}", AsmUtils.methodDeclaration(Type.getObjectType(classNode.name), methodNode)); continue; } // 先查找是否有 atBeforeInvoke 函数，如果有，则说明已经有trace了，则直接不再尝试增强，直接插入 listener if(AsmUtils.containsMethodInsnNode(methodNode, Type.getInternalName(SpyAPI.class), "atBeforeInvoke")) { for (AbstractInsnNode insnNode = methodNode.instructions.getFirst(); insnNode != null; insnNode = insnNode .getNext()) { if (insnNode instanceof MethodInsnNode) { final MethodInsnNode methodInsnNode = (MethodInsnNode) insnNode; if(this.skipJDKTrace) { if(methodInsnNode.owner.startsWith("java/")) { continue; } } // 原始类型的box类型相关的都跳过 if(AsmOpUtils.isBoxType(Type.getObjectType(methodInsnNode.owner))) { continue; } AdviceListenerManager.registerTraceAdviceListener(inClassLoader, className, methodInsnNode.owner, methodInsnNode.name, methodInsnNode.desc, listener); } } }else { MethodProcessor methodProcessor = new MethodProcessor(classNode, methodNode, groupLocationFilter); for (InterceptorProcessor interceptor : interceptorProcessors) { try { List locations = interceptor.process(methodProcessor); for (Location location : locations) { if (location instanceof MethodInsnNodeWare) { MethodInsnNodeWare methodInsnNodeWare = (MethodInsnNodeWare) location; MethodInsnNode methodInsnNode = methodInsnNodeWare.methodInsnNode(); AdviceListenerManager.registerTraceAdviceListener(inClassLoader, className, methodInsnNode.owner, methodInsnNode.name, methodInsnNode.desc, listener); } } } catch (Throwable e) { logger.error("enhancer error, class: {}, method: {}, interceptor: {}", classNode.name, methodNode.name, interceptor.getClass().getName(), e); } } } // enter/exist 总是要插入 listener AdviceListenerManager.registerAdviceListener(inClassLoader, className, methodNode.name, methodNode.desc, listener); affect.addMethodAndCount(inClassLoader, className, methodNode.name, methodNode.desc); } // https://github.com/alibaba/arthas/issues/1223 , V1_5 的major version是49 if (AsmUtils.getMajorVersion(classNode.version) < 49) { classNode.version = AsmUtils.setMajorVersion(classNode.version, 49); } byte[] enhanceClassByteArray = AsmUtils.toBytes(classNode, inClassLoader, classReader); // 增强成功，记录类 classBytesCache.put(classBeingRedefined, new Object()); // dump the class dumpClassIfNecessary(className, enhanceClassByteArray, affect); // 成功计数 affect.cCnt(1); return enhanceClassByteArray; } catch (Throwable t) { logger.warn("transform loader[{}]:class[{}] failed.", inClassLoader, className, t); affect.setThrowable(t); } return null; } /** * 是否抽象属性 */ private boolean isAbstract(int access) { return (Opcodes.ACC_ABSTRACT & access) == Opcodes.ACC_ABSTRACT; } /** * 是否需要忽略 */ private boolean isIgnore(MethodNode methodNode, Matcher methodNameMatcher) { return null == methodNode || isAbstract(methodNode.access) || !methodNameMatcher.matching(methodNode.name) || ArthasCheckUtils.isEquals(methodNode.name, ""); } /** * dump class to file */ private static void dumpClassIfNecessary(String className, byte[] data, EnhancerAffect affect) { if (!GlobalOptions.isDump) { return; } final File dumpClassFile = new File("./arthas-class-dump/" + className + ".class"); final File classPath = new File(dumpClassFile.getParent()); // 创建类所在的包路径 if (!classPath.mkdirs() && !classPath.exists()) { logger.warn("create dump classpath:{} failed.", classPath); return; } // 将类字节码写入文件 try { FileUtils.writeByteArrayToFile(dumpClassFile, data); affect.addClassDumpFile(dumpClassFile); if (GlobalOptions.verbose) { logger.info("dump enhanced class: {}, path: {}", className, dumpClassFile); } } catch (IOException e) { logger.warn("dump class:{} to file {} failed.", className, dumpClassFile, e); } } /** * 是否需要过滤的类 * * @param classes 类集合 */ private List, String>> filter(Set> classes) { List, String>> filteredClasses = new ArrayList, String>>(); final Iterator> it = classes.iterator(); while (it.hasNext()) { final Class clazz = it.next(); boolean removeFlag = false; if (null == clazz) { removeFlag = true; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - labs/arthas-grpc-web-proxy/src/main/java/com/taobao/arthas/grpcweb/grpc/service/advisor/Enhancer.java [54:318]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - public class Enhancer implements ClassFileTransformer { private static final Logger logger = LoggerFactory.getLogger(Enhancer.class); private final AdviceListener listener; private final boolean isTracing; private final boolean skipJDKTrace; private final Matcher classNameMatcher; private final Matcher classNameExcludeMatcher; private final Matcher methodNameMatcher; private final EnhancerAffect affect; private Set> matchingClasses = null; private static final ClassLoader selfClassLoader = Enhancer.class.getClassLoader(); // 被增强的类的缓存 private final static Map/* Class */, Object> classBytesCache = new WeakHashMap, Object>(); private static SpyImpl spyImpl = new SpyImpl(); static { SpyAPI.setSpy(spyImpl); } /** * @param adviceId 通知编号 * @param isTracing 可跟踪方法调用 * @param skipJDKTrace 是否忽略对JDK内部方法的跟踪 * @param matchingClasses 匹配中的类 * @param methodNameMatcher 方法名匹配 * @param affect 影响统计 */ public Enhancer(AdviceListener listener, boolean isTracing, boolean skipJDKTrace, Matcher classNameMatcher, Matcher classNameExcludeMatcher, Matcher methodNameMatcher) { this.listener = listener; this.isTracing = isTracing; this.skipJDKTrace = skipJDKTrace; this.classNameMatcher = classNameMatcher; this.classNameExcludeMatcher = classNameExcludeMatcher; this.methodNameMatcher = methodNameMatcher; this.affect = new EnhancerAffect(); affect.setListenerId(listener.id()); } @Override public byte[] transform(final ClassLoader inClassLoader, String className, Class classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException { try { // 检查classloader能否加载到 SpyAPI，如果不能，则放弃增强 try { if (inClassLoader != null) { inClassLoader.loadClass(SpyAPI.class.getName()); } } catch (Throwable e) { logger.error("the classloader can not load SpyAPI, ignore it. classloader: {}, className: {}", inClassLoader.getClass().getName(), className, e); return null; } // 这里要再次过滤一次，为啥？因为在transform的过程中，有可能还会再诞生新的类 // 所以需要将之前需要转换的类集合传递下来，再次进行判断 if (matchingClasses != null && !matchingClasses.contains(classBeingRedefined)) { return null; } //keep origin class reader for bytecode optimizations, avoiding JVM metaspace OOM. ClassNode classNode = new ClassNode(Opcodes.ASM9); ClassReader classReader = AsmUtils.toClassNode(classfileBuffer, classNode); // remove JSR https://github.com/alibaba/arthas/issues/1304 classNode = AsmUtils.removeJSRInstructions(classNode); // 生成增强字节码 DefaultInterceptorClassParser defaultInterceptorClassParser = new DefaultInterceptorClassParser(); final List interceptorProcessors = new ArrayList(); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyInterceptor1.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyInterceptor2.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyInterceptor3.class)); if (this.isTracing) { if (!this.skipJDKTrace) { interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceInterceptor1.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceInterceptor2.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceInterceptor3.class)); } else { interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceExcludeJDKInterceptor1.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceExcludeJDKInterceptor2.class)); interceptorProcessors.addAll(defaultInterceptorClassParser.parse(SpyTraceExcludeJDKInterceptor3.class)); } } List matchedMethods = new ArrayList(); for (MethodNode methodNode : classNode.methods) { if (!isIgnore(methodNode, methodNameMatcher)) { matchedMethods.add(methodNode); } } // https://github.com/alibaba/arthas/issues/1690 if (AsmUtils.isEnhancerByCGLIB(className)) { for (MethodNode methodNode : matchedMethods) { if (AsmUtils.isConstructor(methodNode)) { AsmUtils.fixConstructorExceptionTable(methodNode); } } } // 用于检查是否已插入了 spy函数，如果已有则不重复处理 GroupLocationFilter groupLocationFilter = new GroupLocationFilter(); LocationFilter enterFilter = new InvokeContainLocationFilter(Type.getInternalName(SpyAPI.class), "atEnter", LocationType.ENTER); LocationFilter existFilter = new InvokeContainLocationFilter(Type.getInternalName(SpyAPI.class), "atExit", LocationType.EXIT); LocationFilter exceptionFilter = new InvokeContainLocationFilter(Type.getInternalName(SpyAPI.class), "atExceptionExit", LocationType.EXCEPTION_EXIT); groupLocationFilter.addFilter(enterFilter); groupLocationFilter.addFilter(existFilter); groupLocationFilter.addFilter(exceptionFilter); LocationFilter invokeBeforeFilter = new InvokeCheckLocationFilter(Type.getInternalName(SpyAPI.class), "atBeforeInvoke", LocationType.INVOKE); LocationFilter invokeAfterFilter = new InvokeCheckLocationFilter(Type.getInternalName(SpyAPI.class), "atInvokeException", LocationType.INVOKE_COMPLETED); LocationFilter invokeExceptionFilter = new InvokeCheckLocationFilter(Type.getInternalName(SpyAPI.class), "atInvokeException", LocationType.INVOKE_EXCEPTION_EXIT); groupLocationFilter.addFilter(invokeBeforeFilter); groupLocationFilter.addFilter(invokeAfterFilter); groupLocationFilter.addFilter(invokeExceptionFilter); for (MethodNode methodNode : matchedMethods) { if (AsmUtils.isNative(methodNode)) { logger.info("ignore native method: {}", AsmUtils.methodDeclaration(Type.getObjectType(classNode.name), methodNode)); continue; } // 先查找是否有 atBeforeInvoke 函数，如果有，则说明已经有trace了，则直接不再尝试增强，直接插入 listener if(AsmUtils.containsMethodInsnNode(methodNode, Type.getInternalName(SpyAPI.class), "atBeforeInvoke")) { for (AbstractInsnNode insnNode = methodNode.instructions.getFirst(); insnNode != null; insnNode = insnNode .getNext()) { if (insnNode instanceof MethodInsnNode) { final MethodInsnNode methodInsnNode = (MethodInsnNode) insnNode; if(this.skipJDKTrace) { if(methodInsnNode.owner.startsWith("java/")) { continue; } } // 原始类型的box类型相关的都跳过 if(AsmOpUtils.isBoxType(Type.getObjectType(methodInsnNode.owner))) { continue; } AdviceListenerManager.registerTraceAdviceListener(inClassLoader, className, methodInsnNode.owner, methodInsnNode.name, methodInsnNode.desc, listener); } } }else { MethodProcessor methodProcessor = new MethodProcessor(classNode, methodNode, groupLocationFilter); for (InterceptorProcessor interceptor : interceptorProcessors) { try { List locations = interceptor.process(methodProcessor); for (Location location : locations) { if (location instanceof MethodInsnNodeWare) { MethodInsnNodeWare methodInsnNodeWare = (MethodInsnNodeWare) location; MethodInsnNode methodInsnNode = methodInsnNodeWare.methodInsnNode(); AdviceListenerManager.registerTraceAdviceListener(inClassLoader, className, methodInsnNode.owner, methodInsnNode.name, methodInsnNode.desc, listener); } } } catch (Throwable e) { logger.error("enhancer error, class: {}, method: {}, interceptor: {}", classNode.name, methodNode.name, interceptor.getClass().getName(), e); } } } // enter/exist 总是要插入 listener AdviceListenerManager.registerAdviceListener(inClassLoader, className, methodNode.name, methodNode.desc, listener); affect.addMethodAndCount(inClassLoader, className, methodNode.name, methodNode.desc); } // https://github.com/alibaba/arthas/issues/1223 , V1_5 的major version是49 if (AsmUtils.getMajorVersion(classNode.version) < 49) { classNode.version = AsmUtils.setMajorVersion(classNode.version, 49); } byte[] enhanceClassByteArray = AsmUtils.toBytes(classNode, inClassLoader, classReader); // 增强成功，记录类 classBytesCache.put(classBeingRedefined, new Object()); // dump the class dumpClassIfNecessary(className, enhanceClassByteArray, affect); // 成功计数 affect.cCnt(1); return enhanceClassByteArray; } catch (Throwable t) { logger.warn("transform loader[{}]:class[{}] failed.", inClassLoader, className, t); affect.setThrowable(t); } return null; } /** * 是否抽象属性 */ private boolean isAbstract(int access) { return (Opcodes.ACC_ABSTRACT & access) == Opcodes.ACC_ABSTRACT; } /** * 是否需要忽略 */ private boolean isIgnore(MethodNode methodNode, Matcher methodNameMatcher) { return null == methodNode || isAbstract(methodNode.access) || !methodNameMatcher.matching(methodNode.name) || ArthasCheckUtils.isEquals(methodNode.name, ""); } /** * dump class to file */ private static void dumpClassIfNecessary(String className, byte[] data, EnhancerAffect affect) { if (!GlobalOptions.isDump) { return; } final File dumpClassFile = new File("./arthas-class-dump/" + className + ".class"); final File classPath = new File(dumpClassFile.getParent()); // 创建类所在的包路径 if (!classPath.mkdirs() && !classPath.exists()) { logger.warn("create dump classpath:{} failed.", classPath); return; } // 将类字节码写入文件 try { FileUtils.writeByteArrayToFile(dumpClassFile, data); affect.addClassDumpFile(dumpClassFile); if (GlobalOptions.verbose) { logger.info("dump enhanced class: {}, path: {}", className, dumpClassFile); } } catch (IOException e) { logger.warn("dump class:{} to file {} failed.", className, dumpClassFile, e); } } /** * 是否需要过滤的类 * * @param classes 类集合 */ private List, String>> filter(Set> classes) { List, String>> filteredClasses = new ArrayList, String>>(); final Iterator> it = classes.iterator(); while (it.hasNext()) { final Class clazz = it.next(); boolean removeFlag = false; if (null == clazz) { removeFlag = true; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -