PPM-300: Add Bus agnostic API as optional dependency to the builds #1545

abelog · 2020-07-21T15:50:59Z

Description

This PR intention is to introduce new HLAPI lib (High Level API) which should which links all BAAPI (Bus Agnostic API) libs.
hlapi is yet optional for build, as we don't use it right now.
Tested for Dummy build on CI. Flag was added by 113da93 commit. Job and pipeline.

Changes

Add Findamx?.cmake files to locate each `amx(c/d/j...) lib.
Add new hlapi lib and new flag ENABLE_HLAPI to build it.

Note

As we don't need to build hlapi right now - ENABLE_HLAPI flag isn't required yet, so no changes to regular build procedure used by CI and developers is required. Build in CI was done just for verification.

Jira link: https://jira.prplfoundation.org/browse/PPM-300

arnout

Since draft, not approving yet.

I gave comments to the first Findxxx.cmake but obviously they apply to all.

cmake/Findamxc.cmake

arnout · 2020-07-24T17:40:36Z

cmake/Findamxc.cmake

+find_path(AMXC_INCLUDE_DIRS
+    NAMES amxc_llist.h amxc_string_join.h amxc_common.h amxc_rbuffer.h amxc_variant_type.h amxc_variant.h amxc_aqueue.h amxc_timestamp.h amxc_astack.h amxc_hash.h amxc_array.h amxc.h amxc_lstack.h amxc_string.h amxc_htable.h amxc_lqueue.h amxc_string_split.h
+    PATH_SUFFIXES amxc
+)


You don't need to list all of them, typically amxc.h should be enough.

Also, typically you'd include it with #include <amxc/amxc.h> so you should search directly for that file.

Suggested change

find_path(AMXC_INCLUDE_DIRS

NAMES amxc_llist.h amxc_string_join.h amxc_common.h amxc_rbuffer.h amxc_variant_type.h amxc_variant.h amxc_aqueue.h amxc_timestamp.h amxc_astack.h amxc_hash.h amxc_array.h amxc.h amxc_lstack.h amxc_string.h amxc_htable.h amxc_lqueue.h amxc_string_split.h

PATH_SUFFIXES amxc

)

find_path(AMXC_INCLUDE_DIRS NAMES amxc/amxc.h)

Applied. Only thing, that PATH_SUFFIXES already point to the subdirectory which should be checked, so i am not sure that is worth to implicitly add amxc/amxc.h.

arnout · 2020-07-24T17:42:56Z

CMakeLists.txt

 option (BUILD_CONTROLLER "Build EasyMesh controller" ON)

 option(BUILD_SHARED_LIBS "Build shared libraries (.so) instead of static ones (.a)" ON)
+option (ENABLE_AMBIORIX "Include Bus agnostic API in the build" OFF)


As I mentioned orally:

Suggested change

option (ENABLE_AMBIORIX "Include Bus agnostic API in the build" OFF)

option (ENABLE_HLAPI "Build the northbound (high-level) API" OFF)

Also please turn it on in at least one build in CI.

Applied. Will resolve as commit to alter CI to check build with flag is added.

RanRegev

Maybe it is too early in the process, but I guess we don't want just hlapi.h file that represents the entire high-level interface of prplmesh.
The HLAPI should be designed and it would probably end up with

namespace prplmesh::hlapi { /*...*/ }

and few classes and/or free functions within this namespace.

framework/platform/CMakeLists.txt

framework/platform/HLAPI/CMakeLists.txt

RanRegev · 2020-07-26T08:23:52Z

framework/platform/HLAPI/CMakeLists.txt

@@ -0,0 +1,43 @@
+project(hlapi VERSION ${prplmesh_VERSION})


maybe preceding with prplmesh_?

Suggested change

project(hlapi VERSION ${prplmesh_VERSION})

project(prplmesh_hlapi VERSION ${prplmesh_VERSION})

framework/platform/HLAPI/CMakeLists.txt

abelog · 2020-08-13T13:33:27Z

@Mergifyio rebase

Add Findamxc.cmake file to locate AMXC library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

Add Findamxb.cmake file to locate AMXB library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

Add Findamxd.cmake file to locate AMXD library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

Add Findamxj.cmake file to locate AMXJ library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

Add Findamxo.cmake file to locate AMXO library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

Add Findamxp.cmake file to locate AMXP library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

Create new Hight Level API library, which should handle interactions with different system buses. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

mergify · 2020-08-13T13:34:07Z

Command rebase: success

Branch has been successfully rebased

github-actions bot assigned abelog Jul 21, 2020

arnout reviewed Jul 24, 2020

View reviewed changes

abelog force-pushed the feature/ppm-300-optional-dependency-on-BAAPI-to-prplMesh-CMakeLists branch from 0ca22ec to 81d14b9 Compare July 24, 2020 20:40

RanRegev reviewed Jul 26, 2020

View reviewed changes

abelog force-pushed the feature/ppm-266-baapi-to-dummy-docker-builder branch from c6f7f8d to 9f1c0d2 Compare August 3, 2020 14:12

arnout force-pushed the feature/ppm-266-baapi-to-dummy-docker-builder branch from 9f1c0d2 to 35f9570 Compare August 3, 2020 14:57

Base automatically changed from feature/ppm-266-baapi-to-dummy-docker-builder to master August 3, 2020 15:12

abelog force-pushed the feature/ppm-300-optional-dependency-on-BAAPI-to-prplMesh-CMakeLists branch from 81d14b9 to 43562cb Compare August 3, 2020 15:49

abelog changed the title ~~Feature/ppm 300 optional dependency on baapi to prpl mesh c make lists~~ PPM-300: optional dependency on baapi to prpl mesh c make lists Aug 4, 2020

abelog force-pushed the feature/ppm-300-optional-dependency-on-BAAPI-to-prplMesh-CMakeLists branch 6 times, most recently from 198f070 to 113da93 Compare August 6, 2020 12:24

abelog changed the title ~~PPM-300: optional dependency on baapi to prpl mesh c make lists~~ PPM-300: Add Bus agnostic API as optional dependency to the builds Aug 6, 2020

abelog force-pushed the feature/ppm-300-optional-dependency-on-BAAPI-to-prplMesh-CMakeLists branch from 113da93 to 9a1ff0b Compare August 6, 2020 12:54

abelog marked this pull request as ready for review August 6, 2020 13:29

abelog requested review from adam1985d, kantera800, mariomaz, morantr, rmelotte, tomereli and vitalybu as code owners August 6, 2020 13:29

abelog added 4 commits August 13, 2020 13:34

cmake: add Findamxc.cmake file

05a42f7

Add Findamxc.cmake file to locate AMXC library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

cmake: add Findamxb.cmake file

93c29ea

Add Findamxb.cmake file to locate AMXB library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

cmake: add Findamxd.cmake file

d08a665

Add Findamxd.cmake file to locate AMXD library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

cmake: add Findamxj.cmake file

c78296b

Add Findamxj.cmake file to locate AMXJ library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

abelog added 3 commits August 13, 2020 13:34

cmake: add Findamxo.cmake file

da06824

Add Findamxo.cmake file to locate AMXO library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

cmake: add Findamxp.cmake file

1c7be8c

Add Findamxp.cmake file to locate AMXP library of BAAPI and relevant header files. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

cmake: create separate HLAPI library

84eceea

Create new Hight Level API library, which should handle interactions with different system buses. Jira link: https://jira.prplfoundation.org/browse/PPM-300 Signed-off-by: Anton Bilohai <[email protected]>

arnout force-pushed the feature/ppm-300-optional-dependency-on-BAAPI-to-prplMesh-CMakeLists branch from 9a1ff0b to 84eceea Compare August 13, 2020 13:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PPM-300: Add Bus agnostic API as optional dependency to the builds #1545

PPM-300: Add Bus agnostic API as optional dependency to the builds #1545

Uh oh!

abelog commented Jul 21, 2020 •

edited

Loading

Uh oh!

arnout left a comment

Uh oh!

Uh oh!

Uh oh!

arnout Jul 24, 2020

Uh oh!

abelog Aug 4, 2020

Uh oh!

arnout Jul 24, 2020

Uh oh!

abelog Aug 4, 2020

Uh oh!

RanRegev left a comment

Uh oh!

Uh oh!

Uh oh!

RanRegev Jul 26, 2020

Uh oh!

Uh oh!

abelog commented Aug 13, 2020

Uh oh!

mergify bot commented Aug 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	option (ENABLE_AMBIORIX "Include Bus agnostic API in the build" OFF)
	option (ENABLE_HLAPI "Build the northbound (high-level) API" OFF)

	project(hlapi VERSION ${prplmesh_VERSION})
	project(prplmesh_hlapi VERSION ${prplmesh_VERSION})

PPM-300: Add Bus agnostic API as optional dependency to the builds #1545

Are you sure you want to change the base?

PPM-300: Add Bus agnostic API as optional dependency to the builds #1545

Uh oh!

Conversation

abelog commented Jul 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Note

Uh oh!

arnout left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

arnout Jul 24, 2020

Choose a reason for hiding this comment

Uh oh!

abelog Aug 4, 2020

Choose a reason for hiding this comment

Uh oh!

arnout Jul 24, 2020

Choose a reason for hiding this comment

Uh oh!

abelog Aug 4, 2020

Choose a reason for hiding this comment

Uh oh!

RanRegev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

RanRegev Jul 26, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abelog commented Aug 13, 2020

Uh oh!

mergify bot commented Aug 13, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

abelog commented Jul 21, 2020 •

edited

Loading