From 1f9107d044190078dfc884249563d0eb8c28a4d7 Mon Sep 17 00:00:00 2001
From: Joe LeVeque <jleveque@users.noreply.github.com>
Date: Mon, 20 Nov 2017 21:07:28 -0800
Subject: [PATCH] [DHCP relay]: Wait for all interfaces to be assigned IPv4
 addresses before starting relay agent(s) (#1173)

---
 dockers/docker-dhcp-relay/start.sh            |  7 ++++-
 dockers/docker-dhcp-relay/wait_for_intf.sh.j2 | 31 ++++++++++++++-----
 2 files changed, 29 insertions(+), 9 deletions(-)

diff --git a/dockers/docker-dhcp-relay/start.sh b/dockers/docker-dhcp-relay/start.sh
index b53d7e4e23..2ee80c4e33 100755
--- a/dockers/docker-dhcp-relay/start.sh
+++ b/dockers/docker-dhcp-relay/start.sh
@@ -6,7 +6,12 @@ rm -f /var/run/rsyslogd.pid
 # Start rsyslog
 supervisorctl start rsyslogd
 
-# Wait for all interfaces to come up before starting the DHCP relay agent(s)
+# Wait for all interfaces to come up and be assigned IPv4 addresses before
+# starting the DHCP relay agent(s). If an interface the relay should listen
+# on is down, the relay agent will not start. If an interface the relay should
+# listen on is up but does not have an IP address assigned when the relay
+# agent starts, it will not listen or send on that interface for the lifetime
+# of the process.
 /usr/bin/wait_for_intf.sh
 
 # Start the DHCP relay agent(s)
diff --git a/dockers/docker-dhcp-relay/wait_for_intf.sh.j2 b/dockers/docker-dhcp-relay/wait_for_intf.sh.j2
index 1524b32213..037dc66ead 100644
--- a/dockers/docker-dhcp-relay/wait_for_intf.sh.j2
+++ b/dockers/docker-dhcp-relay/wait_for_intf.sh.j2
@@ -1,27 +1,42 @@
 #!/usr/bin/env bash
 
-function wait_until_iface_exists
+function wait_until_iface_ready
 {
     IFACE=$1
 
-    echo "Waiting for interface ${IFACE}..."
+    echo "Waiting until interface $IFACE is up..."
 
     # Wait for the interface to come up (i.e., 'ip link show' returns 0)
-    until ip link show $IFACE > /dev/null 2>&1; do
+    until ip link show dev $IFACE up > /dev/null 2>&1; do
         sleep 1
     done
 
-    echo "Interface ${IFACE} is created"
+    echo "Interface $IFACE is up"
+
+    echo "Waiting until interface $IFACE has an IPv4 address..."
+
+    # Wait until the interface gets assigned an IPv4 address
+    while true; do
+        IP=$(ip -4 addr show dev $IFACE | grep "inet " | awk '{ print $2 }' | cut -d '/' -f1)
+
+        if [ -n "$IP" ]; then
+            break
+        fi
+
+        sleep 1
+    done
+
+    echo "Interface $IFACE is configured with IP $IP"
 }
 
 
-# Wait for all interfaces to come up before starting the DHCP relay
+# Wait for all interfaces to come up and have IPv4 addresses assigned
 {% for (name, prefix) in INTERFACE %}
-wait_until_iface_exists {{ name }}
+wait_until_iface_ready {{ name }}
 {% endfor %}
 {% for (name, prefix) in VLAN_INTERFACE %}
-wait_until_iface_exists {{ name }}
+wait_until_iface_ready {{ name }}
 {% endfor %}
 {% for (name, prefix) in PORTCHANNEL_INTERFACE %}
-wait_until_iface_exists {{ name }}
+wait_until_iface_ready {{ name }}
 {% endfor %}