Skip to content

docker: images for the build, a simulated RAN, a simulated dApp and the benchmark - #151

Merged
Thecave3 merged 1 commit into
mainfrom
docker/79-images
Nov 9, 2026
Merged

Thecave3 merged 1 commit into
mainfrom
docker/79-images

Conversation

@Thecave3

@Thecave3 Thecave3 commented Nov 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add docker/ with four Dockerfiles: libe3-build (every encoding, SCTP, the integration tests and latrec), libe3-ran-sim (example_simple_agent), libe3-dapp-sim (example_simple_dapp) and libe3-bench (test_bench_full_loop_latency). build_libe3 -I stays the one list of dependencies, and the dependency layer is rebuilt only when build_libe3 or VERSION changes.
  • Add docker/run-pair.sh, which runs a RAN container and a dApp container on one network namespace and one IPC directory and passes when the dApp exits 0 and prints an indication. docker/README.md shows the build and run commands.

Type of change

  • Bug fix
  • New feature / enhancement
  • New Service Model
  • Refactor (no behavior change)
  • Documentation
  • Test / CI / packaging
  • Other (explain):

Linked issue

Part of #79. The pull request stacked on this one makes CI use these images, and closes #79.

Testing

Built the four images on aarch64 Linux (Docker Desktop). docker/run-pair.sh passes for zmq/ipc, zmq/tcp, posix/ipc, posix/tcp and posix/sctp with ASN.1, and for posix/tcp with JSON and protobuf. The benchmark image prints its table.

Not covered: nothing in CI builds these images in this pull request (the stacked one does, on x86-64), and I have not built them on x86-64 myself.

Twin-repo coordination

  • This PR does not change the E3 wire protocol or public ABI, OR a paired PR exists in each affected twin repo (link below).
  • This PR does not change the wire format or a behavior a peer (OAI, Aerial, OCUDU) can observe, OR I added a row to the change ledger in docs/interop.md.

Paired PR(s): none needed.

…he benchmark

Add docker/ with four Dockerfiles: libe3-build (every encoding, SCTP, the
integration tests and latrec, with build_libe3 -I as the one list of
dependencies), libe3-ran-sim (example_simple_agent), libe3-dapp-sim
(example_simple_dapp) and libe3-bench (test_bench_full_loop_latency). The
dependency layer depends only on build_libe3 and VERSION. docker/run-pair.sh
runs a RAN and a dApp container on one network namespace and one IPC
directory and passes when the dApp exits 0 and prints an indication.

Run with the four images built on aarch64 Linux (Docker Desktop): the pair
passes for zmq/ipc, zmq/tcp, posix/ipc, posix/tcp and posix/sctp with asn1,
and for posix/tcp with json and protobuf; the bench image prints its table.
No CI job builds the images yet.

Assisted-by: Claude:claude-sonnet-5-5
Signed-off-by: Andrea Lacava <a.lacava@northeastern.edu>
@Thecave3 Thecave3 added the enhancement New feature or request label Nov 9, 2026
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

CI report — f4165d2 — ✅ all checks passed

Workflow Result Time Run
Commit policy ✅ success 1m58s #254
Docs ✅ success 0m11s #53
E2E dApp Integration ✅ success 2m05s #220
E2E Topologies (multi-dApp / multi-RAN) ✅ success 2m41s #218
Full-loop Latency Benchmark ✅ success 0m52s #219
Unit Tests ✅ success 5m13s #246
Build libe3py wheels ⏭️ not started (no changed file matches its paths filter) — —
latrec portability ⏭️ not started (no changed file matches its paths filter) — —
MPMC Queue Benchmark ⏭️ not started (no changed file matches its paths filter) — —
E2E Topologies (multi-dApp / multi-RAN)

zmq/ipc

  • ✅ 1 RAN - 1 dApp: indications=5
    • dapp peer=t11 ran=ran-solo sub=1 indications=5 seq=[0..4] dropped=0 (0%) age_ms(avg=0 max=0 @seq=0) hist[<=1:5 2-5:0 6-10:0 >10:0]
  • ✅ 1 RAN - 2 dApps: dApp#1 ind=5 sub=1, dApp#2 ind=6 sub=2, RAN saw 2 dApps
    • dapp1 peer=t12 ran=ran-shared sub=1 indications=5 seq=[0..4] dropped=0 (0%) age_ms(avg=0.8 max=1 @seq=0) hist[<=1:5 2-5:0 6-10:0 >10:0]
    • dapp2 peer=t12 ran=ran-shared sub=2 indications=6 seq=[0..5] dropped=0 (0%) age_ms(avg=0.666667 max=1 @seq=0) hist[<=1:6 2-5:0 6-10:0 >10:0]
  • ✅ 2 RANs - 1 dApp: from ran-a ind=5, from ran-b ind=5
    • dapp peer=t2a ran=ran-a sub=1 indications=5 seq=[0..4] dropped=0 (0%) age_ms(avg=0.8 max=1 @seq=1) hist[<=1:5 2-5:0 6-10:0 >10:0]
    • dapp peer=t2b ran=ran-b sub=1 indications=5 seq=[0..4] dropped=0 (0%) age_ms(avg=0 max=0 @seq=0) hist[<=1:5 2-5:0 6-10:0 >10:0]

