Merge pull request #977 from david-cermak/feat/mosq_linux_build

david-cermak · web-flow · commit 68c22558b3a4 · 2026-01-06T14:53:58.000+01:00
[mosq]: Add support for linux build
diff --git a/.github/workflows/examples_build-host-test.yml b/.github/workflows/examples_build-host-test.yml
@@ -53,15 +53,22 @@ jobs:
     steps:
       - name: Checkout esp-protocols
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
       - name: Build with IDF-${{ matrix.idf_ver }}
         shell: bash
         run: |
           . ${GITHUB_WORKSPACE}/ci/config_env.sh
           . ${IDF_PATH}/export.sh
           python -m pip install idf-build-apps
           python ./ci/build_apps.py examples/mqtt -l -t linux -r 'sdkconfig.ci'
+          ./ci/test_broker/run.sh
+          sleep 1
+          failed=0
           timeout 5 ./examples/mqtt/build_linux/esp_mqtt_demo.elf | tee test.log  || true
-          grep 'MQTT_EVENT_DATA' test.log
+          grep 'MQTT_EVENT_DATA' test.log || failed=1
+          pkill -f 'broker.elf' || true
+          exit $failed
 
   run_on_target:
     # Skip running on forks since it won't have access to secrets
diff --git a/ci/test_broker/run.sh b/ci/test_broker/run.sh
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+BROKER_PATH=components/mosquitto/examples/broker
+SCRIPT_DIR=$(dirname $0)
+cp ${SCRIPT_DIR}/sdkconfig.broker ${BROKER_PATH}/sdkconfig.broker
+idf.py -B build -DSDKCONFIG=sdkconfig.broker -C ${BROKER_PATH} build
+
+./build/broker.elf &
+export MOSQ_PID=$!
+echo "Broker started with PID ${MOSQ_PID}"
diff --git a/ci/test_broker/sdkconfig.broker b/ci/test_broker/sdkconfig.broker
@@ -0,0 +1,5 @@
+CONFIG_IDF_TARGET="linux"
+CONFIG_EXAMPLE_BROKER_PORT=1234
+CONFIG_EXAMPLE_BROKER_RUN_LOCAL_MQTT_CLIENT=n
+CONFIG_EXAMPLE_BROKER_WITH_TLS=n
+CONFIG_ESP_EVENT_POST_FROM_ISR=n
diff --git a/components/mosquitto/.cz.yaml b/components/mosquitto/.cz.yaml
@@ -3,6 +3,6 @@ commitizen:
   bump_message: 'bump(mosq): $current_version -> $new_version'
   pre_bump_hooks: python ../../ci/changelog.py mosquitto
   tag_format: mosq-v$version
-  version: 2.0.20~5
+  version: 2.0.20~6
   version_files:
   - idf_component.yml
