Update PoE implementation

Add build flag to disable PoE feature (enabled by default).
Add cleanup of PoE database during config reload.
Update poesyncd-platform.sh to disable the POESYNCD feature
if the device is missing the poe_config.json file
Fix poesyncd.service using the wrong file path.

Signed-off-by: Serhiy Boiko <[email protected]>
Change-Id: I58d836fd89d9d80a56d5b737fc996b2b5fe23399

Author: SerhiyBoikoPLV

Makefile.work

@@ -540,6 +540,7 @@ SONIC_BUILD_INSTRUCTION :=  $(MAKE) \
                            INCLUDE_DHCP_RELAY=$(INCLUDE_DHCP_RELAY) \
                            INCLUDE_DHCP_SERVER=$(INCLUDE_DHCP_SERVER) \
                            INCLUDE_MACSEC=$(INCLUDE_MACSEC) \
+                           INCLUDE_POE=$(INCLUDE_POE) \
                            INCLUDE_ICCPD=$(INCLUDE_ICCPD) \
                            SONIC_INCLUDE_RESTAPI=$(INCLUDE_RESTAPI) \
                            SONIC_INCLUDE_MUX=$(INCLUDE_MUX) \

files/build_templates/init_cfg.json.j2

@@ -74,7 +74,7 @@
 {% do features.append(("dhcp_relay", "{% if not (DEVICE_METADATA is defined and DEVICE_METADATA['localhost'] is defined and DEVICE_METADATA['localhost']['type'] is defined and DEVICE_METADATA['localhost']['type'] is not in ['ToRRouter', 'EPMS', 'MgmtTsToR', 'MgmtToRRouter', 'BmcMgmtToRRouter']) %}enabled{% else %}disabled{% endif %}", false, "enabled")) %}
 {%- if include_dhcp_server == "y" %}{% do features.append(("dhcp_server", "disabled", false, "enabled")) %}{% endif %}
 {%- if sonic_asic_platform == "vs" %}{% do features.append(("gbsyncd", "enabled", false, "enabled")) %}{% endif %}
-{%- if sonic_asic_platform == "vs" %}{% do features.append(("poesyncd", "enabled", false, "enabled")) %}{% endif %}
+{%- if include_poe == "y" %}{% do features.append(("poesyncd", "enabled", false, "enabled")) %}{% endif %}
 {%- if include_iccpd == "y" %}{% do features.append(("iccpd", "disabled", false, "enabled")) %}{% endif %}
 {%- if include_mgmt_framework == "y" %}{% do features.append(("mgmt-framework", "enabled", true, "enabled")) %}{% endif %}
 {%- if include_mux == "y" %}{% do features.append(("mux", "{% if 'subtype' in DEVICE_METADATA['localhost'] and DEVICE_METADATA['localhost']['subtype'] == 'DualToR' %}enabled{% else %}always_disabled{% endif %}", false, "enabled")) %}{% endif %}

files/build_templates/per_namespace/poesyncd.service.j2

@@ -8,15 +8,13 @@ BindsTo=sonic.target
 After=sonic.target
 
 [Service]
-User={{ sonicadmin_user }}
+User=root
 Environment=sonic_asic_platform={{ sonic_asic_platform }}
 Environment=poesyncd_platform={{ docker_container_name }}
 ExecCondition=/usr/bin/{{docker_container_name}}-platform.sh
-ExecStartPre=/usr/bin/{{docker_container_name}}.sh start{% if multi_instance == 'true' %} %i{% endif %}
-ExecStart=/usr/bin/{{docker_container_name}}.sh wait{% if multi_instance == 'true' %} %i{% endif %}
-ExecStop=/usr/bin/{{docker_container_name}}.sh stop{% if multi_instance == 'true' %} %i{% endif %}
-Restart=always
-RestartSec=30
+ExecStartPre=/usr/local/bin/{{docker_container_name}}.sh start{% if multi_instance == 'true' %} %i{% endif %}
+ExecStart=/usr/local/bin/{{docker_container_name}}.sh wait{% if multi_instance == 'true' %} %i{% endif %}
+ExecStop=/usr/local/bin/{{docker_container_name}}.sh stop{% if multi_instance == 'true' %} %i{% endif %}
 
 [Install]
 WantedBy=sonic.target

files/build_templates/sonic_debian_extension.j2

