Google 致力于为黑人社区推动种族平等。查看具体举措
Эта страница переведена с помощью Cloud Translation API.
Switch to English

Формат исполняемого файла Dalvik

Этот документ описывает структуру и содержимое файлов .dex , которые используются для хранения набора определений классов и связанных с ними дополнительных данных.

Путеводитель по типам

название Описание
байт 8-битное целое число со знаком
убайт 8-битное целое число без знака
короткая 16-битное целое число со знаком, прямой порядок байтов
ushort 16-битное целое число без знака, прямой порядок байтов
int 32-битное целое число со знаком, прямой порядок байтов
uint 32-битное целое число без знака, прямой порядок байтов
длинный 64-битное целое число со знаком, прямой порядок байтов
Улонг 64-битное целое число без знака, прямой порядок байтов
Sleb128 подписанный LEB128, переменной длины (см. ниже)
uleb128 беззнаковый LEB128, переменной длины (см. ниже)
uleb128p1 беззнаковый LEB128 плюс 1 , переменной длины (см. ниже)

LEB128

LEB128 ( «L ittle- Е ndian Б аза 128») является переменной длиной кодирования для любых подписанных или целого числа без знака величин. Формат был заимствован из спецификации DWARF3 . В .dex файл LEB128 только когда используются для кодирования 32-битных величин.

Каждое закодированное значение LEB128 состоит из одного-пяти байтов, которые вместе представляют одно 32-битное значение. Для каждого байта установлен самый старший бит, за исключением последнего байта в последовательности, у которого самый старший бит очищен. Остальные семь бит каждого байта являются полезной нагрузкой, причем семь младших битов количества находятся в первом байте, следующие семь - во втором и так далее. В случае подписанного LEB128 ( sleb128 ) старший бит полезной нагрузки последнего байта в последовательности расширяется по знаку для получения окончательного значения. В беззнаковом случае ( uleb128 ) любые биты, не представленные явно, интерпретируются как 0 .

Побитовая диаграмма двухбайтового значения LEB128
Первый байт Второй байт
1 бит 6 бит 5 бит 4 бит 3 бит 2 бит 1 бит 0 0 бит 13 бит 12 бит 11 бит 10 бит 9 бит 8 бит 7

Вариант uleb128p1 используется для представления значения со uleb128p1 , где представление представляет собой значение плюс один, закодированный как uleb128 . Это делает кодирование -1 (альтернативно считается значением без знака 0xffffffff ) - но никакое другое отрицательное число - одним байтом и полезно именно в тех случаях, когда представленное число должно быть либо неотрицательным, либо -1 (или 0xffffffff ), и где другие отрицательные значения не допускаются (или где большие значения без знака вряд ли понадобятся).

Вот несколько примеров форматов:

Закодированная последовательность As sleb128 Как uleb128 Как uleb128p1
00 0 0 -1
01 1 1 0
7f -1 127 126
80 7f -128 16256 16255

Макет файла

