From d8bfa5a9bc3f691c0bfda89de8d6f17eca5bd327 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Tue, 23 Feb 2021 10:58:56 +0100 Subject: rtems: Add rtems_get_build_label() Update #4269. --- cpukit/Makefile.am | 1 + cpukit/include/rtems/config.h | 33 +++++++++++++++++++++++- cpukit/sapi/src/getbuildlabel.c | 50 +++++++++++++++++++++++++++++++++++++ spec/build/cpukit/cpuopts.yml | 2 ++ spec/build/cpukit/librtemscpu.yml | 1 + spec/build/cpukit/optbuildlabel.yml | 16 ++++++++++++ 6 files changed, 102 insertions(+), 1 deletion(-) create mode 100644 cpukit/sapi/src/getbuildlabel.c create mode 100644 spec/build/cpukit/optbuildlabel.yml diff --git a/cpukit/Makefile.am b/cpukit/Makefile.am index a31cd31596..143a0ee4f5 100644 --- a/cpukit/Makefile.am +++ b/cpukit/Makefile.am @@ -1062,6 +1062,7 @@ librtemscpu_a_SOURCES += sapi/src/extensiondelete.c librtemscpu_a_SOURCES += sapi/src/extensionident.c librtemscpu_a_SOURCES += sapi/src/fatal.c librtemscpu_a_SOURCES += sapi/src/fatalsrctext.c +librtemscpu_a_SOURCES += sapi/src/getbuildlabel.c librtemscpu_a_SOURCES += sapi/src/getconfigmax.c librtemscpu_a_SOURCES += sapi/src/getcopyrightnotice.c librtemscpu_a_SOURCES += sapi/src/getversionstring.c diff --git a/cpukit/include/rtems/config.h b/cpukit/include/rtems/config.h index a3eec39584..2f1a7ecfa4 100644 --- a/cpukit/include/rtems/config.h +++ b/cpukit/include/rtems/config.h @@ -10,7 +10,7 @@ */ /* - * Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de) + * Copyright (C) 2009, 2021 embedded brains GmbH (http://www.embedded-brains.de) * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -93,6 +93,37 @@ extern "C" { * configuration option values, for example rtems_resource_unlimited(). */ +/* Generated from spec:/rtems/config/if/get-build-label */ + +/** + * @ingroup RTEMSAPIConfig + * + * @brief Gets the RTEMS build label. + * + * The build label is a user-provided string defined by the build + * configuration. + * + * @return Returns the pointer to the RTEMS build label. + * + * @par Notes + * The build label can be used to distinguish test suite results obtained from + * different build configurations. A use case is to record test results with + * performance data to track performance regressions. For this a database of + * performance limits is required. The build label and the target hash + * obtained from rtems_get_target_hash() can be used as a key to obtain + * performance limits. + * + * @par Constraints + * @parblock + * The following constraints apply to this directive: + * + * * The directive may be called from within any runtime context. + * + * * The directive will not cause the calling task to be preempted. + * @endparblock + */ +const char *rtems_get_build_label( void ); + /* Generated from spec:/rtems/config/if/get-copyright-notice */ /** diff --git a/cpukit/sapi/src/getbuildlabel.c b/cpukit/sapi/src/getbuildlabel.c new file mode 100644 index 0000000000..3e8d2a4e3b --- /dev/null +++ b/cpukit/sapi/src/getbuildlabel.c @@ -0,0 +1,50 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + +/** + * @file + * + * @ingroup RTEMSImplClassic + * + * @brief This source file contains the implementation of + * rtems_get_build_label(). + */ + +/* + * Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. 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. + * + * 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. + */ + +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include + +const char *rtems_get_build_label( void ) +{ +#ifdef RTEMS_BUILD_LABEL + return RTEMS_BUILD_LABEL; +#else + return "DEFAULT"; +#endif +} diff --git a/spec/build/cpukit/cpuopts.yml b/spec/build/cpukit/cpuopts.yml index 4b2a818b64..e0da529c50 100644 --- a/spec/build/cpukit/cpuopts.yml +++ b/spec/build/cpukit/cpuopts.yml @@ -33,6 +33,8 @@ links: uid: optinstall - role: build-dependency uid: optada +- role: build-dependency + uid: optbuildlabel - role: build-dependency uid: optdebug - role: build-dependency diff --git a/spec/build/cpukit/librtemscpu.yml b/spec/build/cpukit/librtemscpu.yml index 8bd108bea8..c31fa8f5ec 100644 --- a/spec/build/cpukit/librtemscpu.yml +++ b/spec/build/cpukit/librtemscpu.yml @@ -1338,6 +1338,7 @@ source: - cpukit/sapi/src/extensionident.c - cpukit/sapi/src/fatal.c - cpukit/sapi/src/fatalsrctext.c +- cpukit/sapi/src/getbuildlabel.c - cpukit/sapi/src/getconfigmax.c - cpukit/sapi/src/getcopyrightnotice.c - cpukit/sapi/src/getversionstring.c diff --git a/spec/build/cpukit/optbuildlabel.yml b/spec/build/cpukit/optbuildlabel.yml new file mode 100644 index 0000000000..f039089622 --- /dev/null +++ b/spec/build/cpukit/optbuildlabel.yml @@ -0,0 +1,16 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +actions: +- get-string: null +- define: null +build-type: option +copyrights: +- Copyright (C) 2021 embedded brains GmbH (http://www.embedded-brains.de) +default: DEFAULT +default-by-variant: [] +description: | + Defines the build label returned by rtems_get_build_label(). +enabled-by: true +format: '{}' +links: [] +name: RTEMS_BUILD_LABEL +type: build -- cgit v1.2.3