From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 16F3CA0C42;
	Wed, 23 Jun 2021 20:27:00 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id CB05C40141;
	Wed, 23 Jun 2021 20:26:59 +0200 (CEST)
Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182])
 by mails.dpdk.org (Postfix) with ESMTP id 491024003F
 for <dev@dpdk.org>; Wed, 23 Jun 2021 20:26:58 +0200 (CEST)
Received: by linux.microsoft.com (Postfix, from userid 1086)
 id 9EFA320B7188; Wed, 23 Jun 2021 11:26:57 -0700 (PDT)
DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com 9EFA320B7188
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com;
 s=default; t=1624472817;
 bh=flge/tgJLGyG1M/nHlLqWmTa9odnG3OKiUTsQvHQKog=;
 h=Date:From:To:Cc:Subject:From;
 b=QFl8ru9w9nIziyvPiqzDEqyJFxF1ura3+Fb5E6b+TcqKI59GWQw3v7ZZxpW/gTtlR
 wGXeh2wXZb9vKEzE6x0WMwa21RfoUABje6FBv8t0BXik7PXvvgZUM3Utkf7mSU+DMI
 yXG0bgYDboxgj1MEK+SAk+3obxZyb3Jr4UYAA3VM=
Date: Wed, 23 Jun 2021 11:26:57 -0700
From: Tyler Retzlaff <roretzla@linux.microsoft.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net, ferruh.yigit@intel.com, dmitry.kozliuk@gmail.com,
 david.marchand@redhat.com
Message-ID: <20210623182657.GA24634@linuxonhyperv3.guj3yctzbm1etfxqx2vob5hsef.xx.internal.cloudapp.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
User-Agent: Mutt/1.5.21 (2010-09-15)
Subject: [dpdk-dev] [RFC] toolchain specific macro expansion
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

today rte_common.h defines common macros for use by dpdk and consuming
applications. most expansions are specific to the gcc toolchain.

example
// lib/eal/include/rte_common.h

/**
 * Hint never returning function
 */
#define __rte_noreturn __attribute__((noreturn))

there is an anticipated need rte_common.h to expose alternate
expansions for non-gcc toolchains in the future and would like
comments on how to achieve this in an agreeable manner.


option 1 add conditional compilation directly to rte_common.h

example
// lib/eal/include/rte_common.h

/**
 * Hint never returning function
 */
#ifdef RTE_TOOLCHAIN_GCC
#define __rte_noreturn __attribute__((noreturn))
#endif

#ifdef RTE_TOOLCHAIN_FOO
#define __rte_noreturn __foo_expansion_for_noreturn
#endif

represents the simplest approach technically but may be tedious to
maintain due to the number of macros and number of conditional
expansions per macro.


option 2 add toolchain specific files (follow existing platform/os
         includes pattern)

example:
// lib/eal/gcc/rte_toolchain_common.h
#define __rte_noreturn __attribute__((noreturn))

// lib/eal/include/rte_common.h
#include <rte_toolchain_common.h>

// meson.build (illustrative change)
host_toolchain = cc.get_id() # e.g. gcc

global_inc = include_directories('.', 'config',
    'lib/eal/include',
    'lib/eal/@0@/include'.format(host_machine.system()),
    'lib/eal/@0@/include'.format(arch_subdir),
    'lib/eal/@0@/include'.format(host_toolchain),
)

results in the introduction of more files that need to be
published/installed for applications but separate files per
implementation allow for easier maintainability.


we are interested in hearing about alternatives not listed here but in
the absence of other options we would propose to submit a patch
following option 2.

comments and alternatives welcome.

thanks