| #!/usr/bin/env python3 |
| # Copyright 2012 The Chromium Authors |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| """Extracts native methods from a Java file and generates the JNI bindings. |
| If you change this, please run and update the tests.""" |
| import argparse |
| import base64 |
| import collections |
| import hashlib |
| import os |
| import re |
| import shutil |
| from string import Template |
| import subprocess |
| import sys |
| import tempfile |
| import textwrap |
| import zipfile |
| |
| _FILE_DIR = os.path.dirname(__file__) |
| _CHROMIUM_SRC = os.path.join(_FILE_DIR, os.pardir, os.pardir, os.pardir) |
| _BUILD_ANDROID_GYP = os.path.join(_CHROMIUM_SRC, 'build', 'android', 'gyp') |
| |
| # Item 0 of sys.path is the directory of the main file; item 1 is PYTHONPATH |
| # (if set); item 2 is system libraries. |
| sys.path.insert(1, _BUILD_ANDROID_GYP) |
| |
| from util import build_utils |
| import action_helpers # build_utils adds //build to sys.path. |
| |
| # Match single line comments, multiline comments, character literals, and |
| # double-quoted strings. |
| _COMMENT_REMOVER_REGEX = re.compile( |
| r'//.*?$|/\*.*?\*/|\'(?:\\.|[^\\\'])*\'|"(?:\\.|[^\\"])*"', |
| re.DOTALL | re.MULTILINE) |
| |
| _EXTRACT_NATIVES_REGEX = re.compile( |
| r'(@NativeClassQualifiedName' |
| r'\(\"(?P<native_class_name>.*?)\"\)\s+)?' |
| r'(@NativeCall(\(\"(?P<java_class_name>.*?)\"\))\s+)?' |
| r'(?P<qualifiers>\w+\s\w+|\w+|\s+)\s*native ' |
| r'(?P<return_type>\S*) ' |
| r'(?P<name>native\w+)\((?P<params>.*?)\);') |
| |
| _MAIN_DEX_REGEX = re.compile(r'^\s*(?:@(?:\w+\.)*\w+\s+)*@MainDex\b', |
| re.MULTILINE) |
| |
| # Matches on method declarations unlike _EXTRACT_NATIVES_REGEX |
| # doesn't require name to be prefixed with native, and does not |
| # require a native qualifier. |
| _EXTRACT_METHODS_REGEX = re.compile( |
| r'(@NativeClassQualifiedName' |
| r'\(\"(?P<native_class_name>.*?)\"\)\s*)?' |
| r'(?P<qualifiers>' |
| r'((public|private|static|final|abstract|protected|native)\s*)*)\s+' |
| r'(?P<return_type>\S*)\s+' |
| r'(?P<name>\w+)\((?P<params>.*?)\);', |
| flags=re.DOTALL) |
| |
| _NATIVE_PROXY_EXTRACTION_REGEX = re.compile( |
| r'@NativeMethods(?:\(\s*"(?P<module_name>\w+)"\s*\))?[\S\s]+?interface\s*' |
| r'(?P<interface_name>\w*)\s*(?P<interface_body>{(\s*.*)+?\s*})') |
| |
| # Use 100 columns rather than 80 because it makes many lines more readable. |
| _WRAP_LINE_LENGTH = 100 |
| # WrapOutput() is fairly slow. Pre-creating TextWrappers helps a bit. |
| _WRAPPERS_BY_INDENT = [ |
| textwrap.TextWrapper( |
| width=_WRAP_LINE_LENGTH, |
| expand_tabs=False, |
| replace_whitespace=False, |
| subsequent_indent=' ' * (indent + 4), |
| break_long_words=False) for indent in range(50) |
| ] # 50 chosen experimentally. |
| |
| JAVA_POD_TYPE_MAP = { |
| 'int': 'jint', |
| 'byte': 'jbyte', |
| 'char': 'jchar', |
| 'short': 'jshort', |
| 'boolean': 'jboolean', |
| 'long': 'jlong', |
| 'double': 'jdouble', |
| 'float': 'jfloat', |
| } |
| |
| JAVA_TYPE_MAP = { |
| 'void': 'void', |
| 'String': 'jstring', |
| 'Class': 'jclass', |
| 'Throwable': 'jthrowable', |
| 'java/lang/String': 'jstring', |
| 'java/lang/Class': 'jclass', |
| 'java/lang/Throwable': 'jthrowable', |
| } |
| |
| |
| class ParseError(Exception): |
| """Exception thrown when we can't parse the input file.""" |
| |
| def __init__(self, description, *context_lines): |
| Exception.__init__(self) |
| self.description = description |
| self.context_lines = context_lines |
| |
| def __str__(self): |
| context = '\n'.join(self.context_lines) |
| return '***\nERROR: %s\n\n%s\n***' % (self.description, context) |
| |
| |
| class Param(object): |
| """Describes a param for a method, either java or native.""" |
| |
| def __init__(self, **kwargs): |
| self.annotations = kwargs.get('annotations', []) |
| self.datatype = kwargs['datatype'] |
| self.name = kwargs['name'] |
| |
| |
| class NativeMethod(object): |
| """Describes a C/C++ method that is called by Java code""" |
| |
| def __init__(self, **kwargs): |
| self.static = kwargs['static'] |
| self.java_class_name = kwargs['java_class_name'] |
| self.return_type = kwargs['return_type'] |
| self.params = kwargs['params'] |
| self.is_proxy = kwargs.get('is_proxy', False) |
| |
| self.name = kwargs['name'] |
| if self.is_proxy: |
| # Proxy methods don't have a native prefix so the first letter is |
| # lowercase. But we still want the CPP declaration to use upper camel |
| # case for the method name. |
| self.name = self.name[0].upper() + self.name[1:] |
| |
| self.proxy_name = kwargs.get('proxy_name', self.name) |
| self.hashed_proxy_name = kwargs.get('hashed_proxy_name', None) |
| self.switch_num = None |
| |
| if self.params: |
| assert type(self.params) is list |
| assert type(self.params[0]) is Param |
| |
| ptr_type = kwargs.get('ptr_type', 'int') |
| if (self.params and self.params[0].datatype == ptr_type |
| and self.params[0].name.startswith('native')): |
| self.ptr_type = ptr_type |
| self.type = 'method' |
| self.p0_type = kwargs.get('p0_type') |
| if self.p0_type is None: |
| self.p0_type = self.params[0].name[len('native'):] |
| if kwargs.get('native_class_name'): |
| self.p0_type = kwargs['native_class_name'] |
| else: |
| self.type = 'function' |
| self.method_id_var_name = kwargs.get('method_id_var_name', None) |
| self.return_and_signature = (self.return_type, |
| tuple(p.datatype for p in self.params)) |
| |
| |
| class CalledByNative(object): |
| """Describes a java method exported to c/c++""" |
| |
| def __init__(self, **kwargs): |
| self.system_class = kwargs['system_class'] |
| self.unchecked = kwargs['unchecked'] |
| self.static = kwargs['static'] |
| self.java_class_name = kwargs['java_class_name'] |
| self.return_type = kwargs['return_type'] |
| self.name = kwargs['name'] |
| self.params = kwargs['params'] |
| self.method_id_var_name = kwargs.get('method_id_var_name', None) |
| self.signature = kwargs.get('signature') |
| self.is_constructor = kwargs.get('is_constructor', False) |
| self.env_call = GetEnvCall(self.is_constructor, self.static, |
| self.return_type) |
| self.static_cast = GetStaticCastForReturnType(self.return_type) |
| |
| |
| class ConstantField(object): |
| |
| def __init__(self, **kwargs): |
| self.name = kwargs['name'] |
| self.value = kwargs['value'] |
| |
| |
| def JavaDataTypeToC(java_type): |
| """Returns a C datatype for the given java type.""" |
| java_type = _StripGenerics(java_type) |
| if java_type in JAVA_POD_TYPE_MAP: |
| return JAVA_POD_TYPE_MAP[java_type] |
| elif java_type in JAVA_TYPE_MAP: |
| return JAVA_TYPE_MAP[java_type] |
| elif java_type.endswith('[]'): |
| if java_type[:-2] in JAVA_POD_TYPE_MAP: |
| return JAVA_POD_TYPE_MAP[java_type[:-2]] + 'Array' |
| return 'jobjectArray' |
| else: |
| return 'jobject' |
| |
| |
| def JavaTypeToProxyCast(java_type): |
| """Maps from a java type to the type used by the native proxy GEN_JNI class""" |
| # All the types and array types of JAVA_TYPE_MAP become jobjectArray across |
| # jni but they still need to be passed as the original type on the java side. |
| raw_type = java_type.rstrip('[]') |
| if raw_type in JAVA_POD_TYPE_MAP or raw_type in JAVA_TYPE_MAP: |
| return java_type |
| |
| # All other types should just be passed as Objects or Object arrays. |
| return 'Object' + java_type[len(raw_type):] |
| |
| |
| def WrapCTypeForDeclaration(c_type): |
| """Wrap the C datatype in a JavaRef if required.""" |
| if re.match(RE_SCOPED_JNI_TYPES, c_type): |
| return 'const base::android::JavaParamRef<' + c_type + '>&' |
| else: |
| return c_type |
| |
| |
| def _JavaDataTypeToCForDeclaration(java_type): |
| """Returns a JavaRef-wrapped C datatype for the given java type.""" |
| return WrapCTypeForDeclaration(JavaDataTypeToC(java_type)) |
| |
| |
| def JavaDataTypeToCForCalledByNativeParam(java_type): |
| """Returns a C datatype to be when calling from native.""" |
| if java_type == 'int': |
| return 'JniIntWrapper' |
| else: |
| c_type = JavaDataTypeToC(java_type) |
| if re.match(RE_SCOPED_JNI_TYPES, c_type): |
| return 'const base::android::JavaRef<' + c_type + '>&' |
| else: |
| return c_type |
| |
| |
| def JavaReturnValueToC(java_type): |
| """Returns a valid C return value for the given java type.""" |
| java_pod_type_map = { |
| 'int': '0', |
| 'byte': '0', |
| 'char': '0', |
| 'short': '0', |
| 'boolean': 'false', |
| 'long': '0', |
| 'double': '0', |
| 'float': '0', |
| 'void': '' |
| } |
| return java_pod_type_map.get(java_type, 'NULL') |
| |
| |
| def _GetJNIFirstParam(native, for_declaration): |
| c_type = 'jclass' if native.static else 'jobject' |
| |
| if for_declaration: |
| c_type = WrapCTypeForDeclaration(c_type) |
| return [c_type + ' jcaller'] |
| |
| |
| def GetFullyQualifiedClassWithPackagePrefix(fully_qualified_class, |
| package_prefix): |
| if package_prefix: |
| return '%s/%s' % (package_prefix.replace(".", "/"), fully_qualified_class) |
| return fully_qualified_class |
| |
| |
| def _GetParamsInDeclaration(native): |
| """Returns the params for the forward declaration. |
| |
| Args: |
| native: the native dictionary describing the method. |
| |
| Returns: |
| A string containing the params. |
| """ |
| if not native.static: |
| return _GetJNIFirstParam(native, True) + [ |
| _JavaDataTypeToCForDeclaration(param.datatype) + ' ' + param.name |
| for param in native.params |
| ] |
| return [ |
| _JavaDataTypeToCForDeclaration(param.datatype) + ' ' + param.name |
| for param in native.params |
| ] |
| |
| |
| def GetParamsInStub(native): |
| """Returns the params for the stub declaration. |
| |
| Args: |
| native: the native dictionary describing the method. |
| |
| Returns: |
| A string containing the params. |
| """ |
| params = [JavaDataTypeToC(p.datatype) + ' ' + p.name for p in native.params] |
| params = _GetJNIFirstParam(native, False) + params |
| return ',\n '.join(params) |
| |
| |
| def _StripGenerics(value): |
| """Strips Java generics from a string.""" |
| nest_level = 0 # How deeply we are nested inside the generics. |
| start_index = 0 # Starting index of the last non-generic region. |
| out = [] |
| |
| for i, c in enumerate(value): |
| if c == '<': |
| if nest_level == 0: |
| out.append(value[start_index:i]) |
| nest_level += 1 |
| elif c == '>': |
| start_index = i + 1 |
| nest_level -= 1 |
| out.append(value[start_index:]) |
| |
| return ''.join(out) |
| |
| |
| def _NameIsTestOnly(name): |
| return name.endswith('ForTest') or name.endswith('ForTesting') |
| |
| |
| class JniParams(object): |
| """Get JNI related parameters.""" |
| |
| def __init__(self, fully_qualified_class): |
| self._fully_qualified_class = 'L' + fully_qualified_class |
| self._package = '/'.join(fully_qualified_class.split('/')[:-1]) |
| self._imports = [] |
| self._inner_classes = [] |
| self._implicit_imports = [] |
| |
| def ExtractImportsAndInnerClasses(self, contents): |
| contents = contents.replace('\n', '') |
| re_import = re.compile(r'import.*?(?P<class>\S*?);') |
| for match in re.finditer(re_import, contents): |
| self._imports += ['L' + match.group('class').replace('.', '/')] |
| |
| re_inner = re.compile(r'(class|interface|enum)\s+?(?P<name>\w+?)\W') |
| for match in re.finditer(re_inner, contents): |
| inner = match.group('name') |
| if not self._fully_qualified_class.endswith(inner): |
| self._inner_classes += [self._fully_qualified_class + '$' + inner] |
| |
| re_additional_imports = re.compile( |
| r'@JNIAdditionalImport\(\s*{?(?P<class_names>.*?)}?\s*\)') |
| for match in re.finditer(re_additional_imports, contents): |
| for class_name in match.group('class_names').split(','): |
| self._AddAdditionalImport(class_name.strip()) |
| |
| def JavaToJni(self, param): |
| """Converts a java param into a JNI signature type.""" |
| pod_param_map = { |
| 'int': 'I', |
| 'boolean': 'Z', |
| 'char': 'C', |
| 'short': 'S', |
| 'long': 'J', |
| 'double': 'D', |
| 'float': 'F', |
| 'byte': 'B', |
| 'void': 'V', |
| } |
| object_param_list = [ |
| 'Ljava/lang/Boolean', |
| 'Ljava/lang/Integer', |
| 'Ljava/lang/Long', |
| 'Ljava/lang/Object', |
| 'Ljava/lang/String', |
| 'Ljava/lang/Class', |
| 'Ljava/lang/ClassLoader', |
| 'Ljava/lang/CharSequence', |
| 'Ljava/lang/Runnable', |
| 'Ljava/lang/Throwable', |
| ] |
| |
| prefix = '' |
| # Array? |
| while param[-2:] == '[]': |
| prefix += '[' |
| param = param[:-2] |
| # Generic? |
| if '<' in param: |
| param = param[:param.index('<')] |
| if param in pod_param_map: |
| return prefix + pod_param_map[param] |
| if '/' in param: |
| # Coming from javap, use the fully qualified param directly. |
| return prefix + 'L' + param + ';' |
| |
| for qualified_name in (object_param_list + [self._fully_qualified_class] + |
| self._inner_classes): |
| if (qualified_name.endswith('/' + param) |
| or qualified_name.endswith('$' + param.replace('.', '$')) |
| or qualified_name == 'L' + param): |
| return prefix + qualified_name + ';' |
| |
| # Is it from an import? (e.g. referecing Class from import pkg.Class; |
| # note that referencing an inner class Inner from import pkg.Class.Inner |
| # is not supported). |
| for qualified_name in self._imports: |
| if qualified_name.endswith('/' + param): |
| # Ensure it's not an inner class. |
| components = qualified_name.split('/') |
| if len(components) > 2 and components[-2][0].isupper(): |
| raise SyntaxError( |
| 'Inner class (%s) can not be imported ' |
| 'and used by JNI (%s). Please import the outer ' |
| 'class and use Outer.Inner instead.' % (qualified_name, param)) |
| return prefix + qualified_name + ';' |
| |
| # Is it an inner class from an outer class import? (e.g. referencing |
| # Class.Inner from import pkg.Class). |
| if '.' in param: |
| components = param.split('.') |
| outer = '/'.join(components[:-1]) |
| inner = components[-1] |
| for qualified_name in self._imports: |
| if qualified_name.endswith('/' + outer): |
| return (prefix + qualified_name + '$' + inner + ';') |
| raise SyntaxError('Inner class (%s) can not be ' |
| 'used directly by JNI. Please import the outer ' |
| 'class, probably:\n' |
| 'import %s.%s;' % (param, self._package.replace( |
| '/', '.'), outer.replace('/', '.'))) |
| |
| self._CheckImplicitImports(param) |
| |
| # Type not found, falling back to same package as this class. |
| return (prefix + 'L' + self._package + '/' + param + ';') |
| |
| def _AddAdditionalImport(self, class_name): |
| assert class_name.endswith('.class') |
| raw_class_name = class_name[:-len('.class')] |
| if '.' in raw_class_name: |
| raise SyntaxError('%s cannot be used in @JNIAdditionalImport. ' |
| 'Only import unqualified outer classes.' % class_name) |
| new_import = 'L%s/%s' % (self._package, raw_class_name) |
| if new_import in self._imports: |
| raise SyntaxError('Do not use JNIAdditionalImport on an already ' |
| 'imported class: %s' % (new_import.replace('/', '.'))) |
| self._imports += [new_import] |
| |
| def _CheckImplicitImports(self, param): |
| # Ensure implicit imports, such as java.lang.*, are not being treated |
| # as being in the same package. |
| if not self._implicit_imports: |
| # This file was generated from android.jar and lists |
| # all classes that are implicitly imported. |
| android_jar_path = os.path.join(_FILE_DIR, 'android_jar.classes') |
| with open(android_jar_path) as f: |
| self._implicit_imports = f.readlines() |
| for implicit_import in self._implicit_imports: |
| implicit_import = implicit_import.strip().replace('.class', '') |
| implicit_import = implicit_import.replace('/', '.') |
| if implicit_import.endswith('.' + param): |
| raise SyntaxError('Ambiguous class (%s) can not be used directly ' |
| 'by JNI.\nPlease import it, probably:\n\n' |
| 'import %s;' % (param, implicit_import)) |
| |
| def Signature(self, params, returns): |
| """Returns the JNI signature for the given datatypes.""" |
| items = ['('] |
| items += [self.JavaToJni(param.datatype) for param in params] |
| items += [')'] |
| items += [self.JavaToJni(returns)] |
| return '"{}"'.format(''.join(items)) |
| |
| @staticmethod |
| def ParseJavaPSignature(signature_line): |
| prefix = 'Signature: ' |
| index = signature_line.find(prefix) |
| if index == -1: |
| prefix = 'descriptor: ' |
| index = signature_line.index(prefix) |
| return '"%s"' % signature_line[index + len(prefix):] |
| |
| @staticmethod |
| def Parse(params, use_proxy_types=False, from_javap=False): |
| """Parses the params into a list of Param objects.""" |
| if not params: |
| return [] |
| ret = [] |
| params = _StripGenerics(params) |
| for p in params.split(','): |
| items = p.split() |
| |
| if 'final' in items: |
| items.remove('final') |
| |
| # Remove @Annotations from parameters. |
| annotations = [] |
| while items[0].startswith('@'): |
| annotations.append(items[0]) |
| del items[0] |
| |
| param = Param( |
| annotations=annotations, |
| datatype=items[0], |
| name=(items[1] if len(items) > 1 else 'p%s' % len(ret)), |
| ) |
| # Handle varargs. |
| if param.datatype.endswith('...'): |
| param.datatype = param.datatype[:-3] + '[]' |
| |
| if from_javap: |
| param.datatype = param.datatype.replace('.', '/') |
| |
| if use_proxy_types: |
| param.datatype = JavaTypeToProxyCast(param.datatype) |
| |
| ret += [param] |
| return ret |
| |
| |
| def ExtractJNINamespace(contents): |
| re_jni_namespace = re.compile('.*?@JNINamespace\("(.*?)"\)') |
| m = re.findall(re_jni_namespace, contents) |
| if not m: |
| return '' |
| return m[0] |
| |
| |
| def ExtractFullyQualifiedJavaClassName(file_name, contents): |
| assert not file_name.endswith('.kt'), ( |
| f'Found {file_name}, but Kotlin is not supported by JNI generator.') |
| re_package = re.compile('.*?package (.*?);') |
| matches = re.findall(re_package, contents) |
| if not matches: |
| raise SyntaxError('Unable to find "package" line in %s' % file_name) |
| class_path = matches[0].replace('.', '/') |
| class_name = os.path.splitext(os.path.basename(file_name))[0] |
| return class_path + '/' + class_name |
| |
| |
| def ExtractNatives(contents, ptr_type): |
| """Returns a list of dict containing information about a native method.""" |
| contents = contents.replace('\n', '') |
| natives = [] |
| for match in _EXTRACT_NATIVES_REGEX.finditer(contents): |
| native = NativeMethod( |
| static='static' in match.group('qualifiers'), |
| java_class_name=match.group('java_class_name'), |
| native_class_name=match.group('native_class_name'), |
| return_type=match.group('return_type'), |
| name=match.group('name').replace('native', ''), |
| params=JniParams.Parse(match.group('params')), |
| ptr_type=ptr_type) |
| natives += [native] |
| return natives |
| |
| |
| def IsMainDexJavaClass(contents): |
| """Returns True if the class or any of its methods are annotated as @MainDex. |
| |
| JNI registration doesn't always need to be completed for non-browser processes |
| since most Java code is only used by the browser process. Classes that are |
| needed by non-browser processes must explicitly be annotated with @MainDex |
| to force JNI registration. |
| """ |
| return bool(_MAIN_DEX_REGEX.search(contents)) |
| |
| |
| def EscapeClassName(fully_qualified_class): |
| """Returns an escaped string concatenating the Java package and class.""" |
| escaped = fully_qualified_class.replace('_', '_1') |
| return escaped.replace('/', '_').replace('$', '_00024') |
| |
| |
| def GetRegistrationFunctionName(fully_qualified_class): |
| """Returns the register name with a given class.""" |
| return 'RegisterNative_' + EscapeClassName(fully_qualified_class) |
| |
| |
| def GetStaticCastForReturnType(return_type): |
| type_map = { |
| 'String': 'jstring', |
| 'java/lang/String': 'jstring', |
| 'Class': 'jclass', |
| 'java/lang/Class': 'jclass', |
| 'Throwable': 'jthrowable', |
| 'java/lang/Throwable': 'jthrowable', |
| 'boolean[]': 'jbooleanArray', |
| 'byte[]': 'jbyteArray', |
| 'char[]': 'jcharArray', |
| 'short[]': 'jshortArray', |
| 'int[]': 'jintArray', |
| 'long[]': 'jlongArray', |
| 'float[]': 'jfloatArray', |
| 'double[]': 'jdoubleArray' |
| } |
| return_type = _StripGenerics(return_type) |
| ret = type_map.get(return_type, None) |
| if ret: |
| return ret |
| if return_type.endswith('[]'): |
| return 'jobjectArray' |
| return None |
| |
| |
| def GetEnvCall(is_constructor, is_static, return_type): |
| """Maps the types availabe via env->Call__Method.""" |
| if is_constructor: |
| return 'NewObject' |
| env_call_map = { |
| 'boolean': 'Boolean', |
| 'byte': 'Byte', |
| 'char': 'Char', |
| 'short': 'Short', |
| 'int': 'Int', |
| 'long': 'Long', |
| 'float': 'Float', |
| 'void': 'Void', |
| 'double': 'Double', |
| 'Object': 'Object', |
| } |
| call = env_call_map.get(return_type, 'Object') |
| if is_static: |
| call = 'Static' + call |
| return 'Call' + call + 'Method' |
| |
| |
| def GetMangledParam(datatype): |
| """Returns a mangled identifier for the datatype.""" |
| if len(datatype) <= 2: |
| return datatype.replace('[', 'A') |
| ret = '' |
| for i in range(1, len(datatype)): |
| c = datatype[i] |
| if c == '[': |
| ret += 'A' |
| elif c.isupper() or datatype[i - 1] in ['/', 'L']: |
| ret += c.upper() |
| return ret |
| |
| |
| def GetMangledMethodName(jni_params, name, params, return_type): |
| """Returns a mangled method name for the given signature. |
| |
| The returned name can be used as a C identifier and will be unique for all |
| valid overloads of the same method. |
| |
| Args: |
| jni_params: JniParams object. |
| name: string. |
| params: list of Param. |
| return_type: string. |
| |
| Returns: |
| A mangled name. |
| """ |
| mangled_items = [] |
| for datatype in [return_type] + [x.datatype for x in params]: |
| mangled_items += [GetMangledParam(jni_params.JavaToJni(datatype))] |
| mangled_name = name + '_'.join(mangled_items) |
| assert re.match(r'[0-9a-zA-Z_]+', mangled_name) |
| return mangled_name |
| |
| |
| def MangleCalledByNatives(jni_params, called_by_natives, always_mangle): |
| """Mangles all the overloads from the call_by_natives list or |
| mangle all methods if always_mangle is true. |
| """ |
| method_counts = collections.defaultdict( |
| lambda: collections.defaultdict(lambda: 0)) |
| for called_by_native in called_by_natives: |
| java_class_name = called_by_native.java_class_name |
| name = called_by_native.name |
| method_counts[java_class_name][name] += 1 |
| for called_by_native in called_by_natives: |
| java_class_name = called_by_native.java_class_name |
| method_name = called_by_native.name |
| method_id_var_name = method_name |
| if always_mangle or method_counts[java_class_name][method_name] > 1: |
| method_id_var_name = GetMangledMethodName(jni_params, method_name, |
| called_by_native.params, |
| called_by_native.return_type) |
| called_by_native.method_id_var_name = method_id_var_name |
| return called_by_natives |
| |
| |
| # Regex to match the JNI types that should be wrapped in a JavaRef. |
| RE_SCOPED_JNI_TYPES = re.compile('jobject|jclass|jstring|jthrowable|.*Array') |
| |
| # Regex to match a string like "@CalledByNative public void foo(int bar)". |
| RE_CALLED_BY_NATIVE = re.compile( |
| r'@CalledByNative((?P<Unchecked>(?:Unchecked)?|ForTesting))' |
| r'(?:\("(?P<annotation>.*)"\))?' |
| r'(?:\s+@\w+(?:\(.*\))?)*' # Ignore any other annotations. |
| r'\s+(?P<prefix>(' |
| r'(private|protected|public|static|abstract|final|default|synchronized)' |
| r'\s*)*)' |
| r'(?:\s*@\w+)?' # Ignore annotations in return types. |
| r'\s*(?P<return_type>\S*?)' |
| r'\s*(?P<name>\w+)' |
| r'\s*\((?P<params>[^\)]*)\)') |
| |
| |
| # Removes empty lines that are indented (i.e. start with 2x spaces). |
| def RemoveIndentedEmptyLines(string): |
| return re.sub('^(?: {2})+$\n', '', string, flags=re.MULTILINE) |
| |
| |
| def ExtractCalledByNatives(jni_params, contents, always_mangle): |
| """Parses all methods annotated with @CalledByNative. |
| |
| Args: |
| jni_params: JniParams object. |
| contents: the contents of the java file. |
| always_mangle: See MangleCalledByNatives. |
| |
| Returns: |
| A list of dict with information about the annotated methods. |
| TODO(bulach): return a CalledByNative object. |
| |
| Raises: |
| ParseError: if unable to parse. |
| """ |
| called_by_natives = [] |
| for match in re.finditer(RE_CALLED_BY_NATIVE, contents): |
| return_type = match.group('return_type') |
| name = match.group('name') |
| if not return_type: |
| is_constructor = True |
| return_type = name |
| name = "Constructor" |
| else: |
| is_constructor = False |
| |
| called_by_natives += [ |
| CalledByNative(system_class=False, |
| unchecked='Unchecked' in match.group('Unchecked'), |
| static='static' in match.group('prefix'), |
| java_class_name=match.group('annotation') or '', |
| return_type=return_type, |
| name=name, |
| is_constructor=is_constructor, |
| params=JniParams.Parse(match.group('params'))) |
| ] |
| # Check for any @CalledByNative occurrences that weren't matched. |
| unmatched_lines = re.sub(RE_CALLED_BY_NATIVE, '', contents).split('\n') |
| for line1, line2 in zip(unmatched_lines, unmatched_lines[1:]): |
| if '@CalledByNative' in line1: |
| raise ParseError('could not parse @CalledByNative method signature', |
| line1, line2) |
| return MangleCalledByNatives(jni_params, called_by_natives, always_mangle) |
| |
| |
| def RemoveComments(contents): |
| # We need to support both inline and block comments, and we need to handle |
| # strings that contain '//' or '/*'. |
| # TODO(bulach): This is a bit hacky. It would be cleaner to use a real Java |
| # parser. Maybe we could ditch JNIFromJavaSource and just always use |
| # JNIFromJavaP; or maybe we could rewrite this script in Java and use APT. |
| # http://code.google.com/p/chromium/issues/detail?id=138941 |
| def replacer(match): |
| # Replace matches that are comments with nothing; return literals/strings |
| # unchanged. |
| s = match.group(0) |
| if s.startswith('/'): |
| return '' |
| else: |
| return s |
| |
| return _COMMENT_REMOVER_REGEX.sub(replacer, contents) |
| |
| |
| class JNIFromJavaP(object): |
| """Uses 'javap' to parse a .class file and generate the JNI header file.""" |
| |
| def __init__(self, contents, options): |
| self.contents = contents |
| self.namespace = options.namespace |
| for line in contents: |
| class_name = re.match( |
| '.*?(public).*?(class|interface) (?P<class_name>\S+?)( |\Z)', line) |
| if class_name: |
| self.fully_qualified_class = class_name.group('class_name') |
| break |
| self.fully_qualified_class = self.fully_qualified_class.replace('.', '/') |
| # Java 7's javap includes type parameters in output, like HashSet<T>. Strip |
| # away the <...> and use the raw class name that Java 6 would've given us. |
| self.fully_qualified_class = self.fully_qualified_class.split('<', 1)[0] |
| self.jni_params = JniParams(self.fully_qualified_class) |
| self.java_class_name = self.fully_qualified_class.split('/')[-1] |
| if not self.namespace: |
| self.namespace = 'JNI_' + self.java_class_name |
| re_method = re.compile('(?P<prefix>.*?)(?P<return_type>\S+?) (?P<name>\w+?)' |
| '\((?P<params>.*?)\)') |
| self.called_by_natives = [] |
| for lineno, content in enumerate(contents[2:], 2): |
| match = re.match(re_method, content) |
| if not match: |
| continue |
| self.called_by_natives += [ |
| CalledByNative( |
| system_class=True, |
| unchecked=options.unchecked_exceptions, |
| static='static' in match.group('prefix'), |
| java_class_name='', |
| return_type=match.group('return_type').replace('.', '/'), |
| name=match.group('name'), |
| params=JniParams.Parse(match.group('params'), from_javap=True), |
| signature=JniParams.ParseJavaPSignature(contents[lineno + 1])) |
| ] |
| re_constructor = re.compile('(.*?)public ' + |
| self.fully_qualified_class.replace('/', '.') + |
| '\((?P<params>.*?)\)') |
| for lineno, content in enumerate(contents[2:], 2): |
| match = re.match(re_constructor, content) |
| if not match: |
| continue |
| self.called_by_natives += [ |
| CalledByNative(system_class=True, |
| unchecked=options.unchecked_exceptions, |
| static=False, |
| java_class_name='', |
| return_type=self.fully_qualified_class, |
| name='Constructor', |
| params=JniParams.Parse(match.group('params'), |
| from_javap=True), |
| signature=JniParams.ParseJavaPSignature( |
| contents[lineno + 1]), |
| is_constructor=True) |
| ] |
| self.called_by_natives = MangleCalledByNatives( |
| self.jni_params, self.called_by_natives, options.always_mangle) |
| self.constant_fields = [] |
| re_constant_field = re.compile('.*?public static final int (?P<name>.*?);') |
| re_constant_field_value = re.compile( |
| '.*?Constant(Value| value): int (?P<value>(-*[0-9]+)?)') |
| for lineno, content in enumerate(contents[2:], 2): |
| match = re.match(re_constant_field, content) |
| if not match: |
| continue |
| value = re.match(re_constant_field_value, contents[lineno + 2]) |
| if not value: |
| value = re.match(re_constant_field_value, contents[lineno + 3]) |
| if value: |
| self.constant_fields.append( |
| ConstantField(name=match.group('name'), value=value.group('value'))) |
| |
| # We pass in an empty string for the module (which will make the JNI use the |
| # base module's files) for all javap-derived JNI. There may be a way to get |
| # the module from a jar file, but it's not needed right now. |
| self.inl_header_file_generator = InlHeaderFileGenerator( |
| '', self.namespace, self.fully_qualified_class, [], |
| self.called_by_natives, self.constant_fields, self.jni_params, options) |
| |
| def GetContent(self): |
| return self.inl_header_file_generator.GetContent() |
| |
| @staticmethod |
| def CreateFromClass(class_file, options): |
| class_name = os.path.splitext(os.path.basename(class_file))[0] |
| javap_path = os.path.abspath(options.javap) |
| p = subprocess.Popen( |
| args=[javap_path, '-c', '-verbose', '-s', class_name], |
| cwd=os.path.dirname(class_file), |
| stdout=subprocess.PIPE, |
| stderr=subprocess.PIPE, |
| universal_newlines=True) |
| stdout, _ = p.communicate() |
| jni_from_javap = JNIFromJavaP(stdout.split('\n'), options) |
| return jni_from_javap |
| |
| |
| # 'Proxy' native methods are declared in an @NativeMethods interface without |
| # a native qualifier and indicate that the JNI annotation processor should |
| # generate code to link between the equivalent native method as if it were |
| # declared statically. |
| # Under the hood the annotation processor generates the actual native method |
| # declaration in another class (org.chromium.base.natives.GEN_JNI) |
| # but generates wrapper code so it can be called through the declaring class. |
| class ProxyHelpers(object): |
| MAX_CHARS_FOR_HASHED_NATIVE_METHODS = 8 |
| |
| @staticmethod |
| def GetClass(short_name, name_prefix=None): |
| if not name_prefix: |
| name_prefix = '' |
| else: |
| name_prefix += '_' |
| return name_prefix + ('N' if short_name else 'GEN_JNI') |
| |
| @staticmethod |
| def GetPackage(short_name, package_prefix=None): |
| package = 'J' if short_name else 'org/chromium/base/natives' |
| return GetFullyQualifiedClassWithPackagePrefix(package, package_prefix) |
| |
| @staticmethod |
| def GetQualifiedClass(short_name, name_prefix=None, package_prefix=None): |
| return '%s/%s' % (ProxyHelpers.GetPackage(short_name, package_prefix), |
| ProxyHelpers.GetClass(short_name, name_prefix)) |
| |
| @staticmethod |
| def CreateHashedMethodName(fully_qualified_class_name, method_name): |
| descriptor = EscapeClassName(fully_qualified_class_name + '/' + method_name) |
| |
| if not isinstance(descriptor, bytes): |
| descriptor = descriptor.encode() |
| hash = hashlib.md5(descriptor).digest() |
| hash_b64 = base64.b64encode(hash, altchars=b'$_') |
| if not isinstance(hash_b64, str): |
| hash_b64 = hash_b64.decode() |
| |
| long_hash = ('M' + hash_b64).rstrip('=') |
| hashed_name = long_hash[:ProxyHelpers.MAX_CHARS_FOR_HASHED_NATIVE_METHODS] |
| |
| # If the method is a test-only method, we don't care about saving size on |
| # the method name, since it shouldn't show up in the binary. Additionally, |
| # if we just hash the name, our checkers which enforce that we have no |
| # "ForTesting" methods by checking for the suffix "ForTesting" will miss |
| # these. We could preserve the name entirely and not hash anything, but |
| # that risks collisions. So, instead, we just append "ForTesting" to any |
| # test-only hashes, to ensure we catch any test-only methods that |
| # shouldn't be in our final binary. |
| if _NameIsTestOnly(method_name): |
| return hashed_name + '_ForTesting' |
| return hashed_name |
| |
| @staticmethod |
| def CreateProxyMethodName(fully_qualified_class, old_name, use_hash=False): |
| """Returns the literal method name for the corresponding proxy method""" |
| if use_hash: |
| return ProxyHelpers.CreateHashedMethodName(fully_qualified_class, |
| old_name) |
| |
| # The annotation processor currently uses a method name |
| # org_chromium_example_foo_method_1name escaping _ to _1 |
| # and then using the appending the method name to the qualified |
| # class. Since we need to escape underscores for jni to work |
| # we need to double escape _1 to _11 |
| # This is the literal name of the GEN_JNI it still needs to be escaped once. |
| return EscapeClassName(fully_qualified_class + '/' + old_name) |
| |
| @staticmethod |
| def ExtractStaticProxyNatives(fully_qualified_class, |
| contents, |
| ptr_type, |
| include_test_only=True): |
| methods = [] |
| first_match = True |
| module_name = None |
| for match in _NATIVE_PROXY_EXTRACTION_REGEX.finditer(contents): |
| interface_body = match.group('interface_body') |
| if first_match: |
| module_name = match.group('module_name') |
| first_match = False |
| else: |
| assert module_name == match.group( |
| 'module_name' |
| ), 'JNI cannot belong to two modules in one file {} and {}'.format( |
| module_name, match.group('module_name')) |
| for method in _EXTRACT_METHODS_REGEX.finditer(interface_body): |
| name = method.group('name') |
| if not include_test_only and _NameIsTestOnly(name): |
| continue |
| |
| params = JniParams.Parse(method.group('params'), use_proxy_types=True) |
| return_type = JavaTypeToProxyCast(method.group('return_type')) |
| proxy_name = ProxyHelpers.CreateProxyMethodName(fully_qualified_class, |
| name, |
| use_hash=False) |
| hashed_proxy_name = ProxyHelpers.CreateProxyMethodName( |
| fully_qualified_class, name, use_hash=True) |
| native = NativeMethod( |
| static=True, |
| java_class_name=None, |
| return_type=return_type, |
| name=name, |
| native_class_name=method.group('native_class_name'), |
| params=params, |
| is_proxy=True, |
| proxy_name=proxy_name, |
| hashed_proxy_name=hashed_proxy_name, |
| ptr_type=ptr_type) |
| methods.append(native) |
| |
| if not module_name: |
| module_name = '' |
| return methods, module_name |
| |
| |
| class JNIFromJavaSource(object): |
| """Uses the given java source file to generate the JNI header file.""" |
| |
| def __init__(self, contents, fully_qualified_class, options): |
| if options.package_prefix: |
| fully_qualified_class = GetFullyQualifiedClassWithPackagePrefix( |
| fully_qualified_class, options.package_prefix) |
| contents = RemoveComments(contents) |
| self.jni_params = JniParams(fully_qualified_class) |
| self.jni_params.ExtractImportsAndInnerClasses(contents) |
| jni_namespace = ExtractJNINamespace(contents) or options.namespace |
| called_by_natives = ExtractCalledByNatives(self.jni_params, contents, |
| options.always_mangle) |
| |
| natives, module_name = ProxyHelpers.ExtractStaticProxyNatives( |
| fully_qualified_class, contents, options.ptr_type) |
| natives += ExtractNatives(contents, options.ptr_type) |
| |
| if len(natives) == 0 and len(called_by_natives) == 0: |
| raise SyntaxError( |
| 'Unable to find any JNI methods for %s.' % fully_qualified_class) |
| inl_header_file_generator = InlHeaderFileGenerator( |
| module_name, jni_namespace, fully_qualified_class, natives, |
| called_by_natives, [], self.jni_params, options) |
| self.content = inl_header_file_generator.GetContent() |
| |
| def GetContent(self): |
| return self.content |
| |
| @staticmethod |
| def CreateFromFile(java_file_name, options): |
| with open(java_file_name) as f: |
| contents = f.read() |
| fully_qualified_class = ExtractFullyQualifiedJavaClassName( |
| java_file_name, contents) |
| return JNIFromJavaSource(contents, fully_qualified_class, options) |
| |
| |
| class HeaderFileGeneratorHelper(object): |
| """Include helper methods for header generators.""" |
| |
| def __init__(self, |
| class_name, |
| module_name, |
| fully_qualified_class, |
| use_proxy_hash, |
| package_prefix, |
| split_name=None, |
| enable_jni_multiplexing=False): |
| self.class_name = class_name |
| self.module_name = module_name |
| self.fully_qualified_class = fully_qualified_class |
| self.use_proxy_hash = use_proxy_hash |
| self.package_prefix = package_prefix |
| self.split_name = split_name |
| self.enable_jni_multiplexing = enable_jni_multiplexing |
| |
| def GetStubName(self, native): |
| """Return the name of the stub function for this native method. |
| |
| Args: |
| native: the native dictionary describing the method. |
| |
| Returns: |
| A string with the stub function name (used by the JVM). |
| """ |
| if native.is_proxy: |
| if self.use_proxy_hash: |
| method_name = EscapeClassName(native.hashed_proxy_name) |
| else: |
| method_name = EscapeClassName(native.proxy_name) |
| return 'Java_%s_%s' % (EscapeClassName( |
| ProxyHelpers.GetQualifiedClass( |
| self.use_proxy_hash or self.enable_jni_multiplexing, |
| self.module_name, self.package_prefix)), method_name) |
| |
| template = Template('Java_${JAVA_NAME}_native${NAME}') |
| |
| java_name = self.fully_qualified_class |
| if native.java_class_name: |
| java_name += '$' + native.java_class_name |
| |
| values = {'NAME': native.name, 'JAVA_NAME': EscapeClassName(java_name)} |
| return template.substitute(values) |
| |
| def GetUniqueClasses(self, origin): |
| ret = collections.OrderedDict() |
| for entry in origin: |
| if isinstance(entry, NativeMethod) and entry.is_proxy: |
| short_name = self.use_proxy_hash or self.enable_jni_multiplexing |
| ret[ProxyHelpers.GetClass(short_name, self.module_name)] \ |
| = ProxyHelpers.GetQualifiedClass(short_name, self.module_name, self.package_prefix) |
| continue |
| ret[self.class_name] = self.fully_qualified_class |
| |
| class_name = self.class_name |
| jni_class_path = self.fully_qualified_class |
| if entry.java_class_name: |
| class_name = entry.java_class_name |
| jni_class_path = self.fully_qualified_class + '$' + class_name |
| ret[class_name] = jni_class_path |
| return ret |
| |
| def GetClassPathLines(self, classes, declare_only=False): |
| """Returns the ClassPath constants.""" |
| ret = [] |
| if declare_only: |
| template = Template(""" |
| extern const char kClassPath_${JAVA_CLASS}[]; |
| """) |
| else: |
| template = Template(""" |
| JNI_REGISTRATION_EXPORT extern const char kClassPath_${JAVA_CLASS}[]; |
| const char kClassPath_${JAVA_CLASS}[] = \ |
| "${JNI_CLASS_PATH}"; |
| """) |
| |
| for full_clazz in classes.values(): |
| values = { |
| 'JAVA_CLASS': EscapeClassName(full_clazz), |
| 'JNI_CLASS_PATH': full_clazz, |
| } |
| # Since all proxy methods use the same class, defining this in every |
| # header file would result in duplicated extern initializations. |
| if full_clazz != ProxyHelpers.GetQualifiedClass( |
| self.use_proxy_hash or self.enable_jni_multiplexing, self.module_name, |
| self.package_prefix): |
| ret += [template.substitute(values)] |
| |
| class_getter = """\ |
| #ifndef ${JAVA_CLASS}_clazz_defined |
| #define ${JAVA_CLASS}_clazz_defined |
| inline jclass ${JAVA_CLASS}_clazz(JNIEnv* env) { |
| return base::android::LazyGetClass(env, kClassPath_${JAVA_CLASS}, \ |
| ${MAYBE_SPLIT_NAME_ARG}&g_${JAVA_CLASS}_clazz); |
| } |
| #endif |
| """ |
| if declare_only: |
| template = Template("""\ |
| extern std::atomic<jclass> g_${JAVA_CLASS}_clazz; |
| """ + class_getter) |
| else: |
| template = Template("""\ |
| // Leaking this jclass as we cannot use LazyInstance from some threads. |
| JNI_REGISTRATION_EXPORT std::atomic<jclass> g_${JAVA_CLASS}_clazz(nullptr); |
| """ + class_getter) |
| |
| for full_clazz in classes.values(): |
| values = { |
| 'JAVA_CLASS': |
| EscapeClassName(full_clazz), |
| 'MAYBE_SPLIT_NAME_ARG': |
| (('"%s", ' % self.split_name) if self.split_name else '') |
| } |
| # Since all proxy methods use the same class, defining this in every |
| # header file would result in duplicated extern initializations. |
| if full_clazz != ProxyHelpers.GetQualifiedClass( |
| self.use_proxy_hash or self.enable_jni_multiplexing, self.module_name, |
| self.package_prefix): |
| ret += [template.substitute(values)] |
| |
| return ''.join(ret) |
| |
| |
| class InlHeaderFileGenerator(object): |
| """Generates an inline header file for JNI integration.""" |
| |
| def __init__(self, module_name, namespace, fully_qualified_class, natives, |
| called_by_natives, constant_fields, jni_params, options): |
| self.namespace = namespace |
| self.fully_qualified_class = fully_qualified_class |
| self.class_name = self.fully_qualified_class.split('/')[-1] |
| self.natives = natives |
| self.called_by_natives = called_by_natives |
| self.header_guard = fully_qualified_class.replace('/', '_') + '_JNI' |
| self.constant_fields = constant_fields |
| self.jni_params = jni_params |
| self.options = options |
| self.helper = HeaderFileGeneratorHelper( |
| self.class_name, |
| module_name, |
| fully_qualified_class, |
| self.options.use_proxy_hash, |
| self.options.package_prefix, |
| split_name=self.options.split_name, |
| enable_jni_multiplexing=self.options.enable_jni_multiplexing) |
| |
| def GetContent(self): |
| """Returns the content of the JNI binding file.""" |
| template = Template("""\ |
| // Copyright 2014 The Chromium Authors |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| |
| // This file is autogenerated by |
| // ${SCRIPT_NAME} |
| // For |
| // ${FULLY_QUALIFIED_CLASS} |
| |
| #ifndef ${HEADER_GUARD} |
| #define ${HEADER_GUARD} |
| |
| #include <jni.h> |
| |
| ${INCLUDES} |
| |
| // Step 1: Forward declarations. |
| $CLASS_PATH_DEFINITIONS |
| |
| // Step 2: Constants (optional). |
| |
| $CONSTANT_FIELDS\ |
| |
| // Step 3: Method stubs. |
| $METHOD_STUBS |
| |
| #endif // ${HEADER_GUARD} |
| """) |
| values = { |
| 'SCRIPT_NAME': self.options.script_name, |
| 'FULLY_QUALIFIED_CLASS': self.fully_qualified_class, |
| 'CLASS_PATH_DEFINITIONS': self.GetClassPathDefinitionsString(), |
| 'CONSTANT_FIELDS': self.GetConstantFieldsString(), |
| 'METHOD_STUBS': self.GetMethodStubsString(), |
| 'HEADER_GUARD': self.header_guard, |
| 'INCLUDES': self.GetIncludesString(), |
| } |
| open_namespace = self.GetOpenNamespaceString() |
| if open_namespace: |
| close_namespace = self.GetCloseNamespaceString() |
| values['METHOD_STUBS'] = '\n'.join( |
| [open_namespace, values['METHOD_STUBS'], close_namespace]) |
| |
| constant_fields = values['CONSTANT_FIELDS'] |
| if constant_fields: |
| values['CONSTANT_FIELDS'] = '\n'.join( |
| [open_namespace, constant_fields, close_namespace]) |
| |
| return WrapOutput(template.substitute(values)) |
| |
| def GetClassPathDefinitionsString(self): |
| classes = self.helper.GetUniqueClasses(self.called_by_natives) |
| classes.update(self.helper.GetUniqueClasses(self.natives)) |
| return self.helper.GetClassPathLines(classes) |
| |
| def GetConstantFieldsString(self): |
| if not self.constant_fields: |
| return '' |
| ret = ['enum Java_%s_constant_fields {' % self.class_name] |
| for c in self.constant_fields: |
| ret += [' %s = %s,' % (c.name, c.value)] |
| ret += ['};', ''] |
| return '\n'.join(ret) |
| |
| def GetMethodStubsString(self): |
| """Returns the code corresponding to method stubs.""" |
| ret = [] |
| for native in self.natives: |
| ret += [self.GetNativeStub(native)] |
| ret += self.GetLazyCalledByNativeMethodStubs() |
| return '\n'.join(ret) |
| |
| def GetLazyCalledByNativeMethodStubs(self): |
| return [ |
| self.GetLazyCalledByNativeMethodStub(called_by_native) |
| for called_by_native in self.called_by_natives |
| ] |
| |
| def GetIncludesString(self): |
| if not self.options.includes: |
| return '' |
| includes = self.options.includes.split(',') |
| return '\n'.join('#include "%s"' % x for x in includes) + '\n' |
| |
| def GetOpenNamespaceString(self): |
| if self.namespace: |
| all_namespaces = [ |
| 'namespace %s {' % ns for ns in self.namespace.split('::') |
| ] |
| return '\n'.join(all_namespaces) + '\n' |
| return '' |
| |
| def GetCloseNamespaceString(self): |
| if self.namespace: |
| all_namespaces = [ |
| '} // namespace %s' % ns for ns in self.namespace.split('::') |
| ] |
| all_namespaces.reverse() |
| return '\n' + '\n'.join(all_namespaces) |
| return '' |
| |
| def GetCalledByNativeParamsInDeclaration(self, called_by_native): |
| return ',\n '.join([ |
| JavaDataTypeToCForCalledByNativeParam(param.datatype) + ' ' + param.name |
| for param in called_by_native.params |
| ]) |
| |
| def GetJavaParamRefForCall(self, c_type, name): |
| return Template( |
| 'base::android::JavaParamRef<${TYPE}>(env, ${NAME})').substitute({ |
| 'TYPE': |
| c_type, |
| 'NAME': |
| name, |
| }) |
| |
| def GetImplementationMethodName(self, native): |
| class_name = self.class_name |
| if native.java_class_name is not None: |
| # Inner class |
| class_name = native.java_class_name |
| |
| return 'JNI_%s_%s' % (class_name, native.name) |
| |
| def GetNativeStub(self, native): |
| is_method = native.type == 'method' |
| |
| if is_method: |
| params = native.params[1:] |
| else: |
| params = native.params |
| |
| params_in_call = ['env'] |
| if not native.static: |
| # Add jcaller param. |
| params_in_call.append(self.GetJavaParamRefForCall('jobject', 'jcaller')) |
| |
| for p in params: |
| c_type = JavaDataTypeToC(p.datatype) |
| if re.match(RE_SCOPED_JNI_TYPES, c_type): |
| params_in_call.append(self.GetJavaParamRefForCall(c_type, p.name)) |
| else: |
| params_in_call.append(p.name) |
| |
| params_in_declaration = _GetParamsInDeclaration(native) |
| params_in_call = ', '.join(params_in_call) |
| |
| return_type = return_declaration = JavaDataTypeToC(native.return_type) |
| post_call = '' |
| if re.match(RE_SCOPED_JNI_TYPES, return_type): |
| post_call = '.Release()' |
| return_declaration = ( |
| 'base::android::ScopedJavaLocalRef<' + return_type + '>') |
| profiling_entered_native = '' |
| if self.options.enable_profiling: |
| profiling_entered_native = ' JNI_LINK_SAVED_FRAME_POINTER;\n' |
| |
| values = { |
| 'RETURN': return_type, |
| 'RETURN_DECLARATION': return_declaration, |
| 'NAME': native.name, |
| 'IMPL_METHOD_NAME': self.GetImplementationMethodName(native), |
| 'PARAMS': ',\n '.join(params_in_declaration), |
| 'PARAMS_IN_STUB': GetParamsInStub(native), |
| 'PARAMS_IN_CALL': params_in_call, |
| 'POST_CALL': post_call, |
| 'STUB_NAME': self.helper.GetStubName(native), |
| 'PROFILING_ENTERED_NATIVE': profiling_entered_native, |
| } |
| |
| namespace_qual = self.namespace + '::' if self.namespace else '' |
| if is_method: |
| optional_error_return = JavaReturnValueToC(native.return_type) |
| if optional_error_return: |
| optional_error_return = ', ' + optional_error_return |
| values.update({ |
| 'OPTIONAL_ERROR_RETURN': optional_error_return, |
| 'PARAM0_NAME': native.params[0].name, |
| 'P0_TYPE': native.p0_type, |
| }) |
| template = Template("""\ |
| JNI_GENERATOR_EXPORT ${RETURN} ${STUB_NAME}( |
| JNIEnv* env, |
| ${PARAMS_IN_STUB}) { |
| ${PROFILING_ENTERED_NATIVE}\ |
| ${P0_TYPE}* native = reinterpret_cast<${P0_TYPE}*>(${PARAM0_NAME}); |
| CHECK_NATIVE_PTR(env, jcaller, native, "${NAME}"${OPTIONAL_ERROR_RETURN}); |
| return native->${NAME}(${PARAMS_IN_CALL})${POST_CALL}; |
| } |
| """) |
| else: |
| if values['PARAMS']: |
| values['PARAMS'] = ', ' + values['PARAMS'] |
| template = Template("""\ |
| static ${RETURN_DECLARATION} ${IMPL_METHOD_NAME}(JNIEnv* env${PARAMS}); |
| |
| JNI_GENERATOR_EXPORT ${RETURN} ${STUB_NAME}( |
| JNIEnv* env, |
| ${PARAMS_IN_STUB}) { |
| ${PROFILING_ENTERED_NATIVE}\ |
| return ${IMPL_METHOD_NAME}(${PARAMS_IN_CALL})${POST_CALL}; |
| } |
| """) |
| |
| return RemoveIndentedEmptyLines(template.substitute(values)) |
| |
| def GetArgument(self, param): |
| if param.datatype == 'int': |
| return 'as_jint(' + param.name + ')' |
| elif re.match(RE_SCOPED_JNI_TYPES, JavaDataTypeToC(param.datatype)): |
| return param.name + '.obj()' |
| else: |
| return param.name |
| |
| def GetArgumentsInCall(self, params): |
| """Return a string of arguments to call from native into Java""" |
| return [self.GetArgument(p) for p in params] |
| |
| def GetCalledByNativeValues(self, called_by_native): |
| """Fills in necessary values for the CalledByNative methods.""" |
| java_class_only = called_by_native.java_class_name or self.class_name |
| java_class = self.fully_qualified_class |
| if called_by_native.java_class_name: |
| java_class += '$' + called_by_native.java_class_name |
| |
| if called_by_native.static or called_by_native.is_constructor: |
| first_param_in_declaration = '' |
| first_param_in_call = 'clazz' |
| else: |
| first_param_in_declaration = ( |
| ', const base::android::JavaRef<jobject>& obj') |
| first_param_in_call = 'obj.obj()' |
| params_in_declaration = self.GetCalledByNativeParamsInDeclaration( |
| called_by_native) |
| if params_in_declaration: |
| params_in_declaration = ', ' + params_in_declaration |
| params_in_call = ', '.join(self.GetArgumentsInCall(called_by_native.params)) |
| if params_in_call: |
| params_in_call = ', ' + params_in_call |
| pre_call = '' |
| post_call = '' |
| if called_by_native.static_cast: |
| pre_call = 'static_cast<%s>(' % called_by_native.static_cast |
| post_call = ')' |
| check_exception = 'Unchecked' |
| method_id_member_name = 'call_context.method_id' |
| if not called_by_native.unchecked: |
| check_exception = 'Checked' |
| method_id_member_name = 'call_context.base.method_id' |
| return_type = JavaDataTypeToC(called_by_native.return_type) |
| optional_error_return = JavaReturnValueToC(called_by_native.return_type) |
| if optional_error_return: |
| optional_error_return = ', ' + optional_error_return |
| return_declaration = '' |
| return_clause = '' |
| if return_type != 'void': |
| pre_call = ' ' + pre_call |
| return_declaration = return_type + ' ret =' |
| if re.match(RE_SCOPED_JNI_TYPES, return_type): |
| return_type = 'base::android::ScopedJavaLocalRef<' + return_type + '>' |
| return_clause = 'return ' + return_type + '(env, ret);' |
| else: |
| return_clause = 'return ret;' |
| profiling_leaving_native = '' |
| if self.options.enable_profiling: |
| profiling_leaving_native = ' JNI_SAVE_FRAME_POINTER;\n' |
| jni_name = called_by_native.name |
| jni_return_type = called_by_native.return_type |
| if called_by_native.is_constructor: |
| jni_name = '<init>' |
| jni_return_type = 'void' |
| if called_by_native.signature: |
| jni_signature = called_by_native.signature |
| else: |
| jni_signature = self.jni_params.Signature(called_by_native.params, |
| jni_return_type) |
| java_name_full = java_class.replace('/', '.') + '.' + jni_name |
| return { |
| 'JAVA_CLASS_ONLY': java_class_only, |
| 'JAVA_CLASS': EscapeClassName(java_class), |
| 'RETURN_TYPE': return_type, |
| 'OPTIONAL_ERROR_RETURN': optional_error_return, |
| 'RETURN_DECLARATION': return_declaration, |
| 'RETURN_CLAUSE': return_clause, |
| 'FIRST_PARAM_IN_DECLARATION': first_param_in_declaration, |
| 'PARAMS_IN_DECLARATION': params_in_declaration, |
| 'PRE_CALL': pre_call, |
| 'POST_CALL': post_call, |
| 'ENV_CALL': called_by_native.env_call, |
| 'FIRST_PARAM_IN_CALL': first_param_in_call, |
| 'PARAMS_IN_CALL': params_in_call, |
| 'CHECK_EXCEPTION': check_exception, |
| 'PROFILING_LEAVING_NATIVE': profiling_leaving_native, |
| 'JNI_NAME': jni_name, |
| 'JNI_SIGNATURE': jni_signature, |
| 'METHOD_ID_MEMBER_NAME': method_id_member_name, |
| 'METHOD_ID_VAR_NAME': called_by_native.method_id_var_name, |
| 'METHOD_ID_TYPE': 'STATIC' if called_by_native.static else 'INSTANCE', |
| 'JAVA_NAME_FULL': java_name_full, |
| } |
| |
| def GetLazyCalledByNativeMethodStub(self, called_by_native): |
| """Returns a string.""" |
| function_signature_template = Template("""\ |
| static ${RETURN_TYPE} Java_${JAVA_CLASS_ONLY}_${METHOD_ID_VAR_NAME}(\ |
| JNIEnv* env${FIRST_PARAM_IN_DECLARATION}${PARAMS_IN_DECLARATION})""") |
| function_header_template = Template("""\ |
| ${FUNCTION_SIGNATURE} {""") |
| function_header_with_unused_template = Template("""\ |
| [[maybe_unused]] ${FUNCTION_SIGNATURE}; |
| ${FUNCTION_SIGNATURE} {""") |
| template = Template(""" |
| static std::atomic<jmethodID> g_${JAVA_CLASS}_${METHOD_ID_VAR_NAME}(nullptr); |
| ${FUNCTION_HEADER} |
| jclass clazz = ${JAVA_CLASS}_clazz(env); |
| CHECK_CLAZZ(env, ${FIRST_PARAM_IN_CALL}, |
| ${JAVA_CLASS}_clazz(env)${OPTIONAL_ERROR_RETURN}); |
| |
| jni_generator::JniJavaCallContext${CHECK_EXCEPTION} call_context; |
| call_context.Init< |
| base::android::MethodID::TYPE_${METHOD_ID_TYPE}>( |
| env, |
| clazz, |
| "${JNI_NAME}", |
| ${JNI_SIGNATURE}, |
| &g_${JAVA_CLASS}_${METHOD_ID_VAR_NAME}); |
| |
| ${PROFILING_LEAVING_NATIVE}\ |
| ${RETURN_DECLARATION} |
| ${PRE_CALL}env->${ENV_CALL}(${FIRST_PARAM_IN_CALL}, |
| ${METHOD_ID_MEMBER_NAME}${PARAMS_IN_CALL})${POST_CALL}; |
| ${RETURN_CLAUSE} |
| }""") |
| values = self.GetCalledByNativeValues(called_by_native) |
| values['FUNCTION_SIGNATURE'] = ( |
| function_signature_template.substitute(values)) |
| if called_by_native.system_class: |
| values['FUNCTION_HEADER'] = ( |
| function_header_with_unused_template.substitute(values)) |
| else: |
| values['FUNCTION_HEADER'] = function_header_template.substitute(values) |
| return RemoveIndentedEmptyLines(template.substitute(values)) |
| |
| def GetTraceEventForNameTemplate(self, name_template, values): |
| name = Template(name_template).substitute(values) |
| return ' TRACE_EVENT0("jni", "%s");\n' % name |
| |
| |
| def WrapOutput(output): |
| ret = [] |
| for line in output.splitlines(): |
| # Do not wrap preprocessor directives or comments. |
| if len(line) < _WRAP_LINE_LENGTH or line[0] == '#' or line.startswith('//'): |
| ret.append(line) |
| else: |
| # Assumes that the line is not already indented as a continuation line, |
| # which is not always true (oh well). |
| first_line_indent = (len(line) - len(line.lstrip())) |
| wrapper = _WRAPPERS_BY_INDENT[first_line_indent] |
| ret.extend(wrapper.wrap(line)) |
| ret += [''] |
| return '\n'.join(ret) |
| |
| |
| def GenerateJNIHeader(input_file, output_file, options): |
| try: |
| if os.path.splitext(input_file)[1] == '.class': |
| # The current package-prefix implementation does not support adding |
| # prefix to java compiled classes. The current support is only for |
| # java source files. |
| assert not options.package_prefix |
| jni_from_javap = JNIFromJavaP.CreateFromClass(input_file, options) |
| content = jni_from_javap.GetContent() |
| else: |
| jni_from_java_source = JNIFromJavaSource.CreateFromFile( |
| input_file, options) |
| content = jni_from_java_source.GetContent() |
| except ParseError as e: |
| print(e) |
| sys.exit(1) |
| if output_file: |
| with action_helpers.atomic_output(output_file, mode='w') as f: |
| f.write(content) |
| else: |
| print(content) |
| |
| |
| def GetScriptName(): |
| script_components = os.path.abspath(__file__).split(os.path.sep) |
| base_index = 0 |
| for idx, value in enumerate(script_components): |
| if value == 'base' or value == 'third_party': |
| base_index = idx |
| break |
| return os.sep.join(script_components[base_index:]) |
| |
| |
| def _RemoveStaleHeaders(path, output_names): |
| if not os.path.isdir(path): |
| return |
| # Do not remove output files so that timestamps on declared outputs are not |
| # modified unless their contents are changed (avoids reverse deps needing to |
| # be rebuilt). |
| preserve = set(output_names) |
| for root, _, files in os.walk(path): |
| for f in files: |
| if f not in preserve: |
| file_path = os.path.join(root, f) |
| if os.path.isfile(file_path) and file_path.endswith('.h'): |
| os.remove(file_path) |
| |
| |
| def main(): |
| description = """ |
| This script will parse the given java source code extracting the native |
| declarations and print the header file to stdout (or a file). |
| See SampleForTests.java for more details. |
| """ |
| parser = argparse.ArgumentParser(description=description) |
| |
| parser.add_argument( |
| '-j', |
| '--jar_file', |
| dest='jar_file', |
| help='Extract the list of input files from' |
| ' a specified jar file.' |
| ' Uses javap to extract the methods from a' |
| ' pre-compiled class. --input should point' |
| ' to pre-compiled Java .class files.') |
| parser.add_argument( |
| '-n', |
| dest='namespace', |
| help='Uses as a namespace in the generated header ' |
| 'instead of the javap class name, or when there is ' |
| 'no JNINamespace annotation in the java source.') |
| parser.add_argument('--input_file', |
| action='append', |
| required=True, |
| dest='input_files', |
| help='Input filenames, or paths within a .jar if ' |
| '--jar-file is used.') |
| parser.add_argument('--output_dir', required=True, help='Output directory.') |
| # TODO(agrieve): --prev_output_dir used only to make incremental builds work. |
| # Remove --prev_output_dir at some point after 2022. |
| parser.add_argument('--prev_output_dir', |
| help='Delete headers found in this directory.') |
| parser.add_argument('--output_name', |
| action='append', |
| dest='output_names', |
| help='Output filenames within output directory.') |
| parser.add_argument( |
| '--script_name', |
| default=GetScriptName(), |
| help='The name of this script in the generated ' |
| 'header.') |
| parser.add_argument( |
| '--includes', |
| help='The comma-separated list of header files to ' |
| 'include in the generated header.') |
| parser.add_argument( |
| '--ptr_type', |
| default='int', |
| choices=['int', 'long'], |
| help='The type used to represent native pointers in ' |
| 'Java code. For 32-bit, use int; ' |
| 'for 64-bit, use long.') |
| parser.add_argument('--cpp', default='cpp', help='The path to cpp command.') |
| parser.add_argument( |
| '--javap', |
| default=build_utils.JAVAP_PATH, |
| help='The path to javap command.') |
| parser.add_argument( |
| '--enable_profiling', |
| action='store_true', |
| help='Add additional profiling instrumentation.') |
| parser.add_argument( |
| '--always_mangle', action='store_true', help='Mangle all function names') |
| parser.add_argument('--unchecked_exceptions', |
| action='store_true', |
| help='Do not check that no exceptions were thrown.') |
| parser.add_argument('--include_test_only', |
| action='store_true', |
| help='Whether to maintain ForTesting JNI methods.') |
| parser.add_argument( |
| '--use_proxy_hash', |
| action='store_true', |
| help='Hashes the native declaration of methods used ' |
| 'in @JniNatives interface.') |
| parser.add_argument('--enable_jni_multiplexing', |
| action='store_true', |
| help='Enables JNI multiplexing for Java native methods') |
| parser.add_argument( |
| '--split_name', |
| help='Split name that the Java classes should be loaded from.') |
| parser.add_argument( |
| '--package_prefix', |
| help= |
| 'Adds a prefix to the classes fully qualified-name. Effectively changing a class name from' |
| 'foo.bar -> prefix.foo.bar') |
| # TODO(agrieve): --stamp used only to make incremental builds work. |
| # Remove --stamp at some point after 2022. |
| parser.add_argument('--stamp', |
| help='Process --prev_output_dir and touch this file.') |
| args = parser.parse_args() |
| # Kotlin files are not supported by jni_generator.py, but they do end up in |
| # the list of source files passed to jni_generator.py. |
| input_files = [f for f in args.input_files if not f.endswith('.kt')] |
| output_names = args.output_names |
| |
| if args.prev_output_dir: |
| _RemoveStaleHeaders(args.prev_output_dir, []) |
| |
| if args.stamp: |
| build_utils.Touch(args.stamp) |
| sys.exit(0) |
| |
| if output_names: |
| # Remove existing headers so that moving .java source files but not updating |
| # the corresponding C++ include will be a compile failure (otherwise |
| # incremental builds will usually not catch this). |
| _RemoveStaleHeaders(args.output_dir, output_names) |
| else: |
| output_names = [None] * len(input_files) |
| temp_dir = tempfile.mkdtemp() |
| try: |
| if args.jar_file: |
| with zipfile.ZipFile(args.jar_file) as z: |
| z.extractall(temp_dir, input_files) |
| input_files = [os.path.join(temp_dir, f) for f in input_files] |
| |
| for java_path, header_name in zip(input_files, output_names): |
| if header_name: |
| header_path = os.path.join(args.output_dir, header_name) |
| else: |
| header_path = None |
| GenerateJNIHeader(java_path, header_path, args) |
| finally: |
| shutil.rmtree(temp_dir) |
| |
| |
| if __name__ == '__main__': |
| sys.exit(main()) |
