a6dbe3721e
per Intel policy to include file commit date using git cmd below. The policy does not apply to non-Intel (C) notices. git log --follow -C90% --format=%ad --date default <file> | tail -1 and then pull just the 4 digit year from the result. Intel copyrights were not added to files where Intel either had no contribution ot the contribution lacked substance (ie license header updates, formatting changes, etc). Contribution date used "--follow -C95%" to get the most accurate date. Note that several files in this patch didn't end the license/(c) block with a blank comment line so these were added as the vast majority of files do have this last blank line. Simply there for consistency. Signed-off-by: paul luse <paul.e.luse@intel.com> Change-Id: Id5b7ce4f658fe87132f14139ead58d6e285c04d4 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15192 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Community-CI: Mellanox Build Bot
112 lines
3.0 KiB
C
112 lines
3.0 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (C) 2017 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 */
|