Doc emulated environments

[matthew-l-weber]

Add a new doc with the basic/advanced demo docs that talks about what we're building for the emulated environments to run the demos.

• A basic debug or lower DAL environment
• A higher DAL environment

[matthew-l-weber]

Basic Case

Build time

• Cross compiled build for AARCH64 (needs support added to Makefile)
• Uses Kernel Image and rootfs in cpio format
• Initially, a debug build with shell and debug tools + python

Runtime

• Runs in QEMU against the aarch64 virt machine target
• Client, server and monitor behavior is all within the emulation
  • Same log based analysis / monitor condition checking

ACtion

• Port over existing
• Recode to use raw Ethernet
• Retest

[matthew-l-weber]

Emulated Advanced Case

Build time

• Cross compiled build for AARCH64 (needs support added to Makefile)
• Uses Kernel Image and rootfs in cpio format
• Initially, a debug build with shell and debug tools - just C lang support
• (stretch) Try to go for no init and run scenario directly - could be a candidate for having the minimal application analysis after we have a working example (System WG)

Runtime

• Runs in QEMU against the aarch64 virt machine target
• Dataflows we have to support
  • Service running on target using raw Ethernet + current logging
  • Light client running outside as python but modified to talk raw frames
  • Light state change remains a log entry within emulation
• Consistent time within emulation so that delta logic works

Action

• Drop network stack
• Kernel RTC enabled and QEMU virt passthrough (consider if this does any drift correct that we need to account for)
  • Let's start without it so that we don't have time jumps - Could later add it so that host time is in sync in logs
  • Duration of execution could be simpler to determine if the clk always starts at the UNIX epoch date
• Figure out QEMU networking approach that works for rootless local and CICD
• Drop python / recode server (chatgpt) - Switch client is on host system in python. Server and monitor are within the emulation.
• Drop init and have no userspace (all static apps)
• Add Ethernet monitoring of light state change by monitor in emulation - datapath: client switch to server
  • This change is needed as logs on host system vs emulated are separate so we can't parse a single syslog like the original host demo

[matthew-l-weber]

Added to our CI job to compose a OS and post the images. https://gitlab.com/elisa-tech/aero-wg-ci/-/merge_requests/1

How to run?

1. Using the demo environment. cd demos/copilot/src/monitors and run make dev to drop into the Docker container which has the necessary tools installed.
2. Get the prebuilts.

wget "https://gitlab.com/api/v4/projects/61362364/packages/generic/minimal-linux-debug/1.0.0/archive.tar" -O archive.tar

3. Extract tooling

cd ~
tar xf archive.tar
tar xf aarch64-buildroot-linux-musl_sdk-buildroot.tar.gz
cd aarch64-buildroot-linux-musl_sdk-buildroot
./relocate-sdk.sh              # One time, unless you move the folder, you then have to re-run
. environment-setup        # Sets up tools in the shell.  Have to repeat if you close the shell
cd ..

4. Run example images

# requires:   sudo apt install -y qemu-system-aarch64
qemu-system-aarch64 -M virt -cpu cortex-a57 -smp 4 -nographic -kernel Image -initrd rootfs.cpio.gz -append "root=/dev/ram0 console=ttyAMA0"

# 'ctrl-a x' to stop QEMU

[matthew-l-weber]

5. Cross compile test app - While still in the make dev environment from above, update makefile to have the following new target.

main_syslog_time_cross: main_syslog_time.c elisa-time.c elisa-time.h elisa-time_types.h
        /home/user/aarch64-buildroot-linux-musl_sdk-buildroot/bin/gcc -DLOG_PATH=\"syslog_file\" main_syslog_time.c elisa-time.c -o $@

6. Place C and Python app into image - Similar to last step, add target to package cpio image

# requires:   sudo apt install -y cpio
cd
mkdir -p extracted_cpio && sudo gunzip -c rootfs.cpio.gz > rootfs.cpio_uncompressed
sudo cpio -i -R +0:+0 -n -F rootfs.cpio_uncompressed --make-directories --preserve-modification-time --no-absolute-filenames --directory=./extracted_cpio
pushd <path to "wg-aerospace/demos/copilot/src">
sudo cp -f  python/* src/main_syslog_time  ./extracted_cpio/root/
sudo chmod 0755 ./extracted_cpio/root/main_syslog_time
sudo cd extracted_cpio 
sudo find . | sudo cpio -H newc -o | gzip -c > ../rootfs.cpio.gz

7. Run demo within QEMU - Similar to last step, add a target to run the emulation

foo

8. TBD steps once in the emulation to run the scenario? Do we use one of our test scripts for this to wrapper the launch/check output?

[matthew-l-weber]

@ivanperez-keera @MartinHalleTUHH @brian-wood @Shefali199 @wenhuizhang

We can discuss more in the call today but the images are published. If you don’t mind reviewing + approving and I’ll merge it.

https://gitlab.com/elisa-tech/aero-wg-ci/-/merge_requests/1

The start of image usage notes: #33 (comment)

[matthew-l-weber]

The notes above are folded mostly into other tickets and the cFS port ticket has the most consolidated instruction example today. #52

The Makefile has the cross workflows tied together but it's more hidden and will get broken out in the docs as they develop.

[matthew-l-weber]

Need to split this ticket up and close. Next task is to update https://github.com/elisa-tech/wg-aerospace/blob/main/demos/copilot/EmbeddedDemo.md and get the docs to reflect the Cross environment changes.

[matthew-l-weber]

notes on manually running raw socket tests - #65 (comment)