@@ -1011,6 +1011,7 @@ sudo LANG=C cp $SCRIPTS_DIR/syncd.sh $FILESYSTEM_ROOT/usr/local/bin/syncd.sh
 sudo LANG=C cp $SCRIPTS_DIR/syncd_common.sh $FILESYSTEM_ROOT/usr/local/bin/syncd_common.sh
 sudo LANG=C cp $SCRIPTS_DIR/gbsyncd.sh $FILESYSTEM_ROOT/usr/local/bin/gbsyncd.sh
 sudo LANG=C cp $SCRIPTS_DIR/gbsyncd-platform.sh $FILESYSTEM_ROOT/usr/bin/gbsyncd-platform.sh
+sudo LANG=C cp $SCRIPTS_DIR/poesyncd.sh $FILESYSTEM_ROOT/usr/local/bin/poesyncd.sh
 sudo LANG=C cp $SCRIPTS_DIR/poesyncd-platform.sh $FILESYSTEM_ROOT/usr/bin/poesyncd-platform.sh
 sudo LANG=C cp $SCRIPTS_DIR/bgp.sh $FILESYSTEM_ROOT/usr/local/bin/bgp.sh
 sudo LANG=C cp $SCRIPTS_DIR/teamd.sh $FILESYSTEM_ROOT/usr/local/bin/teamd.sh

files/scripts/poesyncd-platform.sh

@@ -1,27 +1,12 @@
 #!/bin/bash
-# Check the poesyncd platform defined on the device matching the service,
-# or otherwise skip starting the service
 
-SERVICE="$poesyncd_platform"
 PLATFORM=${PLATFORM:-`sonic-cfggen -H -v DEVICE_METADATA.localhost.platform`}
-DEVPATH="/usr/share/sonic/device"
-CONFIGFILE="${DEVPATH}/${PLATFORM}/poesyncd.ini"
+HWSKU=${HWSKU:-`sonic-cfggen -d -v DEVICE_METADATA.localhost.hwsku`}
+POECONFIG="/usr/share/sonic/device/${PLATFORM}/${HWSKU}/poe_config.json"
 
-# Skip checking the service for vs
-[ "$sonic_asic_platform" = vs ] && exit 0
-
-if [ ! -f "$CONFIGFILE" ]; then
+if [ ! -f "$POECONFIG" ]; then
+    sudo config feature state poesyncd disabled
     exit 1
 fi
 
-while IFS="=" read -r key value; do
-    case "$key" in
-        platform)
-            if [[ "$value" = "$SERVICE"* ]]; then
-                exit 0
-            fi
-            ;;
-    esac
-done < "$CONFIGFILE"
-
-exit 1
+exit 0

files/scripts/poesyncd.sh

