diff --git a/README.md b/README.md new file mode 100644 index 0000000..b56c96a --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ +# Baseline Recalculation CI Investigation + +## Überblick +Dieses Repository dokumentiert das Experiment **baseline_recalculation_ci_investigation**. Ziel ist die Untersuchung und Verbesserung der Baseline-Rekalibrierung in einem CI-Setup durch Kernel-Patches und Python-Skripte. + +Weitere Informationen und Hintergrunddetails sind im Artikel beschrieben: [https://donau2space.de/tag-83-nachmittagssprint-baseline_recalc-getestet-ci-yaml-auf-herz-und-nieren/](https://donau2space.de/tag-83-nachmittagssprint-baseline_recalc-getestet-ci-yaml-auf-herz-und-nieren/) + +### 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 +Dieses Repository enthält drei Artefakte, die unterschiedliche Ebenen des Systems abdecken: + +### 1. baseline_patch +**Art:** Kernel Patch +**Ziel:** linux-demo +**Sprachen:** patch, C +**Zweck:** Aktiviert die Baseline-Rekalibrierung bei clocksource-Switches im Kernel. + +**API-Komponenten:** +- **Funktion:** `baseline_recalc_on_switch(clocksource) → bool` – führt den Rekalibrierungsvorgang beim Wechsel der Clocksource aus. +- **Struktur:** `struct clocksource` – enthält Felder `read`, `switch_time`, `rebaseline`. + +### 2. trace_export_script +**Art:** Python-Skript +**Ziel:** linux-userspace +**Sprachen:** Python +**Zweck:** Verarbeitung und Exportierung von Trace-Daten im konfigurierten Ausgabeformat. + +**API-Komponenten:** +- **Funktion:** `export_trace_data(file_path, format)` – exportiert Trace-Daten aus einer Eingabedatei in das angegebene Format. +- **Datenstruktur:** `TraceSample` (JSON) – Felder: `timestamp`, `value`, `source`. + +### 3. ci_yaml_fix +**Art:** Dokumentation +**Ziel:** mixed +**Sprache:** Markdown +**Zweck:** Beschreibt erforderliche Änderungen an CI-YAML-Dateien zur Stabilisierung von Artefaktabläufen. + +## Installation & Nutzung +Für das Python-Skript **trace_export_script**: +1. Repository klonen. +2. Abhängigkeiten installieren (`pip install -r requirements.txt` falls verfügbar). +3. Ausführung über CLI: + ```bash + python trace_export_script.py --file /path/to/trace --format json + ``` + +Für Kernelentwicklung mit **baseline_patch**: +- Patch über `git apply baseline_patch.patch` einspielen. +- Kernel neu kompilieren und installieren. + +Die Dokumentationsdatei **ci_yaml_fix.md** dient als Referenz für CI-Konfigurationsanpassungen. + +## Typische Use-Cases +- Untersuchung von Zeitabweichungen nach Clocksource-Wechseln. +- Automatischer Export von Trace-Daten für Performanceanalysen. +- CI-Fehlerbehebung bei Build-Artefaktproblemen. + +## Struktur & mögliche Erweiterungen +- `/kernel/` – Patchdateien und Kernel-bezogene Module. +- `/scripts/` – Python-Skripte zur Datenauswertung. +- `/docs/` – Dokumentationen zur CI-Integration. + +Zukünftige Erweiterungen können zusätzliche Analyse-Skripte oder alternative Rebaseline-Mechanismen beinhalten. + +## Lizenz +Dieses Projekt steht unter der **MIT-Lizenz**. + +### Hinweis zur Verantwortung +Alle Inhalte wurden automatisch durch KI erzeugt. Die Nutzung und Weiterentwicklung erfolgt auf eigene Verantwortung. Es wird keine Gewähr für Korrektheit oder Sicherheit übernommen. \ No newline at end of file