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 ##############################################################################
16 ##############################################################################
17 function(vpp_generate_api_c_header file)
18 set (output_name ${CMAKE_CURRENT_BINARY_DIR}/${file}.h)
19 get_filename_component(output_dir ${output_name} DIRECTORY)
21 set(VPP_APIGEN ${CMAKE_SOURCE_DIR}/tools/vppapigen/vppapigen)
24 set(includedir "--includedir" ${VPP_INCLUDE_DIR})
26 add_custom_command (OUTPUT ${output_name}
27 COMMAND mkdir -p ${output_dir}
29 ARGS ${includedir} --includedir ${CMAKE_SOURCE_DIR} --input ${CMAKE_CURRENT_SOURCE_DIR}/${file} --outputdir ${output_dir} --output ${output_name}
30 DEPENDS ${VPP_APIGEN} ${CMAKE_CURRENT_SOURCE_DIR}/${file}
31 COMMENT "Generating API header ${output_name}"
35 function(vpp_generate_api_json_header file dir component)
36 set (output_name ${CMAKE_CURRENT_BINARY_DIR}/${file}.json)
37 get_filename_component(output_dir ${output_name} DIRECTORY)
39 set(VPP_APIGEN ${CMAKE_SOURCE_DIR}/tools/vppapigen/vppapigen)
42 set(includedir "--includedir" ${VPP_INCLUDE_DIR})
44 add_custom_command (OUTPUT ${output_name}
45 COMMAND mkdir -p ${output_dir}
47 ARGS ${includedir} --includedir ${CMAKE_SOURCE_DIR} --input ${CMAKE_CURRENT_SOURCE_DIR}/${file} JSON --output ${output_name}
48 DEPENDS ${VPP_APIGEN} ${CMAKE_CURRENT_SOURCE_DIR}/${file}
49 COMMENT "Generating API header ${output_name}"
53 DESTINATION share/vpp/api/${dir}/
54 COMPONENT ${component}
58 ##############################################################################
60 ##############################################################################
61 function(vpp_generate_vapi_c_header f)
62 get_filename_component(output ${f}.vapi.h NAME)
63 set (output_name ${CMAKE_BINARY_DIR}/vpp-api/vapi/${output})
64 if(NOT VPP_VAPI_C_GEN)
65 set(VPP_VAPI_C_GEN ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_c_gen.py)
66 set(VPP_VAPI_C_GEN_DEPENDS
67 ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_c_gen.py
68 ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_json_parser.py
73 set(input ${CMAKE_CURRENT_BINARY_DIR}/${f}.json)
76 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/vpp-api/vapi
77 COMMAND ${VPP_VAPI_C_GEN}
78 ARGS --remove-path ${input}
79 DEPENDS ${input} ${VPP_VAPI_C_GEN_DEPENDS}
80 COMMENT "Generating VAPI C header ${output_name}"
84 DESTINATION include/vapi
89 function (vpp_generate_vapi_cpp_header f)
90 get_filename_component(output ${f}.vapi.hpp NAME)
91 set (output_name ${CMAKE_BINARY_DIR}/vpp-api/vapi/${output})
92 if(NOT VPP_VAPI_CPP_GEN)
93 set(VPP_VAPI_CPP_GEN ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_cpp_gen.py)
94 set(VPP_VAPI_CPP_GEN_DEPENDS
95 ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_cpp_gen.py
96 ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_json_parser.py
100 set(input ${CMAKE_CURRENT_BINARY_DIR}/${f}.json)
102 OUTPUT ${output_name}
103 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/vpp-api/vapi
104 COMMAND ${VPP_VAPI_CPP_GEN}
105 ARGS --gen-h-prefix=vapi --remove-path ${input}
106 DEPENDS ${input} ${VPP_VAPI_CPP_GEN_DEPENDS}
107 COMMENT "Generating VAPI C++ header ${output_name}"
111 DESTINATION include/vapi
117 ##############################################################################
118 # generate the .h and .json files for a .api file
119 # @param file - the name of the .api
120 # @param dir - the install directory under ROOT/share/vpp/api to place the
121 # generated .json file
122 ##############################################################################
123 function(vpp_generate_api_header file dir component)
124 vpp_generate_api_c_header (${file})
125 vpp_generate_api_json_header (${file} ${dir} ${component})
126 vpp_generate_vapi_c_header (${file})
127 vpp_generate_vapi_cpp_header (${file})
130 function(vpp_add_api_files name dir component)
132 set(target ${name}_api_headers)
133 file(RELATIVE_PATH rpath ${CMAKE_SOURCE_DIR} ${CMAKE_CURRENT_SOURCE_DIR})
134 foreach(file ${ARGN})
135 vpp_generate_api_header (${file} ${dir} ${component})
136 # Basic api headers get installed in a subdirectory according to
137 # their component name, but vapi is expected to be found directly under
138 # "vapi". Both by in-source components (e.g. vpp-api/vapi/vapi.c), and
139 # out-of-tree plugins use #include <vapi/component.api.vapi.h>.
140 # ${file} contains the subdirectory, so strip it here.
141 get_filename_component(name ${file} NAME)
142 list(APPEND header_files
145 ${CMAKE_BINARY_DIR}/vpp-api/vapi/${name}.vapi.h
146 ${CMAKE_BINARY_DIR}/vpp-api/vapi/${name}.vapi.hpp
149 add_custom_target(${target} DEPENDS ${header_files})
152 add_custom_target(api_headers
153 DEPENDS vlibmemory_api_headers vnet_api_headers vpp_api_headers