feat: model IOL adapters as 4-port units like the IOU node type

IOL interfaces come in 4-port units (Ethernet0/0-3, Ethernet1/0-3, ...),
addressed like IOU as (adapter_number, port_number 0-3):

- IOLDockerVM builds EthernetAdapter(interfaces=4) per adapter and asks
  the runner for adapters x 4 interfaces (num-eth).
- DockerVM threads port_number through the NIO/capture API (the compute
  routes parsed it from the URL but dropped it); single-port adapters
  keep the historical bridge{N} names and command sequence, multi-port
  adapters get one bridge per port (bridge{a}_{p}).
- The unix-socket NIO wiring addresses sockets flat across adapters:
  adapter x ports-per-adapter + port, so single-port images keep their
  exact socket layout.
- The controller port list for GNS3_IOL_RUNNER docker nodes is generated
  by StandardPortFactory with the IOU naming (Ethernet{segment0}/{port0},
  segment size 4); plain docker nodes keep eth{N}.
This commit is contained in:
YueGuobin committed 2026-09-05 21:54:51 +08:00
1 parent 9b55164064
commit 0ca9ccc637
9 files changed
+267 -110

No files matched your search

+99 -54
View File
@@ -899,19 +899,24 @@ class DockerVM(BaseNode):
await self._start_ubridge(require_privileged_access=True)
for adapter_number in range(0, self.adapters):
nio = self._ethernet_adapters[adapter_number].get_nio(0)
async with self.manager.ubridge_lock:
try:
await self._add_ubridge_connection(nio, adapter_number)
except UbridgeNamespaceError:
log.error("Container %s failed to start", self.name)
await self.stop()
adapter = self._ethernet_adapters[adapter_number]
# Single-port adapters (the standard case) loop once, keeping
# the historical command sequence; multi-port adapters
# (e.g. IOL's 4-port units) get one bridge per port.
for port_number in range(0, adapter.interfaces):
nio = adapter.get_nio(port_number)
async with self.manager.ubridge_lock:
try:
await self._add_ubridge_connection(nio, adapter_number, port_number)
except UbridgeNamespaceError:
log.error("Container %s failed to start", self.name)
await self.stop()
# The container can crash soon after the start, this means we can not move the interface to the container namespace
logdata = await self._get_log()
for line in logdata.split("\n"):
log.error(line)
raise DockerError(logdata)
# The container can crash soon after the start, this means we can not move the interface to the container namespace
logdata = await self._get_log()
for line in logdata.split("\n"):
log.error(line)
raise DockerError(logdata)
await self._start_console_server()
@@ -1406,6 +1411,21 @@ class DockerVM(BaseNode):
"""
return f"eth{adapter_number}"
def _bridge_name(self, adapter_number, port_number=0):
"""
uBridge bridge name for an adapter port. Adapters with a single
port (every standard Docker node) keep the historical
"bridge{adapter}" name; multi-port adapters (e.g. IOL's 4-port
units) get one bridge per port.
:param adapter_number: adapter number
:param port_number: port number on the adapter
"""
if port_number:
return f"bridge{adapter_number}_{port_number}"
return f"bridge{adapter_number}"
async def _start_interface_monitor(self):
"""Monitor administrative state changes for this container's adapters.
@@ -1558,12 +1578,14 @@ class DockerVM(BaseNode):
if writer:
await self._close_interface_monitor_writer(writer)
async def _add_ubridge_connection(self, nio, adapter_number):
async def _add_ubridge_connection(self, nio, adapter_number, port_number=0):
"""
Creates a connection in uBridge.
:param nio: NIO instance or None if it's a dummy interface (if an interface is missing in ubridge you can't see it via ifconfig in the container)
:param adapter_number: adapter number
:param port_number: port number on the adapter (standard Docker
adapters have a single port, so this is always 0 on the TAP path)
"""
try:
@@ -1575,6 +1597,13 @@ class DockerVM(BaseNode):
)
)
if port_number and adapter.interfaces == 1:
raise DockerError(
"Port {port_number} doesn't exist on adapter {adapter_number} of Docker container '{name}'".format(
name=self.name, port_number=port_number, adapter_number=adapter_number
)
)
for index in range(4096):
if f"tap-gns3-e{index}" not in psutil.net_if_addrs():
adapter.host_ifc = f"tap-gns3-e{str(index)}"
@@ -1585,12 +1614,12 @@ class DockerVM(BaseNode):
name=self.name, adapter_number=adapter_number
)
)
bridge_name = f"bridge{adapter_number}"
bridge_name = self._bridge_name(adapter_number, port_number)
await self._ubridge_send(f"bridge create {bridge_name}")
self._bridges.add(bridge_name)
await self._ubridge_send(
"bridge add_nio_tap bridge{adapter_number} {hostif} off".format(
adapter_number=adapter_number, hostif=adapter.host_ifc
"bridge add_nio_tap {bridge_name} {hostif} off".format(
bridge_name=bridge_name, hostif=adapter.host_ifc
)
)
@@ -1618,23 +1647,24 @@ class DockerVM(BaseNode):
log.debug(f"Created adapter {adapter_number} with MAC address {mac_address} in namespace {self._namespace}")
if nio:
await self._connect_nio(adapter_number, nio)
await self._set_adapter_carrier(adapter_number, not nio.suspend)
await self._connect_nio(adapter_number, nio, port_number)
await self._set_adapter_carrier(adapter_number, not nio.suspend, port_number)
async def _get_namespace(self):
result = await self.manager.query("GET", f"containers/{self._cid}/json")
return int(result["State"]["Pid"])
async def _set_adapter_carrier(self, adapter_number, connected):
async def _set_adapter_carrier(self, adapter_number, connected, port_number=0):
"""Replicate a Docker adapter's connection state on its TAP device."""
bridge_name = self._bridge_name(adapter_number, port_number)
state = "on" if connected else "off"
await self._ubridge_send(f"bridge set_nio_tap_carrier bridge{adapter_number} {state}")
await self._ubridge_send(f"bridge set_nio_tap_carrier {bridge_name} {state}")
async def _connect_nio(self, adapter_number, nio):
async def _connect_nio(self, adapter_number, nio, port_number=0):
bridge_name = f"bridge{adapter_number}"
bridge_name = self._bridge_name(adapter_number, port_number)
await self._ubridge_send(
"bridge add_nio_udp {bridge_name} {lport} {rhost} {rport}".format(
bridge_name=bridge_name, lport=nio.lport, rhost=nio.rhost, rport=nio.rport
@@ -1650,12 +1680,13 @@ class DockerVM(BaseNode):
await self._ubridge_apply_filters(bridge_name, nio.filters)
await self._ubridge_apply_markers(bridge_name, nio)
async def adapter_add_nio_binding(self, adapter_number, nio):
async def adapter_add_nio_binding(self, adapter_number, nio, port_number=0):
"""
Adds an adapter NIO binding.
:param adapter_number: adapter number
:param nio: NIO instance to add to the slot/port
:param nio: NIO instance to add to the adapter/port
:param port_number: port number on the adapter (0 for single-port adapters)
"""
try:
@@ -1667,38 +1698,47 @@ class DockerVM(BaseNode):
)
)
if self.status == "started" and self.ubridge:
await self._connect_nio(adapter_number, nio)
await self._set_adapter_carrier(adapter_number, not nio.suspend)
if not adapter.port_exists(port_number):
raise DockerError(
"Port {port_number} doesn't exist on adapter {adapter_number} of Docker container '{name}'".format(
name=self.name, port_number=port_number, adapter_number=adapter_number
)
)
adapter.add_nio(0, nio)
if self.status == "started" and self.ubridge:
await self._connect_nio(adapter_number, nio, port_number)
await self._set_adapter_carrier(adapter_number, not nio.suspend, port_number)
adapter.add_nio(port_number, nio)
log.debug(
"Docker container '{name}' [{id}]: {nio} added to adapter {adapter_number}".format(
name=self.name, id=self._id, nio=nio, adapter_number=adapter_number
)
)
async def adapter_update_nio_binding(self, adapter_number, nio):
async def adapter_update_nio_binding(self, adapter_number, nio, port_number=0):
"""
Update an adapter NIO binding.
:param adapter_number: adapter number
:param nio: NIO instance to update the adapter
:param port_number: port number on the adapter (0 for single-port adapters)
"""
if self.ubridge:
bridge_name = f"bridge{adapter_number}"
bridge_name = self._bridge_name(adapter_number, port_number)
if bridge_name in self._bridges:
await self._ubridge_apply_filters(bridge_name, nio.filters)
await self._ubridge_apply_markers(bridge_name, nio)
if self.status == "started":
await self._set_adapter_carrier(adapter_number, not nio.suspend)
await self._set_adapter_carrier(adapter_number, not nio.suspend, port_number)
async def adapter_remove_nio_binding(self, adapter_number):
async def adapter_remove_nio_binding(self, adapter_number, port_number=0):
"""
Removes an adapter NIO binding.
:param adapter_number: adapter number
:param port_number: port number on the adapter (0 for single-port adapters)
:returns: NIO instance
"""
@@ -1712,20 +1752,20 @@ class DockerVM(BaseNode):
)
)
await self.stop_capture(adapter_number)
await self.stop_capture(adapter_number, port_number)
if self.ubridge:
nio = adapter.get_nio(0)
bridge_name = f"bridge{adapter_number}"
nio = adapter.get_nio(port_number)
bridge_name = self._bridge_name(adapter_number, port_number)
if self.status == "started":
await self._set_adapter_carrier(adapter_number, False)
await self._set_adapter_carrier(adapter_number, False, port_number)
await self._ubridge_send(f"bridge stop {bridge_name}")
await self._ubridge_send(
"bridge remove_nio_udp bridge{adapter} {lport} {rhost} {rport}".format(
adapter=adapter_number, lport=nio.lport, rhost=nio.rhost, rport=nio.rport
"bridge remove_nio_udp {bridge_name} {lport} {rhost} {rport}".format(
bridge_name=bridge_name, lport=nio.lport, rhost=nio.rhost, rport=nio.rport
)
)
adapter.remove_nio(0)
adapter.remove_nio(port_number)
log.debug(
"Docker VM '{name}' [{id}]: {nio} removed from adapter {adapter_number}".format(
@@ -1733,11 +1773,12 @@ class DockerVM(BaseNode):
)
)
def get_nio(self, adapter_number):
def get_nio(self, adapter_number, port_number=0):
"""
Gets an adapter NIO binding.
:param adapter_number: adapter number
:param port_number: port number on the adapter (0 for single-port adapters)
:returns: NIO instance
"""
@@ -1751,10 +1792,10 @@ class DockerVM(BaseNode):
)
)
nio = adapter.get_nio(0)
nio = adapter.get_nio(port_number)
if not nio:
raise DockerError(f"Adapter {adapter_number} is not connected")
raise DockerError(f"Adapter {adapter_number} port {port_number} is not connected")
return nio
@@ -1800,46 +1841,49 @@ class DockerVM(BaseNode):
await self.manager.pull_image(image, progress_callback=callback)
async def _start_ubridge_capture(self, adapter_number, output_file):
async def _start_ubridge_capture(self, adapter_number, output_file, port_number=0):
"""
Starts a packet capture in uBridge.
:param adapter_number: adapter number
:param output_file: PCAP destination file for the capture
:param port_number: port number on the adapter (0 for single-port adapters)
"""
adapter = f"bridge{adapter_number}"
bridge_name = self._bridge_name(adapter_number, port_number)
if not self.ubridge:
raise DockerError("Cannot start the packet capture: uBridge is not running")
await self._ubridge_send(f'bridge start_capture {adapter} "{output_file}"')
await self._ubridge_send(f'bridge start_capture {bridge_name} "{output_file}"')
async def _stop_ubridge_capture(self, adapter_number):
async def _stop_ubridge_capture(self, adapter_number, port_number=0):
"""
Stops a packet capture in uBridge.
:param adapter_number: adapter number
:param port_number: port number on the adapter (0 for single-port adapters)
"""
adapter = f"bridge{adapter_number}"
bridge_name = self._bridge_name(adapter_number, port_number)
if not self.ubridge:
raise DockerError("Cannot stop the packet capture: uBridge is not running")
await self._ubridge_send(f"bridge stop_capture {adapter}")
await self._ubridge_send(f"bridge stop_capture {bridge_name}")
async def start_capture(self, adapter_number, output_file):
async def start_capture(self, adapter_number, output_file, port_number=0):
"""
Starts a packet capture.
:param adapter_number: adapter number
:param output_file: PCAP destination file for the capture
:param port_number: port number on the adapter (0 for single-port adapters)
"""
nio = self.get_nio(adapter_number)
nio = self.get_nio(adapter_number, port_number)
if nio.capturing:
raise DockerError(f"Packet capture is already activated on adapter {adapter_number}")
nio.start_packet_capture(output_file)
if self.status == "started" and self.ubridge:
await self._start_ubridge_capture(adapter_number, output_file)
await self._start_ubridge_capture(adapter_number, output_file, port_number)
log.debug(
"Docker VM '{name}' [{id}]: starting packet capture on adapter {adapter_number}".format(
@@ -1847,19 +1891,20 @@ class DockerVM(BaseNode):
)
)
async def stop_capture(self, adapter_number):
async def stop_capture(self, adapter_number, port_number=0):
"""
Stops a packet capture.
:param adapter_number: adapter number
:param port_number: port number on the adapter (0 for single-port adapters)
"""
nio = self.get_nio(adapter_number)
nio = self.get_nio(adapter_number, port_number)
if not nio.capturing:
return
nio.stop_packet_capture()
if self.status == "started" and self.ubridge:
await self._stop_ubridge_capture(adapter_number)
await self._stop_ubridge_capture(adapter_number, port_number)
log.debug(
"Docker VM '{name}' [{id}]: stopping packet capture on adapter {adapter_number}".format(
+25 -1
View File
@@ -43,7 +43,9 @@ import logging
import os
import shutil
from gns3server.compute.adapters.ethernet_adapter import EthernetAdapter
from gns3server.compute.docker.docker_error import DockerHttp404Error
from gns3server.compute.docker.docker_vm import DockerVM
from gns3server.compute.docker.vendor_docker_vm import VendorDockerVM
log = logging.getLogger(__name__)
@@ -90,6 +92,28 @@ class IOLDockerVM(VendorDockerVM):
except ValueError:
pass
@DockerVM.adapters.setter
def adapters(self, adapters):
"""
Override: one IOL adapter is a 4-port unit — the IOU model. The
template's adapter count is the number of units (2 adapters =
Ethernet0/0-3 + Ethernet1/0-3); the generated config asks the runner
for adapters × 4 interfaces and links address ports as
(adapter_number, port_number 0-3).
"""
if len(self._ethernet_adapters) == adapters:
return
self._ethernet_adapters.clear()
for _ in range(0, adapters):
self._ethernet_adapters.append(EthernetAdapter(interfaces=4))
log.debug(
"IOL container '%s': number of 4-port Ethernet adapters set to %d",
self._name, adapters,
)
def _persistent_volume_list(self, image_info, include_network_config=True):
"""
Override: the runner requires ``/config`` (its config file, generated
@@ -168,7 +192,7 @@ class IOLDockerVM(VendorDockerVM):
config = {
"binary": "/binary.iol",
"memory": self._iol_memory,
"num-eth": self.adapters,
"num-eth": self.adapters * 4, # every adapter is a 4-port unit
"num-serial": 0, # GNS3 docker adapters are ethernet-only
"local-app": 1,
"remote-app": 2,
+17 -13
View File
@@ -377,14 +377,17 @@ class VendorDockerVM(DockerVM):
await super().delete()
self._remove_unix_socket_host_dir()
async def _add_ubridge_connection(self, nio, adapter_number):
async def _add_ubridge_connection(self, nio, adapter_number, port_number=0):
"""
Override: with GNS3_UNIX_SOCKET_NIO, bridge the adapter through the
image's AF_UNIX datagram socket pair (raw Ethernet frames) instead of
a TAP interface moved into the container's network namespace.
Override: with GNS3_UNIX_SOCKET_NIO, bridge the adapter port through
the image's AF_UNIX datagram socket pair (raw Ethernet frames)
instead of a TAP interface moved into the container's network
namespace.
Per adapter N the image's network agent is expected to create, inside
GNS3_UNIX_SOCKET_DIR:
Ports are addressed flat across adapters: interface index = adapter
number × ports-per-adapter + port number (single-port adapters
reduce to the adapter number). Per interface N the image's network
agent is expected to create, inside GNS3_UNIX_SOCKET_DIR:
* ``s{N:02d}.sock`` — its receive socket; frames sent there are
injected into guest interface N;
@@ -398,7 +401,7 @@ class VendorDockerVM(DockerVM):
"""
if not self._unix_socket_nio:
return await super()._add_ubridge_connection(nio, adapter_number)
return await super()._add_ubridge_connection(nio, adapter_number, port_number)
try:
adapter = self._ethernet_adapters[adapter_number]
@@ -409,14 +412,15 @@ class VendorDockerVM(DockerVM):
)
)
bridge_name = f"bridge{adapter_number}"
interface_number = adapter_number * adapter.interfaces + port_number
bridge_name = self._bridge_name(adapter_number, port_number)
try:
await self._ubridge_send(f"bridge create {bridge_name}")
self._bridges.add(bridge_name)
wiring_dir = self._unix_socket_wiring_dir()
local_sock = os.path.join(wiring_dir, f"c{adapter_number:02d}.sock")
remote_sock = os.path.join(wiring_dir, f"s{adapter_number:02d}.sock")
local_sock = os.path.join(wiring_dir, f"c{interface_number:02d}.sock")
remote_sock = os.path.join(wiring_dir, f"s{interface_number:02d}.sock")
# A c-socket left over from a previous ubridge run would fail its bind.
with contextlib.suppress(OSError):
@@ -443,12 +447,12 @@ class VendorDockerVM(DockerVM):
raise
adapter.host_ifc = local_sock # bookkeeping / removal logging only
log.debug(
"Adapter %d of container '%s' wired via unix sockets %s <-> %s",
adapter_number, self._name, local_sock, remote_sock,
"Adapter %d port %d of container '%s' wired via unix sockets %s <-> %s",
adapter_number, port_number, self._name, local_sock, remote_sock,
)
if nio:
await self._connect_nio(adapter_number, nio)
await self._connect_nio(adapter_number, nio, port_number)
def _cleanup_console_resources(self):
"""