banger/internal/daemon/logger.go
Thales Maciel 687fcf0b59
vm state: split transient kernel/process handles off the durable schema
Separates what a VM IS (durable intent + identity + deterministic
derived paths — `VMRuntime`) from what is CURRENTLY TRUE about it
(firecracker PID, tap device, loop devices, dm-snapshot target — new
`VMHandles`). The durable state lives in the SQLite `vms` row; the
transient state lives in an in-memory cache on the daemon plus a
per-VM `handles.json` scratch file inside VMDir, rebuilt at startup
from OS inspection. Nothing kernel-level rides the SQLite schema
anymore.

Why:

  Persisting ephemeral process handles to SQLite forced reconcile to
  treat "running with a stale PID" as a first-class case and mix it
  with real state transitions. The schema described what we last
  observed, not what the VM is. Every time the observation model
  shifted (tap pool, DM naming, pgrep fallback) the reconcile logic
  grew a new branch. Splitting lets each layer own what it's good at:
  durable records describe intent, in-memory cache + scratch file
  describe momentary reality.

Shape:

  - `model.VMHandles` = PID, TapDevice, BaseLoop, COWLoop, DMName,
    DMDev. Never in SQLite.
  - `VMRuntime` keeps: State, GuestIP, APISockPath, VSockPath,
    VSockCID, LogPath, MetricsPath, DNSName, VMDir, SystemOverlay,
    WorkDiskPath, LastError. All durable or deterministic.
  - `handleCache` on `*Daemon` — mutex-guarded map + scratch-file
    plumbing (`writeHandlesFile` / `readHandlesFile` /
    `rediscoverHandles`). See `internal/daemon/vm_handles.go`.
  - `d.vmAlive(vm)` replaces the 20+ inline
    `vm.State==Running && ProcessRunning(vm.Runtime.PID, apiSock)`
    spreads. Single source of truth for liveness.
  - Startup reconcile: per running VM, load the scratch file, pgrep
    the api sock, either keep (cache seeded from scratch) or demote
    to stopped (scratch handles passed to cleanupRuntime first so DM
    / loops / tap actually get torn down).

Verification:

  - `go test ./...` green.
  - Live: `banger vm run --name handles-test -- cat /etc/hostname`
    starts; `handles.json` appears in VMDir with the expected PID,
    tap, loops, DM.
  - `kill -9 $(pgrep bangerd)` while the VM is running, re-invoke the
    CLI, daemon auto-starts, reconcile recognises the VM as alive,
    `banger vm ssh` still connects, `banger vm delete` cleans up.

Tests added:

  - vm_handles_test.go: scratch-file roundtrip, missing/corrupt file
    behaviour, cache concurrency, rediscoverHandles prefers pgrep
    over scratch, returns scratch contents even when process is
    dead (so cleanup can tear down kernel state).
  - vm_test.go: reconcile test rewritten to exercise the new flow
    (write scratch → reconcile reads it → verifies process is gone →
    issues dmsetup/losetup teardown).

ARCHITECTURE.md updated; `handles` added to Daemon field docs.
2026-04-19 14:18:13 -03:00

145 lines
3.8 KiB
Go

package daemon
import (
"context"
"fmt"
"io"
"log/slog"
"strings"
"time"
"banger/internal/model"
)
func newDaemonLogger(w io.Writer, rawLevel string) (*slog.Logger, string, error) {
level, normalized, err := parseLogLevel(rawLevel)
if err != nil {
return nil, "", err
}
logger := slog.New(slog.NewJSONHandler(w, &slog.HandlerOptions{Level: level}))
return logger, normalized, nil
}
func parseLogLevel(raw string) (slog.Level, string, error) {
switch strings.ToLower(strings.TrimSpace(raw)) {
case "", "info":
return slog.LevelInfo, "info", nil
case "debug":
return slog.LevelDebug, "debug", nil
case "warn", "warning":
return slog.LevelWarn, "warn", nil
case "error":
return slog.LevelError, "error", nil
default:
return 0, "", fmt.Errorf("unsupported log_level %q (use debug, info, warn, or error)", raw)
}
}
func (d *Daemon) beginOperation(name string, attrs ...any) *operationLog {
if d.logger != nil {
d.logger.Info("operation started", append([]any{"operation", name}, attrs...)...)
}
now := time.Now()
return &operationLog{
logger: d.logger,
name: name,
started: now,
last: now,
attrs: append([]any(nil), attrs...),
}
}
type operationLog struct {
logger *slog.Logger
name string
started time.Time
last time.Time
attrs []any
}
func (o *operationLog) stage(stage string, attrs ...any) {
now := time.Now()
o.log(slog.LevelInfo, "operation stage", append([]any{
"stage", stage,
"since_start_ms", now.Sub(o.started).Milliseconds(),
"since_last_stage_ms", now.Sub(o.last).Milliseconds(),
}, attrs...)...)
o.last = now
}
func (o *operationLog) debugStage(stage string, attrs ...any) {
now := time.Now()
o.log(slog.LevelDebug, "operation stage", append([]any{
"stage", stage,
"since_start_ms", now.Sub(o.started).Milliseconds(),
"since_last_stage_ms", now.Sub(o.last).Milliseconds(),
}, attrs...)...)
o.last = now
}
func (o *operationLog) done(attrs ...any) {
o.log(slog.LevelInfo, "operation completed", append([]any{"duration_ms", time.Since(o.started).Milliseconds()}, attrs...)...)
}
func (o *operationLog) fail(err error, attrs ...any) error {
if err == nil {
return nil
}
o.log(slog.LevelError, "operation failed", append([]any{"duration_ms", time.Since(o.started).Milliseconds(), "error", err.Error()}, attrs...)...)
return err
}
func (o operationLog) log(level slog.Level, msg string, attrs ...any) {
if o.logger == nil {
return
}
base := append([]any{"operation", o.name}, o.attrs...)
base = append(base, attrs...)
o.logger.Log(context.Background(), level, msg, base...)
}
// vmLogAttrs returns the durable identifying fields for a VM that
// are always safe to log. Transient handles (PID, tap device) moved
// off VMRecord when the schema was split; lifecycle ops log those
// explicitly on the events where they matter (e.g. wait_for_exit).
func vmLogAttrs(vm model.VMRecord) []any {
attrs := []any{
"vm_id", vm.ID,
"vm_name", vm.Name,
"image_id", vm.ImageID,
}
if vm.Runtime.GuestIP != "" {
attrs = append(attrs, "guest_ip", vm.Runtime.GuestIP)
}
if vm.Runtime.APISockPath != "" {
attrs = append(attrs, "api_socket", vm.Runtime.APISockPath)
}
if vm.Runtime.LogPath != "" {
attrs = append(attrs, "log_path", vm.Runtime.LogPath)
}
return attrs
}
func imageLogAttrs(image model.Image) []any {
attrs := []any{
"image_id", image.ID,
"image_name", image.Name,
}
if image.ArtifactDir != "" {
attrs = append(attrs, "artifact_dir", image.ArtifactDir)
}
if image.RootfsPath != "" {
attrs = append(attrs, "rootfs_path", image.RootfsPath)
}
if image.WorkSeedPath != "" {
attrs = append(attrs, "work_seed_path", image.WorkSeedPath)
}
return attrs
}
func annotateLogPath(err error, path string) error {
if err == nil || strings.TrimSpace(path) == "" {
return err
}
return fmt.Errorf("%w; inspect %s", err, path)
}