название Формат Описание
заголовок header_item заголовок
string_ids string_id_item [] список строковых идентификаторов. Это идентификаторы для всех строк, используемых этим файлом, либо для внутреннего именования (например, дескрипторы типов), либо как константные объекты, на которые ссылается код. Этот список должен быть отсортирован по содержимому строки с использованием значений кодовой точки UTF-16 (не зависящим от локали), и он не должен содержать повторяющихся записей.
type_ids type_id_item [] список идентификаторов типов. Это идентификаторы для всех типов (классов, массивов или примитивных типов), на которые ссылается этот файл, независимо от того, определены они в файле или нет. Этот список должен быть отсортирован по индексу string_id , и он не должен содержать повторяющихся записей.
proto_ids proto_id_item [] список идентификаторов прототипов методов. Это идентификаторы для всех прототипов, на которые ссылается этот файл. Этот список должен быть отсортирован в основном порядке возвращаемого типа (по индексу type_id ), а затем по списку аргументов (лексикографический порядок, отдельные аргументы упорядочены по индексу type_id ). В списке не должно быть повторяющихся записей.
field_ids field_id_item [] список идентификаторов полей. Это идентификаторы для всех полей, на которые ссылается этот файл, независимо от того, определены они в файле или нет. Этот список должен быть отсортирован, где определяющий тип (по индексу type_id ) является основным порядком, имя поля (по индексу string_id ) является промежуточным порядком, а тип (по индексу type_id ) является второстепенным порядком. В списке не должно быть повторяющихся записей.
method_ids method_id_item [] список идентификаторов методов. Это идентификаторы для всех методов, на которые ссылается этот файл, независимо от того, определены они в файле или нет. Этот список должен быть отсортирован, где определяющий тип (по индексу type_id ) - это основной порядок, имя метода (по индексу string_id ) - это промежуточный порядок, а прототип метода (по индексу proto_id ) - второстепенный порядок. В списке не должно быть повторяющихся записей.
class_defs class_def_item [] список определений классов. Классы должны быть упорядочены так, чтобы суперкласс данного класса и реализованные интерфейсы появлялись в списке раньше, чем ссылающийся класс. Более того, недопустимо, чтобы определение одноименного класса появлялось в списке более одного раза.
call_site_ids call_site_id_item [] список идентификаторов сайтов звонков. Это идентификаторы для всех сайтов вызовов, на которые ссылается этот файл, независимо от того, определены они в файле или нет. Этот список должен быть отсортирован в порядке возрастания call_site_off .
method_handles method_handle_item [] метод обрабатывает список. Список всех дескрипторов методов, на которые ссылается этот файл, независимо от того, определены они в файле или нет. Этот список не отсортирован и может содержать дубликаты, которые логически соответствуют разным экземплярам дескрипторов метода.
данные убайт [] область данных, содержащая все вспомогательные данные для таблиц, перечисленных выше. Различные элементы имеют разные требования к выравниванию, и байты заполнения вставляются перед каждым элементом, если это необходимо для достижения правильного выравнивания.
link_data убайт [] данные, используемые в статически связанных файлах. Формат данных в этом разделе не указан в этом документе. Этот раздел пуст в несвязанных файлах, и реализации среды выполнения могут использовать его по своему усмотрению.

Битовые поля, строки и определения констант

DEX_FILE_MAGIC

встроен в header_item

Постоянный массив / строка DEX_FILE_MAGIC - это список байтов, которые должны появиться в начале файла .dex чтобы он был распознан как таковой. Значение намеренно содержит новую 0x0a ( "\n" или 0x0a ) и нулевой байт ( "\0" или 0x00 ), чтобы помочь в обнаружении определенных форм повреждения. Это значение также кодирует номер версии формата в виде трех десятичных цифр, которые, как ожидается, будут монотонно увеличиваться со временем по мере развития формата.

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

Примечание. Поддержка версии 039 формата была добавлена ​​в выпуске Android 9.0, который представил два новых байт-кода, const-method-handle и const-method-type . (Каждый из них описан в Сводке таблицы набора байт-кода .) В Android 10 версия 039 расширяет формат файла DEX, чтобы включить скрытую информацию API, которая применима только к файлам DEX в пути загрузочного класса.

Примечание. Поддержка версии 038 формата была добавлена ​​в выпуске Android 8.0. В версии 038 добавлены новые байт-коды ( invoke-polymorphic invoke-custom ) и данные для дескрипторов методов.

Примечание. Поддержка версии 037 формата была добавлена ​​в выпуске Android 7.0. До версии 037 большинство версий Android использовали версию 035 формата. Единственная разница между версиями 035 и 037 - добавление методов по умолчанию и настройка invoke .

Примечание. По крайней мере, пара более ранних версий этого формата использовалась в широко доступных общедоступных выпусках программного обеспечения. Например, версия 009 использовалась для выпусков M3 платформы Android (ноябрь – декабрь 2007 г.), а версия 013 использовалась для выпусков M5 платформы Android (февраль – март 2008 г.). В некоторых отношениях эти более ранние версии формата значительно отличаются от версии, описанной в этом документе.

ENDIAN_CONSTANT и REVERSE_ENDIAN_CONSTANT

встроенный в header_item

