Skip to content

Commit 8ef76ce

Browse files
authored
Revise README for MARIE.js performance edition
Updated README to reflect performance profiling features and technical details.
1 parent f070c96 commit 8ef76ce

1 file changed

Lines changed: 67 additions & 1 deletion

File tree

README.md

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,67 @@
1-
# MARIE_ModifiedForPerformance
1+
# MARIE.js - Performance & Memory Profiling Edition
2+
3+
![Svelte](https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00)
4+
![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
5+
![Vite](https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white)
6+
7+
Esta versión modificada del simulador **MARIE.js** introduce capacidades de perfilado de rendimiento y análisis de ocupación de memoria, permitiendo evaluar la eficiencia de algoritmos escritos en lenguaje ensamblador MARIE.
8+
9+
Autor de las modificaciones: **Adriano Scatena**
10+
11+
---
12+
13+
## 🚀 Mejoras e Implementaciones
14+
15+
A diferencia de la versión original, esta edición se centra en la métrica de eficiencia del hardware y el uso optimizado de los recursos de memoria.
16+
17+
### 1. Panel de Análisis de Rendimiento (Performance)
18+
Se ha integrado un nuevo módulo en la interfaz de usuario que monitorea la ejecución en tiempo real:
19+
* **Contador de Microsteps:** Registra el total de micro-operaciones de transferencia entre registros (RTL) realizadas por la unidad de control.
20+
* **Contador de Instrucciones:** Muestra la cantidad de instrucciones completas (ciclos de búsqueda, decodificación y ejecución) procesadas.
21+
22+
### 2. Profiling de Memoria por Segmentos
23+
El simulador ahora identifica y diferencia el uso de la memoria principal ($4096 \times 16$ bits) en dos categorías:
24+
* **Segmento de Programa:** Espacio ocupado por las instrucciones ejecutables tras el proceso de ensamblado.
25+
* **Segmento de Datos:** Cálculo dinámico del espacio ocupado por variables estáticas (declaradas con `DEC`, `HEX`, `OCT`) y datos generados dinámicamente en tiempo de ejecución mediante operaciones de almacenamiento (`Store`, `StoreI`, `JnS`).
26+
* **Métrica de Ocupación:** Visualización porcentual del uso de memoria total para cada segmento.
27+
28+
---
29+
30+
## 🛠️ Detalles Técnicos de la Modificación
31+
32+
### Núcleo del Simulador (`marie.ts`)
33+
* Se han añadido "hooks" en los métodos `microStep()` y `step()` para capturar eventos de ejecución sin interferir en la lógica original de la arquitectura.
34+
* Implementación de la lógica de detección de direcciones dinámicas dentro de la clase `MarieSim`, permitiendo rastrear el mapa de memoria activa.
35+
* Nueva función `calculateDataBytesOccupied` para consolidar el tamaño del segmento de datos sin redundancias entre declaraciones estáticas y escrituras dinámicas.
36+
37+
### Interfaz de Usuario (`App.svelte`)
38+
* Integración de variables de estado reactivas de Svelte para sincronizar las métricas internas del motor de simulación con el DOM.
39+
* Creación de componentes visuales específicos para mostrar los contadores y las barras de progreso de memoria en el panel lateral.
40+
41+
---
42+
43+
## 📂 Estructura del Proyecto
44+
45+
* `/src/marie.ts`: Motor de simulación con lógica de rendimiento añadida.
46+
* `/src/App.svelte`: Interfaz principal con el nuevo panel de métricas.
47+
* `/public/examples`: Ejemplos clásicos de MARIE para probar el rendimiento (Multiplicación, Quicksort, etc.).
48+
49+
---
50+
51+
## ⚙️ Instalación y Uso
52+
53+
1. Clonar el repositorio.
54+
2. Instalar dependencias:
55+
```bash
56+
npm install
57+
3. Ejecutar en modo desarrollo:
58+
```bash
59+
npm run dev
60+
4. Ensamblar cualquier código `.mas` y observar las métricas de memoria y ciclos en el panel de Performance.
61+
62+
---
63+
64+
## Referencias
65+
66+
Este proyecto es un fork mejorado basado en la implementación original de [MARIE.js](https://marie.js.org/).
67+
Puedes encontrar el código fuente original en su [repositorio oficial](https://github.com/MARIE-js/MARIE.js).

0 commit comments

Comments
 (0)