488570ebd4
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>
112 lines
3.0 KiB
C
112 lines
3.0 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (c) Intel Corporation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
#ifndef SPDK_INTERNAL_MOCK_H
|
|
#define SPDK_INTERNAL_MOCK_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#define MOCK_STRUCT_INIT(...) \
|
|
{ __VA_ARGS__ }
|
|
|
|
#define DEFINE_RETURN_MOCK(fn, ret) \
|
|
bool ut_ ## fn ## _mocked = false; \
|
|
ret ut_ ## fn
|
|
|
|
/*
|
|
* For controlling mocked function behavior, setting
|
|
* and getting values from the stub, the _P macros are
|
|
* for mocking functions that return pointer values.
|
|
*/
|
|
#define MOCK_SET(fn, val) \
|
|
ut_ ## fn ## _mocked = true; \
|
|
ut_ ## fn = val
|
|
|
|
#define MOCK_GET(fn) \
|
|
ut_ ## fn
|
|
|
|
#define MOCK_CLEAR(fn) \
|
|
ut_ ## fn ## _mocked = false
|
|
|
|
#define MOCK_CLEAR_P(fn) \
|
|
ut_ ## fn ## _mocked = false; \
|
|
ut_ ## fn = NULL
|
|
|
|
/* for proving to *certain* static analysis tools that we didn't reset the mock function. */
|
|
#define MOCK_CLEARED_ASSERT(fn) \
|
|
SPDK_CU_ASSERT_FATAL(ut_ ## fn ## _mocked == false)
|
|
|
|
/* for declaring function protoypes for wrappers */
|
|
#define DECLARE_WRAPPER(fn, ret, args) \
|
|
extern bool ut_ ## fn ## _mocked; \
|
|
extern ret ut_ ## fn; \
|
|
ret __wrap_ ## fn args; ret __real_ ## fn args
|
|
|
|
/*
|
|
* For defining the implementation of wrappers for syscalls.
|
|
* Avoid nested macro calls to prevent macro expansion of fn.
|
|
*/
|
|
#define DEFINE_WRAPPER(fn, ret, dargs, pargs) \
|
|
bool ut_ ## fn ## _mocked = false; \
|
|
ret ut_ ## fn; \
|
|
__attribute__((used)) ret __wrap_ ## fn dargs \
|
|
{ \
|
|
if (!ut_ ## fn ## _mocked) { \
|
|
return __real_ ## fn pargs; \
|
|
} else { \
|
|
return ut_ ## fn; \
|
|
} \
|
|
}
|
|
|
|
/* DEFINE_STUB is for defining the implementation of stubs for SPDK funcs. */
|
|
#define DEFINE_STUB(fn, ret, dargs, val) \
|
|
bool ut_ ## fn ## _mocked = true; \
|
|
ret ut_ ## fn = val; \
|
|
ret fn dargs; \
|
|
ret fn dargs \
|
|
{ \
|
|
return MOCK_GET(fn); \
|
|
}
|
|
|
|
/* DEFINE_STUB_V macro is for stubs that don't have a return value */
|
|
#define DEFINE_STUB_V(fn, dargs) \
|
|
void fn dargs; \
|
|
void fn dargs \
|
|
{ \
|
|
}
|
|
|
|
#define HANDLE_RETURN_MOCK(fn) \
|
|
if (ut_ ## fn ## _mocked) { \
|
|
return ut_ ## fn; \
|
|
}
|
|
|
|
|
|
/* declare wrapper protos (alphabetically please) here */
|
|
DECLARE_WRAPPER(calloc, void *, (size_t nmemb, size_t size));
|
|
|
|
DECLARE_WRAPPER(pthread_mutex_init, int,
|
|
(pthread_mutex_t *mtx, const pthread_mutexattr_t *attr));
|
|
|
|
DECLARE_WRAPPER(pthread_mutexattr_init, int,
|
|
(pthread_mutexattr_t *attr));
|
|
|
|
DECLARE_WRAPPER(recvmsg, ssize_t, (int sockfd, struct msghdr *msg, int flags));
|
|
|
|
DECLARE_WRAPPER(sendmsg, ssize_t, (int sockfd, const struct msghdr *msg, int flags));
|
|
|
|
DECLARE_WRAPPER(writev, ssize_t, (int fd, const struct iovec *iov, int iovcnt));
|
|
|
|
/* unlink is done a bit differently. */
|
|
extern char *g_unlink_path;
|
|
extern void (*g_unlink_callback)(void);
|
|
/* If g_unlink_path is NULL, __wrap_unlink will return ENOENT.
|
|
* If the __wrap_unlink() parameter does not match g_unlink_path, it will return ENOENT.
|
|
* If g_unlink_path does match, and g_unlink_callback has been set, g_unlink_callback will
|
|
* be called before returning 0.
|
|
*/
|
|
int __wrap_unlink(const char *path);
|
|
|
|
#endif /* SPDK_INTERNAL_MOCK_H */
|