Otimizar DTOs

Esta página discute as otimizações que podem ser feitas na implementação da sobreposição da árvore de dispositivos (DTO, na sigla em inglês), descreve as restrições contra a sobreposição do nó raiz e detalha como configurar sobreposições compactadas na imagem da DTBO. Ela também fornece exemplos de código e instruções de implementação.

Linha de comando do kernel

A linha de comando original do kernel na árvore de dispositivos (DT, na sigla em inglês) está localizada no nó chosen/bootargs. O carregador de inicialização precisa concatenar esse local com outras origens da linha de comando do kernel: 

/dts-v1/;

/ {
  chosen: chosen {
    bootargs = "...";
  };
};

A DTO não pode concatenar valores da DT principal e da DT de sobreposição. Portanto, coloque a linha de comando do kernel da DT principal em chosen/bootargs e a linha de comando do kernel da DT de sobreposição em chosen/bootargs_ext. O carregador de inicialização pode concatenar esses locais e transmitir o resultado ao kernel.

main.dts overlay.dts 
/dts-v1/;

/ {
  chosen: chosen {
    bootargs = "...";
  };
};

/dts-v1/;
/plugin/;

&chosen {
  bootargs_ext = "...";
};

libufdt

Embora a versão mais recente libfdt ofereça suporte a DTO, é recomendável usar libufdt para implementar DTO (fonte do AOSP em platform/system/libufdt). libufdt cria uma estrutura de árvore real (árvore de dispositivos não simplificada, ou ufdt) a partir da árvore de dispositivos simplificada (FDT, na sigla em inglês), para melhorar a mesclagem de dois arquivos .dtb de O(N2) para O(N), em que N é o número de nós na árvore.

Teste de desempenho

Nos testes internos do Google, o uso de libufdt em 2.405 .dtb e 283 nós de DT .dtbo resulta em tamanhos de arquivo de 70.618 e 8.566 bytes após a compilação. Em comparação com uma implementação de DTO portada do FreeBSD (tempo de execução de 124 ms), o tempo de execução de libufdt DTO é de 10 ms.

Os testes de desempenho para dispositivos Pixel compararam libufdt e libfdt. O efeito do número de nós base é semelhante, mas inclui as seguintes diferenças:

  • 500 operações de sobreposição (anexação ou substituição) têm uma diferença de tempo de 6x a 8x
  • 1.000 operações de sobreposição (adição ou substituição) têm uma diferença de tempo de 8 a 10 vezes

Exemplo com a contagem de anexação definida como X:

Figura 1. A contagem de apêndices é X.

Exemplo com a contagem de substituição definida como X:

Figura 2. A contagem de substituição é X.

O libufdt é desenvolvido com algumas APIs e estruturas de dados de libfdt. Ao usar libufdt, você precisa incluir e vincular libfdt. No entanto, é possível usar a API libfdt para operar DTB ou DTBO no código.

API libufdt DTO

A API principal para DTO em libufdt é a seguinte: 

struct fdt_header *ufdt_apply_overlay(
        struct fdt_header *main_fdt_header,
        size_t main_fdt_size,
        void *overlay_fdt,
        size_t overlay_size);

O parâmetro main_fdt_header é a DT principal e overlay_fdt é o buffer que contém o conteúdo de um arquivo .dtbo. O valor de retorno é um novo buffer contendo o DT mesclados (ou null em caso de erro). O DT mesclado é formatado em FDT, que pode ser transmitido ao kernel ao iniciá-lo.

O novo buffer do valor de retorno é criado pelo dto_malloc(), que precisa ser implementado ao transferir libufdt para o carregador de inicialização. Para implementações de referência, consulte sysdeps/libufdt_sysdeps_*.c.

Restrições de nó raiz

Não é possível sobrepor um novo nó ou uma nova propriedade no nó raiz da DT principal, porque as operações de sobreposição dependem de rótulos. Como o DT principal precisa definir um rótulo e o DT de sobreposição atribui os nós a serem sobrepostos com rótulos, não é possível atribuir um rótulo ao nó raiz (e, portanto, não é possível sobrepor o nó raiz).

Os fornecedores de SoC precisam definir a capacidade de sobreposição do DT principal. Os ODM/OEMs só podem anexar ou substituir nós com rótulos definidos pelo fornecedor do SoC. Como solução alternativa, é possível definir um nó odm no nó raiz na DT de base, permitindo que todos os nós ODM na DT de sobreposição adicionem novos nós. Como alternativa, você pode colocar todos os nós relacionados ao SoC no DT de base em um nó soc no nó raiz, conforme descrito abaixo:

