xref: /openbmc/bmcweb/meson.build (revision 9d424669) 
1project('bmcweb', 'cpp',
2        version : '1.0',
3        meson_version: '>=0.53.2',
4        default_options: [
5            'werror=true',
6            'warning_level=3',
7            'cpp_std=c++17',
8            'buildtype=debugoptimized',
9            'b_ndebug=if-release',
10            'b_lto=true',
11            'cpp_rtti=false',
12            'b_lto_mode=default',
13            'b_lto_threads=0'
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++17'
26    error('This project requires c++17 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  'insecure-disable-auth'           : '-DBMCWEB_INSECURE_DISABLE_AUTHENTICATION',
64  'insecure-disable-csrf'           : '-DBMCWEB_INSECURE_DISABLE_CSRF_PREVENTION',
65  'insecure-disable-ssl'            : '-DBMCWEB_INSECURE_DISABLE_SSL',
66  'host-serial-socket'              : '-DBMCWEB_ENABLE_HOST_SERIAL_WEBSOCKET',
67  'ibm-management-console'          : '-DBMCWEB_ENABLE_IBM_MANAGEMENT_CONSOLE',
68  'google-api'                      : '-DBMCWEB_ENABLE_GOOGLE_API',
69  'kvm'                             : '-DBMCWEB_ENABLE_KVM' ,
70  'basic-auth'                      : '-DBMCWEB_ENABLE_BASIC_AUTHENTICATION',
71  'session-auth'                    : '-DBMCWEB_ENABLE_SESSION_AUTHENTICATION',
72  'xtoken-auth'                     : '-DBMCWEB_ENABLE_XTOKEN_AUTHENTICATION',
73  'cookie-auth'                     : '-DBMCWEB_ENABLE_COOKIE_AUTHENTICATION',
74  'mutual-tls-auth'                 : '-DBMCWEB_ENABLE_MUTUAL_TLS_AUTHENTICATION',
75  'pam'                             : '-DWEBSERVER_ENABLE_PAM',
76  'insecure-push-style-notification': '-DBMCWEB_INSECURE_ENABLE_HTTP_PUSH_STYLE_EVENTING',
77  'redfish'                         : '-DBMCWEB_ENABLE_REDFISH',
78  'redfish-bmc-journal'             : '-DBMCWEB_ENABLE_REDFISH_BMC_JOURNAL',
79  'redfish-cpu-log'                 : '-DBMCWEB_ENABLE_REDFISH_CPU_LOG',
80  'redfish-dbus-log'                : '-DBMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES',
81  'redfish-provisioning-feature'    : '-DBMCWEB_ENABLE_REDFISH_PROVISIONING_FEATURE',
82  'redfish-dump-log'                : '-DBMCWEB_ENABLE_REDFISH_DUMP_LOG',
83  'rest'                            : '-DBMCWEB_ENABLE_DBUS_REST',
84  'static-hosting'                  : '-DBMCWEB_ENABLE_STATIC_HOSTING',
85  'insecure-tftp-update'            : '-DBMCWEB_INSECURE_ENABLE_REDFISH_FW_TFTP_UPDATE',
86  #'vm-nbdproxy'                     : '-DBMCWEB_ENABLE_VM_NBDPROXY',
87  'vm-websocket'                    : '-DBMCWEB_ENABLE_VM_WEBSOCKET',
88}
89
90# Get the options status and build a project summary to show which flags are
91# being enabled during the configuration time.
92
93foreach option_key,option_value : feature_map
94  if(get_option(option_key).enabled())
95    if(option_key == 'mutual-tls-auth' or option_key == 'insecure-disable-ssl')
96      if(get_option('insecure-disable-ssl').disabled() or get_option('mutual-tls-auth').disabled())
97        add_project_arguments(option_value,language:'cpp')
98        summary(option_key,option_value, section : 'Enabled Features')
99      endif
100    else
101      summary(option_key,option_value, section : 'Enabled Features')
102      add_project_arguments(option_value,language:'cpp')
103    endif
104  else
105      if(option_key == 'insecure-disable-ssl')
106        summary('ssl','-DBMCWEB_ENABLE_SSL', section : 'Enabled Features')
107        add_project_arguments('-DBMCWEB_ENABLE_SSL', language : 'cpp')
108      endif
109  endif
110endforeach
111
112if(get_option('tests').enabled())
113  summary('unittest','NA', section : 'Enabled Features')
114endif
115
116# Add compiler arguments
117
118# -Wpedantic, -Wextra comes by default with warning level
119add_project_arguments(
120  cxx.get_supported_arguments([
121  '-Wold-style-cast',
122  '-Wcast-align',
123  '-Wunused',
124  '-Woverloaded-virtual',
125  '-Wconversion',
126  '-Wsign-conversion',
127  '-Wno-attributes',
128  ]),
129  language: 'cpp'
130)
131
132if (cxx.get_id() == 'clang' and cxx.version().version_compare('>9.0'))
133add_project_arguments(
134  cxx.get_supported_arguments([
135    '-Weverything',
136    '-Wno-c++98-compat',
137    '-Wno-c++98-compat-pedantic',
138    '-Wno-global-constructors',
139    '-Wno-exit-time-destructors',
140    '-Wno-shadow',
141    '-Wno-used-but-marked-unused',
142    '-Wno-documentation-unknown-command',
143    '-Wno-weak-vtables',
144    '-Wno-documentation',
145    '-Wno-padded',
146    '-Wunused-parameter',
147    '-Wcovered-switch-default',
148    '-Wcomma',
149    '-Wextra-semi',
150    '-Wzero-as-null-pointer-constant',
151    '-Wswitch-enum',
152    '-Wnull-dereference',
153    '-Wdouble-promotion',
154    '-Wformat=2',
155  ]),
156  language:'cpp')
157endif
158
159# if compiler is gnu-gcc , and version is > 8.0 then we add few more
160# compiler arguments , we know that will pass
161
162if (cxx.get_id() == 'gcc' and cxx.version().version_compare('>8.0'))
163
164  ## remove once bmcweb/issues/147 is fixed
165  add_global_link_arguments('-Wno-stringop-overflow',language:['c','cpp'])
166  add_project_arguments('-Wno-stringop-overflow',language:['c','cpp'])
167
168  add_project_arguments(
169    cxx.get_supported_arguments([
170     '-Wduplicated-cond',
171     '-Wduplicated-branches',
172     '-Wlogical-op',
173     '-Wunused-parameter',
174     '-Wnull-dereference',
175     '-Wdouble-promotion',
176     '-Wformat=2',
177     ]),
178    language:'cpp')
179endif
180
181if (get_option('buildtype') != 'plain')
182  if (get_option('b_lto') == true and get_option('optimization')!='0')
183    # Reduce the binary size by removing unnecessary
184    # dynamic symbol table entries
185
186    add_project_arguments(
187     cxx.get_supported_arguments([
188     '-fno-fat-lto-objects',
189     '-fvisibility=hidden',
190     '-fvisibility-inlines-hidden'
191     ]),
192     language: 'cpp')
193
194    if cxx.has_link_argument('-Wl,--exclude-libs,ALL')
195      add_project_link_arguments('-Wl,--exclude-libs,ALL', language: 'cpp')
196    endif
197  endif
198endif
199
200if( get_option('bmcweb-logging').enabled() or \
201    get_option('buildtype').startswith('debug'))
202 add_project_arguments([
203   '-DBMCWEB_ENABLE_LOGGING',
204   '-DBMCWEB_ENABLE_DEBUG'
205   ],
206  language : 'cpp')
207
208  summary({'debug' :'-DBMCWEB_ENABLE_DEBUG',
209     'logging' : '-DBMCWEB_ENABLE_LOGGING',
210    },section : 'Enabled Features')
211endif
212
213if( get_option('redfish-allow-deprecated-hostname-patch').enabled())
214 add_project_arguments([
215   '-DBMCWEB_ALLOW_DEPRECATED_HOSTNAME_PATCH'
216   ],
217  language : 'cpp')
218
219  summary({'hostname-patch' :'-DBMCWEB_ALLOW_DEPRECATED_HOSTNAME_PATCH'
220    },section : 'Enabled Features')
221endif
222
223if( get_option('redfish-allow-deprecated-power-thermal').enabled())
224 add_project_arguments([
225   '-DBMCWEB_ALLOW_DEPRECATED_POWER_THERMAL'
226   ],
227  language : 'cpp')
228
229  summary({'power-thermal' :'-DBMCWEB_ALLOW_DEPRECATED_POWER_THERMAL'
230    },section : 'Enabled Features')
231endif
232
233if( get_option('redfish-new-powersubsystem-thermalsubsystem').enabled())
234 add_project_arguments([
235   '-DBMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM'
236   ],
237  language : 'cpp')
238
239  summary({'new-powersubsystem-thermalsubsystem' :'-DBMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM'
240    },section : 'Enabled Features')
241endif
242
243# Set Compiler Security flags
244
245security_flags = [
246  '-fstack-protector-strong',
247  '-fPIE',
248  '-fPIC',
249  '-D_FORTIFY_SOURCE=2',
250  '-Wformat',
251  '-Wformat-security'
252]
253
254## Add security flags for builds of type 'release','debugoptimized' and 'minsize'
255
256if not (get_option('buildtype') == 'plain' or get_option('buildtype').startswith('debug'))
257  add_project_arguments(
258   cxx.get_supported_arguments([
259    security_flags
260  ]),
261  language: 'cpp')
262endif
263
264# Boost dependency configuration
265
266add_project_arguments(
267cxx.get_supported_arguments([
268  '-DBOOST_ASIO_USE_TS_EXECUTOR_AS_DEFAULT',
269  '-DBOOST_ASIO_DISABLE_THREADS',
270  '-DBOOST_BEAST_USE_STD_STRING_VIEW',
271  '-DBOOST_ERROR_CODE_HEADER_ONLY',
272  '-DBOOST_SYSTEM_NO_DEPRECATED',
273  '-DBOOST_ASIO_NO_DEPRECATED',
274  '-DBOOST_ALL_NO_LIB',
275  '-DBOOST_NO_RTTI',
276  '-DBOOST_NO_TYPEID',
277  '-DBOOST_COROUTINES_NO_DEPRECATION_WARNING',
278  '-DBOOST_URL_STANDALONE',
279  '-DBOOST_URL_HEADER_ONLY',
280  '-DBOOST_ALLOW_DEPRECATED_HEADERS',
281  '-DJSON_NOEXCEPTION'
282]),
283language : 'cpp')
284
285# Find the dependency modules, if not found use meson wrap to get them
286# automatically during the configure step
287bmcweb_dependencies = []
288
289pam = cxx.find_library('pam', required: get_option('pam'))
290atomic =  cxx.find_library('atomic', required: true)
291openssl = dependency('openssl', required : true)
292bmcweb_dependencies += [pam, atomic, openssl]
293
294sdbusplus = dependency('sdbusplus', required : false, include_type: 'system')
295if not sdbusplus.found()
296  sdbusplus_proj = subproject('sdbusplus', required: true)
297  sdbusplus = sdbusplus_proj.get_variable('sdbusplus_dep')
298  sdbusplus = sdbusplus.as_system('system')
299endif
300bmcweb_dependencies += sdbusplus
301
302if get_option('rest').enabled()
303  tinyxml = dependency('tinyxml2', required: false)
304  if not tinyxml.found()
305    tinyxml_proj = subproject('tinyxml2', required: true)
306    tinyxml = tinyxml_proj.get_variable('tinyxml2_dep')
307    tinyxml = tinyxml.as_system('system')
308  endif
309  bmcweb_dependencies += tinyxml
310endif
311
312systemd = dependency('systemd')
313zlib = dependency('zlib')
314bmcweb_dependencies += [systemd, zlib]
315
316if cxx.has_header('nlohmann/json.hpp')
317    nlohmann_json = declare_dependency()
318else
319    subproject('nlohmann', required: false)
320    nlohmann_json = declare_dependency(
321        include_directories: [
322            'subprojects/nlohmann/single_include',
323            'subprojects/nlohmann/single_include/nlohmann',
324        ]
325    )
326    nlohmann_json = nlohmann_json.as_system('system')
327endif
328bmcweb_dependencies += nlohmann_json
329
330boost = dependency('boost',version : '>=1.75.0', required : false, include_type: 'system')
331if not boost.found()
332  subproject('boost', required: false)
333  boost_inc = include_directories('subprojects/boost_1_75_0/', is_system:true)
334  boost  = declare_dependency(include_directories : boost_inc)
335  boost = boost.as_system('system')
336endif
337bmcweb_dependencies += boost
338
339if cxx.has_header('boost/url/url_view.hpp')
340  boost_url = declare_dependency()
341else
342  subproject('boost-url', required: false)
343  boost_url_inc = include_directories('subprojects/boost-url/include', is_system:true)
344  boost_url= declare_dependency(include_directories : boost_url_inc)
345  boost_url = boost_url.as_system('system')
346endif
347bmcweb_dependencies += boost_url
348
349if get_option('tests').enabled()
350  gtest = dependency('gtest', main: true,disabler: true, required : false)
351  gmock = dependency('gmock', required : false)
352  if not gtest.found() and get_option('tests').enabled()
353    gtest_proj = subproject('gtest', required: true)
354    gtest = gtest_proj.get_variable('gtest_main_dep')
355    gmock = gtest_proj.get_variable('gmock_dep')
356  endif
357  gtest = gtest.as_system('system')
358  gmock = gmock.as_system('system')
359endif
360
361# Source files
362
363srcfiles_bmcweb = [
364  'src/webserver_main.cpp',
365  'redfish-core/src/error_messages.cpp',
366  'redfish-core/src/utils/json_utils.cpp'
367]
368
369srcfiles_unittest = [
370  'include/ut/dbus_utility_test.cpp',
371  'include/ut/http_utility_test.cpp',
372  'redfish-core/ut/privileges_test.cpp',
373  'redfish-core/ut/lock_test.cpp',
374  'redfish-core/ut/configfile_test.cpp',
375  'redfish-core/ut/time_utils_test.cpp',
376  'http/ut/utility_test.cpp'
377]
378
379# Gather the Configuration data
380
381conf_data = configuration_data()
382conf_data.set('BMCWEB_HTTP_REQ_BODY_LIMIT_MB', get_option('http-body-limit'))
383xss_enabled = get_option('insecure-disable-xss')
384conf_data.set10('BMCWEB_INSECURE_DISABLE_XSS_PREVENTION', xss_enabled.enabled())
385conf_data.set('MESON_INSTALL_PREFIX', get_option('prefix'))
386conf_data.set('HTTPS_PORT', get_option('https_port'))
387configure_file(input: 'bmcweb_config.h.in',
388               output: 'bmcweb_config.h',
389               configuration: conf_data)
390
391# Configure and install systemd unit files
392
393systemd_system_unit_dir = systemd.get_pkgconfig_variable('systemdsystemunitdir')
394
395bindir = get_option('prefix') + '/' +get_option('bindir')
396
397summary({
398          'prefix' : get_option('prefix'),
399          'bindir' : bindir,
400          'systemd unit directory' : systemd_system_unit_dir
401        }, section : 'Directories')
402
403configure_file(input : 'bmcweb.socket.in',
404               output : 'bmcweb.socket',
405               install_dir: systemd_system_unit_dir,
406               configuration: conf_data,
407               install : true)
408
409configure_file(input : 'bmcweb.service.in',
410               output : 'bmcweb.service',
411               install_dir: systemd_system_unit_dir,
412               configuration: conf_data,
413               install : true)
414
415# Copy pam-webserver to etc/pam.d
416configure_file(input : 'pam-webserver',
417               output : 'webserver',
418               copy : true,
419               install_dir: '/etc/pam.d',
420               install : true)
421
422install_subdir('static', install_dir : 'share/www', strip_directory : true)
423
424# Generate the bmcweb executable and the test binary
425
426executable('bmcweb',srcfiles_bmcweb,
427            include_directories : incdir,
428            dependencies: bmcweb_dependencies,
429            link_args: '-Wl,--gc-sections',
430            install: true,
431            install_dir:bindir)
432
433if(get_option('tests').enabled())
434  foreach src_test : srcfiles_unittest
435    testname = src_test.split('/')[-1].split('.')[0]
436    test(testname,executable(testname,src_test,
437                include_directories : incdir,
438                install_dir: bindir,
439                dependencies: [
440                                boost,
441                                boost_url,
442                                gtest,
443                                openssl,
444                                gmock,
445                                nlohmann_json,
446                                sdbusplus,
447                                pam
448                              ]))
449  endforeach
450endif
451