From c295f8e84c93e143323a93be420162521c109a2d Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Tue, 25 Jul 2023 08:39:03 +0000 Subject: [PATCH 01/10] Header fix part 1 --- source/include/FreeRTOS_ARP.h | 2 ++ source/include/FreeRTOS_DHCP.h | 5 ++--- source/include/FreeRTOS_DNS_Globals.h | 2 ++ source/include/FreeRTOS_IP_Private.h | 5 ++++- source/include/FreeRTOS_IP_Utils.h | 3 +++ source/include/FreeRTOS_IPv4.h | 4 ---- source/include/FreeRTOS_Routing.h | 5 ++--- 7 files changed, 15 insertions(+), 11 deletions(-) diff --git a/source/include/FreeRTOS_ARP.h b/source/include/FreeRTOS_ARP.h index 7be3f2f7da..427e8bc244 100644 --- a/source/include/FreeRTOS_ARP.h +++ b/source/include/FreeRTOS_ARP.h @@ -39,6 +39,8 @@ #include "FreeRTOSIPConfigDefaults.h" #include "IPTraceMacroDefaults.h" +#include "FreeRTOS_IP.h" + /*-----------------------------------------------------------*/ /* Miscellaneous structure and definitions. */ /*-----------------------------------------------------------*/ diff --git a/source/include/FreeRTOS_DHCP.h b/source/include/FreeRTOS_DHCP.h index 2dc1ff97a1..0394e64d32 100644 --- a/source/include/FreeRTOS_DHCP.h +++ b/source/include/FreeRTOS_DHCP.h @@ -33,13 +33,12 @@ extern "C" { #endif -#include "FreeRTOS_Sockets.h" -#include "FreeRTOS_Routing.h" - /* Application level configuration options. */ #include "FreeRTOSIPConfig.h" #include "IPTraceMacroDefaults.h" +#include "FreeRTOS_Sockets.h" + #if ( ipconfigUSE_DHCP != 0 ) && ( ipconfigNETWORK_MTU < 586U ) /* DHCP must be able to receive an options field of 312 bytes, the fixed diff --git a/source/include/FreeRTOS_DNS_Globals.h b/source/include/FreeRTOS_DNS_Globals.h index 291686378d..e01091b6f8 100644 --- a/source/include/FreeRTOS_DNS_Globals.h +++ b/source/include/FreeRTOS_DNS_Globals.h @@ -34,6 +34,8 @@ #include "FreeRTOSIPConfigDefaults.h" #include "IPTraceMacroDefaults.h" +#include "FreeRTOS_Sockets.h" + #define dnsPARSE_ERROR 0UL #if ( ipconfigBYTE_ORDER == pdFREERTOS_LITTLE_ENDIAN ) diff --git a/source/include/FreeRTOS_IP_Private.h b/source/include/FreeRTOS_IP_Private.h index 51463f1ce9..e797d0a1bf 100644 --- a/source/include/FreeRTOS_IP_Private.h +++ b/source/include/FreeRTOS_IP_Private.h @@ -56,7 +56,10 @@ #define ipFOREVER() 1 #endif -typedef enum +/* Forward declaration of 'NetworkEndPoint_t'. */ +typedef struct xNetworkEndPoint NetworkEndPoint_t; + +typedef enum eFrameProcessingResult { eReleaseBuffer = 0, /* Processing the frame did not find anything to do - just release the buffer. */ eProcessBuffer, /* An Ethernet frame has a valid address - continue process its contents. */ diff --git a/source/include/FreeRTOS_IP_Utils.h b/source/include/FreeRTOS_IP_Utils.h index eaa436681d..9c1458aa0f 100644 --- a/source/include/FreeRTOS_IP_Utils.h +++ b/source/include/FreeRTOS_IP_Utils.h @@ -65,6 +65,9 @@ #include "FreeRTOS_IPv4_Utils.h" #include "FreeRTOS_IPv6_Utils.h" +/* Forward declaration of 'NetworkInterface_t'. */ +typedef struct xNetworkInterface NetworkInterface_t; + #if ( ipconfigUSE_DHCP != 0 ) /** diff --git a/source/include/FreeRTOS_IPv4.h b/source/include/FreeRTOS_IPv4.h index 3dfad00d2e..afa2f602c7 100644 --- a/source/include/FreeRTOS_IPv4.h +++ b/source/include/FreeRTOS_IPv4.h @@ -36,7 +36,6 @@ #include "FreeRTOS.h" #include "task.h" -#include "FreeRTOS_IP.h" /* Application level configuration options. */ #include "FreeRTOSIPConfig.h" @@ -48,9 +47,6 @@ #define ipSIZE_OF_ICMPv4_HEADER 8U #define ipTYPE_IPv4 ( 0x40U ) -/* The number of octets in the IP addresses respectively. */ -#define ipIP_ADDRESS_LENGTH_BYTES ( 4U ) - #define ipFIRST_LOOPBACK_IPv4 0x7F000000UL /**< Lowest IPv4 loopback address (including). */ #define ipLAST_LOOPBACK_IPv4 0x80000000UL /**< Highest IPv4 loopback address (excluding). */ diff --git a/source/include/FreeRTOS_Routing.h b/source/include/FreeRTOS_Routing.h index e57d7d5727..353a0c88a3 100644 --- a/source/include/FreeRTOS_Routing.h +++ b/source/include/FreeRTOS_Routing.h @@ -26,6 +26,8 @@ #ifndef FREERTOS_ROUTING_H #define FREERTOS_ROUTING_H + #include "FreeRTOS_IP.h" + #ifdef __cplusplus extern "C" { #endif @@ -40,9 +42,6 @@ /* Every NetworkInterface needs a set of access functions: */ -/* Forward declaration of 'struct xNetworkInterface'. */ - struct xNetworkInterface; - /* Initialise the interface. */ typedef BaseType_t ( * NetworkInterfaceInitialiseFunction_t ) ( struct xNetworkInterface * pxDescriptor ); From 234e714278a3324ae9a6f9b6dcd97a4f01d9e893 Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Tue, 25 Jul 2023 09:37:19 +0000 Subject: [PATCH 02/10] IP_Private --- source/include/FreeRTOS_IPv4.h | 3 +++ source/include/FreeRTOS_IPv6.h | 6 ------ source/include/FreeRTOS_IPv6_Private.h | 5 +++++ 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/source/include/FreeRTOS_IPv4.h b/source/include/FreeRTOS_IPv4.h index afa2f602c7..a755bd9205 100644 --- a/source/include/FreeRTOS_IPv4.h +++ b/source/include/FreeRTOS_IPv4.h @@ -42,6 +42,9 @@ #include "FreeRTOSIPConfigDefaults.h" #include "IPTraceMacroDefaults.h" +typedef enum eFrameProcessingResult eFrameProcessingResult_t; +typedef struct xIP_PACKET IPPacket_t; + #define ipSIZE_OF_IPv4_HEADER 20U #define ipSIZE_OF_IPv4_ADDRESS 4U #define ipSIZE_OF_ICMPv4_HEADER 8U diff --git a/source/include/FreeRTOS_IPv6.h b/source/include/FreeRTOS_IPv6.h index 37a5f3ff35..cb2ed20481 100644 --- a/source/include/FreeRTOS_IPv6.h +++ b/source/include/FreeRTOS_IPv6.h @@ -36,7 +36,6 @@ #include "task.h" #include "FreeRTOS_IP.h" #include "FreeRTOS_IP_Common.h" -#include "FreeRTOS_IPv6_Private.h" /* Some constants defining the sizes of several parts of a packet. * These defines come before including the configuration header files. */ @@ -84,11 +83,6 @@ extern const struct xIPv6_Address FreeRTOS_in6addr_loopback; struct xNetworkEndPoint; struct xNetworkInterface; -/* The function 'prvAllowIPPacket()' checks if a IPv6 packets should be processed. */ -eFrameProcessingResult_t prvAllowIPPacketIPv6( const IPHeader_IPv6_t * const pxIPv6Header, - const NetworkBufferDescriptor_t * const pxNetworkBuffer, - UBaseType_t uxHeaderLength ); - /** @brief Handle the IPv6 extension headers. */ eFrameProcessingResult_t eHandleIPv6ExtensionHeaders( NetworkBufferDescriptor_t * const pxNetworkBuffer, diff --git a/source/include/FreeRTOS_IPv6_Private.h b/source/include/FreeRTOS_IPv6_Private.h index 6851fe8a40..53f757040c 100644 --- a/source/include/FreeRTOS_IPv6_Private.h +++ b/source/include/FreeRTOS_IPv6_Private.h @@ -260,6 +260,11 @@ struct xTCP_PACKET_IPv6 #include "pack_struct_end.h" typedef struct xTCP_PACKET_IPv6 TCPPacket_IPv6_t; +/* The function 'prvAllowIPPacket()' checks if a IPv6 packets should be processed. */ +eFrameProcessingResult_t prvAllowIPPacketIPv6( const IPHeader_IPv6_t * const pxIPv6Header, + const NetworkBufferDescriptor_t * const pxNetworkBuffer, + UBaseType_t uxHeaderLength ); + /* prvProcessICMPMessage_IPv6() is declared in FreeRTOS_routing.c * It handles all ICMP messages except the PING requests. */ eFrameProcessingResult_t prvProcessICMPMessage_IPv6( NetworkBufferDescriptor_t * const pxNetworkBuffer ); From 2092cfc5185db15673fef15fc73f8804e5954f73 Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Tue, 25 Jul 2023 09:38:45 +0000 Subject: [PATCH 03/10] TEST_HEADER_INC_ONLY_IPv4 --- source/include/FreeRTOS_IPv4.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/include/FreeRTOS_IPv4.h b/source/include/FreeRTOS_IPv4.h index a755bd9205..5e462c266d 100644 --- a/source/include/FreeRTOS_IPv4.h +++ b/source/include/FreeRTOS_IPv4.h @@ -42,6 +42,8 @@ #include "FreeRTOSIPConfigDefaults.h" #include "IPTraceMacroDefaults.h" +typedef struct xNETWORK_BUFFER NetworkBufferDescriptor_t; + typedef enum eFrameProcessingResult eFrameProcessingResult_t; typedef struct xIP_PACKET IPPacket_t; From 73498b9c3b37ef1fd5c1e58660b2016e35aece8f Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Tue, 25 Jul 2023 10:41:14 +0000 Subject: [PATCH 04/10] NetworkBufferManagement and NetworkInterface --- source/include/NetworkBufferManagement.h | 2 ++ source/include/NetworkInterface.h | 2 ++ 2 files changed, 4 insertions(+) diff --git a/source/include/NetworkBufferManagement.h b/source/include/NetworkBufferManagement.h index f3065a64e3..3fd9804a3f 100644 --- a/source/include/NetworkBufferManagement.h +++ b/source/include/NetworkBufferManagement.h @@ -34,6 +34,8 @@ #endif /* *INDENT-ON* */ +#include "FreeRTOS_IP.h" + /* _HT_ Two macro's needed while debugging/testing, please ignore. */ #define BUFFER_FROM_WHERE_DECL diff --git a/source/include/NetworkInterface.h b/source/include/NetworkInterface.h index 35a4726607..a9c804cd8d 100644 --- a/source/include/NetworkInterface.h +++ b/source/include/NetworkInterface.h @@ -34,6 +34,8 @@ #endif /* *INDENT-ON* */ +#include "FreeRTOS_IP.h" + /* INTERNAL API FUNCTIONS. */ /* Since there are multiple interfaces, there are multiple versions From 1527a6abd6fe070004f7685d6697fe3dc1b412f0 Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Tue, 25 Jul 2023 10:43:04 +0000 Subject: [PATCH 05/10] Add CI flow to check user related headers can be included independently --- test/build-combination/CMakeLists.txt | 68 ++-- .../HeaderSelfContain/FreeRTOSConfig.h | 220 +++++++++++ .../HeaderSelfContain/FreeRTOSIPConfig.h | 328 +++++++++++++++++ .../HeaderSelfContain/headerSelfContain.cmake | 45 +++ .../HeaderSelfContain/main.c | 60 +++ .../HeaderSelfContain/stubs.c | 343 ++++++++++++++++++ 6 files changed, 1038 insertions(+), 26 deletions(-) create mode 100644 test/build-combination/HeaderSelfContain/FreeRTOSConfig.h create mode 100644 test/build-combination/HeaderSelfContain/FreeRTOSIPConfig.h create mode 100644 test/build-combination/HeaderSelfContain/headerSelfContain.cmake create mode 100644 test/build-combination/HeaderSelfContain/main.c create mode 100644 test/build-combination/HeaderSelfContain/stubs.c diff --git a/test/build-combination/CMakeLists.txt b/test/build-combination/CMakeLists.txt index 59cd47308b..61c7ed063b 100644 --- a/test/build-combination/CMakeLists.txt +++ b/test/build-combination/CMakeLists.txt @@ -1,3 +1,7 @@ +option(TEST_HEADER_SELF_CONTAINED "Start header self contain test" OFF) + +# ------------------------------------------------------------------- + add_library( freertos_plus_tcp_config_common INTERFACE ) target_include_directories(freertos_plus_tcp_config_common INTERFACE Common ) @@ -41,6 +45,11 @@ add_library( freertos_plus_tcp_config_default INTERFACE) target_include_directories(freertos_plus_tcp_config_default INTERFACE DefaultConf) target_link_libraries(freertos_plus_tcp_config_default INTERFACE freertos_plus_tcp_config_common) +# ------------------------------------------------------------------- +add_library( freertos_plus_tcp_header_self_contain INTERFACE) +target_include_directories(freertos_plus_tcp_header_self_contain INTERFACE HeaderSelfContain) +target_link_libraries(freertos_plus_tcp_header_self_contain INTERFACE freertos_plus_tcp_config_common) + # ------------------------------------------------------------------- # Configuration for FreeRTOS-Kernel if(FREERTOS_PLUS_TCP_TEST_CONFIGURATION STREQUAL "CUSTOM" ) @@ -66,31 +75,38 @@ else() add_library( freertos_config ALIAS freertos_plus_tcp_config_default) endif() -add_executable(freertos_plus_tcp_build_test EXCLUDE_FROM_ALL) - -target_sources(freertos_plus_tcp_build_test - PRIVATE - Common/main.c -) +# In header self contain test, we include headers one by one +# to make sure all header files are able to include separately. +if( TEST_HEADER_SELF_CONTAINED ) + include( HeaderSelfContain/headerSelfContain.cmake ) +else() + # Common build combination test. + add_executable(freertos_plus_tcp_build_test EXCLUDE_FROM_ALL) -target_compile_options(freertos_plus_tcp_build_test - PRIVATE - $<$:-Wno-cast-qual> - $<$:-Wno-format-nonliteral> - $<$:-Wno-implicit-function-declaration> - $<$:-Wno-missing-noreturn> - $<$:-Wno-missing-prototypes> - $<$:-Wno-missing-variable-declarations> - $<$:-Wno-reserved-identifier> - $<$:-Wno-shorten-64-to-32> - $<$:-Wno-sign-conversion> - $<$:-Wno-unused-parameter> - $<$:-Wno-unused-macros> - $<$:-Wno-unused-variable> -) + target_sources(freertos_plus_tcp_build_test + PRIVATE + Common/main.c + ) -target_link_libraries(freertos_plus_tcp_build_test - PRIVATE - freertos_plus_tcp - freertos_kernel -) + target_compile_options(freertos_plus_tcp_build_test + PRIVATE + $<$:-Wno-cast-qual> + $<$:-Wno-format-nonliteral> + $<$:-Wno-implicit-function-declaration> + $<$:-Wno-missing-noreturn> + $<$:-Wno-missing-prototypes> + $<$:-Wno-missing-variable-declarations> + $<$:-Wno-reserved-identifier> + $<$:-Wno-shorten-64-to-32> + $<$:-Wno-sign-conversion> + $<$:-Wno-unused-parameter> + $<$:-Wno-unused-macros> + $<$:-Wno-unused-variable> + ) + + target_link_libraries(freertos_plus_tcp_build_test + PRIVATE + freertos_plus_tcp + freertos_kernel + ) +endif() diff --git a/test/build-combination/HeaderSelfContain/FreeRTOSConfig.h b/test/build-combination/HeaderSelfContain/FreeRTOSConfig.h new file mode 100644 index 0000000000..22469a3493 --- /dev/null +++ b/test/build-combination/HeaderSelfContain/FreeRTOSConfig.h @@ -0,0 +1,220 @@ +/* + * FreeRTOS+TCP + * Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of + * this software and associated documentation files (the "Software"), to deal in + * the Software without restriction, including without limitation the rights to + * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + * the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS + * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR + * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER + * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + * http://aws.amazon.com/freertos + * http://www.FreeRTOS.org + */ + +#ifndef FREERTOS_CONFIG_H +#define FREERTOS_CONFIG_H + +/*----------------------------------------------------------- +* Application specific definitions. +* +* These definitions should be adjusted for your particular hardware and +* application requirements. +* +* THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE +* FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE. +* http://www.freertos.org/a00110.html +* +* The bottom of this file contains some constants specific to running the UDP +* stack in this demo. Constants specific to FreeRTOS+TCP itself (rather than +* the demo) are contained in FreeRTOSIPConfig.h. +*----------------------------------------------------------*/ +#define configENABLE_BACKWARD_COMPATIBILITY 1 +#define configUSE_PREEMPTION 1 +#define configUSE_PORT_OPTIMISED_TASK_SELECTION 0 +#define configMAX_PRIORITIES ( 7 ) +#define configTICK_RATE_HZ ( 1000 ) /* In this non-real time simulated environment the tick frequency has to be at least a multiple of the Win32 tick frequency, and therefore very slow. */ +#define configMINIMAL_STACK_SIZE ( ( unsigned short ) 60 ) /* In this simulated case, the stack only has to hold one small structure as the real stack is part of the Win32 thread. */ +#define configTOTAL_HEAP_SIZE ( ( size_t ) ( 2048U * 1024U ) ) +#define configMAX_TASK_NAME_LEN ( 15 ) +#define configUSE_TRACE_FACILITY 1 +#define configUSE_16_BIT_TICKS 0 +#define configIDLE_SHOULD_YIELD 1 +#define configUSE_MUTEXES 1 +#define configUSE_RECURSIVE_MUTEXES 1 +#define configQUEUE_REGISTRY_SIZE 0 +#define configUSE_APPLICATION_TASK_TAG 1 +#define configUSE_COUNTING_SEMAPHORES 1 +#define configUSE_ALTERNATIVE_API 0 +#define configNUM_THREAD_LOCAL_STORAGE_POINTERS 3 /* FreeRTOS+FAT requires 2 pointers if a CWD is supported. */ +#define configRECORD_STACK_HIGH_ADDRESS 1 + +/* Hook function related definitions. */ +#define configUSE_TICK_HOOK 0 +#define configUSE_IDLE_HOOK 1 +#define configUSE_MALLOC_FAILED_HOOK 1 +#define configCHECK_FOR_STACK_OVERFLOW 0 /* Not applicable to the Win32 port. */ + +/* Software timer related definitions. */ +#define configUSE_TIMERS 1 +#define configTIMER_TASK_PRIORITY ( configMAX_PRIORITIES - 1 ) +#define configTIMER_QUEUE_LENGTH 5 +#define configTIMER_TASK_STACK_DEPTH ( configMINIMAL_STACK_SIZE * 2 ) + +/* Event group related definitions. */ +#define configUSE_EVENT_GROUPS 1 + +/* Currently the TCP/IP stack is using dynamic allocation, and the MQTT task is + * using static allocation. */ +#define configSUPPORT_DYNAMIC_ALLOCATION 1 +#define configSUPPORT_STATIC_ALLOCATION 1 + +/* Set the following definitions to 1 to include the API function, or zero + * to exclude the API function. */ +#define INCLUDE_vTaskPrioritySet 1 +#define INCLUDE_uxTaskPriorityGet 1 +#define INCLUDE_vTaskDelete 1 +#define INCLUDE_vTaskCleanUpResources 0 +#define INCLUDE_vTaskSuspend 1 +#define INCLUDE_vTaskDelayUntil 1 +#define INCLUDE_vTaskDelay 1 +#define INCLUDE_uxTaskGetStackHighWaterMark 1 +#define INCLUDE_xTaskGetSchedulerState 1 +#define INCLUDE_xTimerGetTimerTaskHandle 0 +#define INCLUDE_xTaskGetIdleTaskHandle 0 +#define INCLUDE_xQueueGetMutexHolder 1 +#define INCLUDE_eTaskGetState 1 +#define INCLUDE_xEventGroupSetBitsFromISR 1 +#define INCLUDE_xTimerPendFunctionCall 1 +#define INCLUDE_xTaskGetCurrentTaskHandle 1 +#define INCLUDE_xTaskAbortDelay 1 + +/* This demo makes use of one or more example stats formatting functions. These + * format the raw data provided by the uxTaskGetSystemState() function in to human + * readable ASCII form. See the notes in the implementation of vTaskList() within + * FreeRTOS/Source/tasks.c for limitations. configUSE_STATS_FORMATTING_FUNCTIONS + * is set to 2 so the formatting functions are included without the stdio.h being + * included in tasks.c. That is because this project defines its own sprintf() + * functions. */ +#define configUSE_STATS_FORMATTING_FUNCTIONS 1 + +/* The function that implements FreeRTOS printf style output, and the macro + * that maps the configPRINTF() macros to that function. */ +void vLoggingPrintf( char const * pcFormat, + ... ); + +#define configPRINTF( X ) vLoggingPrintf X + +/* Non-format version thread-safe print. */ +#define configPRINT( X ) vLoggingPrintf X + +/* Non-format version thread-safe print. */ +#define configPRINT_STRING( X ) vLoggingPrintf X + +/* Application specific definitions follow. **********************************/ + +/* If configINCLUDE_DEMO_DEBUG_STATS is set to one, then a few basic IP trace + * macros are defined to gather some UDP stack statistics that can then be viewed + * through the CLI interface. */ +#define configINCLUDE_DEMO_DEBUG_STATS 1 + +/* The size of the global output buffer that is available for use when there + * are multiple command interpreters running at once (for example, one on a UART + * and one on TCP/IP). This is done to prevent an output buffer being defined by + * each implementation - which would waste RAM. In this case, there is only one + * command interpreter running, and it has its own local output buffer, so the + * global buffer is just set to be one byte long as it is not used and should not + * take up unnecessary RAM. */ +#define configCOMMAND_INT_MAX_OUTPUT_SIZE 1 + +/* Only used when running in the FreeRTOS Windows simulator. Defines the + * priority of the task used to simulate Ethernet interrupts. */ +#define configMAC_ISR_SIMULATOR_PRIORITY ( configMAX_PRIORITIES - 1 ) + +/* This demo creates a virtual network connection by accessing the raw Ethernet + * or WiFi data to and from a real network connection. Many computers have more + * than one real network port, and configNETWORK_INTERFACE_TO_USE is used to tell + * the demo which real port should be used to create the virtual port. The ports + * available are displayed on the console when the application is executed. For + * example, on my development laptop setting configNETWORK_INTERFACE_TO_USE to 4 + * results in the wired network being used, while setting + * configNETWORK_INTERFACE_TO_USE to 2 results in the wireless network being + * used. */ +#define configNETWORK_INTERFACE_TO_USE ( 0L ) + +/* The address of an echo server that will be used by the two demo echo client + * tasks: + * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Echo_Clients.html, + * http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/UDP_Echo_Clients.html. */ +#define configECHO_SERVER_ADDR0 192 +#define configECHO_SERVER_ADDR1 168 +#define configECHO_SERVER_ADDR2 2 +#define configECHO_SERVER_ADDR3 6 +#define configTCP_ECHO_CLIENT_PORT 7 + +/* Default MAC address configuration. The demo creates a virtual network + * connection that uses this MAC address by accessing the raw Ethernet/WiFi data + * to and from a real network connection on the host PC. See the + * configNETWORK_INTERFACE_TO_USE definition above for information on how to + * configure the real network connection to use. */ +#define configMAC_ADDR0 0x00 +#define configMAC_ADDR1 0x11 +#define configMAC_ADDR2 0x22 +#define configMAC_ADDR3 0x33 +#define configMAC_ADDR4 0x44 +#define configMAC_ADDR5 0x32 + +/* Default IP address configuration. Used in ipconfigUSE_DHCP is set to 0, or + * ipconfigUSE_DHCP is set to 1 but a DNS server cannot be contacted. */ +#define configIP_ADDR0 192 +#define configIP_ADDR1 168 +#define configIP_ADDR2 0 +#define configIP_ADDR3 105 + +/* Default gateway IP address configuration. Used in ipconfigUSE_DHCP is set to + * 0, or ipconfigUSE_DHCP is set to 1 but a DNS server cannot be contacted. */ +#define configGATEWAY_ADDR0 192 +#define configGATEWAY_ADDR1 168 +#define configGATEWAY_ADDR2 0 +#define configGATEWAY_ADDR3 1 + +/* Default DNS server configuration. OpenDNS addresses are 208.67.222.222 and + * 208.67.220.220. Used in ipconfigUSE_DHCP is set to 0, or ipconfigUSE_DHCP is + * set to 1 but a DNS server cannot be contacted.*/ +#define configDNS_SERVER_ADDR0 208 +#define configDNS_SERVER_ADDR1 67 +#define configDNS_SERVER_ADDR2 222 +#define configDNS_SERVER_ADDR3 222 + +/* Default netmask configuration. Used in ipconfigUSE_DHCP is set to 0, or + * ipconfigUSE_DHCP is set to 1 but a DNS server cannot be contacted. */ +#define configNET_MASK0 255 +#define configNET_MASK1 255 +#define configNET_MASK2 255 +#define configNET_MASK3 0 + +/* The UDP port to which print messages are sent. */ +#define configPRINT_PORT ( 15000 ) + +#define configPROFILING ( 0 ) + +/* Pseudo random number generator used by some tasks. */ +extern uint32_t ulRand( void ); +#define configRAND32() ulRand() + +/* The platform that FreeRTOS is running on. */ +#define configPLATFORM_NAME "WinSim" + + +#endif /* FREERTOS_CONFIG_H */ diff --git a/test/build-combination/HeaderSelfContain/FreeRTOSIPConfig.h b/test/build-combination/HeaderSelfContain/FreeRTOSIPConfig.h new file mode 100644 index 0000000000..2f6d5ccec9 --- /dev/null +++ b/test/build-combination/HeaderSelfContain/FreeRTOSIPConfig.h @@ -0,0 +1,328 @@ +/* + * FreeRTOS+TCP + * Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of + * this software and associated documentation files (the "Software"), to deal in + * the Software without restriction, including without limitation the rights to + * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + * the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS + * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR + * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER + * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + * http://aws.amazon.com/freertos + * http://www.FreeRTOS.org + */ + + +/***************************************************************************** +* +* See the following URL for configuration information. +* http://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_IP_Configuration.html +* +*****************************************************************************/ + +#ifndef FREERTOS_IP_CONFIG_H +#define FREERTOS_IP_CONFIG_H + +#define ipconfigUSE_DHCPv6 1 +#define ipconfigIPv4_BACKWARD_COMPATIBLE 1 +#define ipconfigUSE_ARP_REVERSED_LOOKUP 1 +#define ipconfigUSE_ARP_REMOVE_ENTRY 1 +#define ipconfigARP_STORES_REMOTE_ADDRESSES 1 +#define ipconfigUSE_LINKED_RX_MESSAGES 1 +#define ipconfigFORCE_IP_DONT_FRAGMENT 1 +#define ipconfigUDP_PASS_ZERO_CHECKSUM_PACKETS 1 +#define ipconfigDHCP_FALL_BACK_AUTO_IP 1 +#define ipconfigARP_USE_CLASH_DETECTION 1 +#define ipconfigUSE_LLMNR 1 +#define ipconfigUSE_NBNS 1 +#define ipconfigUSE_MDNS 1 +#define ipconfigSUPPORT_OUTGOING_PINGS 1 +#define ipconfigETHERNET_DRIVER_FILTERS_PACKETS 1 +#define ipconfigZERO_COPY_TX_DRIVER 1 +#define ipconfigZERO_COPY_RX_DRIVER 1 +#define ipconfigDRIVER_INCLUDED_TX_IP_CHECKSUM 1 +#define ipconfigSOCKET_HAS_USER_SEMAPHORE 1 +#define ipconfigSELECT_USES_NOTIFY 1 +#define ipconfigSUPPORT_SIGNALS 1 +#define ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES 0 + +/* Set to 1 to print out debug messages. If ipconfigHAS_DEBUG_PRINTF is set to + * 1 then FreeRTOS_debug_printf should be defined to the function used to print + * out the debugging messages. */ +#define ipconfigHAS_DEBUG_PRINTF 1 +#if ( ipconfigHAS_DEBUG_PRINTF == 1 ) + #define FreeRTOS_debug_printf( X ) printf X +#endif + +/* Set to 1 to print out non debugging messages, for example the output of the + * FreeRTOS_netstat() command, and ping replies. If ipconfigHAS_PRINTF is set to 1 + * then FreeRTOS_printf should be set to the function used to print out the + * messages. */ +#define ipconfigHAS_PRINTF 1 +#if ( ipconfigHAS_PRINTF == 1 ) + #define FreeRTOS_printf( X ) printf X +#endif + +/* Define the byte order of the target MCU (the MCU FreeRTOS+TCP is executing + * on). Valid options are pdFREERTOS_BIG_ENDIAN and pdFREERTOS_LITTLE_ENDIAN. */ +#define ipconfigBYTE_ORDER pdFREERTOS_LITTLE_ENDIAN + +/* If the network card/driver includes checksum offloading then set + * ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM to 1 to prevent the software + * stack repeating the checksum calculations. */ +#define ipconfigDRIVER_INCLUDED_RX_IP_CHECKSUM 1 + +/* Several API's will block until the result is known, or the action has been + * performed, for example FreeRTOS_send() and FreeRTOS_recv(). The timeouts can be + * set per socket, using setsockopt(). If not set, the times below will be + * used as defaults. */ +#define ipconfigSOCK_DEFAULT_RECEIVE_BLOCK_TIME ( 5000 ) +#define ipconfigSOCK_DEFAULT_SEND_BLOCK_TIME ( 5000 ) + +/* Include support for DNS caching. For TCP, having a small DNS cache is very + * useful. When a cache is present, ipconfigDNS_REQUEST_ATTEMPTS can be kept low + * and also DNS may use small timeouts. If a DNS reply comes in after the DNS + * socket has been destroyed, the result will be stored into the cache. The next + * call to FreeRTOS_gethostbyname() will return immediately, without even creating + * a socket. + */ +#define ipconfigUSE_DNS_CACHE ( 1 ) +#define ipconfigDNS_CACHE_ADDRESSES_PER_ENTRY ( 6 ) +#define ipconfigDNS_REQUEST_ATTEMPTS ( 2 ) + +/* The IP stack executes it its own task (although any application task can make + * use of its services through the published sockets API). ipconfigUDP_TASK_PRIORITY + * sets the priority of the task that executes the IP stack. The priority is a + * standard FreeRTOS task priority so can take any value from 0 (the lowest + * priority) to (configMAX_PRIORITIES - 1) (the highest priority). + * configMAX_PRIORITIES is a standard FreeRTOS configuration parameter defined in + * FreeRTOSConfig.h, not FreeRTOSIPConfig.h. Consideration needs to be given as to + * the priority assigned to the task executing the IP stack relative to the + * priority assigned to tasks that use the IP stack. */ +#define ipconfigIP_TASK_PRIORITY ( configMAX_PRIORITIES - 2 ) + +/* The size, in words (not bytes), of the stack allocated to the FreeRTOS+TCP + * task. This setting is less important when the FreeRTOS Win32 simulator is used + * as the Win32 simulator only stores a fixed amount of information on the task + * stack. FreeRTOS includes optional stack overflow detection, see: + * http://www.freertos.org/Stacks-and-stack-overflow-checking.html. */ +#define ipconfigIP_TASK_STACK_SIZE_WORDS ( configMINIMAL_STACK_SIZE * 5 ) + +/* ipconfigRAND32() is called by the IP stack to generate random numbers for + * things such as a DHCP transaction number or initial sequence number. Random + * number generation is performed via this macro to allow applications to use their + * own random number generation method. For example, it might be possible to + * generate a random number by sampling noise on an analogue input. */ +extern uint32_t ulRand(); +#define ipconfigRAND32() ulRand() + +/* If ipconfigUSE_NETWORK_EVENT_HOOK is set to 1 then FreeRTOS+TCP will call the + * network event hook at the appropriate times. If ipconfigUSE_NETWORK_EVENT_HOOK + * is not set to 1 then the network event hook will never be called. See: + * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/API/vApplicationIPNetworkEventHook.shtml. + */ +#define ipconfigUSE_NETWORK_EVENT_HOOK 0 + +/* Sockets have a send block time attribute. If FreeRTOS_sendto() is called but + * a network buffer cannot be obtained then the calling task is held in the Blocked + * state (so other tasks can continue to executed) until either a network buffer + * becomes available or the send block time expires. If the send block time expires + * then the send operation is aborted. The maximum allowable send block time is + * capped to the value set by ipconfigMAX_SEND_BLOCK_TIME_TICKS. Capping the + * maximum allowable send block time prevents prevents a deadlock occurring when + * all the network buffers are in use and the tasks that process (and subsequently + * free) the network buffers are themselves blocked waiting for a network buffer. + * ipconfigMAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks. A time in + * milliseconds can be converted to a time in ticks by dividing the time in + * milliseconds by portTICK_PERIOD_MS. */ +#define ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS ( 5000U / portTICK_PERIOD_MS ) + +/* If ipconfigUSE_DHCP is 1 then FreeRTOS+TCP will attempt to retrieve an IP + * address, netmask, DNS server address and gateway address from a DHCP server. If + * ipconfigUSE_DHCP is 0 then FreeRTOS+TCP will use a static IP address. The + * stack will revert to using the static IP address even when ipconfigUSE_DHCP is + * set to 1 if a valid configuration cannot be obtained from a DHCP server for any + * reason. The static configuration used is that passed into the stack by the + * FreeRTOS_IPInit() function call. */ +#define ipconfigUSE_DHCP 1 +#define ipconfigDHCP_REGISTER_HOSTNAME 1 +#define ipconfigDHCP_USES_UNICAST 1 + +/* If ipconfigDHCP_USES_USER_HOOK is set to 1 then the application writer must + * provide an implementation of the DHCP callback function, + * xApplicationDHCPUserHook(). */ +#define ipconfigUSE_DHCP_HOOK 0 + +/* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at + * increasing time intervals until either a reply is received from a DHCP server + * and accepted, or the interval between transmissions reaches + * ipconfigMAXIMUM_DISCOVER_TX_PERIOD. The IP stack will revert to using the + * static IP address passed as a parameter to FreeRTOS_IPInit() if the + * re-transmission time interval reaches ipconfigMAXIMUM_DISCOVER_TX_PERIOD without + * a DHCP reply being received. */ +#define ipconfigMAXIMUM_DISCOVER_TX_PERIOD \ + ( 120000U / portTICK_PERIOD_MS ) + +/* The ARP cache is a table that maps IP addresses to MAC addresses. The IP + * stack can only send a UDP message to a remove IP address if it knowns the MAC + * address associated with the IP address, or the MAC address of the router used to + * contact the remote IP address. When a UDP message is received from a remote IP + * address the MAC address and IP address are added to the ARP cache. When a UDP + * message is sent to a remote IP address that does not already appear in the ARP + * cache then the UDP message is replaced by a ARP message that solicits the + * required MAC address information. ipconfigARP_CACHE_ENTRIES defines the maximum + * number of entries that can exist in the ARP table at any one time. */ +#define ipconfigARP_CACHE_ENTRIES 6 + +/* ARP requests that do not result in an ARP response will be re-transmitted a + * maximum of ipconfigMAX_ARP_RETRANSMISSIONS times before the ARP request is + * aborted. */ +#define ipconfigMAX_ARP_RETRANSMISSIONS ( 5 ) + +/* ipconfigMAX_ARP_AGE defines the maximum time between an entry in the ARP + * table being created or refreshed and the entry being removed because it is stale. + * New ARP requests are sent for ARP cache entries that are nearing their maximum + * age. ipconfigMAX_ARP_AGE is specified in tens of seconds, so a value of 150 is + * equal to 1500 seconds (or 25 minutes). */ +#define ipconfigMAX_ARP_AGE 150 + +/* Implementing FreeRTOS_inet_addr() necessitates the use of string handling + * routines, which are relatively large. To save code space the full + * FreeRTOS_inet_addr() implementation is made optional, and a smaller and faster + * alternative called FreeRTOS_inet_addr_quick() is provided. FreeRTOS_inet_addr() + * takes an IP in decimal dot format (for example, "192.168.0.1") as its parameter. + * FreeRTOS_inet_addr_quick() takes an IP address as four separate numerical octets + * (for example, 192, 168, 0, 1) as its parameters. If + * ipconfigINCLUDE_FULL_INET_ADDR is set to 1 then both FreeRTOS_inet_addr() and + * FreeRTOS_indet_addr_quick() are available. If ipconfigINCLUDE_FULL_INET_ADDR is + * not set to 1 then only FreeRTOS_indet_addr_quick() is available. */ +#define ipconfigINCLUDE_FULL_INET_ADDR 1 + +/* ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS defines the total number of network buffer that + * are available to the IP stack. The total number of network buffers is limited + * to ensure the total amount of RAM that can be consumed by the IP stack is capped + * to a pre-determinable value. */ +#define ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS 60 + +/* A FreeRTOS queue is used to send events from application tasks to the IP + * stack. ipconfigEVENT_QUEUE_LENGTH sets the maximum number of events that can + * be queued for processing at any one time. The event queue must be a minimum of + * 5 greater than the total number of network buffers. */ +#define ipconfigEVENT_QUEUE_LENGTH \ + ( ipconfigNUM_NETWORK_BUFFER_DESCRIPTORS + 5 ) + +/* The address of a socket is the combination of its IP address and its port + * number. FreeRTOS_bind() is used to manually allocate a port number to a socket + * (to 'bind' the socket to a port), but manual binding is not normally necessary + * for client sockets (those sockets that initiate outgoing connections rather than + * wait for incoming connections on a known port number). If + * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 1 then calling + * FreeRTOS_sendto() on a socket that has not yet been bound will result in the IP + * stack automatically binding the socket to a port number from the range + * socketAUTO_PORT_ALLOCATION_START_NUMBER to 0xffff. If + * ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND is set to 0 then calling FreeRTOS_sendto() + * on a socket that has not yet been bound will result in the send operation being + * aborted. */ +#define ipconfigALLOW_SOCKET_SEND_WITHOUT_BIND 1 + +/* Defines the Time To Live (TTL) values used in outgoing UDP packets. */ +#define ipconfigUDP_TIME_TO_LIVE 128 +/* Also defined in FreeRTOSIPConfigDefaults.h. */ +#define ipconfigTCP_TIME_TO_LIVE 128 + +/* USE_TCP: Use TCP and all its features. */ +#define ipconfigUSE_TCP ( 1 ) + +/* USE_WIN: Let TCP use windowing mechanism. */ +#define ipconfigUSE_TCP_WIN ( 1 ) + +/* The MTU is the maximum number of bytes the payload of a network frame can + * contain. For normal Ethernet V2 frames the maximum MTU is 1500. Setting a + * lower value can save RAM, depending on the buffer management scheme used. If + * ipconfigCAN_FRAGMENT_OUTGOING_PACKETS is 1 then (ipconfigNETWORK_MTU - 28) must + * be divisible by 8. */ +#define ipconfigNETWORK_MTU 1500U + +/* Set ipconfigUSE_DNS to 1 to include a basic DNS client/resolver. DNS is used + * through the FreeRTOS_gethostbyname() API function. */ +#define ipconfigUSE_DNS 1 + +/* If ipconfigREPLY_TO_INCOMING_PINGS is set to 1 then the IP stack will + * generate replies to incoming ICMP echo (ping) requests. */ +#define ipconfigREPLY_TO_INCOMING_PINGS 1 + +/* If ipconfigSUPPORT_OUTGOING_PINGS is set to 1 then the + * FreeRTOS_SendPingRequest() API function is available. */ +#define ipconfigSUPPORT_OUTGOING_PINGS 0 + +/* If ipconfigSUPPORT_SELECT_FUNCTION is set to 1 then the FreeRTOS_select() + * (and associated) API function is available. */ +#define ipconfigSUPPORT_SELECT_FUNCTION 1 + +/* If ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES is set to 1 then Ethernet frames + * that are not in Ethernet II format will be dropped. This option is included for + * potential future IP stack developments. */ +#define ipconfigFILTER_OUT_NON_ETHERNET_II_FRAMES 1 + +/* If ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES is set to 1 then it is the + * responsibility of the Ethernet interface to filter out packets that are of no + * interest. If the Ethernet interface does not implement this functionality, then + * set ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES to 0 to have the IP stack + * perform the filtering instead (it is much less efficient for the stack to do it + * because the packet will already have been passed into the stack). If the + * Ethernet driver does all the necessary filtering in hardware then software + * filtering can be removed by using a value other than 1 or 0. */ +#define ipconfigETHERNET_DRIVER_FILTERS_FRAME_TYPES 1 + +/* The windows simulator cannot really simulate MAC interrupts, and needs to + * block occasionally to allow other tasks to run. */ +#define configWINDOWS_MAC_INTERRUPT_SIMULATOR_DELAY ( 20 / portTICK_PERIOD_MS ) + +/* Advanced only: in order to access 32-bit fields in the IP packets with + * 32-bit memory instructions, all packets will be stored 32-bit-aligned, + * plus 16-bits. This has to do with the contents of the IP-packets: all + * 32-bit fields are 32-bit-aligned, plus 16-bit. */ +#define ipconfigPACKET_FILLER_SIZE 2U + +/* Define the size of the pool of TCP window descriptors. On the average, each + * TCP socket will use up to 2 x 6 descriptors, meaning that it can have 2 x 6 + * outstanding packets (for Rx and Tx). When using up to 10 TP sockets + * simultaneously, one could define TCP_WIN_SEG_COUNT as 120. */ +#define ipconfigTCP_WIN_SEG_COUNT 240 + +/* Each TCP socket has a circular buffers for Rx and Tx, which have a fixed + * maximum size. Define the size of Rx buffer for TCP sockets. */ +#define ipconfigTCP_RX_BUFFER_LENGTH ( 10000 ) + +/* Define the size of Tx buffer for TCP sockets. */ +#define ipconfigTCP_TX_BUFFER_LENGTH ( 10000 ) + +/* When using call-back handlers, the driver may check if the handler points to + * real program memory (RAM or flash) or just has a random non-zero value. */ +#define ipconfigIS_VALID_PROG_ADDRESS( x ) ( ( x ) != NULL ) + +/* Include support for TCP keep-alive messages. */ +#define ipconfigTCP_KEEP_ALIVE ( 1 ) +#define ipconfigTCP_KEEP_ALIVE_INTERVAL ( 20 ) /* Seconds. */ + +/* The socket semaphore is used to unblock the MQTT task. */ +#define ipconfigSOCKET_HAS_USER_SEMAPHORE ( 1 ) + +#define ipconfigSOCKET_HAS_USER_WAKE_CALLBACK ( 1 ) +#define ipconfigUSE_CALLBACKS ( 1 ) + + +#define portINLINE __inline + +#endif /* FREERTOS_IP_CONFIG_H */ diff --git a/test/build-combination/HeaderSelfContain/headerSelfContain.cmake b/test/build-combination/HeaderSelfContain/headerSelfContain.cmake new file mode 100644 index 0000000000..1b609f8ece --- /dev/null +++ b/test/build-combination/HeaderSelfContain/headerSelfContain.cmake @@ -0,0 +1,45 @@ +set( COMPILE_OPTIONS + $<$:-Wno-cast-qual> + $<$:-Wno-format-nonliteral> + $<$:-Wno-implicit-function-declaration> + $<$:-Wno-missing-noreturn> + $<$:-Wno-missing-prototypes> + $<$:-Wno-missing-variable-declarations> + $<$:-Wno-reserved-identifier> + $<$:-Wno-shorten-64-to-32> + $<$:-Wno-sign-conversion> + $<$:-Wno-unused-parameter> + $<$:-Wno-unused-macros> + $<$:-Wno-unused-variable> ) + +set( binaryList + TEST_HEADER_INC_ONLY_DHCP + TEST_HEADER_INC_ONLY_DNS + TEST_HEADER_INC_ONLY_IP + TEST_HEADER_INC_ONLY_ND + TEST_HEADER_INC_ONLY_ROUTING + TEST_HEADER_INC_ONLY_SOCKETS + TEST_HEADER_INC_ONLY_NETWORKBUFFERMANAGEMENT + TEST_HEADER_INC_ONLY_NETWORKINTERFACE ) + +foreach( singleOpt IN LISTS binaryList ) + add_executable(freertos_plus_tcp_build_test_${singleOpt} EXCLUDE_FROM_ALL) + target_compile_definitions(freertos_plus_tcp_build_test_${singleOpt} PRIVATE ${singleOpt}) + + target_sources(freertos_plus_tcp_build_test_${singleOpt} + PRIVATE + HeaderSelfContain/main.c + HeaderSelfContain/stubs.c + ) + + target_compile_options(freertos_plus_tcp_build_test_${singleOpt} + PRIVATE + ${COMPILE_OPTIONS} + ) + + target_link_libraries(freertos_plus_tcp_build_test_${singleOpt} + PRIVATE + freertos_plus_tcp + freertos_kernel + ) +endforeach() diff --git a/test/build-combination/HeaderSelfContain/main.c b/test/build-combination/HeaderSelfContain/main.c new file mode 100644 index 0000000000..3bb5a9b3b2 --- /dev/null +++ b/test/build-combination/HeaderSelfContain/main.c @@ -0,0 +1,60 @@ +/* + * FreeRTOS+TCP + * Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of + * this software and associated documentation files (the "Software"), to deal in + * the Software without restriction, including without limitation the rights to + * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + * the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS + * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR + * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER + * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + * http://aws.amazon.com/freertos + * http://www.FreeRTOS.org + */ + +/** + * @file main.c + * @brief Implements the main function. + */ + +/* FreeRTOS include. */ +#include +#include "task.h" + +/* System application includes. */ +#if defined TEST_HEADER_INC_ONLY_DHCP + #include "FreeRTOS_DHCP.h" +#elif defined TEST_HEADER_INC_ONLY_DNS + #include "FreeRTOS_DNS.h" +#elif defined TEST_HEADER_INC_ONLY_IP + #include "FreeRTOS_IP.h" +#elif defined TEST_HEADER_INC_ONLY_ND + #include "FreeRTOS_ND.h" +#elif defined TEST_HEADER_INC_ONLY_ROUTING + #include "FreeRTOS_Routing.h" +#elif defined TEST_HEADER_INC_ONLY_SOCKETS + #include "FreeRTOS_Sockets.h" +#elif defined TEST_HEADER_INC_ONLY_NETWORKBUFFERMANAGEMENT + #include "NetworkBufferManagement.h" +#elif defined TEST_HEADER_INC_ONLY_NETWORKINTERFACE + #include "NetworkInterface.h" +#endif + +/*-----------------------------------------------------------*/ +int main( void ) +{ + return 0; +} diff --git a/test/build-combination/HeaderSelfContain/stubs.c b/test/build-combination/HeaderSelfContain/stubs.c new file mode 100644 index 0000000000..cbc6d8e6c4 --- /dev/null +++ b/test/build-combination/HeaderSelfContain/stubs.c @@ -0,0 +1,343 @@ +/* + * FreeRTOS+TCP + * Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of + * this software and associated documentation files (the "Software"), to deal in + * the Software without restriction, including without limitation the rights to + * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of + * the Software, and to permit persons to whom the Software is furnished to do so, + * subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS + * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR + * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER + * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + * http://aws.amazon.com/freertos + * http://www.FreeRTOS.org + */ + +/** + * @file main.c + * @brief Implements the main function. + */ + +/* FreeRTOS include. */ +#include +#include "task.h" + +/* System application includes. */ +#include "FreeRTOS_IP.h" +#include "FreeRTOS_Sockets.h" +#include "FreeRTOS_DHCP.h" + +#include +#include +#include + +#define mainHOST_NAME "Build Combination" +#define mainDEVICE_NICK_NAME "Build_Combination" + +#if defined( _MSC_VER ) && ( _MSC_VER <= 1600 ) + #define local_stricmp _stricmp +#else + #define local_stricmp strcasecmp +#endif +/*-----------------------------------------------------------*/ + +/* Notes if the trace is running or not. */ +static BaseType_t xTraceRunning = pdTRUE; + +/* Default MAC address configuration. The demo creates a virtual network + * connection that uses this MAC address by accessing the raw Ethernet data + * to and from a real network connection on the host PC. See the + * configNETWORK_INTERFACE_TO_USE definition for information on how to configure + * the real network connection to use. */ +const uint8_t ucMACAddress[ 6 ] = +{ + configMAC_ADDR0, + configMAC_ADDR1, + configMAC_ADDR2, + configMAC_ADDR3, + configMAC_ADDR4, + configMAC_ADDR5 +}; + +/* The default IP and MAC address used by the code. It is used as a place holder. + */ +static const uint8_t ucIPAddress[ 4 ] = +{ + configIP_ADDR0, + configIP_ADDR1, + configIP_ADDR2, + configIP_ADDR3 +}; +static const uint8_t ucNetMask[ 4 ] = +{ + configNET_MASK0, + configNET_MASK1, + configNET_MASK2, + configNET_MASK3 +}; +static const uint8_t ucGatewayAddress[ 4 ] = +{ + configGATEWAY_ADDR0, + configGATEWAY_ADDR1, + configGATEWAY_ADDR2, + configGATEWAY_ADDR3 +}; +static const uint8_t ucDNSServerAddress[ 4 ] = +{ + configDNS_SERVER_ADDR0, + configDNS_SERVER_ADDR1, + configDNS_SERVER_ADDR2, + configDNS_SERVER_ADDR3 +}; + +/* Use by the pseudo random number generator. */ +static UBaseType_t ulNextRand; + +/*-----------------------------------------------------------*/ +/* *INDENT-OFF* */ +#if ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 ) + void vApplicationIPNetworkEventHook( eIPCallbackEvent_t eNetworkEvent ) +#else + void vApplicationIPNetworkEventHook_Multi( eIPCallbackEvent_t eNetworkEvent, + struct xNetworkEndPoint * pxEndPoint ) +#endif +/* *INDENT-ON* */ +{ + static BaseType_t xTasksAlreadyCreated = pdFALSE; + + /* If the network has just come up...*/ + if( ( eNetworkEvent == eNetworkUp ) && ( xTasksAlreadyCreated == pdFALSE ) ) + { + /* Do nothing. Just a stub. */ + + xTasksAlreadyCreated = pdTRUE; + } +} + +/*-----------------------------------------------------------*/ + +#if ( ( ipconfigUSE_LLMNR != 0 ) || \ + ( ipconfigUSE_NBNS != 0 ) || \ + ( ipconfigDHCP_REGISTER_HOSTNAME == 1 ) ) + + const char * pcApplicationHostnameHook( void ) + { + /* This function will be called during the DHCP: the machine will be registered + * with an IP address plus this name. */ + return mainHOST_NAME; + } + +#endif /* if ( ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 ) || ( ipconfigDHCP_REGISTER_HOSTNAME == 1 ) ) */ +/*-----------------------------------------------------------*/ + +#if ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 ) + + BaseType_t xApplicationDNSQueryHook( const char * pcName ) + { + BaseType_t xReturn; + + /* Determine if a name lookup is for this node. Two names are given + * to this node: that returned by pcApplicationHostnameHook() and that set + * by mainDEVICE_NICK_NAME. */ + if( local_stricmp( pcName, pcApplicationHostnameHook() ) == 0 ) + { + xReturn = pdPASS; + } + else if( local_stricmp( pcName, mainDEVICE_NICK_NAME ) == 0 ) + { + xReturn = pdPASS; + } + else + { + xReturn = pdFAIL; + } + + return xReturn; + } + +#endif /* if ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 ) */ +/*-----------------------------------------------------------*/ + +void vApplicationIdleHook( void ) +{ + const uint32_t ulMSToSleep = 1; + const TickType_t xKitHitCheckPeriod = pdMS_TO_TICKS( 1000UL ); + static TickType_t xTimeNow, xLastTimeCheck = 0; + + if( ( xTimeNow - xLastTimeCheck ) > xKitHitCheckPeriod ) + { + xLastTimeCheck = xTimeNow; + } + + /* Exit. Just a stub. */ +} + +/*-----------------------------------------------------------*/ + +void vLoggingPrintf( const char * pcFormat, + ... ) +{ + va_list arg; + + va_start( arg, pcFormat ); + vprintf( pcFormat, arg ); + va_end( arg ); +} +/*-----------------------------------------------------------*/ + +void getUserCmd( char * pucUserCmd ) +{ + /* Provide a stub for this function. */ +} +/*-----------------------------------------------------------*/ + +UBaseType_t uxRand( void ) +{ + const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL; + + /* Utility function to generate a pseudo random number. */ + + ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement; + return( ( int ) ( ulNextRand ) & 0x7fffUL ); +} + +BaseType_t xApplicationGetRandomNumber( uint32_t * pulNumber ) +{ + *pulNumber = uxRand(); + + return pdTRUE; +} + +/*-----------------------------------------------------------*/ + +void vApplicationGetIdleTaskMemory( StaticTask_t ** ppxIdleTaskTCBBuffer, + StackType_t ** ppxIdleTaskStackBuffer, + uint32_t * pulIdleTaskStackSize ) +{ + /* Provide a stub for this function. */ +} + +/*-----------------------------------------------------------*/ + +void vApplicationTickHook( void ) +{ + /* Provide a stub for this function. */ +} + +/*-----------------------------------------------------------*/ + +void vApplicationDaemonTaskStartupHook( void ) +{ + /* Provide a stub for this function. */ +} + +/* + * Callback that provides the inputs necessary to generate a randomized TCP + * Initial Sequence Number per RFC 6528. THIS IS ONLY A DUMMY IMPLEMENTATION + * THAT RETURNS A PSEUDO RANDOM NUMBER SO IS NOT INTENDED FOR USE IN PRODUCTION + * SYSTEMS. + */ +extern uint32_t ulApplicationGetNextSequenceNumber( uint32_t ulSourceAddress, + uint16_t usSourcePort, + uint32_t ulDestinationAddress, + uint16_t usDestinationPort ) +{ + ( void ) ulSourceAddress; + ( void ) usSourcePort; + ( void ) ulDestinationAddress; + ( void ) usDestinationPort; + + return uxRand(); +} + +void vApplicationGetTimerTaskMemory( StaticTask_t ** ppxTimerTaskTCBBuffer, + StackType_t ** ppxTimerTaskStackBuffer, + uint32_t * pulTimerTaskStackSize ) +{ + /* Provide a stub for this function. */ +} + +void vApplicationMallocFailedHook( void ) +{ + /* Provide a stub for this function. */ +} + +BaseType_t xNetworkInterfaceOutput( NetworkInterface_t * pxInterface, + NetworkBufferDescriptor_t * const pxNetworkBuffer, + BaseType_t bReleaseAfterSend ) +{ + /* Provide a stub for this function. */ + return pdTRUE; +} + +BaseType_t xNetworkInterfaceInitialise( void ) +{ + /* Provide a stub for this function. */ + return pdTRUE; +} + +struct xNetworkInterface * pxFillInterfaceDescriptor( BaseType_t xEMACIndex, + struct xNetworkInterface * pxInterface ) +{ + return pxInterface; +} + +#if ( ipconfigUSE_DHCP_HOOK != 0 ) + #if ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 ) + eDHCPCallbackAnswer_t xApplicationDHCPHook( eDHCPCallbackPhase_t eDHCPPhase, + uint32_t ulIPAddress ) + #else + eDHCPCallbackAnswer_t xApplicationDHCPHook_Multi( eDHCPCallbackPhase_t eDHCPPhase, + struct xNetworkEndPoint * pxEndPoint, + IP_Address_t * pxIPAddress ) + #endif + { + /* Provide a stub for this function. */ + return eDHCPContinue; + } +#endif /* ( ipconfigUSE_DHCP_HOOK != 0 ) */ + +#if ( ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES != 0 ) + +/* + * The stack will call this user hook for all Ethernet frames that it + * does not support, i.e. other than IPv4, IPv6 and ARP ( for the moment ) + * If this hook returns eReleaseBuffer or eProcessBuffer, the stack will + * release and reuse the network buffer. If this hook returns + * eReturnEthernetFrame, that means user code has reused the network buffer + * to generate a response and the stack will send that response out. + * If this hook returns eFrameConsumed, the user code has ownership of the + * network buffer and has to release it when it's done. + */ + eFrameProcessingResult_t eApplicationProcessCustomFrameHook( NetworkBufferDescriptor_t * const pxNetworkBuffer ) + { + ( void ) ( pxNetworkBuffer ); + return eProcessBuffer; + } + +#endif +void vApplicationPingReplyHook( ePingReplyStatus_t eStatus, + uint16_t usIdentifier ) +{ + /* Provide a stub for this function. */ +} + +#if ( ipconfigUSE_IPv6 != 0 ) && ( ipconfigUSE_DHCPv6 != 0 ) + /* DHCPv6 needs a time-stamp, seconds after 1970. */ + uint32_t ulApplicationTimeHook( void ) + { + return time( NULL ); + } +#endif From ad2fa325169ebc6c08519395efd6918cbad76466 Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Tue, 25 Jul 2023 10:53:04 +0000 Subject: [PATCH 06/10] Revert some redundant change --- source/include/FreeRTOS_IPv4.h | 2 +- source/include/FreeRTOS_IPv6.h | 4 ++++ source/include/FreeRTOS_IPv6_Private.h | 5 ----- source/include/FreeRTOS_Routing.h | 4 ++-- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/source/include/FreeRTOS_IPv4.h b/source/include/FreeRTOS_IPv4.h index 5e462c266d..3c5ccd7e7f 100644 --- a/source/include/FreeRTOS_IPv4.h +++ b/source/include/FreeRTOS_IPv4.h @@ -42,8 +42,8 @@ #include "FreeRTOSIPConfigDefaults.h" #include "IPTraceMacroDefaults.h" +/* Forward declarations. */ typedef struct xNETWORK_BUFFER NetworkBufferDescriptor_t; - typedef enum eFrameProcessingResult eFrameProcessingResult_t; typedef struct xIP_PACKET IPPacket_t; diff --git a/source/include/FreeRTOS_IPv6.h b/source/include/FreeRTOS_IPv6.h index cb2ed20481..a90338ae2c 100644 --- a/source/include/FreeRTOS_IPv6.h +++ b/source/include/FreeRTOS_IPv6.h @@ -83,6 +83,10 @@ extern const struct xIPv6_Address FreeRTOS_in6addr_loopback; struct xNetworkEndPoint; struct xNetworkInterface; +/* The function 'prvAllowIPPacket()' checks if a IPv6 packets should be processed. */ +eFrameProcessingResult_t prvAllowIPPacketIPv6( const IPHeader_IPv6_t * const pxIPv6Header, + const NetworkBufferDescriptor_t * const pxNetworkBuffer, + UBaseType_t uxHeaderLength ); /** @brief Handle the IPv6 extension headers. */ eFrameProcessingResult_t eHandleIPv6ExtensionHeaders( NetworkBufferDescriptor_t * const pxNetworkBuffer, diff --git a/source/include/FreeRTOS_IPv6_Private.h b/source/include/FreeRTOS_IPv6_Private.h index 53f757040c..6851fe8a40 100644 --- a/source/include/FreeRTOS_IPv6_Private.h +++ b/source/include/FreeRTOS_IPv6_Private.h @@ -260,11 +260,6 @@ struct xTCP_PACKET_IPv6 #include "pack_struct_end.h" typedef struct xTCP_PACKET_IPv6 TCPPacket_IPv6_t; -/* The function 'prvAllowIPPacket()' checks if a IPv6 packets should be processed. */ -eFrameProcessingResult_t prvAllowIPPacketIPv6( const IPHeader_IPv6_t * const pxIPv6Header, - const NetworkBufferDescriptor_t * const pxNetworkBuffer, - UBaseType_t uxHeaderLength ); - /* prvProcessICMPMessage_IPv6() is declared in FreeRTOS_routing.c * It handles all ICMP messages except the PING requests. */ eFrameProcessingResult_t prvProcessICMPMessage_IPv6( NetworkBufferDescriptor_t * const pxNetworkBuffer ); diff --git a/source/include/FreeRTOS_Routing.h b/source/include/FreeRTOS_Routing.h index 353a0c88a3..db7bcdb9ac 100644 --- a/source/include/FreeRTOS_Routing.h +++ b/source/include/FreeRTOS_Routing.h @@ -26,12 +26,12 @@ #ifndef FREERTOS_ROUTING_H #define FREERTOS_ROUTING_H - #include "FreeRTOS_IP.h" - #ifdef __cplusplus extern "C" { #endif + #include "FreeRTOS_IP.h" + #if ( ipconfigUSE_DHCP != 0 ) #include "FreeRTOS_DHCP.h" #endif From 94066a230dffa48c83b9d8ad20a65b9e5ba15856 Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Tue, 25 Jul 2023 10:58:47 +0000 Subject: [PATCH 07/10] Formatting --- source/include/FreeRTOS_IPv4.h | 6 +++--- test/build-combination/HeaderSelfContain/main.c | 3 +-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/source/include/FreeRTOS_IPv4.h b/source/include/FreeRTOS_IPv4.h index 3c5ccd7e7f..9693253285 100644 --- a/source/include/FreeRTOS_IPv4.h +++ b/source/include/FreeRTOS_IPv4.h @@ -43,9 +43,9 @@ #include "IPTraceMacroDefaults.h" /* Forward declarations. */ -typedef struct xNETWORK_BUFFER NetworkBufferDescriptor_t; -typedef enum eFrameProcessingResult eFrameProcessingResult_t; -typedef struct xIP_PACKET IPPacket_t; +typedef struct xNETWORK_BUFFER NetworkBufferDescriptor_t; +typedef enum eFrameProcessingResult eFrameProcessingResult_t; +typedef struct xIP_PACKET IPPacket_t; #define ipSIZE_OF_IPv4_HEADER 20U #define ipSIZE_OF_IPv4_ADDRESS 4U diff --git a/test/build-combination/HeaderSelfContain/main.c b/test/build-combination/HeaderSelfContain/main.c index 3bb5a9b3b2..00b0ddbdba 100644 --- a/test/build-combination/HeaderSelfContain/main.c +++ b/test/build-combination/HeaderSelfContain/main.c @@ -32,7 +32,6 @@ /* FreeRTOS include. */ #include -#include "task.h" /* System application includes. */ #if defined TEST_HEADER_INC_ONLY_DHCP @@ -51,7 +50,7 @@ #include "NetworkBufferManagement.h" #elif defined TEST_HEADER_INC_ONLY_NETWORKINTERFACE #include "NetworkInterface.h" -#endif +#endif /* if defined TEST_HEADER_INC_ONLY_DHCP */ /*-----------------------------------------------------------*/ int main( void ) From 37911e1f86497c0fa4f042b5f4892bf775b823a9 Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Tue, 25 Jul 2023 11:01:12 +0000 Subject: [PATCH 08/10] Add CI flow and fix formatting --- .github/workflows/ci.yml | 12 ++++++++++++ test/build-combination/CMakeLists.txt | 2 +- .../HeaderSelfContain/headerSelfContain.cmake | 2 +- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 30a17eb21d..ba528bb083 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -130,6 +130,18 @@ jobs: cmake -S . -B build -DFREERTOS_PLUS_TCP_TEST_CONFIGURATION=DEFAULT_CONF cmake --build build --target clean cmake --build build --target freertos_plus_tcp_build_test + - name: Build checks (Header Self Contain) + run: | + cmake -S . -B build -DFREERTOS_PLUS_TCP_TEST_CONFIGURATION=ENABLE_ALL -DTEST_HEADER_SELF_CONTAINED=ON + cmake --build build --target clean + cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_DHCP + cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_DNS + cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_IP + cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_ND + cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_ROUTING + cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_SOCKETS + cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_NETWORKBUFFERMANAGEMENT + cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_NETWORKINTERFACE complexity: runs-on: ubuntu-latest diff --git a/test/build-combination/CMakeLists.txt b/test/build-combination/CMakeLists.txt index 61c7ed063b..b9bdb7168c 100644 --- a/test/build-combination/CMakeLists.txt +++ b/test/build-combination/CMakeLists.txt @@ -103,7 +103,7 @@ else() $<$:-Wno-unused-macros> $<$:-Wno-unused-variable> ) - + target_link_libraries(freertos_plus_tcp_build_test PRIVATE freertos_plus_tcp diff --git a/test/build-combination/HeaderSelfContain/headerSelfContain.cmake b/test/build-combination/HeaderSelfContain/headerSelfContain.cmake index 1b609f8ece..83f3a4ba73 100644 --- a/test/build-combination/HeaderSelfContain/headerSelfContain.cmake +++ b/test/build-combination/HeaderSelfContain/headerSelfContain.cmake @@ -1,4 +1,4 @@ -set( COMPILE_OPTIONS +set( COMPILE_OPTIONS $<$:-Wno-cast-qual> $<$:-Wno-format-nonliteral> $<$:-Wno-implicit-function-declaration> From 7ae1cb4f74093dde6b14be876607bfc5e607adb2 Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Fri, 28 Jul 2023 04:59:12 +0000 Subject: [PATCH 09/10] Use -include compile option to test header self contain. --- .github/workflows/ci.yml | 18 +- CMakeLists.txt | 1 + source/include/FreeRTOS_DHCP.h | 2 + source/include/FreeRTOS_DNS.h | 2 + source/include/FreeRTOS_ND.h | 2 + source/include/FreeRTOS_Routing.h | 1 + test/build-combination/CMakeLists.txt | 77 ++-- .../HeaderSelfContain/headerSelfContain.cmake | 45 --- .../HeaderSelfContain/main.c | 59 --- .../HeaderSelfContain/stubs.c | 343 ------------------ .../FreeRTOSConfig.h | 0 .../FreeRTOSIPConfig.h | 24 +- .../headerSelfContain.cmake | 43 +++ 13 files changed, 103 insertions(+), 514 deletions(-) delete mode 100644 test/build-combination/HeaderSelfContain/headerSelfContain.cmake delete mode 100644 test/build-combination/HeaderSelfContain/main.c delete mode 100644 test/build-combination/HeaderSelfContain/stubs.c rename test/build-combination/{HeaderSelfContain => Header_Self_Contain}/FreeRTOSConfig.h (100%) rename test/build-combination/{HeaderSelfContain => Header_Self_Contain}/FreeRTOSIPConfig.h (94%) create mode 100644 test/build-combination/Header_Self_Contain/headerSelfContain.cmake diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ba528bb083..a78449b362 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -132,16 +132,16 @@ jobs: cmake --build build --target freertos_plus_tcp_build_test - name: Build checks (Header Self Contain) run: | - cmake -S . -B build -DFREERTOS_PLUS_TCP_TEST_CONFIGURATION=ENABLE_ALL -DTEST_HEADER_SELF_CONTAINED=ON + cmake -S . -B build -DFREERTOS_PLUS_TCP_TEST_CONFIGURATION=HEADER_SELF_CONTAIN cmake --build build --target clean - cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_DHCP - cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_DNS - cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_IP - cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_ND - cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_ROUTING - cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_SOCKETS - cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_NETWORKBUFFERMANAGEMENT - cmake --build build --target freertos_plus_tcp_build_test_TEST_HEADER_INC_ONLY_NETWORKINTERFACE + cmake --build build --target freertos_plus_tcp_build_test_FreeRTOS_DHCP + cmake --build build --target freertos_plus_tcp_build_test_FreeRTOS_DNS + cmake --build build --target freertos_plus_tcp_build_test_FreeRTOS_IP + cmake --build build --target freertos_plus_tcp_build_test_FreeRTOS_ND + cmake --build build --target freertos_plus_tcp_build_test_FreeRTOS_Routing + cmake --build build --target freertos_plus_tcp_build_test_FreeRTOS_Sockets + cmake --build build --target freertos_plus_tcp_build_test_NetworkBufferManagement + cmake --build build --target freertos_plus_tcp_build_test_NetworkInterface complexity: runs-on: ubuntu-latest diff --git a/CMakeLists.txt b/CMakeLists.txt index 3c6d536a0b..55fb622dfb 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -155,6 +155,7 @@ set(FREERTOS_PLUS_TCP_TEST_CONFIGURATION_LIST ENABLE_ALL_IPV6_TCP # Enable all configuration settings IPv6 TCP ENABLE_ALL_IPV4_IPV6 # Enable all configuration settings IPv4 IPv6 UDP DISABLE_ALL # Disable all configuration settings + HEADER_SELF_CONTAIN # Enable header self contain test DEFAULT_CONF # Default (typical) configuration ) if(NOT FREERTOS_PLUS_TCP_TEST_CONFIGURATION IN_LIST FREERTOS_PLUS_TCP_TEST_CONFIGURATION_LIST) diff --git a/source/include/FreeRTOS_DHCP.h b/source/include/FreeRTOS_DHCP.h index 2ab6c68a60..26fef7dea9 100644 --- a/source/include/FreeRTOS_DHCP.h +++ b/source/include/FreeRTOS_DHCP.h @@ -28,6 +28,8 @@ #ifndef FREERTOS_DHCP_H #define FREERTOS_DHCP_H +#include "FreeRTOS.h" + /* Application level configuration options. */ #include "FreeRTOSIPConfig.h" #include "IPTraceMacroDefaults.h" diff --git a/source/include/FreeRTOS_DNS.h b/source/include/FreeRTOS_DNS.h index c33a0c3a05..ee52841bb1 100644 --- a/source/include/FreeRTOS_DNS.h +++ b/source/include/FreeRTOS_DNS.h @@ -28,6 +28,8 @@ #ifndef FREERTOS_DNS_H #define FREERTOS_DNS_H +#include "FreeRTOS.h" + /* Application level configuration options. */ #include "FreeRTOS_DNS_Globals.h" #include "FreeRTOS_DNS_Callback.h" diff --git a/source/include/FreeRTOS_ND.h b/source/include/FreeRTOS_ND.h index 08c14c8e1e..475973b654 100644 --- a/source/include/FreeRTOS_ND.h +++ b/source/include/FreeRTOS_ND.h @@ -26,6 +26,8 @@ #ifndef FREERTOS_ND_H #define FREERTOS_ND_H +#include "FreeRTOS.h" + /* Application level configuration options. */ #include "FreeRTOSIPConfig.h" #include "FreeRTOSIPConfigDefaults.h" diff --git a/source/include/FreeRTOS_Routing.h b/source/include/FreeRTOS_Routing.h index 1d8fc7c5be..9612491f2e 100644 --- a/source/include/FreeRTOS_Routing.h +++ b/source/include/FreeRTOS_Routing.h @@ -26,6 +26,7 @@ #ifndef FREERTOS_ROUTING_H #define FREERTOS_ROUTING_H + #include "FreeRTOS.h" #include "FreeRTOS_IP.h" #if ( ipconfigUSE_DHCP != 0 ) diff --git a/test/build-combination/CMakeLists.txt b/test/build-combination/CMakeLists.txt index b9bdb7168c..88ada9f481 100644 --- a/test/build-combination/CMakeLists.txt +++ b/test/build-combination/CMakeLists.txt @@ -1,7 +1,3 @@ -option(TEST_HEADER_SELF_CONTAINED "Start header self contain test" OFF) - -# ------------------------------------------------------------------- - add_library( freertos_plus_tcp_config_common INTERFACE ) target_include_directories(freertos_plus_tcp_config_common INTERFACE Common ) @@ -40,16 +36,16 @@ add_library( freertos_plus_tcp_config_all_enable_ipv6_tcp INTERFACE) target_include_directories(freertos_plus_tcp_config_all_enable_ipv6_tcp INTERFACE Enable_IPv6_TCP) target_link_libraries(freertos_plus_tcp_config_all_enable_ipv6_tcp INTERFACE freertos_plus_tcp_config_common) +# ------------------------------------------------------------------- +add_library( freertos_plus_tcp_config_header_self_contain INTERFACE) +target_include_directories(freertos_plus_tcp_config_header_self_contain INTERFACE Header_Self_Contain) +target_link_libraries(freertos_plus_tcp_config_header_self_contain INTERFACE freertos_plus_tcp_config_common) + # ------------------------------------------------------------------- add_library( freertos_plus_tcp_config_default INTERFACE) target_include_directories(freertos_plus_tcp_config_default INTERFACE DefaultConf) target_link_libraries(freertos_plus_tcp_config_default INTERFACE freertos_plus_tcp_config_common) -# ------------------------------------------------------------------- -add_library( freertos_plus_tcp_header_self_contain INTERFACE) -target_include_directories(freertos_plus_tcp_header_self_contain INTERFACE HeaderSelfContain) -target_link_libraries(freertos_plus_tcp_header_self_contain INTERFACE freertos_plus_tcp_config_common) - # ------------------------------------------------------------------- # Configuration for FreeRTOS-Kernel if(FREERTOS_PLUS_TCP_TEST_CONFIGURATION STREQUAL "CUSTOM" ) @@ -71,42 +67,39 @@ elseif(FREERTOS_PLUS_TCP_TEST_CONFIGURATION STREQUAL "ENABLE_ALL_IPV6_TCP" ) add_library( freertos_config ALIAS freertos_plus_tcp_config_all_enable_ipv6_tcp) elseif(FREERTOS_PLUS_TCP_TEST_CONFIGURATION STREQUAL "ENABLE_ALL_IPV4_IPV6" ) add_library( freertos_config ALIAS freertos_plus_tcp_config_all_enable_ipv4_ipv6) +elseif(FREERTOS_PLUS_TCP_TEST_CONFIGURATION STREQUAL "HEADER_SELF_CONTAIN" ) + add_library( freertos_config ALIAS freertos_plus_tcp_config_header_self_contain) + include( Header_Self_Contain/headerSelfContain.cmake ) else() add_library( freertos_config ALIAS freertos_plus_tcp_config_default) endif() -# In header self contain test, we include headers one by one -# to make sure all header files are able to include separately. -if( TEST_HEADER_SELF_CONTAINED ) - include( HeaderSelfContain/headerSelfContain.cmake ) -else() - # Common build combination test. - add_executable(freertos_plus_tcp_build_test EXCLUDE_FROM_ALL) - - target_sources(freertos_plus_tcp_build_test - PRIVATE - Common/main.c - ) +# Common build combination test. +add_executable(freertos_plus_tcp_build_test EXCLUDE_FROM_ALL) - target_compile_options(freertos_plus_tcp_build_test - PRIVATE - $<$:-Wno-cast-qual> - $<$:-Wno-format-nonliteral> - $<$:-Wno-implicit-function-declaration> - $<$:-Wno-missing-noreturn> - $<$:-Wno-missing-prototypes> - $<$:-Wno-missing-variable-declarations> - $<$:-Wno-reserved-identifier> - $<$:-Wno-shorten-64-to-32> - $<$:-Wno-sign-conversion> - $<$:-Wno-unused-parameter> - $<$:-Wno-unused-macros> - $<$:-Wno-unused-variable> - ) +target_sources(freertos_plus_tcp_build_test +PRIVATE + Common/main.c +) - target_link_libraries(freertos_plus_tcp_build_test - PRIVATE - freertos_plus_tcp - freertos_kernel - ) -endif() +target_compile_options(freertos_plus_tcp_build_test + PRIVATE + $<$:-Wno-cast-qual> + $<$:-Wno-format-nonliteral> + $<$:-Wno-implicit-function-declaration> + $<$:-Wno-missing-noreturn> + $<$:-Wno-missing-prototypes> + $<$:-Wno-missing-variable-declarations> + $<$:-Wno-reserved-identifier> + $<$:-Wno-shorten-64-to-32> + $<$:-Wno-sign-conversion> + $<$:-Wno-unused-parameter> + $<$:-Wno-unused-macros> + $<$:-Wno-unused-variable> +) + +target_link_libraries(freertos_plus_tcp_build_test + PRIVATE + freertos_plus_tcp + freertos_kernel +) diff --git a/test/build-combination/HeaderSelfContain/headerSelfContain.cmake b/test/build-combination/HeaderSelfContain/headerSelfContain.cmake deleted file mode 100644 index 83f3a4ba73..0000000000 --- a/test/build-combination/HeaderSelfContain/headerSelfContain.cmake +++ /dev/null @@ -1,45 +0,0 @@ -set( COMPILE_OPTIONS - $<$:-Wno-cast-qual> - $<$:-Wno-format-nonliteral> - $<$:-Wno-implicit-function-declaration> - $<$:-Wno-missing-noreturn> - $<$:-Wno-missing-prototypes> - $<$:-Wno-missing-variable-declarations> - $<$:-Wno-reserved-identifier> - $<$:-Wno-shorten-64-to-32> - $<$:-Wno-sign-conversion> - $<$:-Wno-unused-parameter> - $<$:-Wno-unused-macros> - $<$:-Wno-unused-variable> ) - -set( binaryList - TEST_HEADER_INC_ONLY_DHCP - TEST_HEADER_INC_ONLY_DNS - TEST_HEADER_INC_ONLY_IP - TEST_HEADER_INC_ONLY_ND - TEST_HEADER_INC_ONLY_ROUTING - TEST_HEADER_INC_ONLY_SOCKETS - TEST_HEADER_INC_ONLY_NETWORKBUFFERMANAGEMENT - TEST_HEADER_INC_ONLY_NETWORKINTERFACE ) - -foreach( singleOpt IN LISTS binaryList ) - add_executable(freertos_plus_tcp_build_test_${singleOpt} EXCLUDE_FROM_ALL) - target_compile_definitions(freertos_plus_tcp_build_test_${singleOpt} PRIVATE ${singleOpt}) - - target_sources(freertos_plus_tcp_build_test_${singleOpt} - PRIVATE - HeaderSelfContain/main.c - HeaderSelfContain/stubs.c - ) - - target_compile_options(freertos_plus_tcp_build_test_${singleOpt} - PRIVATE - ${COMPILE_OPTIONS} - ) - - target_link_libraries(freertos_plus_tcp_build_test_${singleOpt} - PRIVATE - freertos_plus_tcp - freertos_kernel - ) -endforeach() diff --git a/test/build-combination/HeaderSelfContain/main.c b/test/build-combination/HeaderSelfContain/main.c deleted file mode 100644 index 00b0ddbdba..0000000000 --- a/test/build-combination/HeaderSelfContain/main.c +++ /dev/null @@ -1,59 +0,0 @@ -/* - * FreeRTOS+TCP - * Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * SPDX-License-Identifier: MIT - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * http://aws.amazon.com/freertos - * http://www.FreeRTOS.org - */ - -/** - * @file main.c - * @brief Implements the main function. - */ - -/* FreeRTOS include. */ -#include - -/* System application includes. */ -#if defined TEST_HEADER_INC_ONLY_DHCP - #include "FreeRTOS_DHCP.h" -#elif defined TEST_HEADER_INC_ONLY_DNS - #include "FreeRTOS_DNS.h" -#elif defined TEST_HEADER_INC_ONLY_IP - #include "FreeRTOS_IP.h" -#elif defined TEST_HEADER_INC_ONLY_ND - #include "FreeRTOS_ND.h" -#elif defined TEST_HEADER_INC_ONLY_ROUTING - #include "FreeRTOS_Routing.h" -#elif defined TEST_HEADER_INC_ONLY_SOCKETS - #include "FreeRTOS_Sockets.h" -#elif defined TEST_HEADER_INC_ONLY_NETWORKBUFFERMANAGEMENT - #include "NetworkBufferManagement.h" -#elif defined TEST_HEADER_INC_ONLY_NETWORKINTERFACE - #include "NetworkInterface.h" -#endif /* if defined TEST_HEADER_INC_ONLY_DHCP */ - -/*-----------------------------------------------------------*/ -int main( void ) -{ - return 0; -} diff --git a/test/build-combination/HeaderSelfContain/stubs.c b/test/build-combination/HeaderSelfContain/stubs.c deleted file mode 100644 index cbc6d8e6c4..0000000000 --- a/test/build-combination/HeaderSelfContain/stubs.c +++ /dev/null @@ -1,343 +0,0 @@ -/* - * FreeRTOS+TCP - * Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. - * - * SPDX-License-Identifier: MIT - * - * Permission is hereby granted, free of charge, to any person obtaining a copy of - * this software and associated documentation files (the "Software"), to deal in - * the Software without restriction, including without limitation the rights to - * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of - * the Software, and to permit persons to whom the Software is furnished to do so, - * subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS - * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR - * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER - * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN - * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * http://aws.amazon.com/freertos - * http://www.FreeRTOS.org - */ - -/** - * @file main.c - * @brief Implements the main function. - */ - -/* FreeRTOS include. */ -#include -#include "task.h" - -/* System application includes. */ -#include "FreeRTOS_IP.h" -#include "FreeRTOS_Sockets.h" -#include "FreeRTOS_DHCP.h" - -#include -#include -#include - -#define mainHOST_NAME "Build Combination" -#define mainDEVICE_NICK_NAME "Build_Combination" - -#if defined( _MSC_VER ) && ( _MSC_VER <= 1600 ) - #define local_stricmp _stricmp -#else - #define local_stricmp strcasecmp -#endif -/*-----------------------------------------------------------*/ - -/* Notes if the trace is running or not. */ -static BaseType_t xTraceRunning = pdTRUE; - -/* Default MAC address configuration. The demo creates a virtual network - * connection that uses this MAC address by accessing the raw Ethernet data - * to and from a real network connection on the host PC. See the - * configNETWORK_INTERFACE_TO_USE definition for information on how to configure - * the real network connection to use. */ -const uint8_t ucMACAddress[ 6 ] = -{ - configMAC_ADDR0, - configMAC_ADDR1, - configMAC_ADDR2, - configMAC_ADDR3, - configMAC_ADDR4, - configMAC_ADDR5 -}; - -/* The default IP and MAC address used by the code. It is used as a place holder. - */ -static const uint8_t ucIPAddress[ 4 ] = -{ - configIP_ADDR0, - configIP_ADDR1, - configIP_ADDR2, - configIP_ADDR3 -}; -static const uint8_t ucNetMask[ 4 ] = -{ - configNET_MASK0, - configNET_MASK1, - configNET_MASK2, - configNET_MASK3 -}; -static const uint8_t ucGatewayAddress[ 4 ] = -{ - configGATEWAY_ADDR0, - configGATEWAY_ADDR1, - configGATEWAY_ADDR2, - configGATEWAY_ADDR3 -}; -static const uint8_t ucDNSServerAddress[ 4 ] = -{ - configDNS_SERVER_ADDR0, - configDNS_SERVER_ADDR1, - configDNS_SERVER_ADDR2, - configDNS_SERVER_ADDR3 -}; - -/* Use by the pseudo random number generator. */ -static UBaseType_t ulNextRand; - -/*-----------------------------------------------------------*/ -/* *INDENT-OFF* */ -#if ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 ) - void vApplicationIPNetworkEventHook( eIPCallbackEvent_t eNetworkEvent ) -#else - void vApplicationIPNetworkEventHook_Multi( eIPCallbackEvent_t eNetworkEvent, - struct xNetworkEndPoint * pxEndPoint ) -#endif -/* *INDENT-ON* */ -{ - static BaseType_t xTasksAlreadyCreated = pdFALSE; - - /* If the network has just come up...*/ - if( ( eNetworkEvent == eNetworkUp ) && ( xTasksAlreadyCreated == pdFALSE ) ) - { - /* Do nothing. Just a stub. */ - - xTasksAlreadyCreated = pdTRUE; - } -} - -/*-----------------------------------------------------------*/ - -#if ( ( ipconfigUSE_LLMNR != 0 ) || \ - ( ipconfigUSE_NBNS != 0 ) || \ - ( ipconfigDHCP_REGISTER_HOSTNAME == 1 ) ) - - const char * pcApplicationHostnameHook( void ) - { - /* This function will be called during the DHCP: the machine will be registered - * with an IP address plus this name. */ - return mainHOST_NAME; - } - -#endif /* if ( ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 ) || ( ipconfigDHCP_REGISTER_HOSTNAME == 1 ) ) */ -/*-----------------------------------------------------------*/ - -#if ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 ) - - BaseType_t xApplicationDNSQueryHook( const char * pcName ) - { - BaseType_t xReturn; - - /* Determine if a name lookup is for this node. Two names are given - * to this node: that returned by pcApplicationHostnameHook() and that set - * by mainDEVICE_NICK_NAME. */ - if( local_stricmp( pcName, pcApplicationHostnameHook() ) == 0 ) - { - xReturn = pdPASS; - } - else if( local_stricmp( pcName, mainDEVICE_NICK_NAME ) == 0 ) - { - xReturn = pdPASS; - } - else - { - xReturn = pdFAIL; - } - - return xReturn; - } - -#endif /* if ( ipconfigUSE_LLMNR != 0 ) || ( ipconfigUSE_NBNS != 0 ) */ -/*-----------------------------------------------------------*/ - -void vApplicationIdleHook( void ) -{ - const uint32_t ulMSToSleep = 1; - const TickType_t xKitHitCheckPeriod = pdMS_TO_TICKS( 1000UL ); - static TickType_t xTimeNow, xLastTimeCheck = 0; - - if( ( xTimeNow - xLastTimeCheck ) > xKitHitCheckPeriod ) - { - xLastTimeCheck = xTimeNow; - } - - /* Exit. Just a stub. */ -} - -/*-----------------------------------------------------------*/ - -void vLoggingPrintf( const char * pcFormat, - ... ) -{ - va_list arg; - - va_start( arg, pcFormat ); - vprintf( pcFormat, arg ); - va_end( arg ); -} -/*-----------------------------------------------------------*/ - -void getUserCmd( char * pucUserCmd ) -{ - /* Provide a stub for this function. */ -} -/*-----------------------------------------------------------*/ - -UBaseType_t uxRand( void ) -{ - const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL; - - /* Utility function to generate a pseudo random number. */ - - ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement; - return( ( int ) ( ulNextRand ) & 0x7fffUL ); -} - -BaseType_t xApplicationGetRandomNumber( uint32_t * pulNumber ) -{ - *pulNumber = uxRand(); - - return pdTRUE; -} - -/*-----------------------------------------------------------*/ - -void vApplicationGetIdleTaskMemory( StaticTask_t ** ppxIdleTaskTCBBuffer, - StackType_t ** ppxIdleTaskStackBuffer, - uint32_t * pulIdleTaskStackSize ) -{ - /* Provide a stub for this function. */ -} - -/*-----------------------------------------------------------*/ - -void vApplicationTickHook( void ) -{ - /* Provide a stub for this function. */ -} - -/*-----------------------------------------------------------*/ - -void vApplicationDaemonTaskStartupHook( void ) -{ - /* Provide a stub for this function. */ -} - -/* - * Callback that provides the inputs necessary to generate a randomized TCP - * Initial Sequence Number per RFC 6528. THIS IS ONLY A DUMMY IMPLEMENTATION - * THAT RETURNS A PSEUDO RANDOM NUMBER SO IS NOT INTENDED FOR USE IN PRODUCTION - * SYSTEMS. - */ -extern uint32_t ulApplicationGetNextSequenceNumber( uint32_t ulSourceAddress, - uint16_t usSourcePort, - uint32_t ulDestinationAddress, - uint16_t usDestinationPort ) -{ - ( void ) ulSourceAddress; - ( void ) usSourcePort; - ( void ) ulDestinationAddress; - ( void ) usDestinationPort; - - return uxRand(); -} - -void vApplicationGetTimerTaskMemory( StaticTask_t ** ppxTimerTaskTCBBuffer, - StackType_t ** ppxTimerTaskStackBuffer, - uint32_t * pulTimerTaskStackSize ) -{ - /* Provide a stub for this function. */ -} - -void vApplicationMallocFailedHook( void ) -{ - /* Provide a stub for this function. */ -} - -BaseType_t xNetworkInterfaceOutput( NetworkInterface_t * pxInterface, - NetworkBufferDescriptor_t * const pxNetworkBuffer, - BaseType_t bReleaseAfterSend ) -{ - /* Provide a stub for this function. */ - return pdTRUE; -} - -BaseType_t xNetworkInterfaceInitialise( void ) -{ - /* Provide a stub for this function. */ - return pdTRUE; -} - -struct xNetworkInterface * pxFillInterfaceDescriptor( BaseType_t xEMACIndex, - struct xNetworkInterface * pxInterface ) -{ - return pxInterface; -} - -#if ( ipconfigUSE_DHCP_HOOK != 0 ) - #if ( ipconfigIPv4_BACKWARD_COMPATIBLE == 1 ) - eDHCPCallbackAnswer_t xApplicationDHCPHook( eDHCPCallbackPhase_t eDHCPPhase, - uint32_t ulIPAddress ) - #else - eDHCPCallbackAnswer_t xApplicationDHCPHook_Multi( eDHCPCallbackPhase_t eDHCPPhase, - struct xNetworkEndPoint * pxEndPoint, - IP_Address_t * pxIPAddress ) - #endif - { - /* Provide a stub for this function. */ - return eDHCPContinue; - } -#endif /* ( ipconfigUSE_DHCP_HOOK != 0 ) */ - -#if ( ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES != 0 ) - -/* - * The stack will call this user hook for all Ethernet frames that it - * does not support, i.e. other than IPv4, IPv6 and ARP ( for the moment ) - * If this hook returns eReleaseBuffer or eProcessBuffer, the stack will - * release and reuse the network buffer. If this hook returns - * eReturnEthernetFrame, that means user code has reused the network buffer - * to generate a response and the stack will send that response out. - * If this hook returns eFrameConsumed, the user code has ownership of the - * network buffer and has to release it when it's done. - */ - eFrameProcessingResult_t eApplicationProcessCustomFrameHook( NetworkBufferDescriptor_t * const pxNetworkBuffer ) - { - ( void ) ( pxNetworkBuffer ); - return eProcessBuffer; - } - -#endif -void vApplicationPingReplyHook( ePingReplyStatus_t eStatus, - uint16_t usIdentifier ) -{ - /* Provide a stub for this function. */ -} - -#if ( ipconfigUSE_IPv6 != 0 ) && ( ipconfigUSE_DHCPv6 != 0 ) - /* DHCPv6 needs a time-stamp, seconds after 1970. */ - uint32_t ulApplicationTimeHook( void ) - { - return time( NULL ); - } -#endif diff --git a/test/build-combination/HeaderSelfContain/FreeRTOSConfig.h b/test/build-combination/Header_Self_Contain/FreeRTOSConfig.h similarity index 100% rename from test/build-combination/HeaderSelfContain/FreeRTOSConfig.h rename to test/build-combination/Header_Self_Contain/FreeRTOSConfig.h diff --git a/test/build-combination/HeaderSelfContain/FreeRTOSIPConfig.h b/test/build-combination/Header_Self_Contain/FreeRTOSIPConfig.h similarity index 94% rename from test/build-combination/HeaderSelfContain/FreeRTOSIPConfig.h rename to test/build-combination/Header_Self_Contain/FreeRTOSIPConfig.h index 2f6d5ccec9..e713802211 100644 --- a/test/build-combination/HeaderSelfContain/FreeRTOSIPConfig.h +++ b/test/build-combination/Header_Self_Contain/FreeRTOSIPConfig.h @@ -55,7 +55,7 @@ #define ipconfigSOCKET_HAS_USER_SEMAPHORE 1 #define ipconfigSELECT_USES_NOTIFY 1 #define ipconfigSUPPORT_SIGNALS 1 -#define ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES 0 +#define ipconfigPROCESS_CUSTOM_ETHERNET_FRAMES 1 /* Set to 1 to print out debug messages. If ipconfigHAS_DEBUG_PRINTF is set to * 1 then FreeRTOS_debug_printf should be defined to the function used to print @@ -119,20 +119,12 @@ * http://www.freertos.org/Stacks-and-stack-overflow-checking.html. */ #define ipconfigIP_TASK_STACK_SIZE_WORDS ( configMINIMAL_STACK_SIZE * 5 ) -/* ipconfigRAND32() is called by the IP stack to generate random numbers for - * things such as a DHCP transaction number or initial sequence number. Random - * number generation is performed via this macro to allow applications to use their - * own random number generation method. For example, it might be possible to - * generate a random number by sampling noise on an analogue input. */ -extern uint32_t ulRand(); -#define ipconfigRAND32() ulRand() - /* If ipconfigUSE_NETWORK_EVENT_HOOK is set to 1 then FreeRTOS+TCP will call the * network event hook at the appropriate times. If ipconfigUSE_NETWORK_EVENT_HOOK * is not set to 1 then the network event hook will never be called. See: * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_UDP/API/vApplicationIPNetworkEventHook.shtml. */ -#define ipconfigUSE_NETWORK_EVENT_HOOK 0 +#define ipconfigUSE_NETWORK_EVENT_HOOK 1 /* Sockets have a send block time attribute. If FreeRTOS_sendto() is called but * a network buffer cannot be obtained then the calling task is held in the Blocked @@ -146,7 +138,7 @@ extern uint32_t ulRand(); * ipconfigMAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks. A time in * milliseconds can be converted to a time in ticks by dividing the time in * milliseconds by portTICK_PERIOD_MS. */ -#define ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS ( 5000U / portTICK_PERIOD_MS ) +#define ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS ( 5000U / portTICK_PERIOD_MS ) /* If ipconfigUSE_DHCP is 1 then FreeRTOS+TCP will attempt to retrieve an IP * address, netmask, DNS server address and gateway address from a DHCP server. If @@ -155,14 +147,14 @@ extern uint32_t ulRand(); * set to 1 if a valid configuration cannot be obtained from a DHCP server for any * reason. The static configuration used is that passed into the stack by the * FreeRTOS_IPInit() function call. */ -#define ipconfigUSE_DHCP 1 -#define ipconfigDHCP_REGISTER_HOSTNAME 1 -#define ipconfigDHCP_USES_UNICAST 1 +#define ipconfigUSE_DHCP 1 +#define ipconfigDHCP_REGISTER_HOSTNAME 1 +#define ipconfigDHCP_USES_UNICAST 1 /* If ipconfigDHCP_USES_USER_HOOK is set to 1 then the application writer must * provide an implementation of the DHCP callback function, * xApplicationDHCPUserHook(). */ -#define ipconfigUSE_DHCP_HOOK 0 +#define ipconfigUSE_DHCP_HOOK 1 /* When ipconfigUSE_DHCP is set to 1, DHCP requests will be sent out at * increasing time intervals until either a reply is received from a DHCP server @@ -264,7 +256,7 @@ extern uint32_t ulRand(); /* If ipconfigSUPPORT_OUTGOING_PINGS is set to 1 then the * FreeRTOS_SendPingRequest() API function is available. */ -#define ipconfigSUPPORT_OUTGOING_PINGS 0 +#define ipconfigSUPPORT_OUTGOING_PINGS 1 /* If ipconfigSUPPORT_SELECT_FUNCTION is set to 1 then the FreeRTOS_select() * (and associated) API function is available. */ diff --git a/test/build-combination/Header_Self_Contain/headerSelfContain.cmake b/test/build-combination/Header_Self_Contain/headerSelfContain.cmake new file mode 100644 index 0000000000..eaedad2561 --- /dev/null +++ b/test/build-combination/Header_Self_Contain/headerSelfContain.cmake @@ -0,0 +1,43 @@ +set( headerList + FreeRTOS_DHCP + FreeRTOS_DNS + FreeRTOS_IP + FreeRTOS_ND + FreeRTOS_Routing + FreeRTOS_Sockets + NetworkBufferManagement + NetworkInterface ) + +foreach( header IN LISTS headerList ) + add_executable(freertos_plus_tcp_build_test_${header} EXCLUDE_FROM_ALL) + + target_sources(freertos_plus_tcp_build_test_${header} + PRIVATE + Common/main.c + ) + + # In header self contain test, we include headers one by one (by "-include ${header}.h") + # to make sure all header files are able to include separately. + target_compile_options(freertos_plus_tcp_build_test_${header} + PRIVATE + -include ${header}.h + $<$:-Wno-cast-qual> + $<$:-Wno-format-nonliteral> + $<$:-Wno-implicit-function-declaration> + $<$:-Wno-missing-noreturn> + $<$:-Wno-missing-prototypes> + $<$:-Wno-missing-variable-declarations> + $<$:-Wno-reserved-identifier> + $<$:-Wno-shorten-64-to-32> + $<$:-Wno-sign-conversion> + $<$:-Wno-unused-parameter> + $<$:-Wno-unused-macros> + $<$:-Wno-unused-variable> + ) + + target_link_libraries(freertos_plus_tcp_build_test_${header} + PRIVATE + freertos_plus_tcp + freertos_kernel + ) +endforeach() From aabab1a96bcf05dfc92f603c6f0d6891ed9fd05d Mon Sep 17 00:00:00 2001 From: ActoryOu Date: Fri, 28 Jul 2023 05:02:19 +0000 Subject: [PATCH 10/10] Formatting --- .../Header_Self_Contain/headerSelfContain.cmake | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/test/build-combination/Header_Self_Contain/headerSelfContain.cmake b/test/build-combination/Header_Self_Contain/headerSelfContain.cmake index eaedad2561..3ebfe6f186 100644 --- a/test/build-combination/Header_Self_Contain/headerSelfContain.cmake +++ b/test/build-combination/Header_Self_Contain/headerSelfContain.cmake @@ -19,8 +19,8 @@ foreach( header IN LISTS headerList ) # In header self contain test, we include headers one by one (by "-include ${header}.h") # to make sure all header files are able to include separately. target_compile_options(freertos_plus_tcp_build_test_${header} - PRIVATE - -include ${header}.h + PRIVATE + -include ${header}.h $<$:-Wno-cast-qual> $<$:-Wno-format-nonliteral> $<$:-Wno-implicit-function-declaration>