diff --git a/components/mosquitto/CHANGELOG.md b/components/mosquitto/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## [2.0.20~6](https://github.com/espressif/esp-protocols/commits/mosq-v2.0.20_6)
+
+### Features
+
+- Add support for linux build ([58380585](https://github.com/espressif/esp-protocols/commit/58380585))
+
+### Bug Fixes
+
+- Fix mosquitto build on latest master ([ebc1258e](https://github.com/espressif/esp-protocols/commit/ebc1258e))
+- Fix build with the new picolibc ([dc68bf87](https://github.com/espressif/esp-protocols/commit/dc68bf87))
+
 ## [2.0.20~5](https://github.com/espressif/esp-protocols/commits/mosq-v2.0.20_5)
 
 ### Features
diff --git a/components/mosquitto/CMakeLists.txt b/components/mosquitto/CMakeLists.txt
@@ -1,3 +1,5 @@
+idf_build_get_property(idf_target IDF_TARGET)
+
 set(m_dir mosquitto)
 set(m_src_dir ${m_dir}/src)
 set(m_incl_dir ${m_dir}/include)
@@ -94,6 +96,10 @@ target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format")
 # without modifying upstream code
 target_link_options(${COMPONENT_LIB} INTERFACE "-Wl,--wrap=mosquitto_unpwd_check")
 
+if(${idf_target} STREQUAL "linux")
+    target_link_options(${COMPONENT_LIB} INTERFACE "-Wl,--wrap=main")
+endif()
+
 # Some mosquitto source unconditionally define `_GNU_SOURCE` which collides with IDF build system
 # producing warning: "_GNU_SOURCE" redefined
 # This workarounds this issue by undefining the macro for the selected files
diff --git a/components/mosquitto/examples/broker/CMakeLists.txt b/components/mosquitto/examples/broker/CMakeLists.txt
@@ -3,4 +3,11 @@
 cmake_minimum_required(VERSION 3.16)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+
+if("${IDF_TARGET}" STREQUAL "linux")
+    list(APPEND EXTRA_COMPONENT_DIRS "../../../../common_components/linux_compat")
+endif()
+
+idf_build_set_property(MINIMAL_BUILD ON)
+
 project(broker)
diff --git a/components/mosquitto/examples/broker/main/example_broker.c b/components/mosquitto/examples/broker/main/example_broker.c
@@ -13,7 +13,7 @@
 #include "mosq_broker.h"
 #include "protocol_examples_common.h"
 
-const static char *TAG = "mqtt_broker";
+__attribute__((unused)) const static char *TAG = "mqtt_broker";
 
 /* Basic auth credentials for the example */
 #define EXAMPLE_USERNAME "testuser"
diff --git a/components/mosquitto/examples/broker/main/idf_component.yml b/components/mosquitto/examples/broker/main/idf_component.yml
@@ -8,3 +8,6 @@ dependencies:
     rules:
     - if: idf_version >=6.0
       version: ^1.0.0
+  espressif/sock_utils:
+    version: '*'
+    override_path: '../../../../sock_utils'
diff --git a/components/mosquitto/idf_component.yml b/components/mosquitto/idf_component.yml
@@ -1,4 +1,4 @@
-version: "2.0.20~5"
+version: "2.0.20~6"
 url: https://github.com/espressif/esp-protocols/tree/master/components/mosquitto
 description: The component provides a simple ESP32 port of mosquitto broker
 dependencies:
diff --git a/components/mosquitto/port/broker.c b/components/mosquitto/port/broker.c
@@ -9,6 +9,8 @@
 #include "mosquitto_broker_internal.h"
 #include "memory_mosq.h"
 #include "mosq_broker.h"
+#include <time.h>
+#include <sys/time.h>
 
 static struct mosquitto__listener_sock *listensock = NULL;
 static int listensock_count = 0;
diff --git a/components/mosquitto/port/config.c b/components/mosquitto/port/config.c
@@ -14,6 +14,7 @@
 #include "utlist.h"
 #include "lib_load.h"
 #include "syslog.h"
+#include <limits.h>
 #include "sdkconfig.h"
 
 
@@ -244,3 +245,13 @@ pid_t fork(void)
     abort();
     return 0;
 }
+
+#ifdef CONFIG_IDF_TARGET_LINUX
+extern void app_main(void);
+
+int __wrap_main(int argc, char *argv[])
+{
+    app_main();
+    return 0;
+}
+#endif
diff --git a/components/mosquitto/port/mosq_time.c b/components/mosquitto/port/mosq_time.c
@@ -8,7 +8,7 @@
 
 #include <time.h>
 #include "time_mosq.h"
-
+#include "esp_err.h"
 #include "esp_timer.h"
 
 void mosquitto_time_init(void)
diff --git a/components/mosquitto/port/priv_include/config.h b/components/mosquitto/port/priv_include/config.h
@@ -23,4 +23,4 @@
 #define isspace(__c) (__ctype_lookup((int)__c)&_S)
 #endif
 
-#define VERSION "v2.0.20~5"
+#define VERSION "v2.0.20~6"
diff --git a/components/mosquitto/port/priv_include/sys/syslog.h b/components/mosquitto/port/priv_include/sys/syslog.h
@@ -6,8 +6,6 @@
 #pragma once
 
 
-#define EAI_SYSTEM      11  /* system error returned in errno */
-
 #include "esp_log.h"
 #define LOG_EMERG  (0)
 #define LOG_ALERT  (1)
@@ -30,6 +28,5 @@
 
 #define syslog(sev, format, ... ) ESP_LOG_LEVEL_LOCAL(sev-2,   "mosquitto", format, ##__VA_ARGS__)
 
-#define gai_strerror(x) "gai_strerror() not supported"
 #define openlog(a, b, c)
 #define closelog()
diff --git a/components/mosquitto/port/signals.c b/components/mosquitto/port/signals.c
@@ -6,8 +6,11 @@
  * SPDX-FileContributor: 2024 Espressif Systems (Shanghai) CO LTD
  */
 #include "signal.h"
+#include "sdkconfig.h"
 
-int sigprocmask (int, const sigset_t *, sigset_t *)
+#ifndef CONFIG_IDF_TARGET_LINUX
+int sigprocmask(int, const sigset_t *, sigset_t *)
 {
     return 0;
 }
+#endif
diff --git a/components/sock_utils/CMakeLists.txt b/components/sock_utils/CMakeLists.txt
@@ -1,3 +1,11 @@
+idf_build_get_property(idf_target IDF_TARGET)
+
+if(${idf_target} STREQUAL "linux" AND NOT SOCK_UTILS_HOST_TESTS)
+     # This component is no-op for linux simulator
+    idf_component_register(PRIV_REQUIRES lwip esp_netif)
+    return()
+endif()
+
 idf_component_register(SRCS "src/getnameinfo.c"
                             "src/ifaddrs.c"
                             "src/gai_strerror.c"
diff --git a/components/sock_utils/test/host/CMakeLists.txt b/components/sock_utils/test/host/CMakeLists.txt
@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.16)
 
 set(COMPONENTS main)
-
+set(SOCK_UTILS_HOST_TESTS 1)    # Force linux build of sock_utils component
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 
 project(sock_utils_host_test)
diff --git a/examples/mqtt/sdkconfig.ci b/examples/mqtt/sdkconfig.ci
@@ -1,2 +1,2 @@
 # CONFIG_ESP_EVENT_POST_FROM_ISR is not set
-CONFIG_BROKER_URL="mqtt://${CI_MQTT_BROKER_URI}"
+CONFIG_BROKER_URL="mqtt://127.0.0.1:1234"

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: "2.0.20~5"`
	`1`	`+version: "2.0.20~6"`
`2`	`2`	`url: https://github.com/espressif/esp-protocols/tree/master/components/mosquitto`
`3`	`3`	`description: The component provides a simple ESP32 port of mosquitto broker`
`4`	`4`	`dependencies:`