zmq/tcp

  • ✅ 1 RAN - 1 dApp: indications=5
    • dapp peer=default ran=ran-solo sub=1 indications=5 seq=[0..4] dropped=0 (0%) age_ms(avg=0 max=0 @seq=0) hist[<=1:5 2-5:0 6-10:0 >10:0]
  • ✅ 1 RAN - 2 dApps: dApp#1 ind=5 sub=1, dApp#2 ind=6 sub=2, RAN saw 2 dApps
    • dapp1 peer=default ran=ran-shared sub=1 indications=5 seq=[0..4] dropped=0 (0%) age_ms(avg=1 max=1 @seq=0) hist[<=1:5 2-5:0 6-10:0 >10:0]
    • dapp2 peer=default ran=ran-shared sub=2 indications=6 seq=[0..5] dropped=0 (0%) age_ms(avg=1 max=1 @seq=0) hist[<=1:6 2-5:0 6-10:0 >10:0]
  • ✅ 2 RANs - 1 dApp: from ran-a ind=5, from ran-b ind=5
    • dapp peer=default ran=ran-a sub=1 indications=5 seq=[0..4] dropped=0 (0%) age_ms(avg=0 max=0 @seq=0) hist[<=1:5 2-5:0 6-10:0 >10:0]
    • dapp peer=off100 ran=ran-b sub=1 indications=5 seq=[0..4] dropped=0 (0%) age_ms(avg=1 max=1 @seq=0) hist[<=1:5 2-5:0 6-10:0 >10:0]
E2E dApp Integration

✅ posix/ipc

  • dApp exit: 0
  • Indications received: 7

✅ posix/tcp

  • dApp exit: 0
  • Indications received: 7

✅ zmq/ipc

  • dApp exit: 0
  • Indications received: 7

✅ zmq/tcp

  • dApp exit: 0
  • Indications received: 7
Full-loop Latency Benchmark

Full-loop latency

Full-loop latency benchmark (N=1003 after 50 warmup)

All values in microseconds (μs). Link: zmq, transport: ipc, encoding: ASN.1 APER.

# Description Tags mean p50 p99 max
1 Collect indication data RECORD_BEGIN to ENCODE_E3SM_BEGIN 0.12 0.12 0.25 0.55
2 Create & encode indication ENCODE_E3SM_BEGIN to ENCODE_E3SM_DONE 1.01 0.97 1.77 3.68
3 Encode E3AP (indication) EMIT_ENTER to ENQUEUE, then DEQUEUE to ENCODE_E3AP_DONE 2.24 2.09 4.81 11.13
4 Queuing (indication) ENQUEUE to DEQUEUE 3.84 1.95 17.09 27.10
5 Delivery (indication) ENCODE_E3AP_DONE to SEND_DONE 0.40 0.20 3.39 62.03
6 E3 wire (RAN -> dApp) SEND_DONE to RECV 40.38 40.11 60.01 67.76
7 Decode E3AP (indication) RECV to DECODE_E3AP_DONE 1.41 1.17 4.49 16.94
8 libe3 dispatch (indication) DECODE_E3AP_DONE to DELIVER_BEGIN 0.14 0.13 0.20 0.28
9 Decode indication DELIVER_BEGIN to DECODE_E3SM_DONE 0.47 0.42 0.72 0.94
10 Process data DECODE_E3SM_DONE to ENCODE_E3SM_BEGIN 0.03 0.03 0.05 0.10
11 Create & encode control ENCODE_E3SM_BEGIN to ENCODE_E3SM_DONE 0.33 0.31 0.60 0.83
12 Encode E3AP (control) EMIT_ENTER to ENQUEUE, then DEQUEUE to ENCODE_E3AP_DONE 3.04 2.71 5.48 20.74
13 Queuing (control) ENQUEUE to DEQUEUE 11.75 11.14 25.05 105.84
14 Delivery (control) ENCODE_E3AP_DONE to SEND_DONE 5.34 4.83 9.22 18.75
15 E3 wire (dApp -> RAN) SEND_DONE to RECV 40.25 39.31 58.74 148.06
16 Decode E3AP (control) RECV to DECODE_E3AP_DONE 2.57 2.40 6.90 9.59
17 libe3 dispatch (control) DECODE_E3AP_DONE to DECODE_E3SM_BEGIN 0.50 0.47 0.81 14.92
18 Decode & handle control DECODE_E3SM_BEGIN to DECODE_E3SM_DONE 0.30 0.27 0.46 13.30
Total Total round-trip 114.56 113.23 155.89 341.63

ubuntu-latest, Release build, ZMQ + IPC, ASN.1 APER.

These numbers are measured inside a GitHub Actions container and should be treated as an upper bound on E3AP's and the library's own latency, not a representative deployment measurement.

Ready to merge (fast-forward only)

A maintainer can land the reviewed commits with:

git fetch origin
git checkout main && git merge --ff-only f4165d2d3360a6d55baf4a86aa19c5b25049930d && git push origin main

Head: f4165d2d3360a6d55baf4a86aa19c5b25049930d (branch docker/79-images). If --ff-only fails as non-fast-forward, the branch must be rebased on the latest main.

One comment per PR, rewritten in place once every workflow for f4165d2 finished.

@Thecave3
Thecave3 marked this pull request as ready for review November 9, 2026 22:57
@Thecave3
Thecave3 merged commit f4165d2 into main Nov 9, 2026
22 checks passed
@Thecave3
Thecave3 deleted the docker/79-images branch November 9, 2026 22:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Add dockerfile folder and let the workflows use it

1 participant