Skip to content

Commit

Permalink
Squashed 'opae-libs/' changes from 1d9192a..59ec00f
Browse files Browse the repository at this point in the history 
59ec00f libofs: add libofs and umd (user mode driver) framework
9561585 libofs: fix blank lines in files
b75690c libofs: finish migration to opae-libs repo
f552e4d ofs_parse: look for call nodes in ast
049e00a ofs-umd: fix ofs_resolve to check func.id
4006206 libofs: add macros to wait for bit fields
15bac6c ofs umd: add ofs umd framework (#1909)
e62592b ofs: initial implementation of libofs (#1899)

git-subtree-dir: opae-libs
git-subtree-split: 59ec00f
  • Loading branch information
@sys-opaerobot
sys-opaerobot committed Mar 12, 2021
1 parent 745dfa6 commit 0f378c5
Show file tree
Hide file tree
Showing 14 changed files with 1,189 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ option(OPAE_BUILD_TESTS "Enable building of OPAE unit tests" OFF)
mark_as_advanced(OPAE_BUILD_TESTS)

include(OPAE)
include(OFS)

get_property(LIB64 GLOBAL PROPERTY FIND_LIBRARY_USE_LIB64_PATHS)
if ("${LIB64}" STREQUAL "TRUE")
Expand Down Expand Up @@ -155,6 +156,7 @@ endif (OPAE_BUILD_LIBOPAEVFIO)
opae_add_subdirectory(external)
opae_add_subdirectory(libopaemem)
opae_add_subdirectory(libopae-c)
opae_add_subdirectory(libofs)

if (OPAE_BUILD_LIBOPAEUIO)
opae_add_subdirectory(libopaeuio)
Expand Down
52 changes: 52 additions & 0 deletions cmake/modules/OFS.cmake
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
#!/usr/bin/cmake -P
## Copyright(c) 2021, Intel Corporation
##
## Redistribution and use in source and binary forms, with or without
## modification, are permitted provided that the following conditions are met:
##
## * Redistributions of source code must retain the above copyright notice,
## this list of conditions and the following disclaimer.
## * 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.
## * Neither the name of Intel Corporation nor the names of its contributors
## may be used to endorse or promote products derived from this software
## without specific prior written permission.
##
## 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.

macro(ofs_add_driver yml_file driver)
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${driver}.h
COMMAND ${PYTHON_EXECUTABLE} ${OPAE_LIBS_ROOT}/scripts/ofs_parse.py ${CMAKE_CURRENT_LIST_DIR}/${yml_file} headers c ${CMAKE_CURRENT_BINARY_DIR} --driver ${driver}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
DEPENDS
${CMAKE_CURRENT_LIST_DIR}/${yml_file}
${CMAKE_SOURCE_DIR}/scripts/ofs_parse.py
)
add_library(${driver} SHARED
${CMAKE_CURRENT_BINARY_DIR}/${driver}.h
${ARGN}
)
target_include_directories(${driver} PUBLIC
$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>
$<BUILD_INTERFACE:${OPAE_LIBS_ROOT}/ofs/libofs>
$<BUILD_INTERFACE:${OPAE_INCLUDE_PATH}>
)

target_link_libraries(${driver} PUBLIC
opae-c
)
endmacro(ofs_add_driver yml_file)


38 changes: 38 additions & 0 deletions include/ofs/ofs.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Copyright(c) 2017, Intel Corporation
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * 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.
// * Neither the name of Intel Corporation nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// 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.
/*
* \file ofs.h
* \brief OFS UMD (User Mode Driver) API
*
*/

#ifndef OFS_H
#define OFS_H

#include <ofs/ofs_primitives.h>


#endif /* !OFS_H */
203 changes: 203 additions & 0 deletions include/ofs/ofs_primitives.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
// Copyright(c) 2021, Intel Corporation
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * 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.
// * Neither the name of Intel Corporation nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// 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.
#ifndef OFS_PRIMITIVES_H
#define OFS_PRIMITIVES_H

#include <stdint.h>
#include <time.h>

#define SEC2NSEC 1000000000
#define SEC2USEC 1000000
#define SEC2MSEC 1000
#define USEC2NSEC 1000
#define NSEC2SEC 1E-9
#define USEC2SEC 1E-6
#define MSEC2SEC 1E-3
#define NSEC2USEC 1E-3

#define OFS_TIMESPEC_USEC(_ts, _usec) \
struct timespec _ts = { \
.tv_sec = (long)(_usec*USEC2SEC), \
.tv_nsec = _usec*USEC2NSEC-(long)(_usec*USEC2SEC)*SEC2NSEC \
}

#define OFS_WAIT_FOR_EQ(_bit, _value, _timeout_usec, _sleep_usec) \
({ \
int _status = 0; \
OFS_TIMESPEC_USEC(ts, _sleep_usec); \
struct timespec begin, now; \
clock_gettime(CLOCK_MONOTONIC, &begin); \
while(_bit != _value) { \
if (_sleep_usec) \
nanosleep(&ts, NULL); \
clock_gettime(CLOCK_MONOTONIC, &now); \
struct timespec delta; \
ofs_diff_timespec(&delta, &now, &begin); \
uint64_t delta_nsec = delta.tv_nsec + delta.tv_sec*SEC2NSEC;\
if (delta_nsec > _timeout_usec*USEC2NSEC) { \
_status = 1; \
break; \
} \
} \
_status; \
}) \

#define OFS_WAIT_FOR_NE(_bit, _value, _timeout_usec, _sleep_usec) \
({ \
int _status = 0; \
OFS_TIMESPEC_USEC(ts, _sleep_usec); \
struct timespec begin, now; \
clock_gettime(CLOCK_MONOTONIC, &begin); \
while(_bit == _value) { \
if (_sleep_usec) \
nanosleep(&ts, NULL); \
clock_gettime(CLOCK_MONOTONIC, &now); \
struct timespec delta; \
ofs_diff_timespec(&delta, &now, &begin); \
uint64_t delta_nsec = delta.tv_nsec + delta.tv_sec*SEC2NSEC;\
if (delta_nsec > _timeout_usec*USEC2NSEC) { \
_status = 1; \
break; \
} \
} \
_status; \
}) \

#ifdef __cplusplus
extern "C" {
#endif

/**
* Get timespec difference
*
* Given two timespec structures, calculate their difference as a timespec
* structure.
*
* This takes care of cases when a simple subtraction of nanosecond portion
* might result in an overflow (per guidance offered in gnu libc
* documentation:
* https://www.gnu.org/software/libc/manual/html_node/Calculating-Elapsed-Time.html
*
* @param[out] result Result of subraction as a 'struct timespec' structure
* @param[in] lhs Left hand side of operation
* @param[in] rhs Right hand side of operation
* @returns 0 if lhs > rhs, 1 otherwise
*/
inline int ofs_diff_timespec(struct timespec *result,
struct timespec *lhs, struct timespec *rhs)
{

long rhs_sec = rhs->tv_sec;
long rhs_nsec = rhs->tv_nsec;
if (lhs->tv_nsec < rhs_nsec) {
int sec = (rhs_nsec - lhs->tv_nsec)*NSEC2SEC + 1;
rhs_nsec -= sec * SEC2NSEC;
rhs_sec += sec;
}

if (lhs->tv_nsec - rhs_nsec > SEC2NSEC) {
int sec = (lhs->tv_nsec - rhs_nsec) * NSEC2SEC;
rhs_nsec += sec * SEC2NSEC;
rhs_sec -= sec;
}

result->tv_sec = lhs->tv_sec - rhs_sec;
result->tv_nsec = lhs->tv_nsec - rhs_nsec;

return lhs->tv_sec < rhs_sec;
}


/**
* Wait for a 32-bit variable to equal a given value
*
* Helper function to poll on a variable given its pointer.
* This is helpful for pointers to MMIO registers that can be
* changed by hardware they are mapped to.
*
* @param[in] var Pointer to a variable that may change
* @param[in] value Value to compare to var
* @param[in] timeout_usec Timeout value in usec
* @param[in] sleep_usec Time (in usec) to sleep while waiting
* @returns 0 if variable changed to value while waiting, 1 otherwise
*/
inline int ofs_wait_for_eq32(uint32_t *var, uint32_t value,
uint64_t timeout_usec, uint32_t sleep_usec)
{
OFS_TIMESPEC_USEC(ts, sleep_usec);
struct timespec begin, now;
clock_gettime(CLOCK_MONOTONIC, &begin);
while(*var != value) {
if (sleep_usec)
nanosleep(&ts, NULL);
clock_gettime(CLOCK_MONOTONIC, &now);
struct timespec delta;
ofs_diff_timespec(&delta, &now, &begin);
uint64_t delta_nsec = delta.tv_nsec + delta.tv_sec*SEC2NSEC;
if (delta_nsec > timeout_usec*USEC2NSEC) {
return 1;
}
}
return 0;
}

/**
* Wait for a 64-bit variable to equal a given value
*
* Helper function to poll on a variable given its pointer.
* This is helpful for pointers to MMIO registers that can be
* changed by hardware they are mapped to.
*
* @param[in] var Pointer to a variable that may change
* @param[in] value Value to compare to var
* @param[in] timeout_usec Timeout value in usec
* @param[in] sleep_usec Time (in usec) to sleep while waiting
* @returns 0 if variable changed to value while waiting, 1 otherwise
*/
inline int ofs_wait_for_eq64(uint64_t *var, uint64_t value,
uint64_t timeout_usec, uint32_t sleep_usec)
{
OFS_TIMESPEC_USEC(ts, sleep_usec);
struct timespec begin, now;
clock_gettime(CLOCK_MONOTONIC, &begin);
while(*var != value) {
if (sleep_usec)
nanosleep(&ts, NULL);
clock_gettime(CLOCK_MONOTONIC, &now);
struct timespec delta;
ofs_diff_timespec(&delta, &now, &begin);
uint64_t delta_nsec = delta.tv_nsec + delta.tv_sec*SEC2NSEC;
if (delta_nsec > timeout_usec*USEC2NSEC) {
return 1;
}
}
return 0;
}

#ifdef __cplusplus
}
#endif
#endif /* !OFS_PRIMITIVES_H */
47 changes: 47 additions & 0 deletions libofs/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Copyright(c) 2021, Intel Corporation
##
## Redistribution and use in source and binary forms, with or without
## modification, are permitted provided that the following conditions are met:
##
## * Redistributions of source code must retain the above copyright notice,
## this list of conditions and the following disclaimer.
## * 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.
## * Neither the name of Intel Corporation nor the names of its contributors
## may be used to endorse or promote products derived from this software
## without specific prior written permission.
##
## 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.

set(src
ofs_primitives.c
)

opae_add_shared_library(
TARGET ofs
SOURCE ${src}
VERSION ${OPAE_VERSION}
SOVERSION ${OPAE_VERSION_MAJOR}
COMPONENT libofs
)

target_include_directories(ofs
PUBLIC
$<BUILD_INTERFACE:${OPAE_INCLUDE_PATH}>
)

target_link_libraries(ofs
rt
)
set_property(TARGET ofs PROPERTY C_STANDARD 11)
27 changes: 27 additions & 0 deletions libofs/ofs_primitives.c
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Copyright(c) 2021, Intel Corporation
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * 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.
// * Neither the name of Intel Corporation nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// 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.

#include <ofs/ofs_primitives.h>
Loading

0 comments on commit 0f378c5

Please sign in to comment.