Константа ENDIAN_CONSTANT используется для обозначения порядка байтов файла, в котором она находится. Хотя стандартный формат .dex является .dex байтов, реализации могут выбрать замену байтов. Если реализация натолкнется на заголовок, endian_tag которого REVERSE_ENDIAN_CONSTANT вместо ENDIAN_CONSTANT , она будет знать, что файл был заменен байтами из ожидаемой формы.

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

NO_INDEX

встроен в class_def_item и debug_info_item

Константа NO_INDEX используется, чтобы указать, что значение индекса отсутствует.

Примечание. Это значение не определено как 0 , потому что обычно это действительный индекс.

Выбранное значение NO_INDEX представляется в виде одного байта в кодировке uleb128p1 .

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

access_flags определения

встроено в class_def_item, encoded_field, encoded_method и InnerClass

Битовые поля этих флагов используются для обозначения доступности и общих свойств классов и членов классов.

название Значение Для классов (и аннотаций InnerClass ) Для полей Для методов
ACC_PUBLIC 0x1 public : виден везде public : виден везде public : виден везде
ACC_PRIVATE 0x2 * private : виден только определяющему классу private : виден только определяющему классу private : виден только определяющему классу
ACC_PROTECTED 0x4 * protected : видимый для пакета и подклассов protected : видимый для пакета и подклассов protected : видимый для пакета и подклассов
ACC_STATIC 0x8 * static : не создается с внешней ссылкой this static : global для определения класса static : не принимает аргумент this
ACC_FINAL 0x10 final : не подклассифицируется final : неизменяемый после построения final : не может быть отменен
ACC_SYNCHRONIZED 0x20 synchronized : связанная блокировка автоматически устанавливается при вызове этого метода.

Примечание: это действительно только для установки, когда также установлено ACC_NATIVE .

ACC_VOLATILE 0x40 volatile : специальные правила доступа для обеспечения безопасности потоков
ACC_BRIDGE 0x40 мост, автоматически добавляемый компилятором как типобезопасный мост
ACC_TRANSIENT 0x80 transient : не сохраняться при сериализации по умолчанию
ACC_VARARGS 0x80 последний аргумент должен рассматриваться компилятором как аргумент "отдыха"
ACC_NATIVE 0x100 native : реализован в машинном коде
ACC_INTERFACE 0x200 interface : многократно реализуемый абстрактный класс
ACC_ABSTRACT 0x400 abstract : напрямую не создается abstract : не реализовано этим классом
ACC_STRICT 0x800 strictfp : строгие правила арифметики с плавающей запятой
ACC_SYNTHETIC 0x1000 прямо не определено в исходном коде прямо не определено в исходном коде прямо не определено в исходном коде
ACC_ANNOTATION 0x2000 объявлен как класс аннотации
ACC_ENUM 0x4000 объявлен как перечислимый тип объявлено как числовое значение
(не используется) 0x8000
ACC_CONSTRUCTOR 0x10000 метод конструктора (инициализатор класса или экземпляра)
ACC_DECLARED_
СИНХРОНИЗИРОВАННЫЙ
0x20000 объявлен synchronized .

Примечание. Это не влияет на выполнение (кроме отражения этого флага как такового).

* Разрешено только для аннотаций InnerClass и никогда не должно быть class_def_item в class_def_item .

Кодировка MUTF-8 (модифицированная UTF-8)

В качестве уступки более простой поддержке устаревших .dex формат .dex кодирует свои строковые данные в де-факто стандартную модифицированную форму UTF-8, далее именуемую MUTF-8. Эта форма идентична стандартной UTF-8, за исключением:

  • Используются только одно-, двух- и трехбайтовые кодировки.
  • Кодовые точки в диапазоне U+10000U+10ffff кодируются как суррогатная пара, каждая из которых представлена ​​как трехбайтовое закодированное значение.
  • Кодовая точка U+0000 кодируется в двухбайтовой форме.
  • Обычный нулевой байт (значение 0 ) указывает конец строки, как и стандартная интерпретация языка C.

Первые два пункта выше можно резюмировать следующим образом: MUTF-8 - это формат кодирования для UTF-16, а не более прямой формат кодирования для символов Unicode.

Последние два пункта выше позволяют одновременно включить кодовую точку U+0000 в строку и по- прежнему манипулировать ею как строкой с завершающим нулем в стиле C.