main.dts overlay.dts 
/dts-v1/;

/ {
    compatible = "corp,bar";
    ...

    chosen: chosen {
        bootargs = "...";
    };

    /* nodes for all soc nodes */
    soc {
        ...
        soc_device@0: soc_device@0 {
            compatible = "corp,bar";
            ...
        };
        ...
    };

    odm: odm {
        /* reserved for overlay by odm */
    };
};

/dts-v1/;
/plugin/;

/ {
};

&chosen {
    bootargs_ex = "...";
};

&odm {
    odm_device@0 {
        ...
    };
    ...
};

Usar sobreposições compactadas

O Android 9 adiciona suporte ao uso de sobreposições compactadas na imagem de DTBO ao usar a versão 1 do cabeçalho da tabela de DT. Ao usar o cabeçalho de DTBO v1, os quatro bits menos significativos do campo de sinalizações em dt_table_entry indicam o formato de compactação da entrada da DT. 

struct dt_table_entry_v1 {
  uint32_t dt_size;
  uint32_t dt_offset;  /* offset from head of dt_table_header */
  uint32_t id;         /* optional, must be zero if unused */
  uint32_t rev;        /* optional, must be zero if unused */
  uint32_t flags;      /* For version 1 of dt_table_header, the 4 least significant bits
                        of 'flags' are used to indicate the compression
                        format of the DT entry as per the enum 'dt_compression_info' */
  uint32_t custom[3];  /* optional, must be zero if unused */
};

Atualmente, as compactações zlib e gzip são compatíveis. 

enum dt_compression_info {
    NO_COMPRESSION,
    ZLIB_COMPRESSION,
    GZIP_COMPRESSION
};

O Android 9 adiciona suporte para testes de sobreposições compactadas ao teste VtsFirmwareDtboVerification para ajudar a verificar a correção do app de sobreposição.

Exemplo de implementação de DTO

As instruções a seguir mostram um exemplo de implementação de DTO com libufdt (exemplo de código abaixo).

Exemplo de instruções de DTO

  1. Inclua bibliotecas. Para usar libufdt, inclua libfdt para estruturas de dados e APIs: 
    #include <libfdt.h>
#include <ufdt_overlay.h>
  2. Carregar a DT principal e a DT de sobreposição. Carregue .dtb e .dtbo do armazenamento na memória (as etapas exatas dependem do seu design). Neste ponto, você tem o buffer e o tamanho de .dtb/.dtbo: 
    main_size = my_load_main_dtb(main_buf, main_buf_size)

    overlay_size = my_load_overlay_dtb(overlay_buf, overlay_buf_size);
  3. Sobrepor os DTs:
    1. Use ufdt_install_blob() para receber o cabeçalho FDT do DT principal: 
      main_fdt_header = ufdt_install_blob(main_buf, main_size);
main_fdt_size = main_size;
    2. Chame ufdt_apply_overlay() para DTO para receber uma DT mesclada no formato FDT: 
      merged_fdt = ufdt_apply_overlay(main_fdt_header, main_fdt_size,
                                overlay_buf, overlay_size);
    3. Use merged_fdt para saber o tamanho de dtc_totalsize(): 
      merged_fdt_size = dtc_totalsize(merged_fdt);
    4. Transmita a DT mesclada para iniciar o kernel: 
      my_kernel_entry(0, machine_type, merged_fdt);

Exemplo de código de DTO

#include <libfdt.h>
#include <ufdt_overlay.h>

…

{
  struct fdt_header *main_fdt_header;
  struct fdt_header *merged_fdt;

  /* load main dtb into memory and get the size */
  main_size = my_load_main_dtb(main_buf, main_buf_size);

  /* load overlay dtb into memory and get the size */
  overlay_size = my_load_overlay_dtb(overlay_buf, overlay_buf_size);

  /* overlay */
  main_fdt_header = ufdt_install_blob(main_buf, main_size);
  main_fdt_size = main_size;
  merged_fdt = ufdt_apply_overlay(main_fdt_header, main_fdt_size,
                                  overlay_buf, overlay_size);
  merged_fdt_size = dtc_totalsize(merged_fdt);

  /* pass to kernel */
  my_kernel_entry(0, machine_type, merged_fdt);
}