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})
28 "${CMAKE_CURRENT_BINARY_DIR}/${file}.h"
29 "${CMAKE_CURRENT_BINARY_DIR}/${file}_fromjson.h"
30 "${CMAKE_CURRENT_BINARY_DIR}/${file}_tojson.h"
31 "${CMAKE_CURRENT_BINARY_DIR}/${file}_enum.h"
32 "${CMAKE_CURRENT_BINARY_DIR}/${file}_types.h"
33 "${CMAKE_CURRENT_BINARY_DIR}/${file}.c"
34 "${CMAKE_CURRENT_BINARY_DIR}/${file}_test.c"
35 "${CMAKE_CURRENT_BINARY_DIR}/${file}_test2.c"
39 OUTPUT ${OUTPUT_HEADERS}
40 COMMAND mkdir -p ${output_dir}
42 ARGS ${includedir} --includedir ${CMAKE_SOURCE_DIR} --input ${CMAKE_CURRENT_SOURCE_DIR}/${file} --outputdir ${output_dir} --output ${output_name}
43 DEPENDS ${VPP_APIGEN} ${CMAKE_CURRENT_SOURCE_DIR}/${file}
44 COMMENT "Generating API header ${output_name}"
46 get_filename_component(barename ${file} NAME)
47 set(t ${barename}_deps)
49 add_custom_target(${t} ALL DEPENDS ${OUTPUT_HEADERS})
50 add_dependencies(api_headers ${t})
54 function(vpp_generate_api_json_header file dir component)
55 set (output_name ${CMAKE_CURRENT_BINARY_DIR}/${file}.json)
56 get_filename_component(output_dir ${output_name} DIRECTORY)
58 set(VPP_APIGEN ${CMAKE_SOURCE_DIR}/tools/vppapigen/vppapigen)
61 set(includedir "--includedir" ${VPP_INCLUDE_DIR})
63 add_custom_command (OUTPUT ${output_name}
64 COMMAND mkdir -p ${output_dir}
66 ARGS ${includedir} --includedir ${CMAKE_SOURCE_DIR} --input ${CMAKE_CURRENT_SOURCE_DIR}/${file} JSON --output ${output_name}
67 DEPENDS ${VPP_APIGEN} ${CMAKE_CURRENT_SOURCE_DIR}/${file}
68 COMMENT "Generating API header ${output_name}"
72 DESTINATION share/vpp/api/${dir}/
73 COMPONENT ${component}
77 ##############################################################################
79 ##############################################################################
80 function(vpp_generate_vapi_c_header f)
81 get_filename_component(output ${f}.vapi.h NAME)
82 set (output_name ${CMAKE_BINARY_DIR}/vpp-api/vapi/${output})
83 if(NOT VPP_VAPI_C_GEN)
84 set(VPP_VAPI_C_GEN ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_c_gen.py)
85 set(VPP_VAPI_C_GEN_DEPENDS
86 ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_c_gen.py
87 ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_json_parser.py
92 set(input ${CMAKE_CURRENT_BINARY_DIR}/${f}.json)
95 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/vpp-api/vapi
96 COMMAND ${VPP_VAPI_C_GEN}
97 ARGS --remove-path ${input}
98 DEPENDS ${input} ${VPP_VAPI_C_GEN_DEPENDS}
99 COMMENT "Generating VAPI C header ${output_name}"
103 DESTINATION include/vapi
108 function (vpp_generate_vapi_cpp_header f)
109 get_filename_component(output ${f}.vapi.hpp NAME)
110 set (output_name ${CMAKE_BINARY_DIR}/vpp-api/vapi/${output})
111 if(NOT VPP_VAPI_CPP_GEN)
112 set(VPP_VAPI_CPP_GEN ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_cpp_gen.py)
113 set(VPP_VAPI_CPP_GEN_DEPENDS
114 ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_cpp_gen.py
115 ${CMAKE_SOURCE_DIR}/vpp-api/vapi/vapi_json_parser.py
119 set(input ${CMAKE_CURRENT_BINARY_DIR}/${f}.json)
121 OUTPUT ${output_name}
122 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/vpp-api/vapi
123 COMMAND ${VPP_VAPI_CPP_GEN}
124 ARGS --gen-h-prefix=vapi --remove-path ${input}
125 DEPENDS ${input} ${VPP_VAPI_CPP_GEN_DEPENDS}
126 COMMENT "Generating VAPI C++ header ${output_name}"
130 DESTINATION include/vapi
136 ##############################################################################
137 # generate the .h and .json files for a .api file
138 # @param file - the name of the .api
139 # @param dir - the install directory under ROOT/share/vpp/api to place the
140 # generated .json file
141 ##############################################################################
142 function(vpp_generate_api_header file dir component)
143 vpp_generate_api_c_header (${file})
144 vpp_generate_api_json_header (${file} ${dir} ${component})
145 vpp_generate_vapi_c_header (${file})
146 vpp_generate_vapi_cpp_header (${file})
149 function(vpp_add_api_files name dir component)
151 set(target ${name}_api_headers)
152 file(RELATIVE_PATH rpath ${CMAKE_SOURCE_DIR} ${CMAKE_CURRENT_SOURCE_DIR})
153 foreach(file ${ARGN})
154 vpp_generate_api_header (${file} ${dir} ${component})
155 # Basic api headers get installed in a subdirectory according to
156 # their component name, but vapi is expected to be found directly under
157 # "vapi". Both by in-source components (e.g. vpp-api/vapi/vapi.c), and
158 # out-of-tree plugins use #include <vapi/component.api.vapi.h>.
159 # ${file} contains the subdirectory, so strip it here.
160 get_filename_component(name ${file} NAME)
161 list(APPEND header_files
164 ${CMAKE_BINARY_DIR}/vpp-api/vapi/${name}.vapi.h
165 ${CMAKE_BINARY_DIR}/vpp-api/vapi/${name}.vapi.hpp
168 add_custom_target(${target} DEPENDS ${header_files})
171 add_custom_target(api_headers
172 DEPENDS vlibmemory_api_headers vnet_api_headers vpp_api_headers vlib_api_headers