@@ -0,0 +1,83 @@
+#!/bin/bash
+
+. /usr/local/bin/syncd_common.sh
+
+function startplatform() {
+
+    declare -A DbCliArray=([0]=$SONIC_GLOBAL_DB_CLI [1]=$SONIC_DB_CLI)
+    for DB_CLI in "${DbCliArray[@]}"; do
+        # Add poesyncd to FEATURE table, if not in. It did have same config as syncd.
+        if [ -z $($DB_CLI CONFIG_DB HGET 'FEATURE|poesyncd' state) ]; then
+            local CMD="local r=redis.call('DUMP', KEYS[1]); redis.call('RESTORE', KEYS[2], 0, r)"
+            $DB_CLI CONFIG_DB EVAL "$CMD" 2 'FEATURE|syncd' 'FEATURE|poesyncd'
+            $DB_CLI CONFIG_DB EVAL "$CMD" 2 'SYSLOG_CONFIG_FEATURE|syncd' 'SYSLOG_CONFIG_FEATURE|poesyncd'
+        fi
+    done
+}
+
+function waitplatform() {
+    :
+}
+
+function stopplatform1() {
+    if ! docker top poesyncd$DEV | grep -q /usr/bin/syncd; then
+        debug "syncd process in container poesyncd$DEV is not running"
+        return
+    fi
+
+    # Invoke platform specific pre shutdown routine.
+    PLATFORM=`$SONIC_DB_CLI CONFIG_DB hget 'DEVICE_METADATA|localhost' platform`
+    PLATFORM_PRE_SHUTDOWN="/usr/share/sonic/device/$PLATFORM/plugins/poesyncd_request_pre_shutdown"
+    [ -f $PLATFORM_PRE_SHUTDOWN ] && \
+        /usr/bin/docker exec -i poesyncd$DEV /usr/share/sonic/platform/plugins/poesyncd_request_pre_shutdown --${TYPE}
+
+    debug "${TYPE} shutdown syncd process in container poesyncd$DEV ..."
+    /usr/bin/docker exec -i poesyncd$DEV /usr/bin/syncd_request_shutdown -g 1 -x /usr/share/sonic/hwsku/context_config.json --${TYPE}
+
+    # wait until syncd quits gracefully or force syncd to exit after
+    # waiting for 20 seconds
+    start_in_secs=${SECONDS}
+    end_in_secs=${SECONDS}
+    timer_threshold=20
+    while docker top poesyncd$DEV | grep -q /usr/bin/syncd \
+            && [[ $((end_in_secs - start_in_secs)) -le $timer_threshold ]]; do
+        sleep 0.1
+        end_in_secs=${SECONDS}
+    done
+
+    if [[ $((end_in_secs - start_in_secs)) -gt $timer_threshold ]]; then
+        debug "syncd process in container poesyncd$DEV did not exit gracefully"
+    fi
+
+    /usr/bin/docker exec -i poesyncd$DEV /bin/sync
+    debug "Finished ${TYPE} shutdown syncd process in container poesyncd$DEV ..."
+}
+
+function stopplatform2() {
+    :
+}
+
+OP=$1
+DEV=$2
+
+SERVICE="$poesyncd_platform"
+PEER="swss"
+DEBUGLOG="/tmp/swss-$SERVICE-debug$DEV.log"
+LOCKFILE="/tmp/swss-$SERVICE-lock$DEV"
+NAMESPACE_PREFIX="asic"
+SONIC_GLOBAL_DB_CLI="sonic-db-cli"
+SONIC_DB_CLI="sonic-db-cli"
+if [ "$DEV" ]; then
+    NET_NS="$NAMESPACE_PREFIX$DEV" #name of the network namespace
+    SONIC_DB_CLI="sonic-db-cli -n $NET_NS"
+fi
+
+case "$1" in
+    start|wait|stop)
+        $1
+        ;;
+    *)
+        echo "Usage: $0 {start|wait|stop}"
+        exit 1
+        ;;
+esac

files/scripts/swss.sh

