Manual de Referencia: brett

Brett — Auditor de Memoria, Padding y Layout Óptimo de Structs en C¶

1. Propósito y Filosofía Pedagógica¶

La herramienta brett forma parte del ecosistema oficial de software de la cátedra. Su diseño sigue principios pedagógicos rigurosos:

1. Evidencia Técnica Directa: Todo diagnóstico se fundamenta en la norma ISO C (C11/C23), en el modelo de memoria del sistema o en convenciones arquitectónicas formales.

2. Acción Correctiva Concreta: Cada advertencia incluye la prescripción técnica inmediata para resolver el defecto sin recurrir a conjeturas.

3. Autonomía del Estudiante: Facilita la autoevaluación local antes de la entrega final del trabajo práctico.

4. Objetividad Docente: Estandariza la corrección automática removiendo discrepancias subjetivas en la evaluación.

2. Instalación y Verificación del Entorno¶

2.1 Requisitos Previos del Sistema¶

Instalá los paquetes del sistema requeridos según tu distribución o entorno:

1
2
3
4
5
6
7
8
9
10
11
12
sudo apt update && sudo apt install -y \
    build-essential \
    gcc \
    gdb \
    valgrind \
    clang-format \
    libclang-dev \
    bubblewrap \
    typst \
    graphviz \
    python3-pip \
    python3-venv

1
2
3
4
5
6
7
8
9
10
11
sudo pacman -S --needed \
    base-devel \
    gcc \
    gdb \
    valgrind \
    clang \
    bubblewrap \
    typst \
    graphviz \
    python-pip \
    uv

1
2
3
4
5
6
7
8
9
10
sudo dnf install -y \
    gcc \
    gcc-c++ \
    gdb \
    valgrind \
    clang-tools-extra \
    bubblewrap \
    typst \
    graphviz \
    python3-pip

brew install gcc gdb clang-format typst graphviz uv

1
2
3
4
5
6
# En WSL2 (Ubuntu): utilizar los paquetes de Ubuntu/Debian arriba.
# En MSYS2 MINGW64:
pacman -S --needed \
    mingw-w64-x86_64-gcc \
    mingw-w64-x86_64-gdb \
    mingw-w64-x86_64-clang-tools-extra

2.2 Métodos de Instalación de brett¶

Podés instalar brett mediante cualquiera de los siguientes métodos estándar:

# Instalación aislada de alta velocidad con uv
uv tool install . --editable

# O instalar todo el ecosistema de herramientas de la cátedra en lote:
source ./install_tools.sh

# Crear y activar un entorno virtual
python3 -m venv .venv
source .venv/bin/activate

# Instalar en modo editable para desarrollo
pip install -e .

# Instalación global aislada en tu PATH
pipx install --editable .

2.3 Autocompletado en la Shell¶

La interfaz CLI de brett cuenta con autocompletado nativo para comandos, flags y archivos. Para configurarlo permanentemente en tu shell:

# Configuración automática en Bash / Zsh / Fish
brett --install-completion

# Para cargar el autocompletado en la sesión actual de inmediato:
source ./install_tools.sh

2.4 Verificación del Entorno con doctor¶

Toda herramienta del ecosistema cuenta con el subcomando unificado doctor. Ejecutalo para auditar el estado del entorno:

brett doctor

Comprobaciones Ejecutadas por el Diagnóstico:¶

• Compilador C: Verifica disponibilidad de gcc o clang con soporte de estándares C11 y C23.

• Depurador y Core Dumps: Comprueba que gdb esté instalado y que ulimit -c permita generación de core dumps.

• Herramientas de Memoria: Valida la presencia de valgrind y librerías libasan/libubsan.

• Formateo y Estilo: Verifica el binario clang-format (versión 16+).

• Sandboxing de Kernel: Audita permisos no privilegiados de bwrap (Bubblewrap namespaces).

• Generador de Tipografía y Documentos: Comprueba typst ($\ge 0.11$) y dot (Graphviz).

Matriz de Resolución de Problemas:¶

3. Referencia Completa de Comandos CLI¶

A continuación se detallan los subcomandos principales disponibles en brett:

4. Tutorial Paso a Paso con Ejemplos Reales¶

Caso de Estudio¶

Considerá el siguiente fragmento de código representativo:

1
2
3
4
5
6
7
// Struct con 10 bytes de padding en arquitectura de 64 bits
struct PaqueteDesalineado {
    char tipo;         // 1 byte (+ 3 padding)
    int id;            // 4 bytes
    char estado;       // 1 byte (+ 7 padding)
    double timestamp;  // 8 bytes
}; // Total: 24 bytes (desperdicio: 41.6%)

Ejecución de la Herramienta¶

Ejecutá el análisis desde tu terminal:

brett audit <archivo.h>

Salida Obtenida en Consola¶

1
2
3
4
5
6
7
8
9
10
11
Struct: struct PaqueteDesalineado (Tamaño: 24 bytes | Padding: 10 bytes)
Layout en memoria (64-bit):
[ tipo (1B) ][ PAD (3B) ][    id (4B)    ]
[ estado (1B) ][        PAD (7B)        ]
[           timestamp (8B)              ]

Propuesta de optimización (Tamaño: 16 bytes | Ahorro: 33.3%):
1. double timestamp; (8 bytes)
2. int id;           (4 bytes)
3. char tipo;        (1 byte)
4. char estado;      (1 byte + 2B pad final)

5. Ejercicios Prácticos y Desafíos¶

Practicá el uso avanzado de brett resolviendo los siguientes ejercicios:

6. Integración en el Flujo de Trabajo y Makefile¶

Para incorporar brett de forma automática a tu flujo de desarrollo, agregá la siguiente regla en el Makefile de tu proyecto:

check-brett:
	@echo "=== Ejecutando verificación con brett ==="
	brett check src/ include/

.PHONY: check-brett

Ejecutá make check-brett antes de cada commit para mantener que tu código conserve el estado de aprobación.

7. Arquitectura Interna y Mecanismo Técnico¶

La herramienta brett implementa un motor de alta precisión basado en:

• Tecnología Núcleo: libclang / C-Parser AST + ABI Memory Layout Calculator (x86_64 / ARM64 / ILP32).

• Aislamiento y Determinismo: Diseñada para operar sin efectos colaterales en entornos de integración continua (CI), terminales de estudiantes y servidores docentes headless.

• Manejo de Errores Pedagógico: Todo fallo de sintaxis, memoria o lógica se traduce en una acción prescriptiva concreta con su respectiva justificación técnica.

8. Integración y Conexión con el Ecosistema¶

Diagrama de Flujo e Interoperabilidad¶

Matriz de Intercambio de Datos¶

• kane (mapeo de archivos binarios)

• bishop (mapa de memoria) | Informes Markdown, diagnósticos Rich, JSON, actas | | Sincronización | ferro, crowe, kane | Validación cruzada, flags compartidos y autofix |

Pipeline de Integración Recomendado¶

Podés encadenar brett con otras herramientas del ecosistema en una única línea de comando:

# Pipeline de integración típico
brett optimize include/tda.h --in-place && gaff format include/tda.h

9. Extensión, Desarrollo de Plugins y API Python¶

Para crear tus propias reglas, conectores de evaluación o integrar brett programáticamente en pipelines de CI/CD:

• 👉 Consultá la guía completa: Guía de Extensión y Creación de Plugins