1 # Copyright (c) 2018 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 macro(add_vpp_plugin name)
15 cmake_parse_arguments(PLUGIN
17 "LINK_FLAGS;COMPONENT;DEV_COMPONENT"
18 "SOURCES;API_FILES;MULTIARCH_SOURCES;MULTIARCH_FORCE_ON;LINK_LIBRARIES;INSTALL_HEADERS;API_TEST_SOURCES;"
21 set(plugin_name ${name}_plugin)
23 if(NOT PLUGIN_COMPONENT)
24 set(PLUGIN_COMPONENT vpp-plugin-core)
26 if(NOT PLUGIN_DEV_COMPONENT)
27 if(NOT VPP_EXTERNAL_PROJECT)
28 set(PLUGIN_DEV_COMPONENT vpp-dev)
30 set(PLUGIN_DEV_COMPONENT ${PLUGIN_COMPONENT}-dev)
34 vpp_add_api_files(${plugin_name} plugins ${PLUGIN_COMPONENT} ${PLUGIN_API_FILES})
35 foreach(f ${PLUGIN_API_FILES})
36 get_filename_component(dir ${f} DIRECTORY)
37 list(APPEND api_includes ${f}.h ${f}_enum.h ${f}_types.h ${f}.json)
40 ${CMAKE_CURRENT_BINARY_DIR}/${f}.h
41 ${CMAKE_CURRENT_BINARY_DIR}/${f}_enum.h
42 ${CMAKE_CURRENT_BINARY_DIR}/${f}_types.h
43 DESTINATION include/vpp_plugins/${name}/${dir}
44 COMPONENT ${PLUGIN_DEV_COMPONENT}
47 add_library(${plugin_name} SHARED ${api_includes} ${PLUGIN_SOURCES})
48 set_target_properties(${plugin_name} PROPERTIES NO_SONAME 1)
49 target_compile_options(${plugin_name} PRIVATE "-fvisibility=hidden")
50 target_compile_options (${plugin_name} PRIVATE "-ffunction-sections")
51 target_compile_options (${plugin_name} PRIVATE "-fdata-sections")
52 target_link_libraries (${plugin_name} "-Wl,--gc-sections")
54 if(NOT VPP_EXTERNAL_PROJECT)
55 list(APPEND deps vpp_version_h api_headers)
58 list(APPEND deps ${plugin_name}_api_headers)
61 add_dependencies(${plugin_name} ${deps})
63 set_target_properties(${plugin_name} PROPERTIES
65 LIBRARY_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/vpp_plugins)
66 if(PLUGIN_MULTIARCH_SOURCES)
67 vpp_library_set_multiarch_sources(${plugin_name}
68 SOURCES ${PLUGIN_MULTIARCH_SOURCES}
70 FORCE_ON ${PLUGIN_MULTIARCH_FORCE_ON}
73 if(PLUGIN_LINK_LIBRARIES)
74 target_link_libraries(${plugin_name} ${PLUGIN_LINK_LIBRARIES})
77 set_target_properties(${plugin_name} PROPERTIES LINK_FLAGS "${PLUGIN_LINK_FLAGS}")
79 if(PLUGIN_INSTALL_HEADERS)
80 foreach(file ${PLUGIN_INSTALL_HEADERS})
81 get_filename_component(dir ${file} DIRECTORY)
84 DESTINATION include/vpp_plugins/${name}/${dir}
89 if(PLUGIN_API_TEST_SOURCES)
90 set(test_plugin_name ${name}_test_plugin)
91 add_library(${test_plugin_name} SHARED ${PLUGIN_API_TEST_SOURCES}
93 set_target_properties(${test_plugin_name} PROPERTIES NO_SONAME 1)
94 if(NOT VPP_EXTERNAL_PROJECT)
95 add_dependencies(${test_plugin_name} api_headers)
98 add_dependencies(${test_plugin_name} ${plugin_name}_api_headers)
100 set_target_properties(${test_plugin_name} PROPERTIES
102 LIBRARY_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/vpp_api_test_plugins)
104 TARGETS ${test_plugin_name}
105 DESTINATION ${VPP_LIBRARY_DIR}/vpp_api_test_plugins
106 COMPONENT ${PLUGIN_COMPONENT}
109 if (PLUGIN_API_FILES)
110 add_vpp_test_library(${name}_test_plugin ${PLUGIN_API_FILES})
114 TARGETS ${plugin_name}
115 DESTINATION ${VPP_LIBRARY_DIR}/vpp_plugins
116 COMPONENT ${PLUGIN_COMPONENT}
120 macro(vpp_plugin_find_library plugin var name)
121 find_library(${var} NAMES ${name} ${ARGN})
122 mark_as_advanced(${var})
124 message(WARNING "-- ${name} library not found - ${plugin} plugin disabled")
127 message(STATUS "${plugin} plugin needs ${name} library - found at ${${var}}")