Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Formato ejecutable Dalvik

Este documento describe el diseño y el contenido de los archivos .dex , que se utilizan para contener un conjunto de definiciones de clases y sus datos adjuntos asociados.

Guía de tipos

Nombre Descripción
byte Int firmado de 8 bits
ubyte Int sin firmar de 8 bits
corto Int firmado de 16 bits, little-endian
corto Int sin firmar de 16 bits, little-endian
En t Int firmado de 32 bits, little-endian
uint 32 bits sin firmar int, little-endian
largo Int firmado de 64 bits, little-endian
ulong Int sin firmar de 64 bits, little-endian
sleb128 LEB128 firmado, longitud variable (ver más abajo)
uleb128 LEB128 sin firmar, longitud variable (ver más abajo)
uleb128p1 LEB128 sin firmar más 1 , longitud variable (ver más abajo)

LEB128

LEB128 (" L ittle- E ndian B ase 128 ") es una codificación de longitud variable para cantidades enteras arbitrarias con o sin signo. El formato fue tomado de la especificación DWARF3 . En un archivo .dex , LEB128 solo se usa para codificar cantidades de 32 bits.

Cada valor codificado LEB128 consta de uno a cinco bytes, que juntos representan un solo valor de 32 bits. Cada byte tiene su conjunto de bits más significativo, excepto el byte final de la secuencia, que tiene su bit más significativo en blanco. Los siete bits restantes de cada byte son carga útil, con los siete bits menos significativos de la cantidad en el primer byte, los siete siguientes en el segundo byte y así sucesivamente. En el caso de un LEB128 con signo ( sleb128 ), el bit de carga útil más significativo del byte final de la secuencia se amplía con el signo para producir el valor final. En el caso sin firmar ( uleb128 ), los bits que no estén representados explícitamente se interpretan como 0 .

Diagrama de bits de un valor LEB128 de dos bytes
Primer byte Segundo byte
1 bit 6 bit 5 bit 4 bit 3 bit 2 bit 1 bit 0 0 poco 13 bit 12 bit 11 poco 10 bit 9 bit 8 poco 7

La variante uleb128p1 se usa para representar un valor con signo, donde la representación es del valor más uno codificado como uleb128 . Esto hace que la codificación de -1 (alternativamente considerado como el valor sin signo 0xffffffff ), pero ningún otro número negativo, sea de un solo byte, y es útil exactamente en aquellos casos donde el número representado debe ser no negativo o -1 (o 0xffffffff ), y donde no se permiten otros valores negativos (o donde es poco probable que se necesiten valores grandes sin signo).

A continuación se muestran algunos ejemplos de los formatos:

Secuencia codificada Como sleb128 Como uleb128 Como uleb128p1
00 0 0 -1
01 1 1 0
7f -1 127 126
80 7f -128 16256 16255

Diseño de archivo

Nombre Formato Descripción
encabezamiento header_item el encabezado
string_ids string_id_item [] lista de identificadores de cadena. Estos son identificadores para todas las cadenas utilizadas por este archivo, ya sea para nombres internos (por ejemplo, descriptores de tipo) o como objetos constantes referidos por código. Esta lista debe estar ordenada por contenido de cadena, utilizando valores de puntos de código UTF-16 (no de manera sensible a la configuración regional) y no debe contener entradas duplicadas.
type_ids type_id_item [] lista de identificadores de tipo. Estos son identificadores para todos los tipos (clases, matrices o tipos primitivos) a los que hace referencia este archivo, ya sea que estén definidos en el archivo o no. Esta lista debe estar ordenada por el índice string_id y no debe contener ninguna entrada duplicada.
proto_ids proto_id_item [] Lista de identificadores de prototipos de métodos. Estos son identificadores para todos los prototipos a los que hace referencia este archivo. Esta lista debe estar ordenada por tipo de retorno (por índice de type_id ) y luego por lista de argumentos (orden lexicográfico, argumentos individuales ordenados por índice de type_id ). La lista no debe contener entradas duplicadas.
field_ids field_id_item [] lista de identificadores de campo. Estos son identificadores para todos los campos a los que hace referencia este archivo, ya sea que estén definidos en el archivo o no. Esta lista debe estar ordenada, donde el tipo de definición (por índice de type_id ) es el orden principal, el nombre del campo (por índice de string_id ) es el orden intermedio y el tipo (por índice de type_id ) es el orden menor. La lista no debe contener entradas duplicadas.
id_métodos method_id_item [] lista de identificadores de métodos. Estos son identificadores para todos los métodos a los que hace referencia este archivo, ya sea que estén definidos en el archivo o no. Esta lista debe estar ordenada, donde el tipo de definición (por índice type_id ) es el orden principal, el nombre del método (por índice string_id ) es el orden intermedio y el prototipo del método (por índice proto_id ) es el orden menor. La lista no debe contener entradas duplicadas.
class_defs class_def_item [] lista de definiciones de clases. Las clases deben ordenarse de manera que la superclase de una clase dada y las interfaces implementadas aparezcan en la lista antes que la clase de referencia. Además, no es válido que una definición de la clase del mismo nombre aparezca más de una vez en la lista.
call_site_ids call_site_id_item [] lista de identificadores de sitios de llamadas. Estos son identificadores para todos los sitios de llamadas a los que hace referencia este archivo, ya sea que estén definidos en el archivo o no. Esta lista se debe ordenar en orden ascendente de call_site_off .
manejadores_métodos item_handle_item [] el método maneja la lista. Una lista de todos los identificadores de métodos a los que hace referencia este archivo, ya sea que estén definidos en el archivo o no. Esta lista no está ordenada y puede contener duplicados que corresponderán lógicamente a diferentes instancias de manejo de métodos.
datos ubyte [] área de datos, que contiene todos los datos de apoyo para las tablas enumeradas anteriormente. Los diferentes elementos tienen diferentes requisitos de alineación y los bytes de relleno se insertan antes de cada elemento si es necesario para lograr una alineación adecuada.
link_data ubyte [] datos utilizados en archivos vinculados estáticamente. Este documento no especifica el formato de los datos de esta sección. Esta sección está vacía en archivos no vinculados, y las implementaciones en tiempo de ejecución pueden usarla como mejor les parezca.

Definiciones de campo de bits, cadenas y constantes

DEX_FILE_MAGIC

incrustado en header_item

La matriz / cadena constante DEX_FILE_MAGIC es la lista de bytes que deben aparecer al principio de un archivo .dex para que se reconozca como tal. El valor contiene intencionalmente una nueva línea ( "\n" o 0x0a ) y un byte nulo ( "\0" o 0x00 ) para ayudar en la detección de ciertas formas de corrupción. El valor también codifica un número de versión de formato con tres dígitos decimales, que se espera que aumente de forma monótona con el tiempo a medida que evoluciona el formato.

ubyte[8] DEX_FILE_MAGIC = { 0x64 0x65 0x78 0x0a 0x30 0x33 0x39 0x00 }
                        = "dex\n039\0"

Nota: Se agregó soporte para la versión 039 del formato en la versión de Android 9.0, que introdujo dos nuevos códigos de bytes, const-method-handle y const-method-type . (Cada uno de estos se describe en la tabla Resumen de conjuntos de códigos de bytes ). En Android 10, la versión 039 amplía el formato de archivo DEX para incluir información de API oculta que solo se aplica a archivos DEX en la ruta de clase de arranque.

