lib: allow disabling optional libraries
[dpdk.git] / lib / meson.build
index a4f5f28..c9a20f6 100644 (file)
@@ -1,37 +1,6 @@
-#   BSD LICENSE
-#
-#   Copyright(c) 2017 Intel Corporation.
-#   All rights reserved.
-#
-#   Redistribution and use in source and binary forms, with or without
-#   modification, are permitted provided that the following conditions
-#   are met:
-#
-#     * Redistributions of source code must retain the above copyright
-#       notice, this list of conditions and the following disclaimer.
-#     * Redistributions in binary form must reproduce the above copyright
-#       notice, this list of conditions and the following disclaimer in
-#       the documentation and/or other materials provided with the
-#       distribution.
-#     * Neither the name of Intel Corporation nor the names of its
-#       contributors may be used to endorse or promote products derived
-#       from this software without specific prior written permission.
-#
-#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-#   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-#   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-#   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-#   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-#   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-#   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-#   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-#   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-# special case for eal, not a simple lib, and compat, just a header
-subdir('librte_eal')
-subdir('librte_compat')
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2017-2019 Intel Corporation
+
 
 # process all libraries equally, as far as possible
 # "core" libs first, then others alphebetically as far as possible
@@ -39,71 +8,258 @@ subdir('librte_compat')
 # sometimes skip deps that would be implied by others, e.g. if mempool is
 # given as a dep, no need to mention ring. This is especially true for the
 # core libs which are widely reused, so their deps are kept to a minimum.
-libraries = ['ring', 'mempool', 'mbuf', 'net', 'ether', 'pci', # core
-       'metrics', # bitrate/latency stats depends on this
-       'hash',    # efd depends on this
-       'kvargs',  # cryptodev depends on this
-       'acl', 'bbdev', 'bitratestats', 'cfgfile',
-       'cmdline', 'cryptodev',
-       'distributor', 'efd', 'eventdev',
-       'gro', 'gso', 'ip_frag', 'jobstats',
-       'kni', 'latencystats', 'lpm', 'member',
-       'meter', 'power', 'pdump',
-       'reorder', 'sched', 'security', 'timer', 'vhost',
-       # add pkt framework libs which use other libs from above
-       'port', 'table', 'pipeline',
-       # flow_classify lib depends on pkt framework table lib
-       'flow_classify']
+libraries = [
+        'kvargs', # eal depends on kvargs
+        'telemetry', # basic info querying
+        'eal', # everything depends on eal
+        'ring',
+        'rcu', # rcu depends on ring
+        'mempool',
+        'mbuf',
+        'net',
+        'meter',
+        'ethdev',
+        'pci', # core
+        'cmdline',
+        'metrics', # bitrate/latency stats depends on this
+        'hash',    # efd depends on this
+        'timer',   # eventdev depends on this
+        'acl',
+        'bbdev',
+        'bitratestats',
+        'cfgfile',
+        'compressdev',
+        'cryptodev',
+        'distributor',
+        'efd',
+        'eventdev',
+        'gro',
+        'gso',
+        'ip_frag',
+        'jobstats',
+        'kni',
+        'latencystats',
+        'lpm',
+        'member',
+        'power',
+        'pdump',
+        'rawdev',
+        'regexdev',
+        'rib',
+        'reorder',
+        'sched',
+        'security',
+        'stack',
+        'vhost',
+        'ipsec', # ipsec lib depends on net, crypto and security
+        'fib', #fib lib depends on rib
+        'port', # pkt framework libs which use other libs from above
+        'table',
+        'pipeline',
+        'flow_classify', # flow_classify lib depends on pkt framework table lib
+        'bpf',
+        'graph',
+        'node',
+]
+
+if is_windows
+    libraries = [
+            'kvargs',
+            'telemetry',
+            'eal',
+            'ring',
+            'rcu',
+            'mempool',
+            'mbuf',
+            'net',
+            'meter',
+            'ethdev',
+            'pci',
+            'cmdline',
+            'hash',
+            'cfgfile',
+    ] # only supported libraries for windows
+endif
+
+optional_libs = [
+    'kni',
+    'power',
+    'vhost',
+]
+
+disabled_libs = []
+opt_disabled_libs = run_command(list_dir_globs, get_option('disable_libs')).stdout().split()
+foreach l:opt_disabled_libs
+    if not optional_libs.contains(l)
+        warning('Cannot disable mandatory library "@0@"'.format(l))
+        continue
+    endif
+    disabled_libs += l
+endforeach
+
+
+default_cflags = machine_args
+default_cflags += ['-DALLOW_EXPERIMENTAL_API']
+default_cflags += ['-DALLOW_INTERNAL_API']
+
+if cc.has_argument('-Wno-format-truncation')
+    default_cflags += '-Wno-format-truncation'
+endif
+
+enabled_libs = [] # used to print summary at the end
 
 foreach l:libraries
