From de739be1299aaa30469fc90ddc0f97ea915c784e Mon Sep 17 00:00:00 2001 From: Daniel Wagner Date: Thu, 7 Jul 2022 14:05:49 +0200 Subject: [PATCH v7] libtracefs: Add initial support for meson Introduce Meson as build framework for building libtracefs. The build steps are: # configure using .build as build directory and install destination # /tmp/test meson setup --prefix=/tmp/libtraceevent .build # trigger the build meson compile -C .build # In case you want to build the documentation, trigger the # build via the 'docs' target: meson compile -C build docs # install the library (and documentation) meson install -C .build Signed-off-by: Daniel Wagner --- v7: - set default html doc path to share/doc/libtracefs-doc - list libtraceevent in Required pkg-config section. - install (any) man5 pages (keep it in sync with other projects) v6: - changed project defaults to --default-library=both - code style consistency updates - hardening doc install script (shellcheck) - renamed install-man.sh.in to install-docs.sh.in - install-docs.sh.in installs html pages too - introduces docs target - updated copyright year - streamlined documentation meson build file v5: - build unit test only if cunit is found - default build target is debug - do not install man pages into subdirs - install sqlhist (because we install the man page too, so why not the tool?) v4: - add subdir include path to cflags in pkgconfg file - refactoring build instruction for section 1 and section 3 documentation into one loop (reduce code duplication) v3: - build documetation - build samples - set default location to /usr/local v2: - updated commit message - dropped the include path patch, the pkg-config from libtraceevent is including them v1: - initial version Documentation/install-docs.sh.in | 20 ++++ Documentation/meson.build | 197 +++++++++++++++++++++++++++++++ include/meson.build | 11 ++ meson.build | 47 ++++++++ meson_options.txt | 16 +++ samples/extract-example.sh | 3 + samples/meson.build | 45 +++++++ src/meson.build | 63 ++++++++++ utest/meson.build | 17 +++ 9 files changed, 419 insertions(+) create mode 100755 Documentation/install-docs.sh.in create mode 100644 Documentation/meson.build create mode 100644 include/meson.build create mode 100644 meson.build create mode 100644 meson_options.txt create mode 100644 samples/extract-example.sh create mode 100644 samples/meson.build create mode 100644 src/meson.build create mode 100644 utest/meson.build diff --git a/Documentation/install-docs.sh.in b/Documentation/install-docs.sh.in new file mode 100755 index 000000000000..eca9b1f42dcc --- /dev/null +++ b/Documentation/install-docs.sh.in @@ -0,0 +1,20 @@ +#!/bin/bash +# SPDX-License-Identifier: LGPL-2.1 +# +# Copyright (c) 2023 Daniel Wagner, SUSE LLC + +for section in 1 3 5; do + while IFS= read -r -d '' man; do + [ ! -d "${DESTDIR}@MANDIR@/man${section}" ] && install -d "${DESTDIR}@MANDIR@/man${section}" + + echo Installing "${man}" to "${DESTDIR}@MANDIR@/man${section}" + install -m 0644 "${man}" "${DESTDIR}@MANDIR@/man${section}/" + done< <(find "@SRCDIR@" -name "*\.${section}" -type f -print0) +done + +while IFS= read -r -d '' html; do + [ ! -d "${DESTDIR}@HTMLDIR@" ] && install -d "${DESTDIR}@HTMLDIR@" + + echo Installing "${html}" to "${DESTDIR}@HTMLDIR@" + install -m 0644 "${html}" "${DESTDIR}@HTMLDIR@" +done< <(find "@SRCDIR@" -name "*\.html" -type f -print0) diff --git a/Documentation/meson.build b/Documentation/meson.build new file mode 100644 index 000000000000..efb78b602965 --- /dev/null +++ b/Documentation/meson.build @@ -0,0 +1,197 @@ +# SPDX-License-Identifier: LGPL-2.1 +# +# Copyright (c) 2023 Daniel Wagner, SUSE LLC + +# input text file: man page section + +sources = { + 'libtracefs-sqlhist.txt.1': '1', + 'libtracefs-cpu-open.txt': '3', + 'libtracefs-cpu.txt': '3', + 'libtracefs-dynevents.txt': '3', + 'libtracefs-eprobes.txt': '3', + 'libtracefs-error.txt': '3', + 'libtracefs-events-file.txt': '3', + 'libtracefs-events-tep.txt': '3', + 'libtracefs-events.txt': '3', + 'libtracefs-files.txt': '3', + 'libtracefs-filter.txt': '3', + 'libtracefs-function-filter.txt': '3', + 'libtracefs-hist-cont.txt': '3', + 'libtracefs-hist-mod.txt': '3', + 'libtracefs-hist.txt': '3', + 'libtracefs-instances-affinity.txt': '3', + 'libtracefs-instances-file-manip.txt': '3', + 'libtracefs-instances-files.txt': '3', + 'libtracefs-instances-manage.txt': '3', + 'libtracefs-instances-utils.txt': '3', + 'libtracefs-iterator.txt': '3', + 'libtracefs-kprobes.txt': '3', + 'libtracefs-log.txt': '3', + 'libtracefs-marker_raw.txt': '3', + 'libtracefs-marker.txt': '3', + 'libtracefs-option-get.txt': '3', + 'libtracefs-option-misc.txt': '3', + 'libtracefs-options.txt': '3', + 'libtracefs-sql.txt': '3', + 'libtracefs-stream.txt': '3', + 'libtracefs-synth2.txt': '3', + 'libtracefs-synth-info.txt': '3', + 'libtracefs-synth.txt': '3', + 'libtracefs-traceon.txt': '3', + 'libtracefs-tracer.txt': '3', + 'libtracefs.txt': '3', + 'libtracefs-uprobes.txt': '3', + 'libtracefs-utils.txt': '3', +} + +conf_dir = meson.current_source_dir() + '/' +top_source_dir = meson.current_source_dir() + '/../' + +## +# For asciidoc ... +# -7.1.2, no extra settings are needed. +# 8.0-, set ASCIIDOC8. +# + +# +# For docbook-xsl ... +# -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0) +# 1.69.0, no extra settings are needed? +# 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP? +# 1.71.1, no extra settings are needed? +# 1.72.0, set DOCBOOK_XSL_172. +# 1.73.0-, set ASCIIDOC_NO_ROFF +# + +# +# If you had been using DOCBOOK_XSL_172 in an attempt to get rid +# of 'the ".ft C" problem' in your generated manpages, and you +# instead ended up with weird characters around callouts, try +# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8). +# + +if get_option('asciidoctor') + asciidoc = find_program('asciidoctor') + asciidoc_extra = ['-a', 'compat-mode'] + asciidoc_extra += ['-I.'] + asciidoc_extra += ['-r', 'asciidoctor-extensions'] + asciidoc_extra += ['-a', 'mansource=libtraceevent'] + asciidoc_extra += ['-a', 'manmanual="libtraceevent Manual"'] + asciidoc_html = 'xhtml5' +else + asciidoc = find_program('asciidoc') + asciidoc_extra = ['--unsafe'] + asciidoc_extra += ['-f', conf_dir + 'asciidoc.conf'] + asciidoc_html = 'xhtml11' + + r = run_command(asciidoc, '--version', check: true) + v = r.stdout().strip() + if v.version_compare('>=8.0') + asciidoc_extra += ['-a', 'asciidoc7compatible'] + endif +endif + +manpage_xsl = conf_dir + 'manpage-normal.xsl' + +if get_option('docbook-xls-172') + asciidoc_extra += ['-a', 'libtraceevent-asciidoc-no-roff'] + manpage_xsl = conf_dir + 'manpage-1.72.xsl' +elif get_option('asciidoc-no-roff') + # docbook-xsl after 1.72 needs the regular XSL, but will not + # pass-thru raw roff codes from asciidoc.conf, so turn them off. + asciidoc_extra += ['-a', 'libtraceevent-asciidoc-no-roff'] +endif + +xmlto = find_program('xmlto') +xmlto_extra = [] + +if get_option('man-bold-literal') + xmlto_extra += ['-m ', conf_dir + 'manpage-bold-literal.xsl'] +endif + +if get_option('docbook-suppress-sp') + xmlto_extra += ['-m ', conf_dir + 'manpage-suppress-sp.xsl'] +endif + +check_doc = custom_target( + 'check-doc', + output: 'dummy', + command : [ + top_source_dir + 'check-manpages.sh', + meson.current_source_dir()]) + +gen = generator( + asciidoc, + output: '@BASENAME@.xml', + arguments: [ + '-b', 'docbook', + '-d', 'manpage', + '-a', 'libtraceevent_version=' + meson.project_version(), + '-o', '@OUTPUT@'] + + asciidoc_extra + + ['@INPUT@']) + +man = [] +html = [] +foreach txt, section : sources + # build man page(s) + xml = gen.process(txt) + man += custom_target( + txt.underscorify() + '_man', + input: xml, + output: '@BASENAME@.' + section, + depends: check_doc, + command: [ + xmlto, + '-m', manpage_xsl, + 'man', + '-o', '@OUTPUT@'] + + xmlto_extra + + ['@INPUT@']) + + # build html pages + html += custom_target( + txt.underscorify() + '_html', + input: txt, + output: '@BASENAME@.html', + depends: check_doc, + command: [ + asciidoc, + '-b', asciidoc_html, + '-d', 'manpage', + '-a', 'libtraceevent_version=' + meson.project_version(), + '-o', '@OUTPUT@'] + + asciidoc_extra + + ['@INPUT@']) +endforeach + +# Install path workaround because: +# +# - xmlto might generate more than one file and we would to tell meson +# about those output files. We could figure out which files are generated +# (see sed match in check-manpages.sh). +# +# - The man page generation puts all the generated files under sub dirs +# and it's not obvious how to tell Meson it should not do this without +# causing the install step to fail (confusion where the generated files +# are stored) +# +# - The documentation build is not part of the 'build' target. The user +# has explicitly to trigger the doc build. Hence the documentation is +# not added to the 'install' target. +# +# Thus just use a plain old shell script to move the generated files to the +# right location. + +conf = configuration_data() +conf.set('SRCDIR', meson.current_build_dir()) +conf.set('MANDIR', mandir) +conf.set('HTMLDIR', htmldir) +configure_file( + input: 'install-docs.sh.in', + output: 'install-docs.sh', + configuration: conf) + +meson.add_install_script( + join_paths(meson.current_build_dir(), 'install-docs.sh')) diff --git a/include/meson.build b/include/meson.build new file mode 100644 index 000000000000..52db432c8275 --- /dev/null +++ b/include/meson.build @@ -0,0 +1,11 @@ +# SPDX-License-Identifier: LGPL-2.1 +# +# Copyright (c) 2023 Daniel Wagner, SUSE LLC + +headers = [ + 'tracefs.h', +] + +foreach h : headers + install_headers(h, subdir : 'libtracefs') +endforeach diff --git a/meson.build b/meson.build new file mode 100644 index 000000000000..e793cfc16e14 --- /dev/null +++ b/meson.build @@ -0,0 +1,47 @@ +# SPDX-License-Identifier: LGPL-2.1 +# +# Copyright (c) 2023 Daniel Wagner, SUSE LLC + +project( + 'libtracefs', ['c'], + meson_version: '>= 0.50.0', + license: 'LGPL-2.1', + version: '1.6.3', + default_options: [ + 'c_std=gnu99', + 'buildtype=debug', + 'default_library=both', + 'prefix=/usr/local', + 'warning_level=1']) + +library_version = meson.project_version() + +libtraceevent_dep = dependency('libtraceevent', version: '>= 1.7.0', required: true) +cunit_dep = dependency('cunit', required : false) + +prefixdir = get_option('prefix') +bindir = join_paths(prefixdir, get_option('bindir')) +mandir = join_paths(prefixdir, get_option('mandir')) +htmldir = join_paths(prefixdir, get_option('htmldir')) + +add_project_arguments( + [ + '-D_GNU_SOURCE', + ], + language : 'c') + +incdir = include_directories(['include']) + +subdir('src') +subdir('include') +if cunit_dep.found() + subdir('utest') +endif +subdir('samples') +subdir('Documentation') + +custom_target( + 'docs', + output: 'docs', + depends: [html, man], + command: ['echo']) diff --git a/meson_options.txt b/meson_options.txt new file mode 100644 index 000000000000..1d92c28d5935 --- /dev/null +++ b/meson_options.txt @@ -0,0 +1,16 @@ +# SPDX-License-Identifier: LGPL-2.1 +# +# Copyright (c) 2023 Daniel Wagner, SUSE LLC + +option('htmldir', type : 'string', value : 'share/doc/libtracefs-doc', + description : 'directory for HTML documentation') +option('asciidoctor', type : 'boolean', value: false, + description : 'use asciidoctor instead of asciidoc') +option('docbook-xls-172', type : 'boolean', value : false, + description : 'enable docbook XLS 172 workaround') +option('asciidoc-no-roff', type : 'boolean', value : false, + description : 'enable no roff workaround') +option('man-bold-literal', type : 'boolean', value : false, + description : 'enable bold literals') +option('docbook-suppress-sp', type : 'boolean', value : false, + description : 'docbook suppress sp') diff --git a/samples/extract-example.sh b/samples/extract-example.sh new file mode 100644 index 000000000000..c5c0f702e7f0 --- /dev/null +++ b/samples/extract-example.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +cat $1 | sed -ne '/^EXAMPLE/,/FILES/ { /EXAMPLE/,+2d ; /^FILES/d ; /^--/d ; p}' > $2 diff --git a/samples/meson.build b/samples/meson.build new file mode 100644 index 000000000000..5e8ad270f812 --- /dev/null +++ b/samples/meson.build @@ -0,0 +1,45 @@ +# SPDX-License-Identifier: LGPL-2.1 +# +# Copyright (c) 2023 Daniel Wagner, SUSE LLC + +examples = [ + 'dynevents', + 'kprobes', + 'eprobes', + 'uprobes', + 'synth', + 'error', + 'filter', + 'function-filter', + 'hist', + 'hist-cont', + 'tracer', + 'stream', + 'instances-affinity', + 'cpu', +] + +extract_examples = find_program('extract-example.sh') +gen = generator( + extract_examples, + output: '@BASENAME@.c', + arguments: ['@INPUT@', '@OUTPUT@']) + +foreach ex : examples + src = gen.process(meson.current_source_dir() + '/../Documentation/libtracefs-@0@.txt'.format(ex)) + executable( + ex.underscorify(), + src, + dependencies: [libtracefs_dep, libtraceevent_dep], + include_directories: [incdir]) +endforeach + +# sqlhist is unique and stands on its own +src = gen.process(meson.current_source_dir() + '/../Documentation/libtracefs-sql.txt') +executable( + 'sqlhist', + src, + dependencies: [libtracefs_dep, libtraceevent_dep], + include_directories: [incdir], + install: true, + install_dir: bindir) diff --git a/src/meson.build b/src/meson.build new file mode 100644 index 000000000000..56087e2301bf --- /dev/null +++ b/src/meson.build @@ -0,0 +1,63 @@ +# SPDX-License-Identifier: LGPL-2.1 +# +# Copyright (c) 2023 Daniel Wagner, SUSE LLC + +sources= [ + 'tracefs-dynevents.c', + 'tracefs-eprobes.c', + 'tracefs-events.c', + 'tracefs-filter.c', + 'tracefs-hist.c', + 'tracefs-instance.c', + 'tracefs-kprobes.c', + 'tracefs-marker.c', + 'tracefs-record.c', + 'tracefs-sqlhist.c', + 'tracefs-tools.c', + 'tracefs-uprobes.c', + 'tracefs-utils.c', +] + +flex = find_program('flex', required: true) +bison = find_program('bison', required: true) + +lgen = generator(flex, +output : '@PLAINNAME@.yy.c', +arguments : ['-o', '@OUTPUT@', '@INPUT@']) + +pgen = generator(bison, +output : ['@BASENAME@.tab.c', '@BASENAME@.tab.h'], +arguments : ['@INPUT@', '--defines=@OUTPUT1@', '--output=@OUTPUT0@']) + +lfiles = lgen.process('sqlhist.l') +pfiles = pgen.process('sqlhist.y') + +libtracefs = library( + 'tracefs', + sources, lfiles, pfiles, + version: library_version, + dependencies: [libtraceevent_dep], + include_directories: [incdir], + install: true) + +libtracefs_static = static_library( + 'tracefs_static', + sources, lfiles, pfiles, + dependencies: [libtraceevent_dep], + include_directories: [incdir], + install: false) + +pkg = import('pkgconfig') +pkg.generate( + libtracefs, + libraries: [libtraceevent_dep], + subdirs: 'libtracefs', + filebase: meson.project_name(), + name: meson.project_name(), + version: meson.project_version(), + description: 'Manage trace fs', + url: 'https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/') + +libtracefs_dep = declare_dependency( + include_directories: ['.'], + link_with: libtracefs) diff --git a/utest/meson.build b/utest/meson.build new file mode 100644 index 000000000000..91a526fca2bf --- /dev/null +++ b/utest/meson.build @@ -0,0 +1,17 @@ +# SPDX-License-Identifier: LGPL-2.1 +# +# Copyright (c) 2023 Daniel Wagner, SUSE LLC + +source = [ + 'trace-utest.c', + 'tracefs-utest.c', +] + +e = executable( + 'trace-utest', + source, + include_directories: [incdir], + dependencies: [libtraceevent_dep, cunit_dep], + link_with: libtracefs_static) + +test('trace-utest', e) -- 2.39.0