Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] Support for CMake #556

Open
phelter opened this issue Sep 23, 2022 · 1 comment
Open

[Feature Request] Support for CMake #556

phelter opened this issue Sep 23, 2022 · 1 comment
Labels
help wanted Extra attention is needed

Comments

@phelter
Copy link
Contributor

phelter commented Sep 23, 2022

Is your feature request related to a problem? Please describe.
As an integrator of FreeRTOS-Plus-TCP would like to support compilation via CMake.

Describe the solution you'd like

I would like to be able to integrate FreeRTOS-Plus-TCP via CMake to support a simpler build environment for native and cross-compilation.

I typically build my environments with an opt-out approach to all warnings and issues linters/compilers provide while compiling/building. The primary compilers I use are GNU and Clang (sometimes MSVC).

I typically pull in repositories of this kind using (FetchContent)[https://cmake.org/cmake/help/latest/module/FetchContent.html?highlight=fetchcontent] functionality as it provides one key benefit over git submodules which is to allow a top level project to dictate the version being pulled, yet others FetchContent repos may request different versions. Allowing the integrator of this project to decide on the version being pulled. It also allows for a simple migration if/when a contributor decides to fork a repo (if required).

Describe alternatives you've considered
There are other build environments out there that support cross compilation (eg. meson, bazel); however, CMake is the most wide spread and widely used. It is also the one that has support in the FreeRTOS-Kernel project as of v10.5.0. Supporting other build environments in the future is not hindered by supporting CMake now.

Additional context
I will provide an example build of the existing code that I lay over the current FreeRTOS-Plus-TCP that allows me to compile for both GCC and CLang and provides hooks to compile with other compilers.

With the addition of the compiler warning opt-out approach it will also identify documentation and other potential fixes that you may want to clean-up within the code, now that those compilers are defined with the strictest of measures.

@phelter
Copy link
Contributor Author

phelter commented Sep 24, 2022

Here is the cmake builds.

Note: Outstanding items:

  • Some of the build Network Interfaces for various platforms are not complete - didn't want to infer anything there. Have not tested on all of them.
  • Left the build of various unit tests alone - suggest making those as just add_subdirectory() integrated as well.
  • Have only tested on Clang 13/GNU 7.5 - with POSIX.

I'm adding a patch file here since I don't have access to create a branch.
cmake_build.patch.txt

phelter added a commit to phelter/FreeRTOS-Plus-TCP that referenced this issue Sep 25, 2022
phelter added a commit to phelter/FreeRTOS-Plus-TCP that referenced this issue Sep 25, 2022
amazonKamath pushed a commit that referenced this issue Feb 24, 2023
* #556 Initial Cmake Module definition.

* Fixing CI builds, rely on pcap. (#556)

* Updating tested configurations and minor clean-up of missing network interfaces (#555)

* Further clean-up based on testing with build environment. (#555)

* Using single definition for libraries everywhere. (#555)

* Fixing A_CUSTOM_NETWORK_IF compile option.

* Identifying and fixing compile issues.

* Adding in additional warnings for GNU to ignore for now.

* Fixing formatting issues with uncrustify.

* More warnings for GNU used by CI/CD pipeline.

* Assuming custom for build tests and using latest freertos-kernel code.  Updated readme for how to consume at project level.

* Fixing up issues identified in the PR. Making the build_test EXCLUDE_FROM_ALL so only compiled if requested.

* Changing to support C89 instead of C99. Renaming tcp_tools to tcp_utilities to mimic the directory.

* Using C90 ISO.  Fixing compiler warnings.

* Fixing non C90 compliant declaration after statement

* Separating out CMakeLists so each port is independent.

* Updating warning list in code.

* Fixed formatting with uncrustify.

* Fix failing tests

* Fix failing unit-test

* Fix a typo.

---------

Co-authored-by: Aniruddha Kanhere <[email protected]>
@amazonKamath amazonKamath reopened this Mar 10, 2023
moninom1 pushed a commit to moninom1/FreeRTOS-Plus-TCP that referenced this issue Mar 14, 2023
* Fixing CI builds, rely on pcap. (FreeRTOS#556)

* Updating tested configurations and minor clean-up of missing network interfaces (FreeRTOS#555)

* Further clean-up based on testing with build environment. (FreeRTOS#555)

* Using single definition for libraries everywhere. (FreeRTOS#555)

* Fixing A_CUSTOM_NETWORK_IF compile option.

* Identifying and fixing compile issues.

* Adding in additional warnings for GNU to ignore for now.

* Fixing formatting issues with uncrustify.

* More warnings for GNU used by CI/CD pipeline.

* Assuming custom for build tests and using latest freertos-kernel code.  Updated readme for how to consume at project level.

* Fixing up issues identified in the PR. Making the build_test EXCLUDE_FROM_ALL so only compiled if requested.

* Changing to support C89 instead of C99. Renaming tcp_tools to tcp_utilities to mimic the directory.

* Using C90 ISO.  Fixing compiler warnings.

* Fixing non C90 compliant declaration after statement

* Separating out CMakeLists so each port is independent.

* Updating warning list in code.

* Fixed formatting with uncrustify.

* Fix failing tests

* Fix failing unit-test

* Fix a typo.

---------

Co-authored-by: Aniruddha Kanhere <[email protected]>
moninom1 pushed a commit to moninom1/FreeRTOS-Plus-TCP that referenced this issue Mar 14, 2023
* Fixing CI builds, rely on pcap. (FreeRTOS#556)

* Updating tested configurations and minor clean-up of missing network interfaces (FreeRTOS#555)

* Further clean-up based on testing with build environment. (FreeRTOS#555)

* Using single definition for libraries everywhere. (FreeRTOS#555)

* Fixing A_CUSTOM_NETWORK_IF compile option.

* Identifying and fixing compile issues.

* Adding in additional warnings for GNU to ignore for now.

* Fixing formatting issues with uncrustify.

* More warnings for GNU used by CI/CD pipeline.

* Assuming custom for build tests and using latest freertos-kernel code.  Updated readme for how to consume at project level.

* Fixing up issues identified in the PR. Making the build_test EXCLUDE_FROM_ALL so only compiled if requested.

* Changing to support C89 instead of C99. Renaming tcp_tools to tcp_utilities to mimic the directory.

* Using C90 ISO.  Fixing compiler warnings.

* Fixing non C90 compliant declaration after statement

* Separating out CMakeLists so each port is independent.

* Updating warning list in code.

* Fixed formatting with uncrustify.

* Fix failing tests

* Fix failing unit-test

* Fix a typo.

---------

Co-authored-by: Aniruddha Kanhere <[email protected]>
moninom1 pushed a commit to moninom1/FreeRTOS-Plus-TCP that referenced this issue Mar 15, 2023
* Fixing CI builds, rely on pcap. (FreeRTOS#556)

* Updating tested configurations and minor clean-up of missing network interfaces (FreeRTOS#555)

* Further clean-up based on testing with build environment. (FreeRTOS#555)

* Using single definition for libraries everywhere. (FreeRTOS#555)

* Fixing A_CUSTOM_NETWORK_IF compile option.

* Identifying and fixing compile issues.

* Adding in additional warnings for GNU to ignore for now.

* Fixing formatting issues with uncrustify.

* More warnings for GNU used by CI/CD pipeline.

* Assuming custom for build tests and using latest freertos-kernel code.  Updated readme for how to consume at project level.

* Fixing up issues identified in the PR. Making the build_test EXCLUDE_FROM_ALL so only compiled if requested.

* Changing to support C89 instead of C99. Renaming tcp_tools to tcp_utilities to mimic the directory.

* Using C90 ISO.  Fixing compiler warnings.

* Fixing non C90 compliant declaration after statement

* Separating out CMakeLists so each port is independent.

* Updating warning list in code.

* Fixed formatting with uncrustify.

* Fix failing tests

* Fix failing unit-test

* Fix a typo.

---------

Co-authored-by: Aniruddha Kanhere <[email protected]>
@amazonKamath amazonKamath added the help wanted Extra attention is needed label May 22, 2023
moninom1 added a commit that referenced this issue Jul 5, 2023
* Update mainline to reflect changes after the release. (#563)

* Update README.md

* Update History.txt

* Update version number macros

* Update manifest.yml

* IPv4/single SAME70 emac race condition (#567)

* Implemented Maty's solution

* Added a new statistic 'tx_write_fail'

* Uncrustify: triggered by comment.

Co-authored-by: Hein Tibosch <[email protected]>
Co-authored-by: GitHub Action <[email protected]>

* IPv4/Single: Add a SocketID to a socket (#546)

* IPv4/Single: Add a SocketID to a socket

* Change in comment

* Applied uncrustify to format the source code

* Added a few entries to lexicon.txt

* Removed the 'ipconfigUSE_SetSocketID' option

* Change to lexicon.txt

* Add unit tests for the newly added API

Co-authored-by: Hein Tibosch <[email protected]>
Co-authored-by: alfred gedeon <[email protected]>
Co-authored-by: Aniruddha Kanhere <[email protected]>

* IPv4/single: SAME70 EMAC buffer sizes (#568)

* Implemented Maty's solution

* Added a new statistic 'tx_write_fail'

* Uncrustify: triggered by comment.

* Increase NETWORK_BUFFER_SIZE in order to include the 'ipBUFFER_PADDING' bytes

* ICMP checksum calculated manually

* Uncrustify: triggered by comment.

* Update gmac_SAM.c

Co-authored-by: Hein Tibosch <[email protected]>
Co-authored-by: GitHub Action <[email protected]>
Co-authored-by: Aniruddha Kanhere <[email protected]>

* Eliminate some warnings (#578)

* Eliminate some warnings related to print statements

Authored-by:  Pete Bone  <[email protected] >

* Add MISRA justification for use of dynamic memory (#581)

* Update deprecated macros in network driver files (#579)

* Update deprecated macros in network driver files

* Fix typo in RX driver.

* Replace #warning with #error on test for deprecated macro.

* Fix doxygen check

Co-authored-by: PeterB <[email protected]>
Co-authored-by: Aniruddha Kanhere <[email protected]>

* Fix Network-interface of the Xilinx UltraScale port (#588)

The underlying issue was when the port would be used with Jumbo frames.
During receives of Jumbo packets the data length was always set
incorrectly, which then would cause buffer allocation issues and
subsequently corrupted data would be sent to the IP-task.

After some inspection in the Xilinx UltraScale port, I found out
that when the data length would be set, the wrong mask from the
Xilinx Ethernet MAC driver would be used. By using the right mask
(XEMACPS_RXBUF_LEN_JUMBO_MASK) when Jumbo Frame support is enabled
the issue was resolved

* Fix Windows thread calling vTaskSuspendAll / xTaskResumeAll. (#592)

Co-authored-by: Jason Carroll <[email protected]>

* Updated comments for FreeRTOS_select return value (#596)

* Updated comments for FreeRTOS_select return value

* Updated the function brief for FreeRTOS_select

* Uncrustify: triggered by comment.

* Updating FreeRTOS_select function @brief

* Updated function brief for FreeRTOS_SignalSocket

* Uncrustify: triggered by comment.

* Update source/FreeRTOS_Sockets.c

Co-authored-by: Ubuntu <[email protected]>
Co-authored-by: GitHub Action <[email protected]>
Co-authored-by: Aniruddha Kanhere <[email protected]>

* Fixed readme script to build and run unit tests (#644)

* Minor warning fixes (#589)

* Eliminate compiler unused parameter warning

* Eliminate compiler unused variable warnings

* Eliminate compiler unused function warning

The function pcGetPHIName(...) would be called only in the
FreeRTOS_printf message, however FreeRTOS_printf maybe be defined
to nothing e.g. release builds, which then the warning would come up

* Rework callback setups in the EMAC-driver of the Xilinx UltraScale port

The calls to the function XEmacPs_SetHandler would trigger the
pedantic warning:

"ISO C forbids conversion of object pointer to function pointer type"

The reason for this, is that the second parameter of the function
XEmacPS_SetHandler is declared as pointer to a void type, but the
function "expects" a function pointer, which in setup_isr rightly
happens.

However IMHO, this is just bad code from the side of Xilinx, as not
on all architectures the size of a data pointer is identical to the
size of a function pointer, which also is correctly recognised by
the compiler.

Instead of using the "bad" function XEmacPs_SetHandler, we can set the
handlers manually to the EmacPS-instance.

* Uncrustify: triggered by comment.

* Update source/portable/NetworkInterface/xilinx_ultrascale/x_emacpsif_hw.c

Co-authored-by: Paul Bartell <[email protected]>

* Apply suggestions from code review

Co-authored-by: Paul Bartell <[email protected]>

* Address comments from reviews

Co-authored-by: GitHub Action <[email protected]>
Co-authored-by: Paul Bartell <[email protected]>

* Use CBMC XML output to enable VSCode debugger (#673)

Prior to this commit, CBMC would emit logging information in plain text
format, which does not contain information required for the CBMC VSCode
debugger. This commit makes CBMC use XML instead of plain text.

Co-authored-by: Mark Tuttle <[email protected]>

* Remove need of token

* Use vTaskDelay for sleep in the network-interface of xilinx_ultrascale (#698)

The issue here is that, the FreeRTOS IP-task would block all other
tasks during PHY-link speed negotiations, as it was using busy
waiting. However this is not really ideal. A much more suitable
function for such a task would be `vTaskDelay`.

* Make sure that a TCP socket is closed only once (#707)

* Make sure that a TCP socket is closed only once

* Fix failing test cases for FreeRTOS_TCP_IP unit test modules post PR#705 changes

* Uncrustify: triggered by comment.

* Fix failing test cases for FreeRTOS_TCP_IP unit test modules post PR - 705 changes

---------

Co-authored-by: Hein Tibosch <[email protected]>
Co-authored-by: GitHub Action <[email protected]>

* Remove Dup function HAL_ETH_SetMDIOClockRange. (#711)

* Update PR template to include checkbox for ut change (#734)

* Main/TCP4 : ACK number in TCP RESET reply to SYN packet (#724)

* Main/TCP4 : ACK number in TCP RESET reply to SYN packet

* Typo fix

* Add unit-test for coverage; Fix ntohl to htonl

* Fix unit-test

---------

Co-authored-by: Nikhil Kamath <[email protected]>
Co-authored-by: Aniruddha Kanhere <[email protected]>

* #556 Initial Cmake Module definition. (#557)

* #556 Initial Cmake Module definition.

* Fixing CI builds, rely on pcap. (#556)

* Updating tested configurations and minor clean-up of missing network interfaces (#555)

* Further clean-up based on testing with build environment. (#555)

* Using single definition for libraries everywhere. (#555)

* Fixing A_CUSTOM_NETWORK_IF compile option.

* Identifying and fixing compile issues.

* Adding in additional warnings for GNU to ignore for now.

* Fixing formatting issues with uncrustify.

* More warnings for GNU used by CI/CD pipeline.

* Assuming custom for build tests and using latest freertos-kernel code.  Updated readme for how to consume at project level.

* Fixing up issues identified in the PR. Making the build_test EXCLUDE_FROM_ALL so only compiled if requested.

* Changing to support C89 instead of C99. Renaming tcp_tools to tcp_utilities to mimic the directory.

* Using C90 ISO.  Fixing compiler warnings.

* Fixing non C90 compliant declaration after statement

* Separating out CMakeLists so each port is independent.

* Updating warning list in code.

* Fixed formatting with uncrustify.

* Fix failing tests

* Fix failing unit-test

* Fix a typo.

---------

Co-authored-by: Aniruddha Kanhere <[email protected]>

* CMake: Fix GIT_REPOSITORY and GIT_TAG (#742)

* Allow use of loopback addresses in IP stack (127.0.0.0/8) (#754)

Authored-by: Adam St. Amand <[email protected]>

* Add release candidate automation (#761)

This is a minimal subset of release automation which only creates a tag
and verifies it.

Signed-off-by: Gaurav Aggarwal <[email protected]>

* Add CBMC-running GitHub Action;

This commit adds a GitHub Action that runs the CBMC proofs in this
repository upon pushes and pull requests

* Copy CBMC output directory to CI location

This commit ensures that the output directory for CBMC proofs is in the
correct location expected by the FreeRTOS CI-CD repository.

* rx: Read mac address using FreeRTOS_GetMACAddress() rather than using the defines (#765)

* Read mac address using FreeRTOS_GetMACAddress() rather than using the defines
---------
Co-authored-by: GitHub Action <[email protected]>

* cmake: Remove add_subdirectory( cbmc ) call

CBMC proofs cannot currently be run using CMake.

fixes #753

* FreeRTOS_IP.h: Fix build error introduced by 55658e1 in FreeRTOS-Kernel

* Add Nxp1060 network interface (#774)

* Update PR template to include checkbox for ut change

* Create NetworkInterface.c

* Uncrustify: triggered by comment.

* Address PR comments

* Uncrustify: triggered by comment.

* Update NetworkInterface.c

* Uncrustify: triggered by comment.

* Update copyright year

* Refactor the init function. Add 'brief'. Cleanup.

* Uncrustify: triggered by comment.

* Update global link status only when the network is quiet

* Uncrustify: triggered by comment.

* Update copyright yeat

* Update the driver to deal with network cable disconnects

* Uncrustify: triggered by comment.

* Update NetworkInterface.c

* Clean up and address PR comments

* More cleanup and address PR comments

* Uncrustify: triggered by comment.

* Empty-Commit

* Address issue comments

* Uncrustify: triggered by comment.

* Empty-Commit to trigger workflow

* Remove Full-Duplex restriction

* Uncrustify: triggered by comment.

* Empty-Commit to trigger workflow

---------

Co-authored-by: GitHub Action <[email protected]>

* Correct GCC warnings (#798)

* Correct GCC warnings

Corrects warnings with current GCC flags
for GCC 7.5.0. The only suppressed warning pertains
to function to object pointer conversion which is
required and common for socket callbacks.

* PR feedback

---------

Co-authored-by: Ubuntu <[email protected]>
Co-authored-by: Nikhil Kamath <[email protected]>

* Cleanup of NXP1060 network driver (#801)

* Update PR template to include checkbox for ut change

* Empty-Commit to trigger workflow

* Fix issues pointed out in PR comments

* Uncrustify: triggered by comment.

* Empty-Commit to trigger workflow

---------

Co-authored-by: GitHub Action <[email protected]>

* Fix Clang warnings (#809)

Corrects several warnings from Clang flags
for Clang 13.

Inspired by @phelter's bug report
#558

* uncrustify yml fix (#815)

* Add NetworkDown notification to NetworkInterface.c [PR: #671] (#812)

* Add NetworkDown notification to EMAC task

* Add NetworkDown notification to NetworkInterface.c

* Uncrustify: triggered by comment.

* Introduce ipconfigSUPPORT_NETWORK_DOWN_EVENT compile flag

* Fix formatting

* Uncrustify: triggered by comment.

---------

Co-authored-by: Filip Oleszek <[email protected]>
Co-authored-by: zipperowiec <[email protected]>
Co-authored-by: GitHub Action <[email protected]>

* Uncrustify bot command fix (#816)

* fix uncrustify run command

* test uncrustify

* Revert "test uncrustify"

This reverts commit f660ab4.

* Fix uncrustify bot command - disable install prompt (#819)

* fix uncrustify run command

* test uncrustify

* Revert "test uncrustify"

This reverts commit f660ab4.

* removing apt-get prompt while installing git

* Removing deprecated set-output command from uncrustify bot run yml (#820)

* fix uncrustify run command

* test uncrustify

* Revert "test uncrustify"

This reverts commit f660ab4.

* removing apt-get prompt while installing git

* removing the deprecated set-output command from uncrustify bot run yml, use latest git

* IPv4/Single: Let send() stop blocking after a connection reset (#561)

* IPv4/Single: Let send() stop after a protocol error

* Remove token need

* Repaired unit-testing

* Added the cunftion test_FreeRTOS_send_DisconnectionOccursDuringWait()

* Added a comment for unit-test function test_FreeRTOS_send_DisconnectionOccursDuringWait()

* Added an item to lexicon.txt

* Restored original tcp_utilities

* Restored original tcp_utilities, once more

---------

Co-authored-by: Hein Tibosch <[email protected]>
Co-authored-by: Aniruddha Kanhere <[email protected]>
Co-authored-by: Nikhil Kamath <[email protected]>

* Add logs to print random number generation failure (#908)

Add logs to print random number generation failure for better debugging of issue.

* Update usage of uint64_t according to C90 standard (#907)

Co-authored-by: kar-rahul-aws <[email protected]>

* Fix pragma pack in CCS compiler to push/pop (#906)

`#pragma pack(1)` would make it so that all structs inserted after pack_struct_start.h
was included for the TI arm compiler would be packed, leading to potential unaligned memory access error.
Refer: https://www.ti.com/lit/ug/spnu151w/spnu151w.pdf SECTION 5.11.23

* Modified libslirp backend file to cover different libslirp library versions (#929)

Authored-by: Xiaodong Li <[email protected]>

* Update according to devIntegration

* Update links to point to main directory

---------

Signed-off-by: Gaurav Aggarwal <[email protected]>
Co-authored-by: Aniruddha Kanhere <[email protected]>
Co-authored-by: Hein Tibosch <[email protected]>
Co-authored-by: Hein Tibosch <[email protected]>
Co-authored-by: GitHub Action <[email protected]>
Co-authored-by: alfred gedeon <[email protected]>
Co-authored-by: Pete Bone <[email protected]>
Co-authored-by: PeterB <[email protected]>
Co-authored-by: ChristosZosi <[email protected]>
Co-authored-by: jasonpcarroll <[email protected]>
Co-authored-by: Jason Carroll <[email protected]>
Co-authored-by: Tony Josi <[email protected]>
Co-authored-by: Ubuntu <[email protected]>
Co-authored-by: Paul Bartell <[email protected]>
Co-authored-by: Kareem Khazem <[email protected]>
Co-authored-by: Mark Tuttle <[email protected]>
Co-authored-by: Tony Josi <[email protected]>
Co-authored-by: ActoryOu <[email protected]>
Co-authored-by: Nikhil Kamath <[email protected]>
Co-authored-by: phelter <[email protected]>
Co-authored-by: Adam St. Amand <[email protected]>
Co-authored-by: Gaurav-Aggarwal-AWS <[email protected]>
Co-authored-by: sayyadumar <[email protected]>
Co-authored-by: Paul Bartell <[email protected]>
Co-authored-by: Kody Stribrny <[email protected]>
Co-authored-by: Ubuntu <[email protected]>
Co-authored-by: Filip Oleszek <[email protected]>
Co-authored-by: zipperowiec <[email protected]>
Co-authored-by: kar-rahul-aws <[email protected]>
Co-authored-by: Rahul Arasikere <[email protected]>
Co-authored-by: Xiaodong Li <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants