Manual de Referencia: ferro

Ferro — Perfilador de Rendimiento Algorítmico, Caché y Contadores de Hardware en C¶

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

La herramienta ferro 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:

2.2 Métodos de Instalación de ferro¶

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

2.3 Autocompletado en la Shell¶

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

# Configuración automática en Bash / Zsh / Fish
ferro --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:

ferro 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 ferro:

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
8
9
10
11
12
13
14
15
16
#define N 1024
int matriz[N][N];

// Recorrido por filas (Cache-Friendly: acceso contiguo)
void recorrido_filas(void) {
    for (int i = 0; i < N; i++)
        for (int j = 0; j < N; j++)
            matriz[i][j] = 1;
}

// Recorrido por columnas (Cache-Unfriendly: saltos de N * 4 bytes)
void recorrido_columnas(void) {
    for (int j = 0; j < N; j++)
        for (int i = 0; i < N; i++)
            matriz[i][j] = 1;
}

Ejecución de la Herramienta¶

Ejecutá el análisis desde tu terminal:

ferro profile -- ./bin/programa

Salida Obtenida en Consola¶

PERFIL FERRO: recorrido_filas vs recorrido_columnas (N = 1024)
┌──────────────────────────┬────────────────────┬────────────────────┬───────────┐
│ Métrica                  │ Recorrido Filas    │ Recorrido Columnas │ Ganancia  │
├──────────────────────────┼────────────────────┼────────────────────┼───────────┤
│ Tiempo de CPU            │ 1.82 ms            │ 14.30 ms           │ 7.85x     │
│ Fallos de Caché L1 (D1)  │ 16,384 (1.5%)      │ 1,048,576 (99.8%)  │ 64.0x     │
│ Instrucciones / Ciclo    │ 2.45 IPC           │ 0.38 IPC           │ 6.44x     │
└──────────────────────────┴────────────────────┴────────────────────┴───────────┘

5. Ejercicios Prácticos y Desafíos¶

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

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

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

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

.PHONY: check-ferro

Ejecutá make check-ferro 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 ferro implementa un motor de alta precisión basado en:

• Tecnología Núcleo: Linux Perf Events Subsystem + Valgrind Cachegrind Simulator + CPU Hardware Counters.

• 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¶

• rachel (impacto de saltos) | Informes Markdown, diagnósticos Rich, JSON, actas | | Sincronización | brett, rachel, tyrell | Validación cruzada, flags compartidos y autofix |

Pipeline de Integración Recomendado¶

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

# Pipeline de integración típico
ferro profile -- ./bin/algoritmo_opt

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

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

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