@@ -329,7 +329,8 @@ start() {
         $SONIC_DB_CLI GB_ASIC_DB FLUSHDB
         $SONIC_DB_CLI GB_COUNTERS_DB FLUSHDB
         $SONIC_DB_CLI RESTAPI_DB FLUSHDB
-        clean_up_tables STATE_DB "'PORT_TABLE*', 'MGMT_PORT_TABLE*', 'VLAN_TABLE*', 'VLAN_MEMBER_TABLE*', 'LAG_TABLE*', 'LAG_MEMBER_TABLE*', 'INTERFACE_TABLE*', 'MIRROR_SESSION*', 'VRF_TABLE*', 'FDB_TABLE*', 'FG_ROUTE_TABLE*', 'BUFFER_POOL*', 'BUFFER_PROFILE*', 'MUX_CABLE_TABLE*', 'ADVERTISE_NETWORK_TABLE*', 'VXLAN_TUNNEL_TABLE*', 'VNET_ROUTE*', 'MACSEC_PORT_TABLE*', 'MACSEC_INGRESS_SA_TABLE*', 'MACSEC_EGRESS_SA_TABLE*', 'MACSEC_INGRESS_SC_TABLE*', 'MACSEC_EGRESS_SC_TABLE*', 'VRF_OBJECT_TABLE*', 'VNET_MONITOR_TABLE*', 'BFD_SESSION_TABLE*', 'SYSTEM_NEIGH_TABLE*', 'FABRIC_PORT_TABLE*', 'TUNNEL_DECAP_TABLE*', 'TUNNEL_DECAP_TERM_TABLE*'"
+        $SONIC_DB_CLI POE_ASIC_DB FLUSHDB
+        clean_up_tables STATE_DB "'PORT_TABLE*', 'MGMT_PORT_TABLE*', 'VLAN_TABLE*', 'VLAN_MEMBER_TABLE*', 'LAG_TABLE*', 'LAG_MEMBER_TABLE*', 'INTERFACE_TABLE*', 'MIRROR_SESSION*', 'VRF_TABLE*', 'FDB_TABLE*', 'FG_ROUTE_TABLE*', 'BUFFER_POOL*', 'BUFFER_PROFILE*', 'MUX_CABLE_TABLE*', 'ADVERTISE_NETWORK_TABLE*', 'VXLAN_TUNNEL_TABLE*', 'VNET_ROUTE*', 'MACSEC_PORT_TABLE*', 'MACSEC_INGRESS_SA_TABLE*', 'MACSEC_EGRESS_SA_TABLE*', 'MACSEC_INGRESS_SC_TABLE*', 'MACSEC_EGRESS_SC_TABLE*', 'VRF_OBJECT_TABLE*', 'VNET_MONITOR_TABLE*', 'BFD_SESSION_TABLE*', 'SYSTEM_NEIGH_TABLE*', 'FABRIC_PORT_TABLE*', 'TUNNEL_DECAP_TABLE*', 'TUNNEL_DECAP_TERM_TABLE*', 'POE_DEVICE_TABLE*', 'POE_PSE_TABLE*', 'POE_PORT_TABLE*'"
         $SONIC_DB_CLI APPL_STATE_DB FLUSHDB
         clean_up_chassis_db_tables
         rm -rf /tmp/cache

platform/template/docker-poesyncd-base.mk

@@ -15,13 +15,15 @@ $(DOCKER_POESYNCD_BASE)_DBG_DEPENDS += $($(DOCKER_CONFIG_ENGINE_BOOKWORM)_DBG_DE
 
 $(DOCKER_POESYNCD_BASE)_DBG_IMAGE_PACKAGES = $($(DOCKER_CONFIG_ENGINE_BOOKWORM)_DBG_IMAGE_PACKAGES)
 
+ifeq ($(INCLUDE_POE), y)
 SONIC_DOCKER_IMAGES += $(DOCKER_POESYNCD_BASE)
 SONIC_BOOKWORM_DOCKERS += $(DOCKER_POESYNCD_BASE)
 SONIC_INSTALL_DOCKER_IMAGES += $(DOCKER_POESYNCD_BASE)
 
 SONIC_DOCKER_DBG_IMAGES += $(DOCKER_POESYNCD_BASE_DBG)
 SONIC_BOOKWORM_DBG_DOCKERS += $(DOCKER_POESYNCD_BASE_DBG)
 SONIC_INSTALL_DOCKER_DBG_IMAGES += $(DOCKER_POESYNCD_BASE_DBG)
+endif
 
 $(DOCKER_POESYNCD_BASE)_CONTAINER_NAME = poesyncd
 $(DOCKER_POESYNCD_BASE)_RUN_OPT += --privileged -t

rules/config

@@ -182,6 +182,9 @@ INCLUDE_MACSEC = y
 # INCLUDE_GBSYNCD - build docker-gbsyncd-* for gearbox support
 INCLUDE_GBSYNCD ?= y
 
+# INCLUDE_POE - build docker-poesyncd-* for PoE support
+INCLUDE_POE = y
+
 # INCLUDE_TEAMD - build docker-teamd for LAG protocol support
 INCLUDE_TEAMD ?= y
 

slave.mk

@@ -456,6 +456,7 @@ $(info "INCLUDE_KUBERNETES"              : "$(INCLUDE_KUBERNETES)")
 $(info "INCLUDE_KUBERNETES_MASTER"       : "$(INCLUDE_KUBERNETES_MASTER)")
 $(info "INCLUDE_MACSEC"                  : "$(INCLUDE_MACSEC)")
 $(info "INCLUDE_MUX"                     : "$(INCLUDE_MUX)")
+$(info "INCLUDE_POE"                     : "$(INCLUDE_POE)")
 $(info "INCLUDE_TEAMD"                   : "$(INCLUDE_TEAMD)")
 $(info "INCLUDE_ROUTER_ADVERTISER"       : "$(INCLUDE_ROUTER_ADVERTISER)")
 $(info "INCLUDE_BOOTCHART                : "$(INCLUDE_BOOTCHART)")
@@ -1499,6 +1500,7 @@ $(addprefix $(TARGET_PATH)/, $(SONIC_INSTALLERS)) : $(TARGET_PATH)/% : \
 	export include_bootchart="$(INCLUDE_BOOTCHART)"
 	export enable_bootchart="$(ENABLE_BOOTCHART)"
 	export enable_multidb="$(ENABLE_MULTIDB)"
+	export include_poe="$(INCLUDE_POE)"
 	$(foreach docker, $($*_DOCKERS),\
 		export docker_image="$(docker)"
 		export docker_image_name="$(basename $(docker))"