Nota: Se agregó soporte para la versión 038 del formato en la versión de Android 8.0. La versión 038 agregó nuevos códigos de bytes ( invoke-polymorphic e invoke-custom ) y datos para identificadores de métodos.

Nota: Se agregó compatibilidad con la versión 037 del formato en la versión de Android 7.0. Antes de la versión 037 mayoría de las versiones de Android usaban la versión 035 del formato. La única diferencia entre las versiones 035 y 037 es la adición de métodos predeterminados y el ajuste de la invoke .

Nota: Al menos un par de versiones anteriores del formato se han utilizado en versiones de software públicas ampliamente disponibles. Por ejemplo, la versión 009 se utilizó para las versiones M3 de la plataforma Android (noviembre-diciembre de 2007) y la versión 013 se utilizó para las versiones M5 de la plataforma Android (febrero-marzo de 2008). En varios aspectos, estas versiones anteriores del formato difieren significativamente de la versión descrita en este documento.

ENDIAN_CONSTANT y REVERSE_ENDIAN_CONSTANT

incrustado en header_item

La constante ENDIAN_CONSTANT se usa para indicar la endianidad del archivo en el que se encuentra. Aunque el formato .dex estándar es little-endian, las implementaciones pueden optar por realizar un intercambio de bytes. Si una implementación se encuentra con un encabezado cuyo endian_tag es REVERSE_ENDIAN_CONSTANT lugar de ENDIAN_CONSTANT , sabrá que el archivo ha sido intercambiado en bytes desde la forma esperada.

uint ENDIAN_CONSTANT = 0x12345678;
uint REVERSE_ENDIAN_CONSTANT = 0x78563412;

NO_INDEX

incrustado en class_def_item y debug_info_item

La constante NO_INDEX se utiliza para indicar que falta un valor de índice.

Nota: Este valor no se define como 0 , porque de hecho suele ser un índice válido.

El valor elegido para NO_INDEX se puede representar como un solo byte en la codificación uleb128p1 .

uint NO_INDEX = 0xffffffff;    // == -1 if treated as a signed int

definiciones de access_flags

incrustado en class_def_item, encoded_field, encoded_method e InnerClass

Los campos de bits de estos indicadores se utilizan para indicar la accesibilidad y las propiedades generales de las clases y los miembros de la clase.

Nombre Valor Para clases (y anotaciones de InnerClass ) Para campos Para métodos
ACC_PUBLIC 0x1 public : visible en todas partes public : visible en todas partes public : visible en todas partes
ACC_PRIVATE 0x2 * private : solo visible para definir la clase private : solo visible para definir la clase private : solo visible para definir la clase
ACC_PROTECTED 0x4 * protected : visible para el paquete y las subclases protected : visible para el paquete y las subclases protected : visible para el paquete y las subclases
ACC_STATIC 0x8 * static : no se construye con una referencia externa a this static : global para definir la clase static : no toma this argumento
ACC_FINAL 0x10 final : no subclasable final : inmutable después de la construcción final : no anulable
ACC_SYNCHRONIZED 0x20 synchronized : bloqueo asociado adquirido automáticamente alrededor de la llamada a este método.

Nota: Esto solo es válido para configurar cuando ACC_NATIVE también está configurado.

ACC_VOLATILE 0x40 volatile : reglas de acceso especiales para ayudar con la seguridad de los subprocesos
ACC_BRIDGE 0x40 método de puente, agregado automáticamente por el compilador como un puente de tipo seguro
ACC_TRANSIENT 0x80 transient : no se guardará por serialización predeterminada
ACC_VARARGS 0x80 El último argumento debe ser tratado como un argumento de "resto" por el compilador
ACC_NATIVE 0x100 native : implementado en código nativo
ACC_INTERFACE 0x200 interface : clase abstracta de implementación múltiple
ACC_ABSTRACT 0x400 abstract : no directamente instanciable abstract : no implementado por esta clase
ACC_STRICT 0x800 strictfp : reglas estrictas para la aritmética de punto flotante
ACC_SYNTHETIC 0x1000 no definido directamente en el código fuente no definido directamente en el código fuente no definido directamente en el código fuente
ACC_ANNOTATION 0x2000 declarado como una clase de anotación
ACC_ENUM 0x4000 declarado como un tipo enumerado declarado como valor enumerado
(no usado) 0x8000
ACC_CONSTRUCTOR 0x10000 método constructor (inicializador de clase o instancia)
ACC_DECLARED_
SINCRONIZADO
0x20000 declarada synchronized .

Nota: Esto no tiene ningún efecto sobre la ejecución (salvo en el reflejo de esta bandera, per se).

* Solo permitido para anotaciones de InnerClass y nunca debe estar class_def_item en un class_def_item .

Codificación MUTF-8 (UTF-8 modificado)

Como concesión a un soporte heredado más fácil, el formato .dex codifica sus datos de cadena en un formato UTF-8 modificado estándar de facto, en lo sucesivo denominado MUTF-8. Este formulario es idéntico al estándar UTF-8, excepto:

  • Solo se utilizan las codificaciones de uno, dos y tres bytes.
  • Los puntos de código en el rango U+10000U+10ffff se codifican como un par sustituto, cada uno de los cuales se representa como un valor codificado de tres bytes.
  • El punto de código U+0000 está codificado en forma de dos bytes.
  • Un byte nulo simple (valor 0 ) indica el final de una cadena, al igual que la interpretación del lenguaje C estándar.

Los dos primeros elementos anteriores se pueden resumir como: MUTF-8 es un formato de codificación para UTF-16, en lugar de ser un formato de codificación más directo para caracteres Unicode.

Los dos últimos elementos anteriores permiten incluir simultáneamente el punto de código U+0000 en una cadena y aún manipularlo como una cadena terminada en nulo de estilo C.

Sin embargo, la codificación especial de U+0000 significa que, a diferencia de UTF-8 normal, el resultado de llamar a la función C estándar strcmp() en un par de cadenas MUTF-8 no siempre indica el resultado de la comparación de cadenas desiguales debidamente firmado. . Cuando el orden (no solo la igualdad) es una preocupación, la forma más sencilla de comparar cadenas MUTF-8 es decodificarlas carácter por carácter y comparar los valores decodificados. (Sin embargo, también son posibles implementaciones más inteligentes).

Consulte El estándar Unicode para obtener más información sobre la codificación de caracteres. MUTF-8 está realmente más cerca de la codificación (relativamente menos conocida) CESU-8 que de UTF-8 per se.

codificación encoded_value

incrustado en annotation_element y encoded_array_item

Un encoded_value es una pieza codificada de datos estructurados jerárquicamente (casi) arbitrarios. La codificación está destinada a ser compacta y sencilla de analizar.

Nombre Formato Descripción
(valor_arg << 5) | tipo de valor ubyte byte que indica el tipo del value inmediatamente posterior junto con un argumento aclaratorio opcional en los tres bits de orden superior. Consulte a continuación las distintas definiciones de value . En la mayoría de los casos, value_arg codifica la longitud del value inmediatamente posterior en bytes, ya que (size - 1) , por ejemplo, 0 significa que el valor requiere un byte y 7 significa que requiere ocho bytes; sin embargo, existen excepciones como se indica a continuación.
valor ubyte [] bytes que representan el valor, de longitud variable y se interpretan de manera diferente para diferentes bytes de value_type , aunque siempre son little-endian. Consulte las diversas definiciones de valores a continuación para obtener más detalles.

Formatos de valor