-       build = true
-       name = l
-       version = 1
-       allow_experimental_apis = false
-       sources = []
-       headers = []
-       cflags = []
-       objs = [] # other object files to link against, used e.g. for instruction-
-                 # optimized versions of code
-       # use "deps" for internal DPDK dependencies, and "ext_deps" for
-       # external package/library requirements
-       deps = ['eal']
-       ext_deps = []
-
-       dir_name = 'librte_' + l
-       subdir(dir_name)
-
-       if build
-               dpdk_conf.set('RTE_LIBRTE_' + name.to_upper(), 1)
-               install_headers(headers)
-
-               dep_objs = ext_deps
-               foreach d:deps
-                       dep_objs += [get_variable('dep_rte_' + d)]
-               endforeach
-
-               if allow_experimental_apis
-                       cflags += '-DALLOW_EXPERIMENTAL_API'
-               endif
-
-               version_map = '@0@/@1@/rte_@2@_version.map'.format(
-                               meson.current_source_dir(), dir_name, name)
-               libname = 'rte_' + name
-               lib = library(libname,
-                               sources,
-                               objects: objs,
-                               c_args: cflags,
-                               dependencies: dep_objs,
-                               include_directories: include_directories(dir_name),
-                               link_args: '-Wl,--version-script=' + version_map,
-                               link_depends: version_map,
-                               version: '@0@.1'.format(version),
-                               install: true)
-               dep = declare_dependency(link_with: lib,
-                               include_directories: include_directories(dir_name),
-                               dependencies: dep_objs)
-               set_variable('dep_' + libname, dep)
-
-               dpdk_libraries = [lib] + dpdk_libraries
-       endif
+    build = true
+    reason = '<unknown reason>' # set if build == false to explain why
+    name = l
+    use_function_versioning = false
+    sources = []
+    headers = []
+    indirect_headers = [] # public headers not directly included by apps
+    driver_sdk_headers = [] # public headers included by drivers
+    includes = []
+    cflags = default_cflags
+    objs = [] # other object files to link against, used e.g. for
+              # instruction-set optimized versions of code
+
+    # use "deps" for internal DPDK dependencies, and "ext_deps" for
+    # external package/library requirements
+    ext_deps = []
+    deps = []
+    # eal is standard dependency once built
+    if dpdk_conf.has('RTE_LIB_EAL')
+        deps += ['eal']
+    endif
+
+    if disabled_libs.contains(l)
+        build = false
+        reason = 'explicitly disabled via build config'
+    else
+        subdir(l)
+    endif
+    if name != l
+        warning('Library name, "@0@", and directory name, "@1@", do not match'.format(name, l))
+    endif
+
+    if not build
+        dpdk_libs_disabled += name
+        set_variable(name.underscorify() + '_disable_reason', reason)
+        continue
+    endif
+
+    shared_deps = ext_deps
+    static_deps = ext_deps
+    foreach d:deps
+        if not is_variable('shared_rte_' + d)
+            error('Missing internal dependency "@0@" for @1@ [@2@]'
+                    .format(d, name, 'lib/' + l))
+        endif
+        shared_deps += [get_variable('shared_rte_' + d)]
+        static_deps += [get_variable('static_rte_' + d)]
+    endforeach
+
+    enabled_libs += name
+    dpdk_conf.set('RTE_LIB_' + name.to_upper(), 1)
+    install_headers(headers)
+    install_headers(indirect_headers)
+    if get_option('enable_driver_sdk')
+        install_headers(driver_sdk_headers)
+    endif
+    dpdk_chkinc_headers += headers
+
+    libname = 'rte_' + name
+    includes += include_directories(l)
+
+    if is_windows and use_function_versioning
+        message('@0@: Function versioning is not supported by Windows.'.format(name))
+    endif
+
+    if use_function_versioning
+        cflags += '-DRTE_USE_FUNCTION_VERSIONING'
+    endif
+
+    # first build static lib
+    static_lib = static_library(libname,
+            sources,
+            objects: objs,
+            c_args: cflags,
+            dependencies: static_deps,
+            include_directories: includes,
+            install: true)
+    static_dep = declare_dependency(
+            include_directories: includes,
+            dependencies: static_deps)
+
+    if not use_function_versioning or is_windows
+        # use pre-build objects to build shared lib
+        sources = []
+        objs += static_lib.extract_all_objects(recursive: false)
+    else
+        # for compat we need to rebuild with
+        # RTE_BUILD_SHARED_LIB defined
+        cflags += '-DRTE_BUILD_SHARED_LIB'
+    endif
+    version_map = '@0@/@1@/version.map'.format(
+            meson.current_source_dir(), l)
+    implib = 'librte_' + l + '.dll.a'
+
+    def_file = custom_target(libname + '_def',
+            command: [map_to_win_cmd, '@INPUT@', '@OUTPUT@'],
+            input: version_map,
+            output: '@0@_exports.def'.format(libname))
+
+    mingw_map = custom_target(libname + '_mingw',
+            command: [map_to_win_cmd, '@INPUT@', '@OUTPUT@'],
+            input: version_map,
+            output: '@0@_mingw.map'.format(libname))
+
+    if is_ms_linker
+        lk_args = ['-Wl,/def:' + def_file.full_path()]
+        if meson.version().version_compare('<0.54.0')
+            lk_args += ['-Wl,/implib:lib\\' + implib]
+        endif
+    else
+        if is_windows
+            lk_args = ['-Wl,--version-script=' + mingw_map.full_path()]
+        else
+            lk_args = ['-Wl,--version-script=' + version_map]
+        endif
+    endif
+
+    lk_deps = [version_map, def_file, mingw_map]
+    if not is_windows
+        # on unix systems check the output of the
+        # check-symbols.sh script, using it as a
+        # dependency of the .so build
+        lk_deps += custom_target(name + '.sym_chk',
+                command: [check_symbols,
+                    version_map, '@INPUT@'],
+                capture: true,
+                input: static_lib,
+                output: name + '.sym_chk')
+    endif
+
+    shared_lib = shared_library(libname,
+            sources,
+            objects: objs,
+            c_args: cflags,
+            dependencies: shared_deps,
+            include_directories: includes,
+            link_args: lk_args,
+            link_depends: lk_deps,
+            version: abi_version,
+            soversion: so_version,
+            install: true)
+    shared_dep = declare_dependency(link_with: shared_lib,
+            include_directories: includes,
+            dependencies: shared_deps)
+
+    dpdk_libraries = [shared_lib] + dpdk_libraries
+    dpdk_static_libraries = [static_lib] + dpdk_static_libraries
+
+    set_variable('shared_rte_' + name, shared_dep)
+    set_variable('static_rte_' + name, static_dep)
+    if developer_mode
+        message('lib/@0@: Defining dependency "@1@"'.format(l, name))
+    endif
 endforeach