Add support for default route (IPv4 and IPv6) #2059

thomasfire · 2023-03-03T05:01:58Z

ARTIQ Pull Request

Description of Changes

Related Issue

Closes #1930
Closes #2033

Primarily cherry-picked from @mbirtwell 's #2033

Type of Changes

	Type
✓	🐛 Bug fix

Testing

PC with two RJ-45 interfaces with Manjaro 22.03 installed, all firewalls disabled (including ip(6)tables) - further - the router
One interface is connected to the office network, another is directly to the Kasli
Configuration of IPv6 on the is as follows:

2: enp0s25: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 state UP qlen 1000
    inet6 2001:470:f891:1:bf12:49f8:e2f3:a057/64 scope global noprefixroute 
       valid_lft forever preferred_lft forever
    inet6 2001:470:f891:1::1/64 scope global 
       valid_lft forever preferred_lft forever
    inet6 fe80::80b1:7abb:eae6:423f/64 scope link noprefixroute 
       valid_lft forever preferred_lft forever
3: enp3s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 state UP qlen 1000
    inet6 2001:470:f891:1::2/64 scope global 
       valid_lft forever preferred_lft forever
    inet6 fe80::a057/64 scope link 
       valid_lft forever preferred_lft forever

radvd.conf:

interface enp0s25
{
    MinRtrAdvInterval 3;
    MaxRtrAdvInterval 10;
    AdvSendAdvert on;
    AdvDefaultLifetime 300;
    route 2001:470:f891:2::/64 {
	AdvRouteLifetime 300;
	AdvRoutePreference high;
    };
};

Kasli: artiq_mkfs -s ip6 2001:470:f891:2::42/64 -s ip 192.168.3.42/24 -s ipv4_default_route 192.168.3.0 -s ipv6_default_route fe80::a057 kasli.config

Licensing

See copyright & licensing for more info.
ARTIQ files that do not contain a license header are copyrighted by M-Labs Limited and are licensed under LGPLv3+.

New config option "ipv4_default_route", which sets a static default route. Support passing a CIDR as ip, e.g. ip = "192.168.1.2/24" the prefix defaults to 0 same as before. If ip mode is use dhcp, then get the default route from the DHCP config.

Signed-off-by: Egor Savkin <es@m-labs.hk>

sbourdeauducq · 2023-03-03T07:33:15Z

artiq/firmware/libboard_misoc/net_settings.rs

+        ipv4_addr,
+        ipv6_ll_addr,
+        ipv6_addr,
+        ipv4_default_route: default_route,


Inconsistent variable naming (again)

sbourdeauducq · 2023-03-03T07:34:16Z

Testing?

thomasfire · 2023-03-03T08:15:04Z

Testing?

Ongoing, that's why it's WIP

mbirtwell

Thanks @thomasfire. That mostly looks good, just a couple of small comments.

mbirtwell · 2023-03-03T09:16:52Z

artiq/firmware/bootloader/main.rs

    };
+    let mut routes = [None; 1];


Should this be:

Suggested change

let mut routes = [None; 1];

let mut routes = [None; 2];

In case both an ipv4 and ipv6 default route is set?

Otherwise one of those unwraps below might panic.

mbirtwell · 2023-03-03T09:22:24Z

artiq/firmware/runtime/main.rs

+        if let Some(default_routev6) = net_addresses.ipv6_default_route {
+            interface.routes_mut().add_default_ipv6_route(default_routev6).unwrap();
+        }


I think we should probably be setting this even if ipv4 is set to use DHCP. There's no DHCPv6 support and I think that would be separate. (There doesn't seem to be DHCPv6 support in smoltcp yet).

mbirtwell · 2023-03-03T09:26:50Z

artiq/firmware/runtime/sched.rs

+    pub fn set_ipv6_address(&self, addr: &Ipv6Cidr) {
+        self.network.borrow_mut().update_ipv6_addr(addr)
+    }
+
+    pub fn set_ipv6_default_route(&self, addr: Ipv6Address) -> Result<Option<Route>, Error> {
+        Ok(self.network.borrow_mut().routes_mut().add_default_ipv6_route(addr)?)
+    }
+
+    pub fn remove_ipv6_default_route(&self) -> Option<Route> {
+        self.network.borrow_mut().routes_mut().remove_default_ipv6_route()
+    }


These all appear to be unused. Personally I'd avoid adding functions until they were needed.

Signed-off-by: Egor Savkin <es@m-labs.hk>

# Conflicts: # doc/manual/installing.rst

Need to set the prefix length of unspecified IP addresses to be 32 so that they don't appear to be in the same subnet as valid IPs

sbourdeauducq · 2023-03-11T10:41:37Z

doc/manual/installing.rst

 Check that you can ping the device. If ping fails, check that the Ethernet link LED is ON - on Kasli, it is the LED next to the SFP0 connector. As a next step, look at the messages emitted on the UART during boot. Use a program such as flterm or PuTTY to connect to the device's serial port at 115200bps 8-N-1 and reboot the device. On Kasli, the serial port is on FTDI channel 2 with v1.1 hardware (with channel 0 being JTAG) and on FTDI channel 1 with v1.0 hardware. Note that on Windows you might need to install the `FTDI drivers <https://ftdichip.com/drivers/>`_ first.

 If you want to use IPv6, the device also has a link-local address that corresponds to its EUI-64, and an additional arbitrary IPv6 address can be defined by using the ``ip6`` configuration key. All IPv4 and IPv6 addresses can be used at the same time.