Escribe un nombre value_type formato value_arg formato de value Descripción
VALUE_BYTE 0x00 (ninguno; debe ser 0 ) ubyte [1] valor entero de un byte con signo
VALUE_SHORT 0x02 tamaño - 1 (0… 1) ubyte [tamaño] valor entero de dos bytes con signo, signo extendido
VALUE_CHAR 0x03 tamaño - 1 (0… 1) ubyte [tamaño] valor entero de dos bytes sin signo, extendido por cero
VALUE_INT 0x04 tamaño - 1 (0… 3) ubyte [tamaño] valor entero de cuatro bytes con signo, signo extendido
VALUE_LONG 0x06 tamaño - 1 (0… 7) ubyte [tamaño] valor entero de ocho bytes con signo, signo extendido
VALUE_FLOAT 0x10 tamaño - 1 (0… 3) ubyte [tamaño] patrón de bits de cuatro bytes, extendido a cero hacia la derecha e interpretado como un valor de coma flotante de 32 bits IEEE754
VALUE_DOUBLE 0x11 tamaño - 1 (0… 7) ubyte [tamaño] patrón de bits de ocho bytes, extendido a cero hacia la derecha e interpretado como un valor de punto flotante IEEE754 de 64 bits
VALUE_METHOD_TYPE 0x15 tamaño - 1 (0… 3) ubyte [tamaño] valor entero de cuatro bytes sin signo (extendido por cero), interpretado como un índice en la sección proto_ids y que representa un valor de tipo de método
VALUE_METHOD_HANDLE 0x16 tamaño - 1 (0… 3) ubyte [tamaño] valor entero de cuatro bytes sin signo (extendido por cero), interpretado como un índice en la sección method_handles y que representa un valor de identificador de método
VALUE_STRING 0x17 tamaño - 1 (0… 3) ubyte [tamaño] valor entero de cuatro bytes sin signo (extendido por cero), interpretado como un índice en la sección string_ids y que representa un valor de cadena
TIPO DE VALOR 0x18 tamaño - 1 (0… 3) ubyte [tamaño] valor entero de cuatro bytes sin signo (extendido por cero), interpretado como un índice en la sección type_ids y que representa un valor de tipo / clase reflectante
VALUE_FIELD 0x19 tamaño - 1 (0… 3) ubyte [tamaño] valor entero de cuatro bytes sin signo (extendido por cero), interpretado como un índice en la sección field_ids y que representa un valor de campo reflectante
VALUE_METHOD 0x1a tamaño - 1 (0… 3) ubyte [tamaño] valor entero de cuatro bytes sin signo (extendido por cero), interpretado como un índice en la sección method_ids y que representa un valor de método reflectante
VALUE_ENUM 0x1b tamaño - 1 (0… 3) ubyte [tamaño] valor entero de cuatro bytes sin signo (extendido por cero), interpretado como un índice en la sección field_ids y que representa el valor de una constante de tipo enumerada
VALUE_ARRAY 0x1c (ninguno; debe ser 0 ) matriz_codificada una matriz de valores, en el formato especificado por " encoded_array formato" a continuación. El tamaño del value está implícito en la codificación.
VALUE_ANNOTATION 0x1D (ninguno; debe ser 0 ) anotación_codificada una encoded_annotation , en el formato especificado por "formato de encoded_annotation " a continuación. El tamaño del value está implícito en la codificación.
VALUE_NULL 0x1e (ninguno; debe ser 0 ) (ninguna) null referencia null
VALUE_BOOLEAN 0x1f booleano (0… 1) (ninguna) valor de un bit; 0 para false y 1 para true . El bit está representado en value_arg .

formato encoded_array

Nombre Formato Descripción
Talla uleb128 número de elementos en la matriz
valores encoded_value [tamaño] una serie de secuencias de bytes de size encoded_value en el formato especificado por esta sección, concatenadas secuencialmente.

formato de anotación_codificada

Nombre Formato Descripción
type_idx uleb128 tipo de anotación. Debe ser un tipo de clase (no matriz ni primitiva).
Talla uleb128 número de asignaciones de nombre-valor en esta anotación
elementos annotation_element [tamaño] elementos de la anotación, representados directamente en línea (no como compensaciones). Los elementos deben ordenarse en orden creciente por el índice string_id .

formato annotation_element

Nombre Formato Descripción
name_idx uleb128 nombre del elemento, representado como un índice en la sección string_ids . La cadena debe ajustarse a la sintaxis de MemberName , definida anteriormente.
valor encoded_value valor del elemento

Sintaxis de cadena

Hay varios tipos de elementos en un archivo .dex que, en última instancia, se refieren a una cadena. Las siguientes definiciones de estilo BNF indican la sintaxis aceptable para estas cadenas.

SimpleName

Un SimpleName es la base de la sintaxis de los nombres de otras cosas. El formato .dex permite una buena cantidad de latitud aquí (mucho más que la mayoría de los lenguajes fuente comunes). En resumen, un nombre simple consta de cualquier carácter o dígito alfabético de bajo ASCII, algunos símbolos específicos de bajo ASCII y la mayoría de los puntos de código que no son de ASCII que no son caracteres de control, espacio o especiales. A partir de la versión 040 el formato permite además caracteres de espacio (categoría Unicode Zs ). Tenga en cuenta que los puntos de código sustitutos (en el rango U+d800U+dfff ) no se consideran caracteres de nombre válidos, per se, pero los caracteres suplementarios Unicode son válidos (que están representados por la alternativa final de la regla para SimpleNameChar ), y deben representarse en un archivo como pares de puntos de código sustitutos en la codificación MUTF-8.

SimpleName
SimpleNameChar ( SimpleNameChar ) *
SimpleNameChar
'A' ... 'Z'
| 'a' ... 'z'
| '0''9'
| ' ' desde DEX versión 040
| '$'
| '-'
| '_'
| U+00a0 desde DEX versión 040
| U+00a1U+1fff
| U+2000U+200a desde DEX versión 040
| U+2010U+2027
| U+202f desde DEX versión 040
| U+2030U+d7ff
| U+e000U+ffef
| U+10000U+10ffff

Nombre de miembro

utilizado por field_id_item y method_id_item

Un MemberName es el nombre de un miembro de una clase, los miembros son campos, métodos y clases internas.

MemberName
SimpleName
| '<' Nombre simple '>'

FullClassName

Un FullClassName es un nombre de clase completamente calificado, que incluye un especificador de paquete opcional seguido de un nombre obligatorio.

FullClassName
OpcionalPackagePrefix SimpleName
OpcionalPackagePrefix
( Nombre simple '/' ) *

TypeDescriptor

utilizado por type_id_item

Un TypeDescriptor es la representación de cualquier tipo, incluidas primitivas, clases, matrices y void . Consulte a continuación el significado de las distintas versiones.

TypeDescriptor
'V'
| FieldTypeDescriptor
FieldTypeDescriptor
NonArrayFieldTypeDescriptor
| ( '[' * 1… 255) NonArrayFieldTypeDescriptor
NonArrayFieldTypeDescriptor
'Z'
| 'B'
| 'S'
| 'C'
| 'I'
| 'J'
| 'F'
| 'D'
| 'L' FullClassName ';'

ShortyDescriptor

utilizado por proto_id_item

Un ShortyDescriptor es la representación de forma abreviada de un prototipo de método, incluidos los tipos de retorno y parámetros, excepto que no hay distinción entre varios tipos de referencia (clase o matriz). En cambio, todos los tipos de referencia están representados por un solo carácter 'L' .