Однако специальная кодировка U+0000 означает, что, в отличие от обычного UTF-8, результат вызова стандартной функции C strcmp() для пары строк MUTF-8 не всегда указывает на результат сравнения неравных строк со знаком. . Когда упорядочение (а не только равенство) вызывает беспокойство, самый простой способ сравнить строки MUTF-8 - это декодировать их посимвольно и сравнивать декодированные значения. (Однако возможны и более умные реализации.)

Пожалуйста, обратитесь к Стандарту Unicode для получения дополнительной информации о кодировке символов. MUTF-8 на самом деле ближе к (относительно менее известному) кодированию CESU-8, чем к UTF-8 как таковому.

encoded_value кодировка

встроен в annotation_element и encoded_array_item

encoded_value - это закодированная часть (почти) произвольных иерархически структурированных данных. Кодировка должна быть компактной и простой для анализа.

название Формат Описание
(аргумент_значения << 5) | тип значения убайт байт, указывающий тип непосредственно следующего за ним value вместе с необязательным уточняющим аргументом в трех старших битах. Ниже приведены различные определения value . В большинстве случаев value_arg кодирует длину непосредственно следующего за ним value в байтах, так как (size - 1) , например, 0 означает, что для значения требуется один байт, а 7 означает, что для этого требуется восемь байтов; однако есть исключения, указанные ниже.
значение убайт [] байты, представляющие значение, переменной по длине и по-разному интерпретируемые для разных байтов value_type , хотя всегда с value_type байтов. Для получения подробной информации см. Различные определения значений ниже.

Форматы значений

Тип Имя value_type value_arg Формат формат value Описание
VALUE_BYTE 0x00 (нет; должно быть 0 ) убайт [1] однобайтовое целое со знаком
VALUE_SHORT 0x02 размер - 1 (0… 1) убайт [размер] знаковое двухбайтовое целое число с расширенным знаком
VALUE_CHAR 0x03 размер - 1 (0… 1) убайт [размер] беззнаковое двухбайтовое целое число с расширением нулями
VALUE_INT 0x04 размер - 1 (0… 3) убайт [размер] подписанное четырехбайтовое целое число, расширенное знаком
VALUE_LONG 0x06 размер - 1 (0… 7) убайт [размер] знаковое восьмибайтовое целое число с расширенным знаком
VALUE_FLOAT 0x10 размер - 1 (0… 3) убайт [размер] четырехбайтовый битовый шаблон, расширенный нулем вправо и интерпретируемый как 32-битное значение с плавающей запятой IEEE754
VALUE_DOUBLE 0x11 размер - 1 (0… 7) убайт [размер] восьмибайтовый битовый шаблон, с расширением нулями вправо и интерпретируемый как 64-битное значение с плавающей запятой IEEE754
VALUE_METHOD_TYPE 0x15 размер - 1 (0… 3) убайт [размер] Беззнаковое (расширенное нулями) четырехбайтовое целочисленное значение, интерпретируемое как индекс в разделе proto_ids и представляющее значение типа метода
VALUE_METHOD_HANDLE 0x16 размер - 1 (0… 3) убайт [размер] четырехбайтовое целое число без знака (расширенное нулем), интерпретируемое как индекс в разделе method_handles и представляющее значение дескриптора метода
VALUE_STRING 0x17 размер - 1 (0… 3) убайт [размер] Беззнаковое (расширенное нулем) четырехбайтовое целочисленное значение, интерпретируемое как индекс в разделе string_ids и представляющее строковое значение
ТИП ЗНАЧЕНИЯ 0x18 размер - 1 (0… 3) убайт [размер] беззнаковое (расширенное нулями) четырехбайтовое целочисленное значение, интерпретируемое как индекс в разделе type_ids и представляющее значение отражающего типа / класса
VALUE_FIELD 0x19 размер - 1 (0… 3) убайт [размер] четырехбайтовое целое число без знака (расширенное нулем), интерпретируемое как индекс в разделе field_ids и представляющее значение отражающего поля
VALUE_METHOD 0x1a размер - 1 (0… 3) убайт [размер] четырехбайтовое целое число без знака (расширенное нулем), интерпретируемое как индекс в разделе method_ids и представляющее значение отражающего метода
VALUE_ENUM 0x1b размер - 1 (0… 3) убайт [размер] четырехбайтовое целочисленное значение без знака (расширенное нулем), интерпретируемое как индекс в разделе field_ids и представляющее значение константы перечислимого типа
VALUE_ARRAY 0x1c (нет; должно быть 0 ) encoded_array массив значений в формате, указанном ниже в "формате encoded_array ". Размер value неявно указан в кодировке.
VALUE_ANNOTATION 0x1d (нет; должно быть 0 ) encoded_annotation вспомогательная аннотация в формате, указанном в «формате encoded_annotation » ниже. Размер value неявно указан в кодировке.
VALUE_NULL 0x1e (нет; должно быть 0 ) (никто) null значение ссылки
VALUE_BOOLEAN 0x1f логическое (0… 1) (никто) однобитовое значение; 0 для false и 1 для true . Бит представлен в value_arg .