+If IPv6 ping fails, check that the IPv6 default route is set up correctly. In general, the default route should point to the global unicast address of the next-hop gateway/router.


Why is this specific to IPv6?

Also this sounds like a general network issue - the manual does mention checking the Ethernet LED and where it is if ping fails because this is specific to our device, but the ARTIQ manual is not really the place for general network setup advice.

Removed this from manual

sbourdeauducq · 2023-03-13T03:26:16Z

doc/manual/installing.rst

  $ artiq_flash -t [board] -V [variant] -f flash_storage.img storage start

 For Kasli devices, flashing a MAC address is not necessary as they can obtain it from their EEPROM.
+If you only want to access the kasli from the same subnet you might be able to


Kasli or "core device" since this is not even specific to Kasli
IP
"Might be able to"? You don't seem so sure. Is that code so buggy?

sbourdeauducq · 2023-03-13T03:26:57Z

doc/manual/installing.rst

-If the ip config field is not set, or set to "use_dhcp" then the device will attempt to obtain an IP address using
-DHCP. If a static IP address is wanted, install OpenOCD as before, and flash the IP (and, if necessary, MAC) addresses
-directly: ::
+If the ip config field is not set, or set to "use_dhcp" then the device will


ip with backticks

Signed-off-by: Egor Savkin <es@m-labs.hk>

mbirtwell and others added 2 commits March 3, 2023 12:57

firmware: Add support for default route

d7f0224

New config option "ipv4_default_route", which sets a static default route. Support passing a CIDR as ip, e.g. ip = "192.168.1.2/24" the prefix defaults to 0 same as before. If ip mode is use dhcp, then get the default route from the DHCP config.

Add IPv6 default route

56fd5aa

Signed-off-by: Egor Savkin <es@m-labs.hk>

thomasfire requested a review from sbourdeauducq March 3, 2023 05:01

sbourdeauducq reviewed Mar 3, 2023

View reviewed changes

mbirtwell reviewed Mar 3, 2023

View reviewed changes

thomasfire and others added 3 commits March 8, 2023 17:10

Bugfix IPv6 default routing

e01e36a

Signed-off-by: Egor Savkin <es@m-labs.hk>

Add some documentation for setting the default gateway

1f896b8

# Conflicts: # doc/manual/installing.rst

Default gateway support: Tidy up and bug fix

8284641

Need to set the prefix length of unspecified IP addresses to be 32 so that they don't appear to be in the same subnet as valid IPs

thomasfire force-pushed the 1930-default-route branch from 8db46ae to 6f8e0c2 Compare March 8, 2023 09:31

thomasfire changed the title ~~WIP: add default route~~ Add support for default route (IPv4 and IPv6) Mar 8, 2023

sbourdeauducq reviewed Mar 11, 2023

View reviewed changes

thomasfire force-pushed the 1930-default-route branch from 6f8e0c2 to dab5e53 Compare March 13, 2023 03:24

sbourdeauducq reviewed Mar 13, 2023

View reviewed changes

thomasfire force-pushed the 1930-default-route branch from dab5e53 to 0219d2d Compare March 13, 2023 03:47

Adjust documentation for IPv6 set up

ed79a13

Signed-off-by: Egor Savkin <es@m-labs.hk>

thomasfire force-pushed the 1930-default-route branch from 0219d2d to ed79a13 Compare March 13, 2023 09:18

sbourdeauducq merged commit 1ca09b9 into m-labs:master Mar 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for default route (IPv4 and IPv6) #2059

Add support for default route (IPv4 and IPv6) #2059

thomasfire commented Mar 3, 2023 •

edited

Loading

sbourdeauducq Mar 3, 2023 •

edited

Loading

sbourdeauducq commented Mar 3, 2023

thomasfire commented Mar 3, 2023

mbirtwell left a comment

mbirtwell Mar 3, 2023

mbirtwell Mar 3, 2023

mbirtwell Mar 3, 2023

sbourdeauducq Mar 11, 2023

sbourdeauducq Mar 11, 2023 •

edited

Loading

thomasfire Mar 13, 2023

sbourdeauducq Mar 13, 2023

sbourdeauducq Mar 13, 2023

Add support for default route (IPv4 and IPv6) #2059

Add support for default route (IPv4 and IPv6) #2059

Conversation

thomasfire commented Mar 3, 2023 • edited Loading

ARTIQ Pull Request

Description of Changes

Related Issue

Type of Changes

Testing

Licensing

sbourdeauducq Mar 3, 2023 • edited Loading

Choose a reason for hiding this comment

sbourdeauducq commented Mar 3, 2023

thomasfire commented Mar 3, 2023

mbirtwell left a comment

Choose a reason for hiding this comment

mbirtwell Mar 3, 2023

Choose a reason for hiding this comment

mbirtwell Mar 3, 2023

Choose a reason for hiding this comment

mbirtwell Mar 3, 2023

Choose a reason for hiding this comment

sbourdeauducq Mar 11, 2023

Choose a reason for hiding this comment

sbourdeauducq Mar 11, 2023 • edited Loading

Choose a reason for hiding this comment

thomasfire Mar 13, 2023

Choose a reason for hiding this comment

sbourdeauducq Mar 13, 2023

Choose a reason for hiding this comment

sbourdeauducq Mar 13, 2023

Choose a reason for hiding this comment

thomasfire commented Mar 3, 2023 •

edited

Loading

sbourdeauducq Mar 3, 2023 •

edited

Loading

sbourdeauducq Mar 11, 2023 •

edited

Loading