Ce document décrit la disposition et le contenu des fichiers .dex
, qui sont utilisés pour contenir un ensemble de définitions de classe et leurs données complémentaires associées.
Guide des types
Nom | La description |
---|---|
octet | Int signé 8 bits |
ubyte | entier non signé 8 bits |
court | 16 bits signé int, petit-boutiste |
bref | entier non signé 16 bits, petit-boutiste |
entier | 32 bits signé int, petit-boutiste |
uint | entier non signé 32 bits, petit-boutiste |
long | 64 bits signé int, petit-boutiste |
longtemps | 64 bits entier non signé, petit-boutiste |
sleb128 | signé LEB128, longueur variable (voir ci-dessous) |
uleb128 | LEB128 non signé, de longueur variable (voir ci-dessous) |
uleb128p1 | LEB128 non signé plus 1 , longueur variable (voir ci-dessous) |
LEB128
LEB128 ("Little- Endian B ase 128 ") est un codage à longueur variable pour des quantités entières arbitraires signées ou non signées. Le format a été emprunté à la spécification DWARF3 . Dans un fichier .dex
, LEB128 n'est jamais utilisé que pour encoder des quantités 32 bits.
Chaque valeur codée LEB128 se compose de un à cinq octets, qui représentent ensemble une seule valeur de 32 bits. Chaque octet a son bit le plus significatif défini, à l'exception du dernier octet de la séquence, qui a son bit le plus significatif effacé. Les sept bits restants de chaque octet sont la charge utile, avec les sept bits les moins significatifs de la quantité dans le premier octet, les sept suivants dans le deuxième octet et ainsi de suite. Dans le cas d'un LEB128 signé ( sleb128
), le bit de charge utile le plus significatif de l'octet final de la séquence est prolongé par un signe pour produire la valeur finale. Dans le cas non signé ( uleb128
), tous les bits non représentés explicitement sont interprétés comme 0
.
Diagramme au niveau du bit d'une valeur LEB128 à deux octets | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Premier octet | Deuxième octet | ||||||||||||||
1 | bit 6 | peu 5 | peu 4 | peu 3 | peu 2 | peu 1 | peu 0 | 0 | peu 13 | bit 12 | bit 11 | peu 10 | peu 9 | peu 8 | peu 7 |
La variante uleb128p1
est utilisée pour représenter une valeur signée, où la représentation est de la valeur plus un encodée en tant que uleb128
. Cela rend le codage de -1
(alternativement considéré comme la valeur non signée 0xffffffff
) - mais aucun autre nombre négatif - un seul octet, et est utile exactement dans les cas où le nombre représenté doit être non négatif ou -1
(ou 0xffffffff
), et où aucune autre valeur négative n'est autorisée (ou où il est peu probable que de grandes valeurs non signées soient nécessaires).
Voici quelques exemples de formats :
Séquence codée | Comme sleb128 | Comme uleb128 | Comme uleb128p1 |
---|---|---|---|
00 | 0 | 0 | -1 |
01 | 1 | 1 | 0 |
7f | -1 | 127 | 126 |
80 7f | -128 | 16256 | 16255 |
Mise en page du fichier
Nom | Format | La description |
---|---|---|
entête | header_item | l'en-tête |
string_ids | string_id_item[] | liste des identificateurs de chaîne. Il s'agit d'identificateurs pour toutes les chaînes utilisées par ce fichier, soit pour la dénomination interne (par exemple, des descripteurs de type) soit en tant qu'objets constants référencés par code. Cette liste doit être triée par contenu de chaîne, en utilisant des valeurs de point de code UTF-16 (pas d'une manière sensible aux paramètres régionaux), et elle ne doit pas contenir d'entrées en double. |
type_ids | type_id_item[] | liste des identificateurs de type. Ce sont des identifiants pour tous les types (classes, tableaux ou types primitifs) référencés par ce fichier, qu'ils soient définis dans le fichier ou non. Cette liste doit être triée par index string_id et ne doit contenir aucune entrée en double. |
proto_ids | proto_id_item[] | liste des identifiants des prototypes de méthode. Ce sont des identifiants pour tous les prototypes auxquels ce fichier fait référence. Cette liste doit être triée dans l'ordre majeur du type de retour (par index type_id ), puis par liste d'arguments (ordre lexicographique, arguments individuels classés par index type_id ). La liste ne doit contenir aucune entrée en double. |
field_ids | field_id_item[] | liste des identifiants de champs. Il s'agit des identifiants de tous les champs référencés par ce fichier, qu'ils soient définis ou non dans le fichier. Cette liste doit être triée, où le type de définition (par l'index type_id ) est l'ordre majeur, le nom du champ (par l'index string_id ) est l'ordre intermédiaire et le type (par l'index type_id ) est l'ordre mineur. La liste ne doit contenir aucune entrée en double. |
method_ids | method_id_item[] | liste des identifiants de méthode. Ce sont des identifiants pour toutes les méthodes auxquelles ce fichier fait référence, qu'elles soient définies dans le fichier ou non. Cette liste doit être triée, où le type de définition (par l'index type_id ) est l'ordre majeur, le nom de la méthode (par l'index string_id ) est l'ordre intermédiaire et le prototype de la méthode (par l'index proto_id ) est l'ordre mineur. La liste ne doit contenir aucune entrée en double. |
class_defs | class_def_item[] | liste des définitions de classe. Les classes doivent être ordonnées de telle sorte que la superclasse d'une classe donnée et les interfaces implémentées apparaissent dans la liste avant la classe de référence. De plus, il n'est pas valide qu'une définition pour la classe portant le même nom apparaisse plus d'une fois dans la liste. |
call_site_ids | call_site_id_item[] | liste des identifiants des sites d'appel. Il s'agit des identifiants de tous les sites d'appel auxquels ce fichier fait référence, qu'ils soient définis ou non dans le fichier. Cette liste doit être triée dans l'ordre croissant de call_site_off . |
method_handles | method_handle_item[] | méthode gère la liste. Une liste de tous les descripteurs de méthode référencés par ce fichier, qu'ils soient définis dans le fichier ou non. Cette liste n'est pas triée et peut contenir des doublons qui correspondront logiquement à différentes instances de handle de méthode. |
Les données | ubyte[] | zone de données, contenant toutes les données de support pour les tables répertoriées ci-dessus. Différents éléments ont des exigences d'alignement différentes et des octets de remplissage sont insérés avant chaque élément si nécessaire pour obtenir un alignement correct. |
lien_données | ubyte[] | données utilisées dans les fichiers liés statiquement. Le format des données dans cette section n'est pas spécifié par ce document. Cette section est vide dans les fichiers non liés et les implémentations d'exécution peuvent l'utiliser comme bon leur semble. |
Définitions des champs de bits, des chaînes et des constantes
DEX_FILE_MAGIC
intégré dans header_item
Le tableau/chaîne constant DEX_FILE_MAGIC
est la liste des octets qui doivent apparaître au début d'un fichier .dex
pour qu'il soit reconnu comme tel. La valeur contient intentionnellement une nouvelle ligne ( "\n"
ou 0x0a
) et un octet nul ( "\0"
ou 0x00
) afin d'aider à la détection de certaines formes de corruption. La valeur encode également un numéro de version de format sous la forme de trois chiffres décimaux, qui devrait augmenter de manière monotone au fil du temps à mesure que le format évolue.
ubyte[8] DEX_FILE_MAGIC = { 0x64 0x65 0x78 0x0a 0x30 0x33 0x39 0x00 } = "dex\n039\0"
Remarque : la prise en charge de la version 039
du format a été ajoutée dans la version Android 9.0, qui a introduit deux nouveaux bytecodes, const-method-handle
et const-method-type
. (Ceux-ci sont chacun décrits dans le tableau Résumé du jeu de bytecodes .) Dans Android 10, la version 039
étend le format de fichier DEX pour inclure des informations d'API masquées qui ne s'appliquent qu'aux fichiers DEX sur le chemin de classe de démarrage.
Remarque : La prise en charge de la version 038
du format a été ajoutée dans la version Android 8.0. La version 038
a ajouté de nouveaux bytecodes ( invoke-polymorphic
et invoke-custom
) et des données pour les poignées de méthode.
Remarque : La prise en charge de la version 037
du format a été ajoutée dans la version Android 7.0. Avant la version 037
, la plupart des versions d'Android utilisaient la version 035
du format. La seule différence entre les versions 035
et 037
est l'ajout de méthodes par défaut et l'ajustement de l' invoke
.
Remarque : Au moins quelques versions antérieures du format ont été utilisées dans des versions logicielles publiques largement disponibles. Par exemple, la version 009
a été utilisée pour les versions M3 de la plate-forme Android (novembre-décembre 2007) et la version 013
a été utilisée pour les versions M5 de la plate-forme Android (février-mars 2008). À plusieurs égards, ces versions antérieures du format diffèrent considérablement de la version décrite dans ce document.
ENDIAN_CONSTANT et REVERSE_ENDIAN_CONSTANT
intégré dans header_item
La constante ENDIAN_CONSTANT
est utilisée pour indiquer l'endianité du fichier dans lequel elle se trouve. Bien que le format .dex
standard soit little-endian, les implémentations peuvent choisir d'effectuer un échange d'octets. Si une implémentation rencontre un en-tête dont la endian_tag
est REVERSE_ENDIAN_CONSTANT
au lieu de ENDIAN_CONSTANT
, elle saura que le fichier a été échangé par octet à partir de la forme attendue.
uint ENDIAN_CONSTANT = 0x12345678; uint REVERSE_ENDIAN_CONSTANT = 0x78563412;
AUCUN_INDEX
intégré dans class_def_item et debug_info_item
La constante NO_INDEX
est utilisée pour indiquer qu'une valeur d'index est absente.
Remarque : Cette valeur n'est pas définie comme étant 0
, car il s'agit en fait généralement d'un index valide.
La valeur choisie pour NO_INDEX
est représentable sous la forme d'un seul octet dans l'encodage uleb128p1
.
uint NO_INDEX = 0xffffffff; // == -1 if treated as a signed int
définitions d'access_flags
intégré dans class_def_item, encoded_field, encoded_method et InnerClass
Les champs de bits de ces drapeaux sont utilisés pour indiquer l'accessibilité et les propriétés globales des classes et des membres de classe.
Nom | Évaluer | Pour les classes (et les annotations InnerClass ) | Pour les champs | Pour les méthodes |
---|---|---|---|---|
ACC_PUBLIC | 0x1 | public : visible partout | public : visible partout | public : visible partout |
ACC_PRIVATE | 0x2 | private : visible uniquement pour la classe de définition | private : visible uniquement pour la classe de définition | private : visible uniquement pour la classe de définition |
ACC_PROTECTED | 0x4 | protected : visible pour le package et les sous-classes | protected : visible pour le package et les sous-classes | protected : visible pour le package et les sous-classes |
ACC_STATIC | 0x8 | static : n'est pas construit avec une référence externe this | static : global pour définir la classe | static : ne prend pas d'argument this |
ACC_FINAL | 0x10 | final : non sous-classable | final : immuable après construction | final : non remplaçable |
ACC_SYNCHRONIZED | 0x20 | synchronized : verrou associé acquis automatiquement autour de l'appel à cette méthode. Remarque : Ceci n'est valable que si | ||
ACC_VOLATILE | 0x40 | volatile : règles d'accès spéciales pour aider à la sécurité des threads | ||
ACC_BRIDGE | 0x40 | méthode de pont, ajoutée automatiquement par le compilateur en tant que pont de type sécurisé | ||
ACC_TRANSIENT | 0x80 | transient : ne pas être enregistré par la sérialisation par défaut | ||
ACC_VARARGS | 0x80 | le dernier argument doit être traité comme un argument "reste" par le compilateur | ||
ACC_NATIVE | 0x100 | native : implémentée en code natif | ||
ACC_INTERFACE | 0x200 | interface : classe abstraite multi-implémentable | ||
ACC_ABSTRACT | 0x400 | abstract : non directement instanciable | abstract : non implémenté par cette classe | |
ACC_STRICT | 0x800 | strictfp : règles strictes pour l'arithmétique à virgule flottante | ||
ACC_SYNTHÉTIQUE | 0x1000 | pas directement défini dans le code source | pas directement défini dans le code source | pas directement défini dans le code source |
ACC_ANNOTATION | 0x2000 | déclaré comme une classe d'annotation | ||
ACC_ENUM | 0x4000 | déclaré comme un type énuméré | déclaré comme une valeur énumérée | |
(inutilisé) | 0x8000 | |||
ACC_CONSTRUCTOR | 0x10000 | méthode constructeur (initialiseur de classe ou d'instance) | ||
ACC_DECLARED_ SYNCHRONISÉ | 0x20000 | déclarée synchronized .Remarque : Cela n'a aucun effet sur l'exécution (autre que dans le reflet de cet indicateur, en soi). |
InnerClass
et ne doit jamais être activé dans un class_def_item
.
Codage MUTF-8 (UTF-8 modifié)
En tant que concession à une prise en charge héritée plus facile, le format .dex
encode ses données de chaîne sous une forme UTF-8 modifiée standard de facto, ci-après appelée MUTF-8. Cette forme est identique à la norme UTF-8, sauf :
- Seuls les codages à un, deux et trois octets sont utilisés.
- Les points de code dans la plage
U+10000
…U+10ffff
sont codés comme une paire de substitution, chacun étant représenté par une valeur codée sur trois octets. - Le point de code
U+0000
est codé sous forme de deux octets. - Un octet nul simple (valeur
0
) indique la fin d'une chaîne, comme c'est le cas dans l'interprétation standard du langage C.
Les deux premiers éléments ci-dessus peuvent être résumés comme suit : MUTF-8 est un format d'encodage pour UTF-16, au lieu d'être un format d'encodage plus direct pour les caractères Unicode.
Les deux derniers éléments ci-dessus permettent simultanément d'inclure le point de code U+0000
dans une chaîne et de le manipuler comme une chaîne à terminaison nulle de style C.
Cependant, le codage spécial de U+0000
signifie que, contrairement à l'UTF-8 normal, le résultat de l'appel de la fonction C standard strcmp()
sur une paire de chaînes MUTF-8 n'indique pas toujours le résultat correctement signé de la comparaison de chaînes inégales . . Lorsque l'ordre (pas seulement l'égalité) est un problème, la façon la plus simple de comparer les chaînes MUTF-8 est de les décoder caractère par caractère et de comparer les valeurs décodées. (Cependant, des implémentations plus intelligentes sont également possibles.)
Veuillez vous référer à la norme Unicode pour plus d'informations sur l'encodage des caractères. MUTF-8 est en fait plus proche de l'encodage (relativement moins connu) CESU-8 que de l'UTF-8 en soi.
encodage encoding_value
intégré dans annotation_element et encoded_array_item
Une encoded_value
est un élément codé de données structurées hiérarchiquement (presque) arbitraires. L'encodage est censé être à la fois compact et simple à analyser.
Nom | Format | La description |
---|---|---|
(value_arg << 5) | type de valeur | ubyte | octet indiquant le type de la value immédiatement suivante avec un argument de clarification facultatif dans les trois bits de poids fort. Voir ci-dessous pour les différentes définitions de value . Dans la plupart des cas, value_arg code la longueur de la value immédiatement suivante en octets, comme (size - 1) , par exemple, 0 signifie que la valeur nécessite un octet et 7 signifie qu'elle nécessite huit octets ; cependant, il existe des exceptions comme indiqué ci-dessous. |
évaluer | ubyte[] | octets représentant la valeur, de longueur variable et interprétés différemment pour différents octets value_type , bien que toujours little-endian. Voir les différentes définitions de valeur ci-dessous pour plus de détails. |
Formats de valeur
Tapez le nom | value_type | format value_arg | Format de value | La description |
---|---|---|---|---|
VALUE_BYTE | 0x00 | (aucun ; doit être 0 ) | ubyte[1] | valeur entière signée sur un octet |
VALUE_SHORT | 0x02 | taille - 1 (0…1) | ubyte[taille] | valeur entière signée sur deux octets, étendue par le signe |
VALUE_CHAR | 0x03 | taille - 1 (0…1) | ubyte[taille] | valeur entière non signée sur deux octets, étendue par zéro |
VALUE_INT | 0x04 | taille - 1 (0…3) | ubyte[taille] | valeur entière signée sur quatre octets, étendue par le signe |
VALUE_LONG | 0x06 | taille - 1 (0…7) | ubyte[taille] | valeur entière signée sur huit octets, étendue par le signe |
VALUE_FLOAT | 0x10 | taille - 1 (0…3) | ubyte[taille] | modèle de bits à quatre octets, étendu par zéro vers la droite et interprété comme une valeur à virgule flottante IEEE754 32 bits |
VALUE_DOUBLE | 0x11 | taille - 1 (0…7) | ubyte[taille] | modèle de bits à huit octets, étendu par zéro vers la droite et interprété comme une valeur à virgule flottante IEEE754 64 bits |
VALUE_METHOD_TYPE | 0x15 | taille - 1 (0…3) | ubyte[taille] | valeur entière de quatre octets non signée (zéro étendu), interprétée comme un index dans la section proto_ids et représentant une valeur de type de méthode |
VALUE_METHOD_HANDLE | 0x16 | taille - 1 (0…3) | ubyte[taille] | valeur entière de quatre octets non signée (zéro étendu), interprétée comme un index dans la section method_handles et représentant une valeur de handle de méthode |
VALUE_STRING | 0x17 | taille - 1 (0…3) | ubyte[taille] | valeur entière de quatre octets non signée (zéro étendu), interprétée comme un index dans la section string_ids et représentant une valeur de chaîne |
TYPE DE VALEUR | 0x18 | taille - 1 (0…3) | ubyte[taille] | valeur entière non signée (zéro étendue) de quatre octets, interprétée comme un index dans la section type_ids et représentant une valeur de type/classe réfléchissante |
VALUE_FIELD | 0x19 | taille - 1 (0…3) | ubyte[taille] | valeur entière de quatre octets non signée (zéro étendu), interprétée comme un index dans la section field_ids et représentant une valeur de champ réfléchissante |
VALUE_METHOD | 0x1a | taille - 1 (0…3) | ubyte[taille] | valeur entière de quatre octets non signée (zéro étendu), interprétée comme un index dans la section method_ids et représentant une valeur de méthode réfléchissante |
VALUE_ENUM | 0x1b | taille - 1 (0…3) | ubyte[taille] | valeur entière de quatre octets non signée (zéro étendu), interprétée comme un index dans la section field_ids et représentant la valeur d'une constante de type énumération |
VALUE_ARRAY | 0x1c | (aucun ; doit être 0 ) | tableau_encodé | un tableau de valeurs, au format spécifié par " encoded_array " ci-dessous. La taille de la value est implicite dans l'encodage. |
VALUE_ANNOTATION | 0x1d | (aucun ; doit être 0 ) | annotation_encodée | une sous-annotation, au format spécifié par " format d' encoded_annotation " ci-dessous. La taille de la value est implicite dans l'encodage. |
VALUE_NULL | 0x1e | (aucun ; doit être 0 ) | (rien) | valeur de référence null |
VALUE_BOOLEEN | 0x1f | booléen (0…1) | (rien) | valeur d'un bit ; 0 pour false et 1 pour true . Le bit est représenté dans le value_arg . |
format de tableau_encodé
Nom | Format | La description |
---|---|---|
Taille | uleb128 | nombre d'éléments dans le tableau |
valeurs | valeur_encodée[taille] | une série de séquences d'octets size encoded_value dans le format spécifié par cette section, concaténées séquentiellement. |
format d'annotation_encodée
Nom | Format | La description |
---|---|---|
type_idx | uleb128 | type d'annotation. Il doit s'agir d'un type de classe (et non de tableau ou primitif). |
Taille | uleb128 | nombre de mappages nom-valeur dans cette annotation |
éléments | annotation_element[taille] | éléments de l'annotation, représentés directement en ligne (et non sous forme de décalages). Les éléments doivent être triés dans l'ordre croissant par l'index string_id . |
format annotation_element
Nom | Format | La description |
---|---|---|
nom_idx | uleb128 | nom de l'élément, représenté sous la forme d'un index dans la section string_ids . La chaîne doit être conforme à la syntaxe de MemberName , définie ci-dessus. |
évaluer | valeur_encodée | valeur de l'élément |
Syntaxe de chaîne
Il existe plusieurs types d'éléments dans un fichier .dex
qui se réfèrent finalement à une chaîne. Les définitions de style BNF suivantes indiquent la syntaxe acceptable pour ces chaînes.
Nom_simple
Un SimpleName est la base de la syntaxe des noms d'autres choses. Le format .dex
permet ici une bonne latitude (bien plus que la plupart des langues sources courantes). En bref, un nom simple se compose de tout caractère ou chiffre alphabétique bas-ASCII, de quelques symboles spécifiques bas-ASCII et de la plupart des points de code non-ASCII qui ne sont pas des caractères de contrôle, d'espace ou spéciaux. A partir de la version 040
, le format autorise en plus les espaces (catégorie Unicode Zs
). Notez que les points de code de substitution (dans la plage U+d800
… U+dfff
) ne sont pas considérés comme des caractères de nom valides, en soi, mais les caractères supplémentaires Unicode sont valides (qui sont représentés par l'alternative finale de la règle pour SimpleNameChar ), et ils doivent être représentés dans un fichier sous forme de paires de points de code de substitution dans le codage MUTF-8.
NomSimple → | ||
SimpleNameChar ( SimpleNameChar )* | ||
SimpleNameChar → | ||
'A' … 'Z' | ||
| | 'a' … 'z' | |
| | '0' … '9' | |
| | ' ' | depuis la version DEX 040 |
| | '$' | |
| | '-' | |
| | '_' | |
| | U+00a0 | depuis la version DEX 040 |
| | U+00a1 … U+1fff | |
| | U+2000 … U+200a | depuis la version DEX 040 |
| | U+2010 … U+2027 | |
| | U+202f | depuis la version DEX 040 |
| | U+2030 … U+d7ff | |
| | U+e000 … U+ffef | |
| | U+10000 … U+10ffff |
Nom de membre
utilisé par field_id_item et method_id_item
Un MemberName est le nom d'un membre d'une classe, les membres étant des champs, des méthodes et des classes internes.
Nom du membre → | |
Nom_simple | |
| | '<' NomSimple '>' |
NomClasseComplet
Un FullClassName est un nom de classe complet, comprenant un spécificateur de package facultatif suivi d'un nom obligatoire.
NomClasseComplète → | |
FacultatifPackagePrefix SimpleName | |
Préfixe de package facultatif → | |
( NomSimple '/' )* |
TypeDescriptor
utilisé par type_id_item
Un TypeDescriptor est la représentation de n'importe quel type, y compris les primitives, les classes, les tableaux et void
. Voir ci-dessous pour la signification des différentes versions.
Descripteur de type → | |
'V' | |
| | FieldTypeDescriptor |
Descripteur de type de champ → | |
NonArrayFieldTypeDescriptorNonArrayFieldTypeDescriptor | |
| | ( '[' * 1…255) NonArrayFieldTypeDescriptor |
NonArrayFieldTypeDescriptor → | |
'Z' | |
| | 'B' |
| | 'S' |
| | 'C' |
| | 'I' |
| | 'J' |
| | 'F' |
| | 'D' |
| | 'L' NomClasseComplète ';' |
ShortyDescriptor
utilisé par proto_id_item
Un ShortyDescriptor est la représentation abrégée d'un prototype de méthode, y compris les types de retour et de paramètre, sauf qu'il n'y a pas de distinction entre les différents types de référence (classe ou tableau). Au lieu de cela, tous les types de référence sont représentés par un seul caractère 'L'
.
ShortyDescriptor → | |
ShortyReturnType ( ShortyFieldType )* | |
Type de retour court → | |
'V' | |
| | ShortyFieldType |
ShortyFieldType → | |
'Z' | |
| | 'B' |
| | 'S' |
| | 'C' |
| | 'I' |
| | 'J' |
| | 'F' |
| | 'D' |
| | 'L' |
Sémantique TypeDescriptorTypeDescriptor Semantics
C'est la signification de chacune des variantes de TypeDescriptor .
Syntaxe | Sens |
---|---|
V | void ; valable uniquement pour les types de retour |
Z | boolean |
B | byte |
S | short |
C | char |
je | int |
J | long |
F | float |
ré | double |
L pleinement/qualifié/Nom ; | la classe fully.qualified.Name |
[ descripteur | tableau de descriptor , utilisable de manière récursive pour les tableaux de tableaux, bien qu'il ne soit pas valide d'avoir plus de 255 dimensions. |
Articles et structures associées
Cette section comprend des définitions pour chacun des éléments de niveau supérieur pouvant apparaître dans un fichier .dex
.
header_item
apparaît dans la section d'en-tête
alignement : 4 octets
Nom | Format | La description |
---|---|---|
la magie | ubyte[8] = DEX_FILE_MAGIC | valeur magique. Voir la discussion ci-dessus sous " DEX_FILE_MAGIC " pour plus de détails. |
somme de contrôle | uint | somme de contrôle adler32 du reste du fichier (tout sauf magic et ce champ) ; utilisé pour détecter la corruption de fichiers |
Signature | ubyte[20] | Signature SHA-1 (hachage) du reste du fichier (tout sauf magic , checksum et ce champ) ; utilisé pour identifier de manière unique les fichiers |
taille du fichier | uint | taille du fichier entier (y compris l'en-tête), en octets |
header_size | uint = 0x70 | taille de l'en-tête (toute cette section), en octets. Cela permet au moins une quantité limitée de compatibilité ascendante/aval sans invalider le format. |
endian_tag | uint = ENDIAN_CONSTANT | balise d'endianité. Voir la discussion ci-dessus sous " ENDIAN_CONSTANT et REVERSE_ENDIAN_CONSTANT " pour plus de détails. |
taille_lien | uint | taille de la section de lien, ou 0 si ce fichier n'est pas lié statiquement |
lien_off | uint | décalage du début du fichier à la section de lien, ou 0 si link_size == 0 . Le décalage, s'il est différent de zéro, doit correspondre à un décalage dans la section link_data . Le format des données pointées n'est pas spécifié par ce document ; ce champ d'en-tête (et le précédent) sont laissés comme crochets pour être utilisés par les implémentations d'exécution. |
map_off | uint | décalage entre le début du fichier et l'élément de la carte. Le décalage, qui doit être différent de zéro, doit être un décalage dans la section des data , et les données doivent être au format spécifié par " map_list " ci-dessous. |
string_ids_size | uint | nombre de chaînes dans la liste des identificateurs de chaîne |
string_ids_off | uint | décalage du début du fichier à la liste des identifiants de chaîne, ou 0 si string_ids_size == 0 (certes un cas étrange). Le décalage, s'il est différent de zéro, doit être au début de la section string_ids . |
type_ids_size | uint | nombre d'éléments dans la liste des identificateurs de type, au plus 65535 |
type_ids_off | uint | décalage du début du fichier à la liste des identificateurs de type, ou 0 si type_ids_size == 0 (certes un étrange cas marginal). Le décalage, s'il est différent de zéro, doit être au début de la section type_ids . |
proto_ids_size | uint | nombre d'éléments dans la liste des identifiants de prototype, au plus 65535 |
proto_ids_off | uint | décalage du début du fichier à la liste des identifiants du prototype, ou 0 si proto_ids_size == 0 (certes un étrange cas limite). Le décalage, s'il est différent de zéro, doit être au début de la section proto_ids . |
field_ids_size | uint | nombre d'éléments dans la liste des identifiants de champ |
field_ids_off | uint | décalage du début du fichier à la liste des identifiants de champ, ou 0 si field_ids_size == 0 . Le décalage, s'il est différent de zéro, doit être au début de la section field_ids . |
method_ids_size | uint | nombre d'éléments dans la liste des identificateurs de méthode |
method_ids_off | uint | décalage du début du fichier à la liste des identifiants de méthode, ou 0 si method_ids_size == 0 . Le décalage, s'il est différent de zéro, doit être au début de la section method_ids . |
class_defs_size | uint | nombre d'éléments dans la liste des définitions de classe |
class_defs_off | uint | décalage du début du fichier à la liste des définitions de classe, ou 0 si class_defs_size == 0 (certes un étrange cas marginal). Le décalage, s'il est différent de zéro, doit être au début de la section class_defs . |
data_size | uint | Taille de la section de data en octets. Doit être un multiple pair de sizeof(uint). |
data_off | uint | décalage entre le début du fichier et le début de la section de data . |
map_list
apparaît dans la section des données
référencé depuis header_item
alignement : 4 octets
Il s'agit d'une liste de tout le contenu d'un fichier, dans l'ordre. Il contient une certaine redondance par rapport à header_item
mais est destiné à être une forme facile à utiliser pour itérer sur un fichier entier. Un type donné doit apparaître au plus une fois dans une carte, mais il n'y a aucune restriction sur l'ordre dans lequel les types peuvent apparaître, autres que les restrictions impliquées par le reste du format (par exemple, une section d'en- header
doit apparaître en premier, suivie d'un string_ids
section, etc). De plus, les entrées de la carte doivent être triées par décalage initial et ne doivent pas se chevaucher.
Nom | Format | La description |
---|---|---|
Taille | uint | taille de la liste, en entrées |
liste | map_item[taille] | éléments de la liste |
format map_item
Nom | Format | La description |
---|---|---|
taper | bref | type d'articles ; voir le tableau ci-dessous |
inutilisé | bref | (inutilisé) |
Taille | uint | décompte du nombre d'éléments à trouver à l'offset indiqué |
décalage | uint | décalage du début du fichier aux éléments concernés |
Codes de types
Type d'élément | Constant | Évaluer | Taille de l'élément en octets |
---|---|---|---|
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 |
method_handle_item | TYPE_METHOD_HANDLE_ITEM | 0x0008 | 0x08 |
map_list | TYPE_MAP_LIST | 0x1000 | 4 + (taille article * 12) |
type_list | TYPE_TYPE_LIST | 0x1001 | 4 + (taille de l'article * 2) |
annotation_set_ref_list | TYPE_ANNOTATION_SET_REF_LIST | 0x1002 | 4 + (taille de l'article * 4) |
annotation_set_item | TYPE_ANNOTATION_SET_ITEM | 0x1003 | 4 + (taille de l'article * 4) |
class_data_item | TYPE_CLASS_DATA_ITEM | 0x2000 | implicite; doit analyser |
code_item | TYPE_CODE_ITEM | 0x2001 | implicite; doit analyser |
string_data_item | TYPE_STRING_DATA_ITEM | 0x2002 | implicite; doit analyser |
debug_info_item | TYPE_DEBUG_INFO_ITEM | 0x2003 | implicite; doit analyser |
annotation_item | TYPE_ANNOTATION_ITEM | 0x2004 | implicite; doit analyser |
encoding_array_item | TYPE_ENCODED_ARRAY_ITEM | 0x2005 | implicite; doit analyser |
annotations_directory_item | TYPE_ANNOTATIONS_DIRECTORY_ITEM | 0x2006 | implicite; doit analyser |
cachéapi_class_data_item | TYPE_HIDDENAPI_CLASS_DATA_ITEM | 0xF000 | implicite; doit analyser |
string_id_item
apparaît dans la section string_ids
alignement : 4 octets
Nom | Format | La description |
---|---|---|
string_data_off | uint | décalage entre le début du fichier et les données de chaîne pour cet élément. Le décalage doit être à un emplacement dans la section des data , et les données doivent être au format spécifié par " string_data_item " ci-dessous. Il n'y a aucune exigence d'alignement pour le décalage. |
string_data_item
apparaît dans la section des données
alignement : aucun (aligné sur les octets)
Nom | Format | La description |
---|---|---|
utf16_size | uleb128 | taille de cette chaîne, en unités de code UTF-16 (qui est la "longueur de chaîne" dans de nombreux systèmes). C'est-à-dire qu'il s'agit de la longueur décodée de la chaîne. (La longueur codée est impliquée par la position de l'octet 0 ) |
Les données | ubyte[] | une série d'unités de code MUTF-8 (c'est-à-dire des octets, c'est-à-dire des octets) suivies d'un octet de valeur 0 . Voir "Codage MUTF-8 (UTF-8 modifié)" ci-dessus pour plus de détails et une discussion sur le format de données. Remarque : Il est acceptable d'avoir une chaîne qui inclut (la forme codée) des unités de code de substitution UTF-16 (c'est-à-dire |
type_id_item
apparaît dans la section type_ids
alignement : 4 octets
Nom | Format | La description |
---|---|---|
descripteur_idx | uint | index dans la liste string_ids pour la chaîne de description de ce type. La chaîne doit être conforme à la syntaxe de TypeDescriptor , définie ci-dessus. |
proto_id_item
apparaît dans la section proto_ids
alignement : 4 octets
Nom | Format | La description |
---|---|---|
shorty_idx | uint | index dans la liste string_ids pour la chaîne de description abrégée de ce prototype. La chaîne doit être conforme à la syntaxe de ShortyDescriptor , définie ci-dessus, et doit correspondre au type de retour et aux paramètres de cet élément. |
return_type_idx | uint | index dans la liste type_ids pour le type de retour de ce prototype |
paramètres_off | uint | décalage du début du fichier à la liste des types de paramètres pour ce prototype, ou 0 si ce prototype n'a pas de paramètres. Ce décalage, s'il est différent de zéro, doit être dans la section des data , et les données doivent être au format spécifié par "type_list" ci-dessous. De plus, il ne devrait y avoir aucune référence au type void dans la liste. |
field_id_item
apparaît dans la section field_ids
alignement : 4 octets
Nom | Format | La description |
---|---|---|
classe_idx | bref | index dans la liste type_ids pour le définisseur de ce champ. Il doit s'agir d'un type de classe et non d'un tableau ou d'un type primitif. |
type_idx | bref | index dans la liste type_ids pour le type de ce champ |
nom_idx | uint | index dans la liste string_ids pour le nom de ce champ. La chaîne doit être conforme à la syntaxe de MemberName , définie ci-dessus. |
method_id_item
apparaît dans la section method_ids
alignement : 4 octets
Nom | Format | La description |
---|---|---|
classe_idx | bref | index dans la liste type_ids pour le définisseur de cette méthode. Il doit s'agir d'un type classe ou tableau, et non d'un type primitif. |
proto_idx | bref | index dans la liste proto_ids pour le prototype de cette méthode |
nom_idx | uint | index dans la liste string_ids pour le nom de cette méthode. La chaîne doit être conforme à la syntaxe de MemberName , définie ci-dessus. |
class_def_item
apparaît dans la section class_defs
alignement : 4 octets
Nom | Format | La description |
---|---|---|
classe_idx | uint | index dans la liste type_ids pour cette classe. Il doit s'agir d'un type de classe et non d'un tableau ou d'un type primitif. |
access_flags | uint | drapeaux d'accès pour la classe ( public , final , etc.). Voir "Définitions des access_flags " pour plus de détails. |
superclass_idx | uint | index dans la liste type_ids pour la superclasse, ou la valeur constante NO_INDEX si cette classe n'a pas de superclasse (c'est-à-dire, c'est une classe racine telle que Object ). S'il est présent, il doit s'agir d'un type de classe et non d'un tableau ou d'un type primitif. |
interfaces_off | uint | décalage du début du fichier à la liste des interfaces, ou 0 s'il n'y en a pas. Ce décalage doit être dans la section des data , et les données doivent être au format spécifié par " type_list " ci-dessous. Chacun des éléments de la liste doit être un type de classe (et non un tableau ou un type primitif) et il ne doit pas y avoir de doublons. |
source_file_idx | uint | index dans la liste string_ids pour le nom du fichier contenant la source d'origine pour (au moins la plupart de) cette classe, ou la valeur spéciale NO_INDEX pour représenter un manque de cette information. Le debug_info_item d'une méthode donnée peut remplacer ce fichier source, mais on s'attend à ce que la plupart des classes ne proviennent que d'un seul fichier source. |
annotations_off | uint | décalage entre le début du fichier et la structure des annotations pour cette classe, ou 0 s'il n'y a pas d'annotations sur cette classe. Ce décalage, s'il est différent de zéro, doit être dans la section des data , et les données doivent être au format spécifié par " annotations_directory_item " ci-dessous, avec tous les éléments faisant référence à cette classe en tant que définisseur. |
class_data_off | uint | décalage entre le début du fichier et les données de classe associées pour cet élément, ou 0 s'il n'y a pas de données de classe pour cette classe. (Cela peut être le cas, par exemple, si cette classe est une interface de marqueur.) Le décalage, s'il est différent de zéro, doit être dans la section des data , et les données doivent être au format spécifié par " class_data_item " ci-dessous, avec tous les éléments faisant référence à cette classe en tant que définisseur. |
static_values_off | uint | décalage du début du fichier à la liste des valeurs initiales pour les champs static , ou 0 s'il n'y en a pas (et tous les champs static doivent être initialisés avec 0 ou null ). Ce décalage doit être dans la section des data , et les données doivent être au format spécifié par " encoded_array_item " ci-dessous. La taille du tableau ne doit pas être supérieure au nombre de champs static déclarés par cette classe, et les éléments correspondent aux champs static dans le même ordre que celui déclaré dans la field_list correspondante. Le type de chaque élément du tableau doit correspondre au type déclaré de son champ correspondant. S'il y a moins d'éléments dans le tableau qu'il n'y a de champs static , les champs restants sont initialisés avec un type approprié 0 ou null . |
call_site_id_item
apparaît dans la section call_site_ids
alignement : 4 octets
Nom | Format | La description |
---|---|---|
appel_site_off | uint | décalage depuis le début du fichier pour appeler la définition du site. Le décalage doit être dans la section des données, et les données doivent être au format spécifié par "call_site_item" ci-dessous. |
call_site_item
apparaît dans la section des données
alignement : aucun (aligné sur les octets)
Le call_site_item est un encoded_array_item dont les éléments correspondent aux arguments fournis à une méthode de l'éditeur de liens bootstrap. Les trois premiers arguments sont :
- Un handle de méthode représentant la méthode de l'éditeur de liens bootstrap (VALUE_METHOD_HANDLE).
- Un nom de méthode que l'éditeur de liens d'amorçage doit résoudre (VALUE_STRING).
- Un type de méthode correspondant au type du nom de méthode à résoudre (VALUE_METHOD_TYPE).
Tous les arguments supplémentaires sont des valeurs constantes transmises à la méthode de l'éditeur de liens bootstrap. Ces arguments sont passés dans l'ordre et sans aucune conversion de type.
Le handle de méthode représentant la méthode de l'éditeur de liens d'amorçage doit avoir le type de retour java.lang.invoke.CallSite
. Les trois premiers types de paramètres sont :
-
java.lang.invoke.Lookup
-
java.lang.String
-
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
Nom | Format | La description |
---|---|---|
method_handle_type | bref | type of the method handle; see table below |
unused | bref | (inutilisé) |
field_or_method_id | bref | Field or method id depending on whether the method handle type is an accessor or a method invoker |
unused | bref | (inutilisé) |
Method Handle Type Codes
Constant | Évaluer | La 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)
Nom | Format | La 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
Nom | Format | La 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
Nom | Format | La 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
Nom | Format | La description |
---|---|---|
Taille | uint | size of the list, in entries |
list | type_item[size] | elements of the list |
type_item format
Nom | Format | La description |
---|---|---|
type_idx | bref | index into the type_ids list |
code_item
referenced from encoded_method
appears in the data section
alignment: 4 bytes
Nom | Format | La description |
---|---|---|
registers_size | bref | the number of registers used by this code |
ins_size | bref | the number of words of incoming arguments to the method that this code is for |
outs_size | bref | the number of words of outgoing argument space required by this code for method invocation |
tries_size | bref | 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
Nom | Format | La 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 | bref | number of 16-bit code units covered by this entry. The last code unit covered (inclusive) is start_addr + insn_count - 1 . |
handler_off | bref | 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
Nom | Format | La description |
---|---|---|
Taille | 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
Nom | Format | La description |
---|---|---|
Taille | 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
Nom | Format | La 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:
Nom | Format | La 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:
Nom | Évaluer | Format | Arguments | La 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 localname_idx : string index of the nametype_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 localname_idx : string index of the nametype_idx : type index of the typesig_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 " |
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
Nom | Format | La 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
Nom | Format | La 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
Nom | Format | La 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
Nom | Format | La 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
Nom | Format | La description |
---|---|---|
Taille | uint | size of the list, in entries |
list | annotation_set_ref_item[size] | elements of the list |
annotation_set_ref_item format
Nom | Format | La 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
Nom | Format | La description |
---|---|---|
Taille | 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
Nom | Format | La 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)
Nom | Format | La 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
:
Nom | Évaluer | La 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)
Nom | Format | La 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 .
Nom | Format | La description |
---|---|---|
Taille | 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:
Nom | Évaluer | La 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.
Nom | Format | La 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.
Nom | Format | La 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.
Nom | Format | La 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.
Nom | Format | La 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 | entier | 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.)
Nom | Format | La 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.
Nom | Format | La 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:
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.
Nom | Format | La 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.
Nom | Format | La description |
---|---|---|
value | Class[] | the array of exception types thrown |