Comparar um trace com um baseline golden

Use o Altifigence CLI 0.1.9 no Linux para registrar um baseline a partir de um trace .altrace sabidamente correto e verificar traces posteriores em relação a ele. Uma verificação termina com 0 quando todas as etapas estão dentro da tolerância e com 1 quando alguma etapa se desvia.

Preparar dois traces

golden-diff lê traces .altrace cujo cabeçalho declara "encoding":"bincode". O script abaixo grava run.altrace, um trace sabidamente correto com um núcleo e cinco eventos, e changed.altrace, o mesmo trace com mais um evento MAC_COMPUTE. Cada linha de evento é core start duration type [api_name].

PROJECT="$(cd "$HOME/alti-projects/demo-project" && pwd -P)"
cd "$PROJECT"

le() { local n=$1 v=$2; while [ "$n" -gt 0 ]; do printf "\\x$(printf %02x $((v & 255)))"; v=$((v >> 8)); n=$((n - 1)); done; }
str() { le 8 "${#1}"; printf '%s' "$1"; }
write_trace() {
  local out="$1" payload line core start dur type api total=0 header
  local -a lines
  mapfile -t lines
  payload="$(mktemp)"
  {
    for line in "${lines[@]}"; do
      read -r core start dur type api <<<"$line"
      (( start + dur > total )) && total=$((start + dur))
    done
    le 8 "$total"
    le 8 "${#lines[@]}"
    for line in "${lines[@]}"; do
      read -r core start dur type api <<<"$line"
      le 4 "$core"; le 8 "$start"; le 8 "$dur"; str "$type"
      if [ -n "$api" ]; then printf '\x01'; str "$api"; else printf '\x00'; fi
    done
  } >"$payload"
  header="{\"altifigence_trace_version\":\"1.0\",\"trace\":{\"cycles\":$total,\"cores\":1,\"clock_mhz\":1000},\"payload\":{\"encoding\":\"bincode\",\"byte_length\":$(wc -c <"$payload")}}"
  { printf 'ALTR\x01\x01\x00\x00'; le 8 "${#header}"; printf '%s' "$header"; cat "$payload"; } >"$out"
  rm -f "$payload"
}

write_trace run.altrace <<'EVENTS'
0 0 100 MAC_COMPUTE
0 100 50 DMA_READ
0 150 5 API_CALL step_1
0 160 100 MAC_COMPUTE
0 260 100 MAC_COMPUTE
EVENTS

write_trace changed.altrace <<'EVENTS'
0 0 100 MAC_COMPUTE
0 100 50 DMA_READ
0 150 5 API_CALL step_1
0 160 100 MAC_COMPUTE
0 260 100 MAC_COMPUTE
0 360 100 MAC_COMPUTE
EVENTS

wc -c < run.altrace
wc -c < changed.altrace

Exija que os dois comandos wc imprimam os tamanhos dos arquivos.

376
416

Criar o baseline

alti verification golden-diff emit-profile lê um trace e grava o baseline em stdout, portanto redirecione-o para um arquivo. Uma etapa começa em cada API_CALL, e os eventos antes do primeiro API_CALL pertencem à etapa 0. --tolerance-pct grava em cada linha o desvio permitido em porcentagem, e o padrão é 10.

alti verification golden-diff emit-profile --project "$PROJECT" run.altrace > "$PROJECT/reference.jsonl"
grep -v '^#' "$PROJECT/reference.jsonl"

Exija o status de saída 0. O arquivo começa com duas linhas de comentário # e, depois, contém uma linha JSON por etapa.

{"step":0,"api_name":null,"expect_mac":1,"expect_dma_read":1,"expect_dma_write":0,"expect_barrier":0,"cycle_budget":165,"tolerance_pct":10.0,"abs_tolerance":null}
{"step":1,"api_name":"step_1","expect_mac":2,"expect_dma_read":0,"expect_dma_write":0,"expect_barrier":0,"cycle_budget":232,"tolerance_pct":10.0,"abs_tolerance":null}

Cada linha armazena as contagens de eventos observadas como expect_mac, expect_dma_read, expect_dma_write e expect_barrier. cycle_budget são os ciclos que a etapa abrange, aumentados por tolerance_pct e arredondados para cima: a etapa 0 abrange 150 ciclos e a etapa 1 abrange 210. Linhas em branco e linhas que começam com # são ignoradas quando o arquivo é lido.

Verificar um trace em relação ao baseline

alti verification golden-diff check recebe primeiro o baseline e, depois, o trace. A saída de texto tem um resumo golden-diff: entre duas linhas de banner formadas por caracteres ═ e, depois, uma linha por etapa. Os trechos abaixo omitem as linhas de banner.

alti verification golden-diff check --project "$PROJECT" reference.jsonl run.altrace; echo "exit=$?"

  golden-diff: all 2 steps within tolerance