формат encoded_array

название Формат Описание
размер uleb128 количество элементов в массиве
ценности encoded_value [размер] серия последовательностей байтов size encoded_value в формате, указанном в этом разделе, соединенных последовательно.

формат encoded_annotation

название Формат Описание
type_idx uleb128 тип аннотации. Это должен быть класс (не массив или примитив).
размер uleb128 количество отображений "имя-значение" в этой аннотации
элементы annotation_element [размер] элементы аннотации, представленные непосредственно в строке (не как смещения). Элементы должны быть отсортированы в порядке возрастания по индексу string_id .

формат элемента_аннотации

название Формат Описание
name_idx uleb128 имя элемента, представленное в виде индекса в разделе string_ids . Строка должна соответствовать синтаксису MemberName , определенному выше.
значение encoded_value значение элемента

Синтаксис строки

В файле .dex есть несколько типов элементов, которые в конечном итоге относятся к строке. Следующие определения в стиле BNF указывают приемлемый синтаксис для этих строк.

SimpleName

SimpleName - это основа для синтаксиса имен других вещей. Формат .dex обеспечивает здесь большую свободу действий (гораздо больше, чем в большинстве распространенных исходных языков). Вкратце, простое имя состоит из любого алфавитного символа или цифры с низким ASCII, нескольких конкретных символов с низким ASCII и большинства кодовых точек, отличных от ASCII, которые не являются управляющими, пробелами или специальными символами. Начиная с версии 040 формат дополнительно позволяет использовать пробелы (категория Unicode Zs ). Обратите внимание , что точки суррогатной кода (в диапазоне U+d800 ... U+dfff ) не считаются действительными символы в имени, по сути, но наборах Unicode дополнительные символы действительны (которые представлены в окончательной альтернативой правилу SimpleNameChar), и они должны быть представлены в файле как пары суррогатных кодовых точек в кодировке MUTF-8.

SimpleName
SimpleNameChar ( SimpleNameChar ) *
SimpleNameChar
'A''Z'
| 'a' ... 'z'
| '0''9'
| ' ' начиная с версии DEX 040
| '$'
| '-'
| '_'
| U+00a0 начиная с версии DEX 040
| U+00a1U+1fff
| U+2000U+200a начиная с версии DEX 040
| U+2010U+2027
| U+202f начиная с версии DEX 040
| U+2030U+d7ff
| U+e000U+ffef
| U+10000U+10ffff

Имя члена

используется field_id_item и method_id_item

MemberName - это имя члена класса, члены которого являются полями, методами и внутренними классами.

MemberName
SimpleName
| '<' SimpleName '>'

FullClassName

FullClassName - это полное имя класса, включая необязательный спецификатор пакета, за которым следует обязательное имя.

FullClassName
OptionalPackagePrefix SimpleName
OptionalPackagePrefix
( SimpleName '/' ) *

TypeDescriptor

используется type_id_item

TypeDescriptor - это представление любого типа, включая примитивы, классы, массивы и void . См. Ниже значение различных версий.

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

ShortyDescriptor

используется proto_id_item

