xref: /openbmc/bmcweb/meson.build (revision 74ab83c5) 
1project('bmcweb', 'cpp',
2        version : '1.0',
3        meson_version: '>=0.57.0',
4        default_options: [
5            'b_lto_mode=default',
6            'b_lto_threads=0',
7            'b_lto=true',
8            'b_ndebug=if-release',
9            'buildtype=debugoptimized',
10            'cpp_rtti=false',
11            'cpp_std=c++20',
12            'warning_level=3',
13            'werror=true',
14           ])
15
16# Project related links
17
18project_pretty_name = 'bmcweb'
19project_url = 'https://github.com/openbmc/' + project_pretty_name
20project_issues_url = project_url + '/issues/new'
21summary('Issues',project_issues_url, section: 'Report Issues')
22
23# Validate the c++ Standard
24
25if get_option('cpp_std') != 'c++20'
26    error('This project requires c++20 support')
27endif
28
29# Get compiler and default build type
30
31cxx = meson.get_compiler('cpp')
32build = get_option('buildtype')
33optimization = get_option('optimization')
34summary('Build Type',build, section : 'Build Info')
35summary('Optimization',optimization, section : 'Build Info')
36
37
38# remove debug information for minsize buildtype
39if(get_option('buildtype') == 'minsize')
40  add_project_arguments(['-fdata-sections', '-ffunction-sections'], language : 'cpp')
41  add_project_arguments('-DNDEBUG', language : 'cpp')
42endif
43
44# Disable lto when compiling with no optimization
45if(get_option('optimization') == '0')
46  add_project_arguments('-fno-lto', language: 'cpp')
47  message('Disabling lto & its supported features as optimization is disabled')
48endif
49
50# Include Directories
51
52incdir = include_directories(
53  'include',
54  'redfish-core/include',
55  'redfish-core/lib',
56  'http'
57)
58
59# Get the options and enable the respective features
60## create a MAP of  "options : feature_flag"
61
62feature_map = {
63  'basic-auth'                                  : '-DBMCWEB_ENABLE_BASIC_AUTHENTICATION',
64  'cookie-auth'                                 : '-DBMCWEB_ENABLE_COOKIE_AUTHENTICATION',
65  'google-api'                                  : '-DBMCWEB_ENABLE_GOOGLE_API',
66  'host-serial-socket'                          : '-DBMCWEB_ENABLE_HOST_SERIAL_WEBSOCKET',
67  'ibm-management-console'                      : '-DBMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE',
68  'insecure-disable-auth'                       : '-DBMCWEB_INSECURE_DISABLE_AUTHX',
69  'insecure-disable-csrf'                       : '-DBMCWEB_INSECURE_DISABLE_CSRF_PREVENTION',
70  'insecure-disable-ssl'                        : '-DBMCWEB_INSECURE_DISABLE_SSL',
71  'insecure-push-style-notification'            : '-DBMCWEB_INSECURE_ENABLE_HTTP_PUSH_STYLE_EVENTING',
72  'insecure-tftp-update'                        : '-DBMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE',
73  'kvm'                                         : '-DBMCWEB_ENABLE_KVM' ,
74  'mutual-tls-auth'                             : '-DBMCWEB_ENABLE_MUTUAL_TLS_AUTHENTICATION',
75  'redfish-aggregation'                         : '-DBMCWEB_ENABLE_REDFISH_AGGREGATION',
76  'redfish-allow-deprecated-power-thermal'      : '-DBMCWEB_ALLOW_DEPRECATED_POWER_THERMAL',
77  'redfish-bmc-journal'                         : '-DBMCWEB_ENABLE_REDFISH_BMC_JOURNAL',
78  'redfish-cpu-log'                             : '-DBMCWEB_ENABLE_REDFISH_CPU_LOG',
79  'redfish-dbus-log'                            : '-DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES',
80  'redfish-dump-log'                            : '-DBMCWEB_ENABLE_REDFISH_DUMP_LOG',
81  'redfish-host-logger'                         : '-DBMCWEB_ENABLE_REDFISH_HOST_LOGGER',
82  'redfish-new-powersubsystem-thermalsubsystem' : '-DBMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM',
83  'redfish-oem-manager-fan-data'                : '-DBMCWEB_ENABLE_REDFISH_OEM_MANAGER_FAN_DATA',
84  'redfish-provisioning-feature'                : '-DBMCWEB_ENABLE_REDFISH_PROVISIONING_FEATURE',
85  'redfish-post-to-old-updateservice'           : '-DBMCWEB_ENABLE_REDFISH_UPDATESERVICE_OLD_POST_URL',
86  'redfish'                                     : '-DBMCWEB_ENABLE_REDFISH',
87  'rest'                                        : '-DBMCWEB_ENABLE_DBUS_REST',
88  'session-auth'                                : '-DBMCWEB_ENABLE_SESSION_AUTHENTICATION',
89  'static-hosting'                              : '-DBMCWEB_ENABLE_STATIC_HOSTING',
90  'vm-websocket'                                : '-DBMCWEB_ENABLE_VM_WEBSOCKET',
91  'xtoken-auth'                                 : '-DBMCWEB_ENABLE_XTOKEN_AUTHENTICATION',
92  #'vm-nbdproxy'                                : '-DBMCWEB_ENABLE_VM_NBDPROXY',
93}
94
95# Get the options status and build a project summary to show which flags are
96# being enabled during the configuration time.
97
98foreach option_key,option_value : feature_map
99  if(get_option(option_key).enabled())
100    if(option_key == 'mutual-tls-auth' or option_key == 'insecure-disable-ssl')
101      if(get_option('insecure-disable-ssl').disabled() or get_option('mutual-tls-auth').disabled())
102        add_project_arguments(option_value,language:'cpp')
103        summary(option_key,option_value, section : 'Enabled Features')
104      endif
105    elif (option_key in ['basic-auth', 'cookie-auth', 'session-auth', 'xtoken-auth', 'mutual-tls-auth'])
106      if (get_option('insecure-disable-auth').disabled())
107        add_project_arguments(option_value, language:'cpp')
108        summary(option_key,option_value, section : 'Enabled Features')
109      endif
110    else
111      summary(option_key,option_value, section : 'Enabled Features')
112      add_project_arguments(option_value,language:'cpp')
113    endif
114  else
115      if(option_key == 'insecure-disable-ssl')
116        summary('ssl','-DBMCWEB_ENABLE_SSL', section : 'Enabled Features')
117        add_project_arguments('-DBMCWEB_ENABLE_SSL', language : 'cpp')
118      endif
119  endif
120endforeach
121
122if(get_option('tests').enabled())
123  summary('unittest','NA', section : 'Enabled Features')
124endif
125
126# Add compiler arguments
127
128# -Wpedantic, -Wextra comes by default with warning level
129add_project_arguments(
130  cxx.get_supported_arguments([
131  '-Wcast-align',
132  '-Wconversion',
133  '-Wformat=2',
134  '-Wold-style-cast',
135  '-Woverloaded-virtual',
136  '-Wsign-conversion',
137  '-Wunused',
138  '-Wno-attributes',
139  ]),
140  language: 'cpp'
141)
142
143if (cxx.get_id() == 'clang' and cxx.version().version_compare('>9.0'))
144add_project_arguments(
145  cxx.get_supported_arguments([
146    '-Weverything',
147    '-Wno-c++98-compat-pedantic',
148    '-Wno-c++98-compat',
149    '-Wno-documentation-unknown-command',
150    '-Wno-documentation',
151    '-Wno-exit-time-destructors',
152    '-Wno-global-constructors',
153    '-Wno-newline-eof',
154    '-Wno-padded',
155    '-Wno-shadow',
156    '-Wno-used-but-marked-unused',
157    '-Wno-weak-vtables',
158  ]),
159  language:'cpp')
160endif
161
162# if compiler is gnu-gcc , and version is > 8.0 then we add few more
163# compiler arguments , we know that will pass
164
165if (cxx.get_id() == 'gcc' and cxx.version().version_compare('>8.0'))
166  add_project_arguments(
167    cxx.get_supported_arguments([
168     '-Wduplicated-cond',
169     '-Wduplicated-branches',
170     '-Wlogical-op',
171     '-Wunused-parameter',
172     '-Wnull-dereference',
173     '-Wdouble-promotion',
174     '-Wshadow',
175     '-Wno-psabi',
176     ]),
177    language:'cpp')
178endif
179
180if (get_option('buildtype') != 'plain')
181  if (get_option('b_lto') == true and get_option('optimization')!='0')
182    # Reduce the binary size by removing unnecessary
183    # dynamic symbol table entries
184
185    add_project_arguments(
186     cxx.get_supported_arguments([
187     '-fno-fat-lto-objects',
188     '-fvisibility=hidden',
189     '-fvisibility-inlines-hidden'
190     ]),
191     language: 'cpp')
192
193    if cxx.has_link_argument('-Wl,--exclude-libs,ALL')
194      add_project_link_arguments('-Wl,--exclude-libs,ALL', language: 'cpp')
195    endif
196  endif
197endif
198
199if( get_option('bmcweb-logging').enabled() or \
200    get_option('buildtype').startswith('debug'))
201 add_project_arguments([
202   '-DBMCWEB_ENABLE_LOGGING',
203   '-DBMCWEB_ENABLE_DEBUG'
204   ],
205  language : 'cpp')
206
207  summary({'debug' :'-DBMCWEB_ENABLE_DEBUG',
208     'logging' : '-DBMCWEB_ENABLE_LOGGING',
209
210    },section : 'Enabled Features')
211endif
212
213# Set Compiler Security flags
214
215security_flags = [
216  '-fstack-protector-strong',
217  '-fPIE',
218  '-fPIC',
219  '-D_FORTIFY_SOURCE=2',
220  '-Wformat',
221  '-Wformat-security'
222]
223
224## Add security flags for builds of type 'release','debugoptimized' and 'minsize'
225
226if not (get_option('buildtype') == 'plain' or get_option('buildtype').startswith('debug'))
227  add_project_arguments(
228   cxx.get_supported_arguments([
229    security_flags
230  ]),
231  language: 'cpp')
232endif
233
234# Boost dependency configuration
235
236add_project_arguments(
237cxx.get_supported_arguments([
238  '-DBOOST_ALL_NO_LIB',
239  '-DBOOST_ALLOW_DEPRECATED_HEADERS',
240  '-DBOOST_ASIO_DISABLE_THREADS',
241  '-DBOOST_ASIO_NO_DEPRECATED',
242  '-DBOOST_ASIO_SEPARATE_COMPILATION',
243  '-DBOOST_BEAST_SEPARATE_COMPILATION',
244  '-DBOOST_BEAST_USE_STD_STRING_VIEW',
245  '-DBOOST_EXCEPTION_DISABLE',
246  '-DBOOST_URL_NO_SOURCE_LOCATION',
247  '-DJSON_NOEXCEPTION',
248  '-DOPENSSL_NO_FILENAMES',
249]),
250language : 'cpp')
251
252# Find the dependency modules, if not found use meson wrap to get them
253# automatically during the configure step
254bmcweb_dependencies = []
255
256pam = cxx.find_library('pam', required: true)
257atomic =  cxx.find_library('atomic', required: true)
258openssl = dependency('openssl', required : true)
259bmcweb_dependencies += [pam, atomic, openssl]
260
261sdbusplus = dependency('sdbusplus', required : false, include_type: 'system')
262if not sdbusplus.found()
263  sdbusplus_proj = subproject('sdbusplus', required: true)
264  sdbusplus = sdbusplus_proj.get_variable('sdbusplus_dep')
265  sdbusplus = sdbusplus.as_system('system')
266endif
267bmcweb_dependencies += sdbusplus
268
269tinyxml = dependency('tinyxml2',
270    default_options: ['tests=false'],
271    include_type: 'system',
272)
273bmcweb_dependencies += tinyxml
274
275systemd = dependency('systemd')
276zlib = dependency('zlib')
277bmcweb_dependencies += [systemd, zlib]
278
279if cxx.has_header('nlohmann/json.hpp')
280    nlohmann_json = declare_dependency()
281else
282    nlohmann_json_proj = subproject('nlohmann', required: true)
283    nlohmann_json = nlohmann_json_proj.get_variable('nlohmann_json_dep')
284    nlohmann_json = nlohmann_json.as_system('system')
285endif
286bmcweb_dependencies += nlohmann_json
287
288boost = dependency('boost',version : '>=1.80.0', required : false, include_type: 'system')
289if not boost.found()
290  subproject('boost', required: false)
291  boost_inc = include_directories('subprojects/boost_1_80_0/', is_system:true)
292  boost  = declare_dependency(include_directories : boost_inc)
293  boost = boost.as_system('system')
294endif
295bmcweb_dependencies += boost
296
297if cxx.has_header('boost/url/url_view.hpp')
298  boost_url = declare_dependency()
299else
300  subproject('boost-url', required: false)
301  boost_url_inc = include_directories('subprojects/boost-url/include', is_system:true)
302  boost_url= declare_dependency(include_directories : boost_url_inc)
303  boost_url = boost_url.as_system('system')
304endif
305bmcweb_dependencies += boost_url
306
307if get_option('tests').enabled()
308  gtest = dependency('gtest', main: true,disabler: true, required : false)
309  gmock = dependency('gmock', required : false)
310  if not gtest.found() and get_option('tests').enabled()
311    gtest_proj = subproject('gtest', required: true)
312    gtest = gtest_proj.get_variable('gtest_main_dep')
313    gmock = gtest_proj.get_variable('gmock_dep')
314  endif
315  gtest = gtest.as_system('system')
316  gmock = gmock.as_system('system')
317endif
318
319# Gather the Configuration data
320
321conf_data = configuration_data()
322conf_data.set('BMCWEB_HTTP_REQ_BODY_LIMIT_MB', get_option('http-body-limit'))
323xss_enabled = get_option('insecure-disable-xss')
324conf_data.set10('BMCWEB_INSECURE_DISABLE_XSS_PREVENTION', xss_enabled.enabled())
325enable_redfish_query = get_option('insecure-enable-redfish-query')
326conf_data.set10('BMCWEB_INSECURE_ENABLE_QUERY_PARAMS', enable_redfish_query.enabled())
327# enable_redfish_aggregation = get_option('redfish-aggregation')
328# conf_data.set10('BMCWEB_ENABLE_REDFISH_AGGREGATION', enable_redfish_aggregation.enabled())
329insecure_push_style_notification = get_option('insecure-push-style-notification')
330conf_data.set10('BMCWEB_INSECURE_ENABLE_HTTP_PUSH_STYLE_EVENTING', insecure_push_style_notification.enabled())
331conf_data.set('MESON_INSTALL_PREFIX', get_option('prefix'))
332conf_data.set('HTTPS_PORT', get_option('https_port'))
333configure_file(input: 'bmcweb_config.h.in',
334               output: 'bmcweb_config.h',
335               configuration: conf_data)
336
337# Configure and install systemd unit files
338
339systemd_system_unit_dir = systemd.get_variable(pkgconfig: 'systemdsystemunitdir')
340
341bindir = get_option('prefix') + '/' +get_option('bindir')
342
343summary({
344          'prefix' : get_option('prefix'),
345          'bindir' : bindir,
346          'systemd unit directory' : systemd_system_unit_dir
347        }, section : 'Directories')
348
349configure_file(input : 'bmcweb.socket.in',
350               output : 'bmcweb.socket',
351               install_dir: systemd_system_unit_dir,
352               configuration: conf_data,
353               install : true)
354
355configure_file(input : 'bmcweb.service.in',
356               output : 'bmcweb.service',
357               install_dir: systemd_system_unit_dir,
358               configuration: conf_data,
359               install : true)
360
361# Copy pam-webserver to etc/pam.d
362configure_file(input : 'pam-webserver',
363               output : 'webserver',
364               copy : true,
365               install_dir: '/etc/pam.d',
366               install : true)
367
368install_subdir('static', install_dir : 'share/www', strip_directory : true)
369
370# Source files
371
372srcfiles_bmcweb = [
373  'redfish-core/src/error_messages.cpp',
374  'redfish-core/src/utils/json_utils.cpp',
375  'src/boost_asio_ssl.cpp',
376  'src/boost_asio.cpp',
377  'src/boost_beast.cpp',
378  'src/boost_url.cpp',
379  'src/dbus_singleton.cpp',
380]
381
382# Generate the bmcweb executable
383executable(
384  'bmcweb',
385  srcfiles_bmcweb + ['src/webserver_main.cpp'],
386  include_directories : incdir,
387  dependencies: bmcweb_dependencies,
388  link_args: '-Wl,--gc-sections',
389  install: true,
390  install_dir:bindir
391)
392
393srcfiles_unittest = [
394  'http/ut/utility_test.cpp',
395  'http/ut/router_test.cpp',
396  'include/google/google_service_root_test.cpp',
397  'include/ut/dbus_utility_test.cpp',
398  'include/ut/http_utility_test.cpp',
399  'include/ut/human_sort_test.cpp',
400  'include/ut/multipart_test.cpp',
401  'include/ut/openbmc_dbus_rest_test.cpp',
402  'redfish-core/include/utils/query_param_test.cpp',
403  'redfish-core/lib/ut/service_root_test.cpp',
404  'redfish-core/lib/ut/thermal_subsystem_test.cpp',
405  'redfish-core/lib/chassis_test.cpp',
406  'redfish-core/ut/configfile_test.cpp',
407  'redfish-core/ut/hex_utils_test.cpp',
408  'redfish-core/ut/ip_utils_test.cpp',
409  'redfish-core/ut/json_utils_test.cpp',
410  'redfish-core/ut/lock_test.cpp',
411  'redfish-core/ut/privileges_test.cpp',
412  'redfish-core/ut/registries_test.cpp',
413  'redfish-core/ut/stl_utils_test.cpp',
414  'redfish-core/ut/time_utils_test.cpp',
415  'src/crow_getroutes_test.cpp',
416]
417
418if(get_option('tests').enabled())
419    # generate the test executable
420    ut_bin = executable(
421      'bmcweb_unit_test',
422      srcfiles_unittest + srcfiles_bmcweb,
423      include_directories : incdir,
424      install_dir: bindir,
425      dependencies: bmcweb_dependencies + [
426        gtest,
427        gmock,
428      ]
429    )
430    test('bmcweb_unit_test', ut_bin)
431endif
432