step   0 pass
step   1 pass
exit=0

Exija o status de saída 0. Execute os comandos desta seção sem a opção global --json de alti, para que stdout contenha o próprio relatório. --format json imprime o relatório, e --format json-v1 imprime o resultado versionado com procedência. Ambos usam o mesmo status de saída que o formato de texto.

alti verification golden-diff check --project "$PROJECT" reference.jsonl run.altrace --format json \
  | jq '{summary, step_count, pass_count, total_metrics, exact_matches, tolerance_passes, metric_mismatches, unexpected_observed_steps}'

{
  "summary": "golden-diff: all 2 steps within tolerance",
  "step_count": 2,
  "pass_count": 2,
  "total_metrics": 10,
  "exact_matches": 8,
  "tolerance_passes": 2,
  "metric_mismatches": 0,
  "unexpected_observed_steps": 0
}

alti verification golden-diff check --project "$PROJECT" reference.jsonl run.altrace --format json-v1 \
  | jq '{schema, operation_id, artifact_schema: .artifact.artifact_schema, engine: .provenance.engine}'

{
  "schema": "altifigence.golden-diff.operation-result.v1",
  "operation_id": "altifigence.verification.golden-diff.v1",
  "artifact_schema": "altifigence.golden-diff.report.v1",
  "engine": "alti-verification"
}

Ler uma verificação com falha

A etapa 1 de changed.altrace contém três eventos MAC_COMPUTE e abrange 310 ciclos, enquanto o baseline espera dois eventos e um orçamento de 232 ciclos.

alti verification golden-diff check --project "$PROJECT" reference.jsonl changed.altrace; echo "exit=$?"

  golden-diff: 1 / 2 steps PASS — 1 regressed
step   0 pass
step   1 drift on [mac, cycles]
    └─ mac       observed=3 · expected=2 · tol ±10.0%
    └─ cycles    observed=310 · expected=232 · tol ±10.0%
exit=1

Exija o status de saída 1. alti também imprime em stderr uma linha de status que inclui exit=1. Somente as métricas que falharam são listadas em cada etapa. Para lê-las no relatório JSON, selecione as métricas cujo pass é false.

alti verification golden-diff check --project "$PROJECT" reference.jsonl changed.altrace --format json \
  | jq -c '.steps[] | select(.is_pass | not) | .metrics[] | select(.pass | not) | {name, observed, expected}'

{"name":"mac","observed":3,"expected":2}
{"name":"cycles","observed":310,"expected":232}

Uma etapa que o baseline lista, mas que falta no trace, imprime step N missing from observed trace. Uma etapa do trace que não tem linha no baseline é contada em unexpected_observed_steps. Ambos fazem a verificação terminar com 1.

Resolver falhas

Quando o desvio é o comportamento pretendido, transforme o trace alterado no novo baseline e verifique novamente.

alti verification golden-diff emit-profile --project "$PROJECT" changed.altrace > "$PROJECT/reference.jsonl"
alti verification golden-diff check --project "$PROJECT" reference.jsonl changed.altrace; echo "exit=$?"

  golden-diff: all 2 steps within tolerance
step   0 pass
step   1 pass
exit=0

Um arquivo que não é um trace faz emit-profile e check terminarem com 1 e com as mensagens abaixo. Passe um arquivo que comece com ALTR, como run.altrace.

printf 'this is not a trace\n' > "$PROJECT/notes.txt"
alti verification golden-diff emit-profile --project "$PROJECT" notes.txt
alti verification golden-diff check --project "$PROJECT" reference.jsonl notes.txt

parse error in 'notes.txt': Invalid magic number — expected 'ALTR', got '[116, 104, 105, 115]'
trace parse error for 'notes.txt': invalid .altrace magic

Um trace cujo cabeçalho declara outra codificação de carga útil faz check terminar com 1 e com uma mensagem neste formato. Passe um trace cujo cabeçalho declare "encoding":"bincode", como run.altrace.

trace parse error for 'other.altrace': unsupported .altrace payload encoding 'flatbuf'

Um baseline sem linhas faz check terminar com 1 e com a mensagem abaixo. Execute emit-profile novamente para gravar um baseline com uma linha por etapa.

: > "$PROJECT/empty.jsonl"
alti verification golden-diff check --project "$PROJECT" empty.jsonl run.altrace

empty reference file: empty.jsonl

Um --tolerance-pct negativo ou não numérico termina com 2 antes de o mecanismo iniciar, com este texto no erro. Passe um número de 0 ou mais, como 5.

tolerance-pct must be a finite non-negative number

alti verification golden-diff emit-profile --project "$PROJECT" run.altrace --tolerance-pct 5 > "$PROJECT/reference.jsonl"

Comandos de engine da CLI