fix(mdns): Host test with IDFv5.1

Author: david-cermak

.github/workflows/host-test.yml

@@ -3,8 +3,8 @@ name: Host test
 on: [push, pull_request]
 
 jobs:
-  host_test:
-    name: Build and Test on Host
+  host_test_esp_modem:
+    name: esp-modem Build and Test on Host
     runs-on: ubuntu-20.04
     container: espressif/idf:release-v4.3
     env:
@@ -38,3 +38,23 @@ jobs:
         if: always()
         with:
           files: esp-protocols/components/esp_modem/test/host_test/junit.xml
+
+  host_test_mdns:
+    name: mdns Build and Test on Host
+    runs-on: ubuntu-20.04
+    container: espressif/idf:latest
+
+    steps:
+      - name: Checkout esp-protocols
+        uses: actions/checkout@master
+        with:
+          path: esp-protocols
+
+      - name: Build and Test
+        shell: bash
+        run: |
+          apt-get update && apt-get install -y dnsutils gcc g++
+          . ${IDF_PATH}/export.sh
+          cd $GITHUB_WORKSPACE/esp-protocols/components/mdns/tests/host_test
+          idf.py build
+          ./build/mdns_host.elf & dig +short -p 5353 @224.0.0.251 myesp.local

components/mdns/CMakeLists.txt

@@ -6,7 +6,7 @@ endif()
 
 idf_build_get_property(target IDF_TARGET)
 if(${target} STREQUAL "linux")
-    set(dependencies esp_system_protocols_linux)
+    set(dependencies esp_event esp_netif_linux esp_timer_linux esp_system)
     set(srcs "mdns.c" ${MDNS_NETWORKING})
 else()
     set(dependencies lwip console esp_netif)
@@ -22,6 +22,11 @@ idf_component_register(
         PRIV_REQUIRES ${private_dependencies})
 target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format")
 
+if(${target} STREQUAL "linux")
+    target_link_libraries(${COMPONENT_LIB} PRIVATE "-lbsd")
+endif()
+
+
 if(CONFIG_ETH_ENABLED)
     idf_component_optional_requires(PRIVATE esp_eth)
 endif()

components/mdns/Kconfig

@@ -81,6 +81,20 @@ menu "mDNS"
             This option creates a new thread to serve receiving packets (TODO).
             This option uses additional N sockets, where N is number of interfaces.
 
+    config MDNS_SKIP_SUPPRESSING_OWN_QUERIES
+        bool "Skip suppressing our own packets"
+        default n
+        help
+            Enable only if the querier and the responder share the same IP address.
+            This usually happens in test mode, where we may run multiple instances of
+            responders/queriers on the same interface.
+
+    config MDNS_ENABLE_DEBUG_PRINTS
+        bool "Enable debug prints of mDNS packets"
+        default n
+        help
+            Enable for the library to log received and sent mDNS packets to stdout.
+
     config MDNS_MULTIPLE_INSTANCE
         bool "Multiple instances under the same service type"
         default y

components/mdns/mdns.c

@@ -17,10 +17,15 @@
 #include "mdns_networking.h"
 #include "esp_log.h"
 #include "esp_random.h"
-#if CONFIG_ETH_ENABLED
+#if __has_include("bsd/string.h")
+#include "bsd/string.h"
+#endif
+#if CONFIG_ETH_ENABLED && CONFIG_MDNS_PREDEF_NETIF_ETH
 #include "esp_eth.h"
 #endif
+#if CONFIG_MDNS_PREDEF_NETIF_STA || CONFIG_MDNS_PREDEF_NETIF_AP
 #include "esp_wifi.h"
+#endif
 
 
 #ifdef MDNS_ENABLE_DEBUG
