Add README.md

README.md

@@ -0,0 +1,83 @@
+# Kernel Trace Offset Analysis
+
+## Überblick
+Dieses Repository dokumentiert das Experiment **kernel_trace_offset_analysis**, das die Ursachen für Zeitoffsets in einer isolierten virtuellen Maschine untersucht. Ziel ist es, softwareinduzierte Effekte von elektromagnetischen Störeinflüssen (EM-Interferenz) zu unterscheiden und den Einfluss auf Kernel-Zeitstempel zu analysieren.
+
+Weitere Informationen sind im begleitenden Artikel verfügbar:
+[https://donau2space.de/tag-90-1256-kernel-trace-in-isolierter-vm-em-gedimmt-offset-bleibt/](https://donau2space.de/tag-90-1256-kernel-trace-in-isolierter-vm-em-gedimmt-offset-bleibt/)
+
+### Hinweis
+Alle Inhalte wurden per KI generiert. Nutzung, Anpassung und Weiterentwicklung erfolgen eigenverantwortlich auf eigenes Risiko. Es wird keine Korrektheit, Sicherheit, Funktionsfähigkeit oder rechtliche Eignung zugesichert.
+
+## Inhalt des Repositories
+Das Repository enthält Werkzeuge und Skripte zur Erfassung, Analyse und Berichterstellung von Tracedaten.
+
+### Artefakt-Liste
+
+#### 1. trace_cmd_tool
+- **Zweck:** Erfassung und Analyse von Kernel-Traces über das Linux-Tool *trace-cmd*.
+- **Art:** Linux CLI-Tool
+- **Zielplattform:** Linux Userspace
+- **Sprachen:** C
+- **API-Funktionen:**
+  - **run_trace(trace_id, duration) → trace_result**: Führt einen Trace aus und gibt die Ergebnisse als strukturierte Daten zurück.
+- **Datenstrukturen:**
+  - **trace_result (struct)**: Enthält *timestamp* und *event_data* für jedes erfasste Ereignis.
+
+#### 2. trace_analysis_script
+- **Zweck:** Analyse der Kernel-Traces und Berechnung von Zeitstatistiken.
+- **Art:** Python-Skript
+- **Zielplattform:** gemischt (lokal & VM)
+- **Sprachen:** Python
+- **API-Funktionen:**
+  - **analyze_trace(trace_file) → summary_statistics**: Analysiert eine Tracedatei und erstellt zusammenfassende Werte.
+- **Datenstrukturen:**
+  - **summary_statistics (JSON):** Enthält *peak_amplitude*, *median_bandpower*, *crosscorr_with_clockevents*.
+
+#### 3. summary_report_generator
+- **Zweck:** Erstellung eines zusammenfassenden Berichts aus Analyseergebnissen.
+- **Art:** Python-Skript
+- **Zielplattform:** gemischt
+- **Sprachen:** Python
+- **API-Funktionen:**
+  - **generate_report(summary_statistics) → report_file**: Generiert einen Bericht aus den Analyseergebnissen.
+- **Datenstrukturen:**
+  - **report_file (JSON):** Enthält *report_content* mit formatierten Ergebnissen.
+
+## Installation & Nutzung
+
+### Installation (für Linux-CLI-Tool)
+1. Repository klonen:
+   `git clone <repository-url>`
+2. Ins Verzeichnis wechseln:
+   `cd kernel_trace_offset_analysis`
+3. Kompilieren des Tools:
+   `gcc -o trace_cmd_tool src/trace_cmd_tool.c -ltracecmd`
+
+### Ausführung
+Beispielaufruf des CLI-Tools:
+`./trace_cmd_tool <trace_id> <duration>`
+
+Nach der Trace-Erfassung kann das Analyse-Skript ausgeführt werden:
+`python trace_analysis_script.py <trace_output_file>`
+
+Zum Erstellen eines Berichts:
+`python summary_report_generator.py <summary_stats_file>`
+
+## Typische Use-Cases
+- Untersuchung von Zeitabweichungen zwischen Kernel- und Realzeituhr in isolierten VMs.
+- Vergleich von Traces unter unterschiedlichen CPU-Isolations- und Interrupt-Konfigurationen.
+- Bewertung des Einflusses elektromagnetischer Störungen auf Zeitsynchronität.
+
+## Struktur & Erweiterbarkeit
+- **src/**: Quellcode für das CLI-Tool in C.
+- **scripts/**: Python-Skripte für Analyse und Berichtserstellung.
+- **data/**: Beispiel-Tracedateien und Ergebnisse.
+- **reports/**: Generierte Ergebnisberichte.
+
+Das System ist modular aufgebaut. Neue Analysemodule oder alternative Trace-Datenquellen können durch zusätzliche Python-Module integriert werden.
+
+## Lizenz
+Dieses Projekt steht unter der **MIT-Lizenz**.
+
+**Hinweis:** Diese Dokumentation wurde vollständig automatisiert durch ein KI-System erzeugt. Verwendung und Weiterentwicklung auf eigene Verantwortung.