Spdk/include/spdk/likely.h

/*   SPDX-License-Identifier: BSD-3-Clause
 *   Copyright (c) Intel Corporation.
 *   All rights reserved.
 */

/** \file
 * Likely/unlikely branch prediction macros
 */

#ifndef SPDK_LIKELY_H
#define SPDK_LIKELY_H

#include "spdk/stdinc.h"

#define spdk_unlikely(cond)	__builtin_expect((cond), 0)
#define spdk_likely(cond)	__builtin_expect(!!(cond), 1)

#endif
Replace most BSD 3-clause license text with SPDX identifier. Many open source projects have moved to using SPDX identifiers to specify license information, reducing the amount of boilerplate code in every source file. This patch replaces the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause identifier. Almost all of these files share the exact same license text, and this patch only modifies the files that contain the most common license text. There can be slight variations because the third clause contains company names - most say "Intel Corporation", but there are instances for Nvidia, Samsung, Eideticom and even "the copyright holder". Used a bash script to automate replacement of the license text with SPDX identifier which is checked into scripts/spdx.sh. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Dong Yi <dongx.yi@intel.com> Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: <qun.wan@intel.com> 2022-06-03 19:15:11 +00:00			`/* SPDX-License-Identifier: BSD-3-Clause`
Add likely/unlikely branch prediction annotations Change-Id: Id20b7c646735178349de8c4c2095bb0e8865d6c7 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2016-09-16 22:17:33 +00:00			`* Copyright (c) Intel Corporation.`
			`* All rights reserved.`
			`*/`

			`/** \file`
			`* Likely/unlikely branch prediction macros`
			`*/`

			`#ifndef SPDK_LIKELY_H`
			`#define SPDK_LIKELY_H`

include: move standard includes into spdk/stdinc.h This is the first step toward isolating standard C and POSIX headers into a single replaceable header file. Change-Id: I527297f5e7260b01103018ad3429922962ee9add Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2017-05-01 20:22:48 +00:00			`#include "spdk/stdinc.h"`

Add likely/unlikely branch prediction annotations Change-Id: Id20b7c646735178349de8c4c2095bb0e8865d6c7 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2016-09-16 22:17:33 +00:00			`#define spdk_unlikely(cond) __builtin_expect((cond), 0)`
likely.h: fix spdk_likely condition The __builtin_expect(), as written before, would have generated the right branch taken/not taken condition, but the return value was the opposite of the cond value. We need to double-not the value to convert it to a 0/1 value while preserving its original 0/non-zero sense. Change-Id: I38101ff3ed8e89fc6516cfcdf7d642651545e4ff Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2016-12-15 20:01:08 +00:00			`#define spdk_likely(cond) __builtin_expect(!!(cond), 1)`
Add likely/unlikely branch prediction annotations Change-Id: Id20b7c646735178349de8c4c2095bb0e8865d6c7 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2016-09-16 22:17:33 +00:00
			`#endif`