ShortyDescriptor - это краткое представление прототипа метода, включая возвращаемые типы и типы параметров, за исключением того, что нет различия между различными ссылочными типами (классами или массивами). Вместо этого все ссылочные типы представлены одним символом 'L' .

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

Тип Дескриптор Семантика

В этом смысл каждого из вариантов TypeDescriptor .

Синтаксис Имея в виду
V void ; действительно только для возвращаемых типов
Z boolean
B byte
S short
C char
я int
J long
F float
D double
L полностью / квалифицированный / Имя ; класс fully.qualified.Name
[ дескриптор массив descriptor , рекурсивно используемый для массивов массивов, хотя недопустимо иметь более 255 измерений.

Предметы и связанные структуры

Этот раздел включает определения для каждого из элементов верхнего уровня, которые могут появиться в файле .dex .

header_item

появляется в разделе заголовка

выравнивание: 4 байта

название Формат Описание
магия убайт [8] = DEX_FILE_MAGIC магическая ценность. См. Обсуждение выше в разделе « DEX_FILE_MAGIC » для получения более подробной информации.
контрольная сумма uint контрольная сумма adler32 остальной части файла (все, кроме magic и этого поля); используется для обнаружения повреждения файлов
подпись убайт [20] Подпись (хэш) SHA-1 остальной части файла (все, кроме magic , checksum и этого поля); используется для однозначной идентификации файлов
размер файла uint размер всего файла (включая заголовок) в байтах
header_size uint = 0x70 размер заголовка (всего этого раздела) в байтах. Это позволяет обеспечить по крайней мере ограниченную обратную / прямую совместимость без аннулирования формата.
endian_tag uint = ENDIAN_CONSTANT тег endianness. См. Обсуждение выше в ENDIAN_CONSTANT " ENDIAN_CONSTANT и REVERSE_ENDIAN_CONSTANT " для получения дополнительных сведений.
link_size uint размер раздела ссылки или 0 если этот файл не связан статически
link_off uint смещение от начала файла до раздела ссылок или 0 если link_size == 0 . Смещение, если оно не равно нулю, должно соответствовать смещению в разделе link_data . Формат указанных данных не указан в этом документе; это поле заголовка (и предыдущее) оставлено как перехватчики для использования реализацией среды выполнения.
map_off uint смещение от начала файла до элемента карты. Смещение, которое не должно быть нулевым, должно соответствовать смещению в разделе data , и данные должны быть в формате, указанном ниже " map_list ".
string_ids_size uint количество строк в списке идентификаторов строк
string_ids_off uint смещение от начала файла до списка строковых идентификаторов или 0 если string_ids_size == 0 (по общему признанию, странный string_ids_size == 0 случай). Смещение, если оно не равно нулю, должно быть до начала раздела string_ids .
type_ids_size uint количество элементов в списке идентификаторов типов, не более 65535
type_ids_off uint смещение от начала файла до списка идентификаторов типов или 0 если type_ids_size == 0 (по общему признанию, странный type_ids_size == 0 случай). Смещение, если оно не равно нулю, должно быть до начала раздела type_ids .
proto_ids_size uint количество элементов в списке идентификаторов прототипа, не более 65535
proto_ids_off uint смещение от начала файла до списка идентификаторов прототипа или 0 если proto_ids_size == 0 (по общему признанию, странный proto_ids_size == 0 случай). Смещение, если оно не равно нулю, должно быть до начала раздела proto_ids .
field_ids_size uint количество элементов в списке идентификаторов полей
field_ids_off uint смещение от начала файла до списка идентификаторов полей, или 0 если field_ids_size == 0 . Смещение, если оно не равно нулю, должно быть до начала раздела field_ids .
method_ids_size uint количество элементов в списке идентификаторов методов
method_ids_off uint смещение от начала файла до списка идентификаторов методов или 0 если method_ids_size == 0 . Смещение, если оно не равно нулю, должно быть до начала раздела method_ids .
class_defs_size uint количество элементов в списке определений классов
class_defs_off uint смещение от начала файла до списка определений классов или 0 если class_defs_size == 0 (по общему признанию, странный class_defs_size == 0 случай). Смещение, если оно не равно нулю, должно быть до начала раздела class_defs .
data_size uint Размер раздела data в байтах. Должен быть кратным sizeof (uint).
data_off uint смещение от начала файла до начала раздела data .

map_list

появляется в разделе данных

ссылка на header_item

выравнивание: 4 байта

Это список всего содержимого файла по порядку. Он содержит некоторую избыточность по отношению к header_item но предназначен для простой формы для перебора всего файла. Данный тип должен появляться на карте не более одного раза, но нет никаких ограничений на то, в каком порядке могут появляться типы, кроме ограничений, подразумеваемых остальной частью формата (например, сначала должен появиться раздел header , а затем string_ids раздел и т. д.). Кроме того, записи карты должны быть упорядочены по начальному смещению и не должны перекрываться.

название Формат Описание
размер uint размер списка, в записях
список map_item [размер] элементы списка

формат map_item

название Формат Описание
тип ushort вид предметов; см. таблицу ниже
неиспользованный ushort (не используется)
размер uint подсчет количества предметов, которые будут найдены по указанному смещению
смещение uint смещение от начала файла до рассматриваемых элементов

Коды типов

Тип объекта Постоянный Значение Размер элемента в байтах
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 + (размер шт. * 12)
type_list TYPE_TYPE_LIST 0x1001 4 + (размер элемента * 2)
annotation_set_ref_list TYPE_ANNOTATION_SET_REF_LIST 0x1002 4 + (размер элемента * 4)
annotation_set_item TYPE_ANNOTATION_SET_ITEM 0x1003 4 + (размер элемента * 4)
class_data_item TYPE_CLASS_DATA_ITEM 0x2000 неявный; должен разобрать
code_item TYPE_CODE_ITEM 0x2001 неявный; должен разобрать
string_data_item TYPE_STRING_DATA_ITEM 0x2002 неявный; должен разобрать
debug_info_item TYPE_DEBUG_INFO_ITEM 0x2003 неявный; должен разобрать
annotation_item TYPE_ANNOTATION_ITEM 0x2004 неявный; должен разобрать
encoded_array_item TYPE_ENCODED_ARRAY_ITEM 0x2005 неявный; должен разобрать
annotations_directory_item TYPE_ANNOTATIONS_DIRECTORY_ITEM 0x2006 неявный; должен разобрать
hiddenapi_class_data_item TYPE_HIDDENAPI_CLASS_DATA_ITEM 0xF000 неявный; должен разобрать

string_id_item

появляется в разделе string_ids

выравнивание: 4 байта

название Формат Описание
string_data_off uint смещение от начала файла до строковых данных для этого элемента. Смещение должно указывать на место в разделе data , и данные должны быть в формате, указанном ниже " string_data_item ". Для смещения не требуется выравнивание.

string_data_item

появляется в разделе данных

выравнивание: нет (с выравниванием по байтам)

название Формат Описание
utf16_size uleb128 размер этой строки в единицах кода UTF-16 (который во многих системах является «длиной строки»). То есть это декодированная длина строки. (Закодированная длина подразумевается позицией 0 байта.)
данные убайт [] последовательность кодовых единиц MUTF-8 (также известных как октеты, или байты), за которыми следует байт со значением 0 . См. «Кодировка MUTF-8 (модифицированная UTF-8)» выше для получения подробной информации и обсуждения формата данных.

Примечание. Допускается наличие строки, которая включает в себя (закодированную форму) суррогатные кодовые единицы UTF-16 (то есть U+d800U+dfff ) либо изолированно, либо не по порядку относительно обычного кодирования Unicode в UTF-16. Отказ от таких недопустимых кодировок, если это необходимо, зависит от использования строк на более высоком уровне.

type_id_item

появляется в разделе type_ids

выравнивание: 4 байта

название Формат Описание
descriptor_idx uint index в список string_ids для строки дескриптора этого типа. Строка должна соответствовать синтаксису TypeDescriptor , определенному выше.

proto_id_item

появляется в разделе proto_ids

выравнивание: 4 байта

название Формат Описание
shorty_idx uint index в список string_ids для короткой строки дескриптора этого прототипа. Строка должна соответствовать синтаксису ShortyDescriptor , определенному выше, и должна соответствовать типу возвращаемого значения и параметрам этого элемента.
return_type_idx uint индекс в списке type_ids для типа возврата этого прототипа
parameters_off uint смещение от начала файла до списка типов параметров для этого прототипа, или 0 если этот прототип не имеет параметров. Это смещение, если оно не равно нулю, должно быть в разделе data , а данные там должны быть в формате, указанном ниже "type_list" . Кроме того, в списке не должно быть ссылки на тип void .

field_id_item

появляется в разделе field_ids

выравнивание: 4 байта

название Формат Описание
class_idx ushort index в список type_ids для определителя этого поля. Это должен быть тип класса, а не массив или примитивный тип.
type_idx ushort индекс в списке type_ids для типа этого поля
name_idx uint index в список string_ids для имени этого поля. Строка должна соответствовать синтаксису MemberName , определенному выше.

method_id_item

появляется в разделе method_ids

выравнивание: 4 байта

название Формат Описание
class_idx ushort index в список type_ids для определителя этого метода. Это должен быть тип класса или массива, а не примитивный тип.
proto_idx ushort index в список proto_ids для прототипа этого метода
name_idx uint index в список string_ids для имени этого метода. Строка должна соответствовать синтаксису MemberName , определенному выше.

class_def_item

появляется в разделе class_defs

выравнивание: 4 байта

название Формат Описание
class_idx uint index в список type_ids для этого класса. Это должен быть тип класса, а не массив или примитивный тип.
access_flags uint флаги доступа для класса ( public , final и т. д.). См. «Определения access_flags » для деталей.
superclass_idx uint index в список type_ids для суперкласса или постоянное значение NO_INDEX если у этого класса нет суперкласса (т. е. это корневой класс, такой как Object ). Если присутствует, это должен быть тип класса, а не массив или примитивный тип.
interfaces_off uint смещение от начала файла до списка интерфейсов или 0 если их нет. Это смещение должно быть в разделе data , и данные там должны быть в формате, указанном ниже " type_list ". Каждый из элементов списка должен быть типом класса (не массивом или примитивным типом), и не должно быть дубликатов.
source_file_idx uint index в список string_ids для имени файла, содержащего исходный источник (по крайней мере, для большей части) этого класса, или специальное значение NO_INDEX для обозначения отсутствия этой информации. debug_info_item любого данного метода может переопределить этот исходный файл, но debug_info_item что большинство классов будет происходить только из одного исходного файла.
annotations_off uint смещение от начала файла до структуры аннотаций для этого класса или 0 если аннотации для этого класса отсутствуют. Это смещение, если оно не равно нулю, должно быть в разделе data , и данные там должны быть в формате, указанном ниже " annotations_directory_item ", со всеми элементами, относящимися к этому классу как к определителю.
class_data_off uint смещение от начала файла до связанных данных класса для этого элемента, или 0 если для этого класса нет данных класса. (Это может иметь место, например, если этот класс является интерфейсом маркера.) Смещение, если оно не равно нулю, должно быть в разделе data , а данные там должны быть в формате, указанном ниже " class_data_item ", со всеми элементами, относящимися к этому классу как к определителю.
static_values_off uint смещение от начала файла до списка начальных значений для static полей или 0 если их нет (и все static поля должны быть инициализированы 0 или null ). Это смещение должно быть в разделе data , и данные там должны быть в формате, указанном ниже " encoded_array_item ". Размер массива не должен быть больше количества static полей, объявленных этим классом, а элементы соответствуют static полям в том же порядке, что и объявленные в соответствующем field_list . Тип каждого элемента массива должен соответствовать объявленному типу соответствующего поля. Если в массиве меньше элементов, чем имеется static полей, то оставшиеся поля инициализируются соответствующим типу 0 или null .

call_site_id_item

появляется в разделе call_site_ids

выравнивание: 4 байта

название Формат Описание
call_site_off uint смещение от начала файла для вызова определения сайта. Смещение должно быть в разделе данных, а данные там должны быть в формате, указанном ниже "call_site_item".

call_site_item

появляется в разделе данных

выравнивание: нет (с выравниванием по байтам)

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