ShortyDescriptor
ShortyReturnType ( ShortyFieldType ) *
ShortyReturnType
'V'
| ShortyFieldType
ShortyFieldType
'Z'
| 'B'
| 'S'
| 'C'
| 'I'
| 'J'
| 'F'
| 'D'
| 'L'

Semántica TypeDescriptor

Este es el significado de cada una de las variantes de TypeDescriptor .

Sintaxis Sentido
V void solo válido para tipos de devolución
Z boolean
segundo byte
S short
C char
yo int
J long
F float
re double
L completo / calificado / Nombre ; la clase fully.qualified.Name
[ descriptor array of descriptor , utilizable de forma recursiva para arrays-of-arrays, aunque no es válido tener más de 255 dimensiones.

Elementos y estructuras relacionadas

Esta sección incluye definiciones para cada uno de los elementos de nivel superior que pueden aparecer en un archivo .dex .

header_item

aparece en la sección del encabezado

alineación: 4 bytes

Nombre Formato Descripción
magia ubyte [8] = DEX_FILE_MAGIC valor mágico. Consulte la discusión anterior en " DEX_FILE_MAGIC " para obtener más detalles.
suma de comprobación uint suma de comprobación adler32 del resto del archivo (todo menos magic y este campo); utilizado para detectar corrupción de archivos
firma ubyte [20] Firma SHA-1 (hash) del resto del archivo (todo menos magic , checksum y este campo); utilizado para identificar archivos de forma única
tamaño del archivo uint tamaño de todo el archivo (incluido el encabezado), en bytes
header_size uint = 0x70 tamaño del encabezado (toda esta sección), en bytes. Esto permite al menos una cantidad limitada de compatibilidad hacia atrás / adelante sin invalidar el formato.
endian_tag uint = ENDIAN_CONSTANT etiqueta de endianness. Consulte la discusión anterior en " ENDIAN_CONSTANT y REVERSE_ENDIAN_CONSTANT " para obtener más detalles.
link_size uint tamaño de la sección del enlace, o 0 si este archivo no está enlazado estáticamente
link_off uint Desplazamiento desde el inicio del archivo hasta la sección del enlace, o 0 si link_size == 0 . El desplazamiento, si no es cero, debe ser un desplazamiento en la sección link_data . El formato de los datos señalados no se especifica en este documento; este campo de encabezado (y el anterior) se dejan como ganchos para que lo utilicen las implementaciones en tiempo de ejecución.
map_off uint desplazamiento desde el inicio del archivo hasta el elemento del mapa. El desplazamiento, que debe ser distinto de cero, debe ser un desplazamiento en la sección de data , y los datos deben estar en el formato especificado por " map_list " a continuación.
string_ids_size uint recuento de cadenas en la lista de identificadores de cadenas
string_ids_off uint desplazamiento desde el inicio del archivo a la lista de identificadores de cadena, o 0 si string_ids_size == 0 (es cierto que es un caso de borde extraño). El desplazamiento, si no es cero, debe estar al comienzo de la sección string_ids .
type_ids_size uint recuento de elementos en la lista de identificadores de tipo, como máximo 65535
type_ids_off uint desplazamiento desde el inicio del archivo a la lista de identificadores de tipo, o 0 si type_ids_size == 0 (es cierto que es un caso de borde extraño). El desplazamiento, si no es cero, debe estar al comienzo de la sección type_ids .
proto_ids_size uint recuento de elementos en la lista de identificadores de prototipos, como máximo 65535
proto_ids_off uint desplazarse desde el inicio del archivo hasta la lista de identificadores de prototipos, o 0 si proto_ids_size == 0 (es cierto que es un caso de borde extraño). El desplazamiento, si no es cero, debe estar al comienzo de la sección proto_ids .
field_ids_size uint recuento de elementos en la lista de identificadores de campo
field_ids_off uint desplazamiento desde el inicio del archivo hasta la lista de identificadores de campo, o 0 si field_ids_size == 0 . El desplazamiento, si no es cero, debe estar al comienzo de la sección field_ids .
method_ids_size uint recuento de elementos en la lista de identificadores de métodos
method_ids_off uint Desplazamiento desde el inicio del archivo hasta la lista de identificadores de método, o 0 si method_ids_size == 0 . El desplazamiento, si no es cero, debe estar al comienzo de la sección method_ids .
class_defs_size uint recuento de elementos en la lista de definiciones de clases
class_defs_off uint desplazamiento desde el inicio del archivo a la lista de definiciones de clases, o 0 si class_defs_size == 0 (es cierto que es un caso de borde extraño). El desplazamiento, si no es cero, debe estar al comienzo de la sección class_defs .
tamaño de datos uint Tamaño de data sección de data en bytes. Debe ser un múltiplo par de sizeof (uint).
data_off uint desplazamiento desde el inicio del archivo hasta el inicio de la sección de data .

map_list

aparece en la sección de datos

referenciado desde header_item

alineación: 4 bytes

Esta es una lista de todo el contenido de un archivo, en orden. Contiene algo de redundancia con respecto al header_item pero está destinado a ser una forma fácil de usar para iterar sobre un archivo completo. Un tipo determinado debe aparecer como máximo una vez en un mapa, pero no hay restricciones sobre en qué tipos de orden pueden aparecer, aparte de las restricciones implícitas en el resto del formato (por ejemplo, una sección de header debe aparecer primero, seguida de un string_ids sección, etc.). Además, las entradas del mapa deben ordenarse por desplazamiento inicial y no deben superponerse.

Nombre Formato Descripción
Talla uint tamaño de la lista, en entradas
lista map_item [tamaño] elementos de la lista

formato map_item

Nombre Formato Descripción
tipo corto tipo de artículos; vea la tabla de abajo
no usado corto (no usado)
Talla uint recuento del número de elementos que se encontrarán en el desplazamiento indicado
compensar uint compensar desde el inicio del archivo hasta los elementos en cuestión

Códigos de tipo

Tipo de artículo Constante Valor Tamaño del artículo en bytes
header_item TYPE_HEADER_ITEM 0x0000 0x70
string_id_item TYPE_STRING_ID_ITEM 0x0001 0x04
type_id_item TYPE_TYPE_ID_ITEM 0x0002 0x04
proto_id_item TYPE_PROTO_ID_ITEM 0x0003 0x0c
field_id_item TYPE_FIELD_ID_ITEM 0x0004 0x08
method_id_item TYPE_METHOD_ID_ITEM 0x0005 0x08
class_def_item TYPE_CLASS_DEF_ITEM 0x0006 0x20
call_site_id_item TYPE_CALL_SITE_ID_ITEM 0x0007 0x04
item_handle_item TYPE_METHOD_HANDLE_ITEM 0x0008 0x08
map_list TYPE_MAP_LIST 0x1000 4 + (tamaño del artículo * 12)
type_list TYPE_TYPE_LIST 0x1001 4 + (tamaño del artículo * 2)
annotation_set_ref_list TYPE_ANNOTATION_SET_REF_LIST 0x1002 4 + (tamaño del artículo * 4)
annotation_set_item TYPE_ANNOTATION_SET_ITEM 0x1003 4 + (tamaño del artículo * 4)
class_data_item TYPE_CLASS_DATA_ITEM 0x2000 implícito; debe analizar
code_item TYPE_CODE_ITEM 0x2001 implícito; debe analizar
string_data_item TYPE_STRING_DATA_ITEM 0x2002 implícito; debe analizar
debug_info_item TYPE_DEBUG_INFO_ITEM 0x2003 implícito; debe analizar
annotation_item TYPE_ANNOTATION_ITEM 0x2004 implícito; debe analizar
elemento_arreglo_codificado TYPE_ENCODED_ARRAY_ITEM 0x2005 implícito; debe analizar
annotations_directory_item TYPE_ANNOTATIONS_DIRECTORY_ITEM 0x2006 implícito; debe analizar
hiddenapi_class_data_item TYPE_HIDDENAPI_CLASS_DATA_ITEM 0xF000 implícito; debe analizar

string_id_item

aparece en la sección string_ids

alineación: 4 bytes

Nombre Formato Descripción
string_data_off uint Desplazamiento desde el inicio del archivo hasta los datos de la cadena para este elemento. El desplazamiento debe estar en una ubicación en la sección de data , y los datos deben estar en el formato especificado por " string_data_item " a continuación. No hay ningún requisito de alineación para el desplazamiento.

string_data_item

aparece en la sección de datos

alineación: ninguna (alineada por bytes)

Nombre Formato Descripción
utf16_size uleb128 tamaño de esta cadena, en unidades de código UTF-16 (que es la "longitud de la cadena" en muchos sistemas). Es decir, esta es la longitud decodificada de la cadena. (La longitud codificada está implícita en la posición del byte 0 ).
datos ubyte [] una serie de unidades de código MUTF-8 (también conocidas como octetos, también conocidas como bytes) seguidas de un byte de valor 0 . Consulte "Codificación MUTF-8 (UTF-8 modificado)" más arriba para obtener detalles y una discusión sobre el formato de datos.

Nota: Es aceptable tener una cadena que incluya (la forma codificada de) unidades de código sustituto UTF-16 (es decir, U+d800U+dfff ) ya sea de forma aislada o U+dfff con respecto a la codificación habitual de Unicode en UTF-16. Depende de los usos de cadenas de nivel superior rechazar tales codificaciones no válidas, si corresponde.

type_id_item

aparece en la sección type_ids

alineación: 4 bytes

Nombre Formato Descripción
descriptor_idx uint indexar en la lista string_ids para la cadena de descriptor de este tipo. La cadena debe ajustarse a la sintaxis de TypeDescriptor , definida anteriormente.

proto_id_item

aparece en la sección proto_ids

alineación: 4 bytes

Nombre Formato Descripción
shorty_idx uint indexar en la lista string_ids para la cadena de descriptor de formato corto de este prototipo. La cadena debe ajustarse a la sintaxis de ShortyDescriptor , definida anteriormente, y debe corresponder al tipo de retorno y los parámetros de este elemento.
return_type_idx uint indexar en la lista type_ids para el tipo de retorno de este prototipo
parameters_off uint desplazarse desde el inicio del archivo a la lista de tipos de parámetros para este prototipo, o 0 si este prototipo no tiene parámetros. Este desplazamiento, si no es cero, debe estar en la sección de data , y los datos deben estar en el formato especificado por "type_list" continuación. Además, no debe haber ninguna referencia al tipo void en la lista.

field_id_item

aparece en la sección field_ids

alineación: 4 bytes

Nombre Formato Descripción
class_idx corto indexar en la lista type_ids para el definidor de este campo. Debe ser un tipo de clase y no una matriz o un tipo primitivo.
type_idx corto indexar en la lista type_ids para el tipo de este campo
name_idx uint indexar en la lista string_ids para el nombre de este campo. La cadena debe ajustarse a la sintaxis de MemberName , definida anteriormente.

method_id_item

aparece en la sección method_ids

alineación: 4 bytes

Nombre Formato Descripción
class_idx corto indexar en la lista type_ids para el definidor de este método. Debe ser un tipo de clase o matriz, y no un tipo primitivo.
proto_idx corto indexar en la lista proto_ids para el prototipo de este método
name_idx uint indexar en la lista string_ids para el nombre de este método. La cadena debe ajustarse a la sintaxis de MemberName , definida anteriormente.

class_def_item

aparece en la sección class_defs

alineación: 4 bytes

Nombre Formato Descripción
class_idx uint indexar en la lista type_ids para esta clase. Debe ser un tipo de clase y no una matriz o un tipo primitivo.
access_flags uint banderas de acceso para la clase ( public , final , etc.). Consulte "Definiciones de access_flags " para obtener más detalles.
superclass_idx uint indexar en la lista type_ids para la superclase, o el valor constante NO_INDEX si esta clase no tiene superclase (es decir, es una clase raíz como Object ). Si está presente, debe ser un tipo de clase y no una matriz o un tipo primitivo.
interfaces_off uint desplazarse desde el inicio del archivo hasta la lista de interfaces, o 0 si no hay ninguna. Este desplazamiento debe estar en la sección de data y los datos deben estar en el formato especificado por " type_list " a continuación. Cada uno de los elementos de la lista debe ser un tipo de clase (no una matriz o un tipo primitivo) y no debe haber duplicados.
source_file_idx uint indexar en la lista string_ids para el nombre del archivo que contiene la fuente original para (al menos la mayoría de) esta clase, o el valor especial NO_INDEX para representar la falta de esta información. El debug_info_item de cualquier método dado puede anular este archivo fuente, pero la expectativa es que la mayoría de las clases solo provendrán de un archivo fuente.
annotations_off uint desplazarse desde el inicio del archivo hasta la estructura de anotaciones para esta clase, o 0 si no hay anotaciones en esta clase. Este desplazamiento, si no es cero, debe estar en la sección de data , y los datos deben estar en el formato especificado por " annotations_directory_item " a continuación, con todos los elementos refiriéndose a esta clase como definidor.
class_data_off uint compensar desde el inicio del archivo hasta los datos de clase asociados para este elemento, o 0 si no hay datos de clase para esta clase. (Este puede ser el caso, por ejemplo, si esta clase es una interfaz de marcador). El desplazamiento, si no es cero, debe estar en la sección de data , y los datos deben estar en el formato especificado por " class_data_item " a continuación, con todos los elementos que se refieren a esta clase como definidor.
static_values_off uint Desplazamiento desde el inicio del archivo a la lista de valores iniciales para campos static , o 0 si no hay ninguno (y todos static campos static deben inicializarse con 0 o null ). Este desplazamiento debe estar en la sección de data y los datos deben estar en el formato especificado por " encoded_array_item " a continuación. El tamaño de la matriz no debe ser mayor que el número de campos static declarados por esta clase, y los elementos corresponden a los campos static en el mismo orden que los declarados en la correspondiente field_list . El tipo de cada elemento de la matriz debe coincidir con el tipo declarado de su campo correspondiente. Si hay menos elementos en la matriz que campos static , los campos sobrantes se inicializan con un 0 o null apropiado para el tipo.

call_site_id_item

aparece en la sección call_site_ids

alineación: 4 bytes

Nombre Formato Descripción
call_site_off uint Desplazamiento desde el inicio del archivo para llamar a la definición del sitio. El desplazamiento debe estar en la sección de datos y los datos deben estar en el formato especificado por "call_site_item" a continuación.

call_site_item

aparece en la sección de datos

alineación: ninguna (byte alineado)

The call_site_item is an encoded_array_item whose elements correspond to the arguments provided to a bootstrap linker method. The first three arguments are:

  1. A method handle representing the bootstrap linker method (VALUE_METHOD_HANDLE).
  2. A method name that the bootstrap linker should resolve (VALUE_STRING).
  3. A method type corresponding to the type of the method name to be resolved (VALUE_METHOD_TYPE).

Any additional arguments are constant values passed to the bootstrap linker method. These arguments are passed in order and without any type conversions.

The method handle representing the bootstrap linker method must have return type java.lang.invoke.CallSite . The first three parameter types are:

  1. java.lang.invoke.Lookup
  2. java.lang.String
  3. java.lang.invoke.MethodType

The parameter types of any additional arguments are determined from their constant values.

method_handle_item

appears in the method_handles section

alignment: 4 bytes

Name Format Description
method_handle_type ushort type of the method handle; see table below
unused ushort (unused)
field_or_method_id ushort Field or method id depending on whether the method handle type is an accessor or a method invoker
unused ushort (unused)

Method Handle Type Codes

Constant Value Description
METHOD_HANDLE_TYPE_STATIC_PUT 0x00 Method handle is a static field setter (accessor)
METHOD_HANDLE_TYPE_STATIC_GET 0x01 Method handle is a static field getter (accessor)
METHOD_HANDLE_TYPE_INSTANCE_PUT 0x02 Method handle is an instance field setter (accessor)
METHOD_HANDLE_TYPE_INSTANCE_GET 0x03 Method handle is an instance field getter (accessor)
METHOD_HANDLE_TYPE_INVOKE_STATIC 0x04 Method handle is a static method invoker
METHOD_HANDLE_TYPE_INVOKE_INSTANCE 0x05 Method handle is an instance method invoker
METHOD_HANDLE_TYPE_INVOKE_CONSTRUCTOR 0x06 Method handle is a constructor method invoker
METHOD_HANDLE_TYPE_INVOKE_DIRECT 0x07 Method handle is a direct method invoker
METHOD_HANDLE_TYPE_INVOKE_INTERFACE 0x08 Method handle is an interface method invoker

class_data_item

referenced from class_def_item

appears in the data section

alignment: none (byte-aligned)

Name Format Description
static_fields_size uleb128 the number of static fields defined in this item
instance_fields_size uleb128 the number of instance fields defined in this item
direct_methods_size uleb128 the number of direct methods defined in this item
virtual_methods_size uleb128 the number of virtual methods defined in this item
static_fields encoded_field[static_fields_size] the defined static fields, represented as a sequence of encoded elements. The fields must be sorted by field_idx in increasing order.
instance_fields encoded_field[instance_fields_size] the defined instance fields, represented as a sequence of encoded elements. The fields must be sorted by field_idx in increasing order.
direct_methods encoded_method[direct_methods_size] the defined direct (any of static , private , or constructor) methods, represented as a sequence of encoded elements. The methods must be sorted by method_idx in increasing order.
virtual_methods encoded_method[virtual_methods_size] the defined virtual (none of static , private , or constructor) methods, represented as a sequence of encoded elements. This list should not include inherited methods unless overridden by the class that this item represents. The methods must be sorted by method_idx in increasing order. The method_idx of a virtual method must not be the same as any direct method.

Note: All elements' field_id s and method_id s must refer to the same defining class.

encoded_field format

Name Format Description
field_idx_diff uleb128 index into the field_ids list for the identity of this field (includes the name and descriptor), represented as a difference from the index of previous element in the list. The index of the first element in a list is represented directly.
access_flags uleb128 access flags for the field ( public , final , etc.). See " access_flags Definitions" for details.

encoded_method format

Name Format Description
method_idx_diff uleb128 index into the method_ids list for the identity of this method (includes the name and descriptor), represented as a difference from the index of previous element in the list. The index of the first element in a list is represented directly.
access_flags uleb128 access flags for the method ( public , final , etc.). See " access_flags Definitions" for details.
code_off uleb128 offset from the start of the file to the code structure for this method, or 0 if this method is either abstract or native . The offset should be to a location in the data section. The format of the data is specified by " code_item " below.

type_list

referenced from class_def_item and proto_id_item

appears in the data section

alignment: 4 bytes

Name Format Description
size uint size of the list, in entries
list type_item[size] elements of the list

type_item format

Name Format Description
type_idx ushort index into the type_ids list

code_item

referenced from encoded_method

appears in the data section

alignment: 4 bytes

Name Format Description
registers_size ushort the number of registers used by this code
ins_size ushort the number of words of incoming arguments to the method that this code is for
outs_size ushort the number of words of outgoing argument space required by this code for method invocation
tries_size ushort the number of try_item s for this instance. If non-zero, then these appear as the tries array just after the insns in this instance.
debug_info_off uint offset from the start of the file to the debug info (line numbers + local variable info) sequence for this code, or 0 if there simply is no information. The offset, if non-zero, should be to a location in the data section. The format of the data is specified by " debug_info_item " below.
insns_size uint size of the instructions list, in 16-bit code units
insns ushort[insns_size] actual array of bytecode. The format of code in an insns array is specified by the companion document Dalvik bytecode . Note that though this is defined as an array of ushort , there are some internal structures that prefer four-byte alignment. Also, if this happens to be in an endian-swapped file, then the swapping is only done on individual ushort s and not on the larger internal structures.
padding ushort (optional) = 0 two bytes of padding to make tries four-byte aligned. This element is only present if tries_size is non-zero and insns_size is odd.
tries try_item[tries_size] (optional) array indicating where in the code exceptions are caught and how to handle them. Elements of the array must be non-overlapping in range and in order from low to high address. This element is only present if tries_size is non-zero.
handlers encoded_catch_handler_list (optional) bytes representing a list of lists of catch types and associated handler addresses. Each try_item has a byte-wise offset into this structure. This element is only present if tries_size is non-zero.

try_item format

Name Format Description
start_addr uint start address of the block of code covered by this entry. The address is a count of 16-bit code units to the start of the first covered instruction.
insn_count ushort number of 16-bit code units covered by this entry. The last code unit covered (inclusive) is start_addr + insn_count - 1 .
handler_off ushort offset in bytes from the start of the associated encoded_catch_hander_list to the encoded_catch_handler for this entry. This must be an offset to the start of an encoded_catch_handler .

encoded_catch_handler_list format

Name Format Description
size uleb128 size of this list, in entries
list encoded_catch_handler[handlers_size] actual list of handler lists, represented directly (not as offsets), and concatenated sequentially

encoded_catch_handler format

Name Format Description
size sleb128 number of catch types in this list. If non-positive, then this is the negative of the number of catch types, and the catches are followed by a catch-all handler. For example: A size of 0 means that there is a catch-all but no explicitly typed catches. A size of 2 means that there are two explicitly typed catches and no catch-all. And a size of -1 means that there is one typed catch along with a catch-all.
handlers encoded_type_addr_pair[abs(size)] stream of abs(size) encoded items, one for each caught type, in the order that the types should be tested.
catch_all_addr uleb128 (optional) bytecode address of the catch-all handler. This element is only present if size is non-positive.

encoded_type_addr_pair format

Name Format Description
type_idx uleb128 index into the type_ids list for the type of the exception to catch
addr uleb128 bytecode address of the associated exception handler

debug_info_item

referenced from code_item

appears in the data section

alignment: none (byte-aligned)

Each debug_info_item defines a DWARF3-inspired byte-coded state machine that, when interpreted, emits the positions table and (potentially) the local variable information for a code_item . The sequence begins with a variable-length header (the length of which depends on the number of method parameters), is followed by the state machine bytecodes, and ends with an DBG_END_SEQUENCE byte.

The state machine consists of five registers. The address register represents the instruction offset in the associated insns_item in 16-bit code units. The address register starts at 0 at the beginning of each debug_info sequence and must only monotonically increase. The line register represents what source line number should be associated with the next positions table entry emitted by the state machine. It is initialized in the sequence header, and may change in positive or negative directions but must never be less than 1 . The source_file register represents the source file that the line number entries refer to. It is initialized to the value of source_file_idx in class_def_item . The other two variables, prologue_end and epilogue_begin , are boolean flags (initialized to false ) that indicate whether the next position emitted should be considered a method prologue or epilogue. The state machine must also track the name and type of the last local variable live in each register for the DBG_RESTART_LOCAL code.

The header is as follows:

Name Format Description
line_start uleb128 the initial value for the state machine's line register. Does not represent an actual positions entry.
parameters_size uleb128 the number of parameter names that are encoded. There should be one per method parameter, excluding an instance method's this , if any.
parameter_names uleb128p1[parameters_size] string index of the method parameter name. An encoded value of NO_INDEX indicates that no name is available for the associated parameter. The type descriptor and signature are implied from the method descriptor and signature.

The byte code values are as follows:

Name Value Format Arguments Description
DBG_END_SEQUENCE 0x00 (none) terminates a debug info sequence for a code_item
DBG_ADVANCE_PC 0x01 uleb128 addr_diff addr_diff : amount to add to address register advances the address register without emitting a positions entry
DBG_ADVANCE_LINE 0x02 sleb128 line_diff line_diff : amount to change line register by advances the line register without emitting a positions entry
DBG_START_LOCAL 0x03 uleb128 register_num
uleb128p1 name_idx
uleb128p1 type_idx
register_num : register that will contain local
name_idx : string index of the name
type_idx : type index of the type
introduces a local variable at the current address. Either name_idx or type_idx may be NO_INDEX to indicate that that value is unknown.
DBG_START_LOCAL_EXTENDED 0x04 uleb128 register_num
uleb128p1 name_idx
uleb128p1 type_idx
uleb128p1 sig_idx
register_num : register that will contain local
name_idx : string index of the name
type_idx : type index of the type
sig_idx : string index of the type signature
introduces a local with a type signature at the current address. Any of name_idx , type_idx , or sig_idx may be NO_INDEX to indicate that that value is unknown. (If sig_idx is -1 , though, the same data could be represented more efficiently using the opcode DBG_START_LOCAL .)

Note: See the discussion under " dalvik.annotation.Signature " below for caveats about handling signatures.

DBG_END_LOCAL 0x05 uleb128 register_num register_num : register that contained local marks a currently-live local variable as out of scope at the current address
DBG_RESTART_LOCAL 0x06 uleb128 register_num register_num : register to restart re-introduces a local variable at the current address. The name and type are the same as the last local that was live in the specified register.
DBG_SET_PROLOGUE_END 0x07 (none) sets the prologue_end state machine register, indicating that the next position entry that is added should be considered the end of a method prologue (an appropriate place for a method breakpoint). The prologue_end register is cleared by any special ( >= 0x0a ) opcode.
DBG_SET_EPILOGUE_BEGIN 0x08 (none) sets the epilogue_begin state machine register, indicating that the next position entry that is added should be considered the beginning of a method epilogue (an appropriate place to suspend execution before method exit). The epilogue_begin register is cleared by any special ( >= 0x0a ) opcode.
DBG_SET_FILE 0x09 uleb128p1 name_idx name_idx : string index of source file name; NO_INDEX if unknown indicates that all subsequent line number entries make reference to this source file name, instead of the default name specified in code_item
Special Opcodes 0x0a…0xff (none) advances the line and address registers, emits a position entry, and clears prologue_end and epilogue_begin . See below for description.

Special opcodes

Opcodes with values between 0x0a and 0xff (inclusive) move both the line and address registers by a small amount and then emit a new position table entry. The formula for the increments are as follows:

DBG_FIRST_SPECIAL = 0x0a  // the smallest special opcode
DBG_LINE_BASE   = -4      // the smallest line number increment
DBG_LINE_RANGE  = 15      // the number of line increments represented

adjusted_opcode = opcode - DBG_FIRST_SPECIAL

line += DBG_LINE_BASE + (adjusted_opcode % DBG_LINE_RANGE)
address += (adjusted_opcode / DBG_LINE_RANGE)

annotations_directory_item

referenced from class_def_item

appears in the data section

alignment: 4 bytes

Name Format Description
class_annotations_off uint offset from the start of the file to the annotations made directly on the class, or 0 if the class has no direct annotations. The offset, if non-zero, should be to a location in the data section. The format of the data is specified by " annotation_set_item " below.
fields_size uint count of fields annotated by this item
annotated_methods_size uint count of methods annotated by this item
annotated_parameters_size uint count of method parameter lists annotated by this item
field_annotations field_annotation[fields_size] (optional) list of associated field annotations. The elements of the list must be sorted in increasing order, by field_idx .
method_annotations method_annotation[methods_size] (optional) list of associated method annotations. The elements of the list must be sorted in increasing order, by method_idx .
parameter_annotations parameter_annotation[parameters_size] (optional) list of associated method parameter annotations. The elements of the list must be sorted in increasing order, by method_idx .

Note: All elements' field_id s and method_id s must refer to the same defining class.

field_annotation format

Name Format Description
field_idx uint index into the field_ids list for the identity of the field being annotated
annotations_off uint offset from the start of the file to the list of annotations for the field. The offset should be to a location in the data section. The format of the data is specified by " annotation_set_item " below.

method_annotation format

Name Format Description
method_idx uint index into the method_ids list for the identity of the method being annotated
annotations_off uint offset from the start of the file to the list of annotations for the method. The offset should be to a location in the data section. The format of the data is specified by " annotation_set_item " below.

parameter_annotation format

Name Format Description
method_idx uint index into the method_ids list for the identity of the method whose parameters are being annotated
annotations_off uint offset from the start of the file to the list of annotations for the method parameters. The offset should be to a location in the data section. The format of the data is specified by " annotation_set_ref_list " below.

annotation_set_ref_list

referenced from parameter_annotations_item

appears in the data section

alignment: 4 bytes

Name Format Description
size uint size of the list, in entries
list annotation_set_ref_item[size] elements of the list

annotation_set_ref_item format

Name Format Description
annotations_off uint offset from the start of the file to the referenced annotation set or 0 if there are no annotations for this element. The offset, if non-zero, should be to a location in the data section. The format of the data is specified by " annotation_set_item " below.

annotation_set_item

referenced from annotations_directory_item, field_annotations_item, method_annotations_item, and annotation_set_ref_item

appears in the data section

alignment: 4 bytes

Name Format Description
size uint size of the set, in entries
entries annotation_off_item[size] elements of the set. The elements must be sorted in increasing order, by type_idx .

annotation_off_item format

Name Format Description
annotation_off uint offset from the start of the file to an annotation. The offset should be to a location in the data section, and the format of the data at that location is specified by " annotation_item " below.

annotation_item

referenced from annotation_set_item

appears in the data section

alignment: none (byte-aligned)

Name Format Description
visibility ubyte intended visibility of this annotation (see below)
annotation encoded_annotation encoded annotation contents, in the format described by " encoded_annotation format" under " encoded_value encoding" above.

Visibility values

These are the options for the visibility field in an annotation_item :

Name Value Description
VISIBILITY_BUILD 0x00 intended only to be visible at build time (eg, during compilation of other code)
VISIBILITY_RUNTIME 0x01 intended to visible at runtime
VISIBILITY_SYSTEM 0x02 intended to visible at runtime, but only to the underlying system (and not to regular user code)

encoded_array_item

referenced from class_def_item

appears in the data section

alignment: none (byte-aligned)

Name Format Description
value encoded_array bytes representing the encoded array value, in the format specified by " encoded_array Format" under " encoded_value Encoding" above.

hiddenapi_class_data_item

This section contains data on restricted interfaces used by each class.

Note: The hidden API feature was introduced in Android 10.0 and is only applicable to the DEX files of classes in the boot class path. The list of flags described below may be extended in the future releases of Android. For more information, see restrictions on non-SDK interfaces .

Name Format Description
size uint total size of the section
offsets uint[] array of offsets indexed by class_idx . A zero array entry at index class_idx means that either there is no data for this class_idx , or all hidden API flags are zero. Otherwise the array entry is non-zero and contains an offset from the beginning of the section to an array of hidden API flags for this class_idx .
flags uleb128[] concatenated arrays of hidden API flags for each class. Possible flag values are described in the table below. Flags are encoded in the same order as fields and methods are encoded in class data.

Restriction flag types:

Name Value Description
whitelist 0 Interfaces that can be freely used and are supported as part of the officially documented Android framework Package Index .
greylist 1 Non-SDK interfaces that can be used regardless of the application's target API level .
blacklist 2 Non-SDK interfaces that cannot be used regardless of the application's target API level . Accessing one of these interfaces causes a runtime error .
greylist‑max‑o 3 Non-SDK interfaces that can be used for Android 8.x and below unless they are restricted.
greylist‑max‑p 4 Non-SDK interfaces that can be used for Android 9.x unless they are restricted.
greylist‑max‑q 5 Non-SDK interfaces that can be used for Android 10.x unless they are restricted.
greylist‑max‑r 6 Non-SDK interfaces that can be used for Android 11.x unless they are restricted.

System annotations

System annotations are used to represent various pieces of reflective information about classes (and methods and fields). This information is generally only accessed indirectly by client (non-system) code.

System annotations are represented in .dex files as annotations with visibility set to VISIBILITY_SYSTEM .

dalvik.annotation.AnnotationDefault

appears on methods in annotation interfaces

An AnnotationDefault annotation is attached to each annotation interface which wishes to indicate default bindings.

Name Format Description
value Annotation the default bindings for this annotation, represented as an annotation of this type. The annotation need not include all names defined by the annotation; missing names simply do not have defaults.

dalvik.annotation.EnclosingClass

appears on classes

An EnclosingClass annotation is attached to each class which is either defined as a member of another class, per se, or is anonymous but not defined within a method body (eg, a synthetic inner class). Every class that has this annotation must also have an InnerClass annotation. Additionally, a class must not have both an EnclosingClass and an EnclosingMethod annotation.

Name Format Description
value Class the class which most closely lexically scopes this class

dalvik.annotation.EnclosingMethod

appears on classes

An EnclosingMethod annotation is attached to each class which is defined inside a method body. Every class that has this annotation must also have an InnerClass annotation. Additionally, a class must not have both an EnclosingClass and an EnclosingMethod annotation.

Name Format Description
value Method the method which most closely lexically scopes this class

dalvik.annotation.InnerClass

appears on classes

An InnerClass annotation is attached to each class which is defined in the lexical scope of another class's definition. Any class which has this annotation must also have either an EnclosingClass annotation or an EnclosingMethod annotation.

Name Format Description
name String the originally declared simple name of this class (not including any package prefix). If this class is anonymous, then the name is null .
accessFlags int the originally declared access flags of the class (which may differ from the effective flags because of a mismatch between the execution models of the source language and target virtual machine)

dalvik.annotation.MemberClasses

appears on classes

A MemberClasses annotation is attached to each class which declares member classes. (A member class is a direct inner class that has a name.)

Name Format Description
value Class[] array of the member classes

dalvik.annotation.MethodParameters

appears on methods

Note: This annotation was added after Android 7.1. Its presence on earlier Android releases will be ignored.

A MethodParameters annotation is optional and can be used to provide parameter metadata such as parameter names and modifiers.

The annotation can be omitted from a method or constructor safely when the parameter metadata is not required at runtime. java.lang.reflect.Parameter.isNamePresent() can be used to check whether metadata is present for a parameter, and the associated reflection methods such as java.lang.reflect.Parameter.getName() will fall back to default behavior at runtime if the information is not present.

When including parameter metadata, compilers must include information for generated classes such as enums, since the parameter metadata includes whether or not a parameter is synthetic or mandated.

A MethodParameters annotation describes only individual method parameters. Therefore, compilers may omit the annotation entirely for constructors and methods that have no parameters, for the sake of code-size and runtime efficiency.

The arrays documented below must be the same size as for the method_id_item dex structure associated with the method, otherwise a java.lang.reflect.MalformedParametersException will be thrown at runtime.

That is: method_id_item.proto_idx -> proto_id_item.parameters_off -> type_list.size must be the same as names().length and accessFlags().length .

Because MethodParameters describes all formal method parameters, even those not explicitly or implicitly declared in source code, the size of the arrays may differ from the Signature or other metadata information that is based only on explicit parameters declared in source code. MethodParameters will also not include any information about type annotation receiver parameters that do not exist in the actual method signature.

Name Format Description
names String[] The names of formal parameters for the associated method. The array must not be null but must be empty if there are no formal parameters. A value in the array must be null if the formal parameter with that index has no name.
If parameter name strings are empty or contain '.', ';', '[' or '/' then a java.lang.reflect.MalformedParametersException will be thrown at runtime.
accessFlags int[] The access flags of the formal parameters for the associated method. The array must not be null but must be empty if there are no formal parameters.
The value is a bit mask with the following values:
  • 0x0010 : final, the parameter was declared final
  • 0x1000 : synthetic, the parameter was introduced by the compiler
  • 0x8000 : mandated, the parameter is synthetic but also implied by the language specification
If any bits are set outside of this set then a java.lang.reflect.MalformedParametersException will be thrown at runtime.

dalvik.annotation.Signature

appears on classes, fields, and methods

A Signature annotation is attached to each class, field, or method which is defined in terms of a more complicated type than is representable by a type_id_item . The .dex format does not define the format for signatures; it is merely meant to be able to represent whatever signatures a source language requires for successful implementation of that language's semantics. As such, signatures are not generally parsed (or verified) by virtual machine implementations. The signatures simply get handed off to higher-level APIs and tools (such as debuggers). Any use of a signature, therefore, should be written so as not to make any assumptions about only receiving valid signatures, explicitly guarding itself against the possibility of coming across a syntactically invalid signature.

Because signature strings tend to have a lot of duplicated content, a Signature annotation is defined as an array of strings, where duplicated elements naturally refer to the same underlying data, and the signature is taken to be the concatenation of all the strings in the array. There are no rules about how to pull apart a signature into separate strings; that is entirely up to the tools that generate .dex files.

Name Format Description
value String[] the signature of this class or member, as an array of strings that is to be concatenated together

dalvik.annotation.Throws

appears on methods

A Throws annotation is attached to each method which is declared to throw one or more exception types.

Name Format Description
value Class[] the array of exception types thrown