Skyframe

Informar um problema Acessar código-fonte

O modelo de avaliação paralela e incrementabilidade do Bazel.

Modelo de dados

O modelo de dados consiste nos seguintes itens:

  • SkyValue. Também chamados de nós. SkyValues são objetos imutáveis que contêm todos os dados criados durante o build e as entradas dele. Exemplos: arquivos de entrada, arquivos de saída e destinos configurados.
  • SkyKey: um nome curto e imutável para se referir a um SkyValue, por exemplo, FILECONTENTS:/tmp/foo ou PACKAGE://foo.
  • SkyFunction. Cria nós com base em suas chaves e nós dependentes.
  • Gráfico de nós. Uma estrutura de dados contendo a relação de dependência entre os nós.
  • Skyframe. Codinome do framework de avaliação incremental em que o Bazel é baseado.

Avaliação

Um build consiste em avaliar o nó que representa a solicitação de build. Esse é o estado que queremos, mas há muito código legado no caminho. Primeiro, o SkyFunction é encontrado e chamado com a chave do SkyKey de nível superior. Em seguida, a função solicita a avaliação dos nós necessários para avaliar o nó de nível superior, que por sua vez resulta em outras invocações de função e assim por diante, até que os nós folhas sejam alcançados (que geralmente são nós que representam arquivos de entrada no sistema de arquivos). Por fim, temos o valor do SkyValue de nível superior, alguns efeitos colaterais (como arquivos de saída no sistema de arquivos) e um gráfico acíclico dirigido das dependências entre os nós envolvidos no build.

Um SkyFunction pode solicitar SkyKeys em vários cartões se não puder informar com antecedência todos os nós necessários para realizar o trabalho. Um exemplo simples é avaliar um nó de arquivo de entrada que acaba sendo um link simbólico: a função tenta ler o arquivo, percebe que é um link simbólico e busca o nó do sistema de arquivos que representa o destino do link simbólico. No entanto, ele pode ser um link simbólico. Nesse caso, a função original também precisará buscar o destino.

As funções são representadas no código pela interface SkyFunction e os serviços fornecidos a ela por uma interface chamada SkyFunction.Environment. As funções podem fazer o seguinte:

  • Solicite a avaliação de outro nó chamando env.getValue. Se o nó estiver disponível, o valor dele será retornado. Caso contrário, null será retornado e a função em si vai retornar null. No último caso, o nó dependente é avaliado e, em seguida, o builder de nós original é invocado novamente, mas, desta vez, a mesma chamada env.getValue retorna um valor não null.
  • Solicite a avaliação de vários outros nós chamando env.getValues(). Essencialmente, o processo é igual, mas os nós dependentes são avaliados em paralelo.
  • Fazer cálculos durante a invocação
  • Têm efeitos colaterais, como a gravação de arquivos no sistema de arquivos. É preciso tomar cuidado para que duas funções diferentes não pisem na ponta da outra. Em geral, não há problemas com os efeitos colaterais de gravação (em que os dados fluem para fora do Bazel), mas os efeitos colaterais de leitura (quando os dados fluem para dentro do Bazel sem uma dependência registrada) porque são uma dependência não registrada e, por isso, podem causar compilações incrementais incorretas.

As implementações de SkyFunction não podem acessar dados de outra maneira que não seja a solicitação de dependências, como a leitura direta do sistema de arquivos. Isso faz com que o Bazel não registre a dependência de dados no arquivo lido, o que resulta em builds incrementais incorretos.

Quando uma função tiver dados suficientes para fazer o trabalho dela, ela retornará um valor diferente de null, indicando a conclusão.

Essa estratégia de avaliação tem vários benefícios:

  • Hermeticidade. Se as funções solicitarem dados de entrada apenas dependendo de outros nós, o Bazel poderá garantir que, se o estado de entrada for o mesmo, os mesmos dados serão retornados. Se todas as funções do céu forem determinísticas, isso significa que toda a construção também será determinista.
  • Incrementabilidade correta e perfeita. Se todos os dados de entrada de todas as funções forem gravados, o Bazel poderá invalidar apenas o conjunto exato de nós que precisa ser invalidado quando os dados de entrada forem alterados.
  • Paralelismo. Como as funções só podem interagir entre si por meio de solicitações de dependências, as funções que não dependem umas das outras podem ser executadas em paralelo, e o Bazel pode garantir que o resultado seja o mesmo que seria executado em sequência.

Incrementabilidade

Como as funções só podem acessar dados de entrada dependendo de outros nós, o Bazel pode criar um gráfico de fluxo de dados completo dos arquivos de entrada para os arquivos de saída e usar essas informações para recriar apenas os nós que realmente precisam ser recriados: o fechamento transitivo reverso do conjunto de arquivos de entrada alterados.