@@ -1102,10 +1107,11 @@ static uint16_t _mdns_append_question(uint8_t *packet, uint16_t *index, mdns_out
     const char *str[6];
     uint8_t str_index = 0;
     uint8_t part_length;
+    char *host_dup = NULL;  // need to duplicate host-name for some cases
     if (q->host && strstr(q->host, "in-addr")) {
-        char * host = strdup(q->host);
+        host_dup = strdup(q->host);
         char *rest = NULL;
-        for (char *p = strtok_r(host,".", &rest); p != NULL; p = strtok_r(NULL, ".", &rest)) {
+        for (char *p = strtok_r(host_dup, ".", &rest); p != NULL; p = strtok_r(NULL, ".", &rest)) {
             str[str_index++] = p;
         }
         if (q->domain) {
@@ -1131,11 +1137,13 @@ static uint16_t _mdns_append_question(uint8_t *packet, uint16_t *index, mdns_out
 
     part_length = _mdns_append_fqdn(packet, index, str, str_index, MDNS_MAX_PACKET_SIZE);
     if (!part_length) {
+        free(host_dup);
         return 0;
     }
 
     part_length += _mdns_append_u16(packet, index, q->type);
     part_length += _mdns_append_u16(packet, index, q->unicast ? 0x8001 : 0x0001);
+    free(host_dup);
     return part_length;
 }
 
@@ -1213,17 +1221,17 @@ static uint8_t _mdns_append_host_answer(uint8_t *packet, uint16_t *index, mdns_h
     return num_records;
 }
 
-static uint16_t _mdns_append_rev_ptr_record(uint8_t * packet, uint16_t * index, const char* name, bool flush, bool bye)
+static uint16_t _mdns_append_rev_ptr_record(uint8_t *packet, uint16_t *index, const char *name, bool flush, bool bye)
 {
-    const char * str[6];
+    const char *str[6];
     int i = 0;
 
     if (strstr(name, "in-addr") == NULL) {
         return 0;
     }
-    char * host = strdup(name);
+    char *host = strdup(name);
     char *rest = NULL;
-    for (char *p = strtok_r(host,".", &rest); p != NULL; p = strtok_r(NULL, ".", &rest)) {
+    for (char *p = strtok_r(host, ".", &rest); p != NULL; p = strtok_r(NULL, ".", &rest)) {
         str[i++] = p;
     }
     str[i++] = "arpa";
@@ -1236,7 +1244,7 @@ static uint16_t _mdns_append_rev_ptr_record(uint8_t * packet, uint16_t * index,
     }
     record_length += part_length;
 
-    part_length = _mdns_append_type(packet, index, MDNS_ANSWER_PTR, false, bye?0:MDNS_ANSWER_PTR_TTL);
+    part_length = _mdns_append_type(packet, index, MDNS_ANSWER_PTR, false, bye ? 0 : MDNS_ANSWER_PTR_TTL);
     if (!part_length) {
         return 0;
     }
@@ -1258,7 +1266,7 @@ static uint16_t _mdns_append_rev_ptr_record(uint8_t * packet, uint16_t * index,
 }
 
 
-static uint8_t _mdns_append_reverse_ptr_record(uint8_t *packet, uint16_t *index, const char* name, bool flush, bool bye)
+static uint8_t _mdns_append_reverse_ptr_record(uint8_t *packet, uint16_t *index, const char *name, bool flush, bool bye)
 {
     uint8_t appended_answers = 0;
 
@@ -1711,9 +1719,9 @@ static bool _mdns_create_answer_from_service(mdns_tx_packet_t *packet, mdns_serv
     return true;
 }
 
-static bool _mdns_create_answer_from_reverse_query(mdns_tx_packet_t * packet, const char * hostname, bool send_flush)
+static bool _mdns_create_answer_from_reverse_query(mdns_tx_packet_t *packet, const char *hostname, bool send_flush)
 {
-    mdns_host_item_t * host = mdns_get_host_item(hostname);
+    mdns_host_item_t *host = mdns_get_host_item(hostname);
     if (!_mdns_alloc_answer(&packet->answers, MDNS_TYPE_PTR, NULL, host, send_flush, false)) {
         return false;
     }
@@ -3394,6 +3402,7 @@ void mdns_parse_packet(mdns_rx_packet_t *packet)
     mdns_debug_packet(data, len);
 #endif
 
+#ifndef CONFIG_MDNS_SKIP_SUPPRESSING_OWN_QUERIES
     // Check if the packet wasn't sent by us
     if (packet->ip_protocol == MDNS_IP_PROTOCOL_V4) {
         esp_netif_ip_info_t if_ip_info;
@@ -3410,6 +3419,7 @@ void mdns_parse_packet(mdns_rx_packet_t *packet)
         }
 #endif
     }
+#endif
 
     // Check for the minimum size of mdns packet
     if (len <=  MDNS_HEAD_ADDITIONAL_OFFSET) {
@@ -3977,6 +3987,7 @@ static inline void post_mdns_announce_pcb(mdns_predef_if_t preset_if, mdns_ip_pr
     mdns_post_custom_action_tcpip_if(mdns_if_from_preset_if(preset_if), protocol == MDNS_IP_PROTOCOL_V4 ? MDNS_EVENT_ANNOUNCE_IP4 : MDNS_EVENT_ANNOUNCE_IP6);
 }
 
+#if CONFIG_MDNS_PREDEF_NETIF_STA || CONFIG_MDNS_PREDEF_NETIF_AP || CONFIG_MDNS_PREDEF_NETIF_ETH
 void mdns_preset_if_handle_system_event(void *arg, esp_event_base_t event_base,
                                         int32_t event_id, void *event_data)
 {
@@ -4054,6 +4065,7 @@ void mdns_preset_if_handle_system_event(void *arg, esp_event_base_t event_base,
         }
     }
 }
+#endif /* CONFIG_MDNS_PREDEF_NETIF_STA || CONFIG_MDNS_PREDEF_NETIF_AP || CONFIG_MDNS_PREDEF_NETIF_ETH */
 
 /*
  * MDNS Search
@@ -6151,19 +6163,19 @@ void mdns_debug_packet(const uint8_t *data, size_t len)
     _mdns_dbg_printf("Packet[%u]: ", t);
 
     header.id = _mdns_read_u16(data, MDNS_HEAD_ID_OFFSET);
-    header.flags.value = _mdns_read_u16(data, MDNS_HEAD_FLAGS_OFFSET);
+    header.flags = _mdns_read_u16(data, MDNS_HEAD_FLAGS_OFFSET);
     header.questions = _mdns_read_u16(data, MDNS_HEAD_QUESTIONS_OFFSET);
     header.answers = _mdns_read_u16(data, MDNS_HEAD_ANSWERS_OFFSET);
     header.servers = _mdns_read_u16(data, MDNS_HEAD_SERVERS_OFFSET);
     header.additional = _mdns_read_u16(data, MDNS_HEAD_ADDITIONAL_OFFSET);
 
     _mdns_dbg_printf("%s",
-                     (header.flags.value == MDNS_FLAGS_QR_AUTHORITATIVE) ? "AUTHORITATIVE\n" :
-                     (header.flags.value == MDNS_FLAGS_DISTRIBUTED) ? "DISTRIBUTED\n" :
-                     (header.flags.value == 0) ? "\n" : " "
+                     (header.flags == MDNS_FLAGS_QR_AUTHORITATIVE) ? "AUTHORITATIVE\n" :
+                     (header.flags == MDNS_FLAGS_DISTRIBUTED) ? "DISTRIBUTED\n" :
+                     (header.flags == 0) ? "\n" : " "
                     );
-    if (header.flags.value && header.flags.value != MDNS_FLAGS_QR_AUTHORITATIVE) {
-        _mdns_dbg_printf("0x%04X\n", header.flags.value);
+    if (header.flags && header.flags != MDNS_FLAGS_QR_AUTHORITATIVE) {
+        _mdns_dbg_printf("0x%04X\n", header.flags);
     }
 
     if (header.questions) {

components/mdns/private_include/mdns_private.h

@@ -14,10 +14,10 @@
 #include "freertos/queue.h"
 #include "freertos/semphr.h"
 #include "esp_timer.h"
+#include "esp_system.h"
 
-//#define MDNS_ENABLE_DEBUG
-
-#ifdef MDNS_ENABLE_DEBUG
+#ifdef CONFIG_MDNS_ENABLE_DEBUG_PRINTS
+#define MDNS_ENABLE_DEBUG
 #define _mdns_dbg_printf(...) printf(__VA_ARGS__)
 #endif
 

components/mdns/tests/host_test/CMakeLists.txt

@@ -1,5 +1,7 @@
 cmake_minimum_required(VERSION 3.5)
 
+set(EXTRA_COMPONENT_DIRS "../..")
+
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(COMPONENTS main)
+set(COMPONENTS main esp_netif_linux)
 project(mdns_host)

components/mdns/tests/host_test/README.md

@@ -1,7 +1,10 @@
 # Setup dummy network interfaces
+
+Note: Set two addresses so we could use one as source and another as destination
 ```
 sudo ip link add eth2 type dummy
 sudo ip addr add 192.168.1.200/24 dev eth2
+sudo ip addr add 192.168.1.201/24 dev eth2
 sudo ip link set eth2 up
 sudo ifconfig eth2 multicast
 ```
@@ -12,6 +15,11 @@ sudo ifconfig eth2 multicast
 dig +short -b 192.168.1.200 -p 5353 @224.0.0.251 myesp.local
 ```
 
+or a reverse query:
+```
+dig +short -b 192.168.2.200 -p 5353 @224.0.0.251 -x 192.168.1.200
+```
+
 # Run avahi to browse services
 
 Avahi needs the netif to have the "multicast" flag set

components/mdns/tests/host_test/components/esp_event_mock/CMakeLists.txt renamed to components/mdns/tests/host_test/components/esp_event/CMakeLists.txt

@@ -1,3 +1,3 @@
 idf_component_register(SRCS esp_event_mock.c
                        INCLUDE_DIRS include
-                       REQUIRES esp_system_protocols_linux)
+                       REQUIRES)

components/mdns/tests/host_test/components/esp_event_mock/esp_event_mock.c renamed to components/mdns/tests/host_test/components/esp_event/esp_event_mock.c

@@ -8,16 +8,12 @@
 #include "stdbool.h"
 #include "esp_err.h"
 #include "esp_event_base.h"
-#include "bsd_strings.h"
+//#include "bsd_strings.h"
 
-#define ESP_EVENT_DECLARE_BASE(x)
-#define ESP_EVENT_ANY_ID       (-1)
 
-typedef void *esp_event_base_t;
-typedef void *system_event_t;
 
-const char *WIFI_EVENT;
-const char *IP_EVENT;
+//const char *WIFI_EVENT;
+//const char *IP_EVENT;
 
 esp_err_t esp_event_handler_register(const char *event_base, int32_t event_id, void *event_handler, void *event_handler_arg);