Existem duas estratégias de incrementabilidade possíveis: a de baixo para cima e a de cima para baixo. A escolha ideal depende da aparência do gráfico de dependências.

  • Durante a invalidação de baixo para cima, depois que um gráfico é criado e o conjunto de entradas alteradas é conhecido, todos os nós são invalidados e dependem transitivamente de arquivos alterados. Isso é ideal se soubermos que o mesmo nó de nível superior será construído novamente. A invalidação de baixo para cima requer a execução de stat() em todos os arquivos de entrada do build anterior para determinar se eles foram mudados. Isso pode ser melhorado usando inotify ou um mecanismo semelhante para aprender sobre os arquivos alterados.

  • Durante a invalidação de cima para baixo, o fechamento transitivo do nó de nível superior é verificado e apenas os nós que têm um fechamento transitivo limpo são mantidos. Isso é melhor quando sabemos que o gráfico de nós atual é grande, mas precisamos apenas de um pequeno subconjunto dele no próximo build: a invalidação de baixo para cima invalidaria o gráfico maior do primeiro build, ao contrário da invalidação de cima para baixo, que apenas percorre o gráfico pequeno do segundo build.

No momento, só fazemos a invalidação de baixo para cima.

Para aumentar a incrementabilidade, usamos a remoção de alterações: se um nó for invalidado, mas, após a recriação, descobrir que o novo valor é igual ao anterior, os nós que foram invalidados devido a uma alteração nesse nó serão "ressurgidos".

Isso é útil, por exemplo, se alguém mudar um comentário em um arquivo C++: o arquivo .o gerado a partir dele será o mesmo. Assim, não será necessário chamar o vinculador novamente.

Compilação / vinculação incremental

A principal limitação desse modelo é que a invalidação de um nó é uma questão de tudo ou nada: quando uma dependência muda, o nó dependente é sempre reconstruído do zero, mesmo que exista um algoritmo melhor que modifique o valor antigo do nó com base nas alterações. Veja alguns exemplos em que isso pode ser útil:

  • Vinculação incremental
  • Quando um único arquivo .class muda em uma .jar, podemos, teoricamente, modificar o arquivo .jar em vez de criá-lo do zero novamente.

Atualmente, o Bazel não oferece suporte a essas coisas de uma forma com princípios (temos alguma compatibilidade com a vinculação incremental, mas ela não é implementada no Skyframe) é dupla: tínhamos apenas ganhos de desempenho limitados, e era difícil garantir que o resultado da mutação fosse o mesmo de uma recriação limpa seria repetível, e os builds de valores do Google que são repetíveis bit a bit.

Até agora, sempre podíamos ter um desempenho bom o suficiente simplesmente decompondo uma etapa de build cara e fazendo uma reavaliação parcial dessa forma: isso divide todas as classes de um app em vários grupos e faz a dexação separadamente. Dessa forma, se as classes de um grupo não mudarem, a dexação não precisará ser refeita.

Como mapear para conceitos do Bazel

Esta é uma visão geral aproximada de algumas das implementações SkyFunction que o Bazel usa para executar um build:

  • FileStateValue de valor. O resultado de um lstat(). Para arquivos existentes, também computamos informações adicionais a fim de detectar alterações no arquivo. Este é o nó de nível mais baixo no gráfico do Skyframe e não tem dependências.
  • FileValue. Usado por qualquer coisa que se importe com o conteúdo real e/ou o caminho resolvido de um arquivo. Depende da FileStateValue correspondente e de todos os links simbólicos que precisam ser resolvidos (como a FileValue para a/b precisa do caminho resolvido de a e do caminho resolvido de a/b). A distinção entre FileStateValue é importante porque, em alguns casos (por exemplo, avaliar globs do sistema de arquivos (como srcs=glob(["*/*.java"])), o conteúdo do arquivo não é realmente necessário.
  • DirectoryListingValue associado. Basicamente, o resultado de readdir(). Depende do FileValue associado associado ao diretório.
  • PackageValue para código. Representa a versão analisada de um arquivo BUILD. Depende do FileValue do arquivo BUILD associado e também transitivamente de qualquer DirectoryListingValue usado para resolver os globs no pacote (a estrutura de dados que representa o conteúdo de um arquivo BUILD internamente).
  • ConfiguredTargetValue. Representa um alvo configurado, que é uma tupla do conjunto de ações geradas durante a análise de um alvo e informações fornecidas aos alvos configurados que dependem deste. Depende do PackageValue em que o destino correspondente está, o ConfiguredTargetValues das dependências diretas e um nó especial que representa a configuração do build.
  • ArtifactValue. Representa um arquivo no build, seja ele um artefato de origem ou de saída. Os artefatos são quase equivalentes aos arquivos e são usados para se referir aos arquivos durante a execução real das etapas de compilação. Para arquivos de origem, isso depende do FileValue do nó associado. Para artefatos de saída, ele depende do ActionExecutionValue de qualquer ação que gere o artefato.
  • ActionExecutionValue (em inglês). Representa a execução de uma ação. Depende do ArtifactValues dos arquivos de entrada. No momento, a ação executada está contida na chave de céu, o que é contrário ao conceito de que as chaves de céu são pequenas. Estamos trabalhando para resolver essa discrepância. Observe que ActionExecutionValue e ArtifactValue não serão usados se não executarmos a fase de execução no Skyframe.