add an example library with test

CMakeLists.txt

@@ -0,0 +1,236 @@
+#
+# Copyright 2018, 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 the copyright holder 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.
+
+cmake_minimum_required(VERSION 3.3)
+project(pmdk-convert C)
+
+set(VERSION_MAJOR 1)
+set(VERSION_MINOR 5)
+set(VERSION ${VERSION_MAJOR}.${VERSION_MINOR})
+
+set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR})
+
+include(FindThreads)
+
+set(MAX_VERSION 1.5)
+
+STRING(REGEX REPLACE "^([0-9]+)\\.[0-9]+" "\\1" MIN_VERSION_MAJOR "${MIN_VERSION}")
+STRING(REGEX REPLACE "^[0-9]+\\.([0-9]+)" "\\1" MIN_VERSION_MINOR "${MIN_VERSION}")
+
+STRING(REGEX REPLACE "^([0-9]+)\\.[0-9]+" "\\1" MAX_VERSION_MAJOR "${MAX_VERSION}")
+STRING(REGEX REPLACE "^[0-9]+\\.([0-9]+)" "\\1" MAX_VERSION_MINOR "${MAX_VERSION}")
+
+if(NOT CMAKE_BUILD_TYPE)
+	set(CMAKE_BUILD_TYPE "RelWithDebInfo")
+endif (NOT CMAKE_BUILD_TYPE)
+
+include(CheckCCompilerFlag)
+include(GNUInstallDirs)
+if(NOT MSVC)
+	find_package(PkgConfig QUIET)
+endif()
+
+set(CMAKE_C_STANDARD 99)
+
+# Checks whether flag is supported by current C compiler and appends
+# it to the relevant cmake variable.
+# 1st argument is a flag
+# 2nd (optional) argument is a build type (debug, release, relwithdebinfo)
+macro(add_c_flag flag)
+	string(REPLACE - _ flag2 ${flag})
+	string(REPLACE " " _ flag2 ${flag2})
+	string(REPLACE = "_" flag2 ${flag2})
+	set(check_name "C_HAS_${flag2}")
+
+	check_c_compiler_flag("${flag}" "${check_name}")
+
+	if (${${check_name}})
+		if (${ARGC} EQUAL 1)
+			set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${flag}")
+		else()
+			set(CMAKE_C_FLAGS_${ARGV1} "${CMAKE_C_FLAGS_${ARGV1}} ${flag}")
+		endif()
+	endif()
+endmacro()
+
+if(NOT MSVC)
+	add_c_flag(-fno-common)
+	add_c_flag(-Wall)
+	add_c_flag(-Wconversion)
+	add_c_flag(-Wmissing-field-initializers)
+	add_c_flag(-Wmissing-prototypes)
+	add_c_flag(-Wmissing-variable-declarations)
+	add_c_flag(-Wpointer-arith)
+	add_c_flag(-Wsign-compare)
+	add_c_flag(-Wsign-conversion)
+	add_c_flag(-Wunused-macros)
+	add_c_flag(-Wunreachable-code-return)
+
+	# Place each function or data item into its own section. Will be used to strip unneeded symbols.
+	add_c_flag(-fdata-sections)
+	add_c_flag(-ffunction-sections)
+
+	add_c_flag(-ggdb DEBUG)
+	add_c_flag(-DDEBUG DEBUG)
+
+	add_c_flag(-ggdb RELWITHDEBINFO)
+	add_c_flag(-fno-omit-frame-pointer RELWITHDEBINFO)
+
+	check_c_compiler_flag(-Wl,-z,relro LINKER_HAS_RELRO)
+	if(LINKER_HAS_RELRO)
+		set(CMAKE_EXE_LINKER_FLAGS  "${CMAKE_EXE_LINKER_FLAGS}  -Wl,-z,relro")
+		set(CMAKE_SHARED_LINKER_FLAGS  "${CMAKE_SHARED_LINKER_FLAGS}  -Wl,-z,relro")
+	endif()
+
+	check_c_compiler_flag(-Wl,--warn-common LINKER_HAS_WARN_COMMON)
+	if(LINKER_HAS_WARN_COMMON)
+		set(CMAKE_EXE_LINKER_FLAGS  "${CMAKE_EXE_LINKER_FLAGS} -Wl,--warn-common")
+		set(CMAKE_SHARED_LINKER_FLAGS  "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--warn-common")
+	endif()
+
+	add_c_flag("-U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=2" RELEASE)
+endif()
+
+configure_file(
+	"${CMAKE_CURRENT_SOURCE_DIR}/cmake_uninstall.cmake.in"
+	"${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
+	IMMEDIATE @ONLY)
+
+add_custom_target(uninstall
+	COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)
+
+# add_executable(check_license EXCLUDE_FROM_ALL utils/check_license/check-license.c)
+
+# function(add_cstyle name)
+# 	if(${ARGC} EQUAL 1)
+# 		add_custom_target(cstyle-${name}
+# 			COMMAND ${PERL_EXECUTABLE}
+# 			${CMAKE_SOURCE_DIR}/utils/cstyle
+# 			${CMAKE_CURRENT_SOURCE_DIR}/*.c
+# 			${CMAKE_CURRENT_SOURCE_DIR}/*.h)
+# 	else()
+# 		add_custom_target(cstyle-${name}
+# 			COMMAND ${PERL_EXECUTABLE}
+# 			${CMAKE_SOURCE_DIR}/utils/cstyle ${ARGN})
+# 	endif()
+# 	add_dependencies(cstyle cstyle-${name})
+# endfunction()
+
+# Generates check-whitespace-$name target and attaches it as a dependency
+# of global "check-whitespace" target. This target verifies C files in current
+# source dir do not have any whitespace errors.
+# If more arguments are used, then they are used as files to be checked
+# instead.
+# ${name} must be unique.
+
+# function(add_check_whitespace name)
+# 	if(${ARGC} EQUAL 1)
+# 		add_custom_target(check-whitespace-${name}
+# 			COMMAND ${PERL_EXECUTABLE}
+# 			${CMAKE_SOURCE_DIR}/utils/check_whitespace
+# 			${CMAKE_CURRENT_SOURCE_DIR}/*.c
+# 			${CMAKE_CURRENT_SOURCE_DIR}/*.h)
+# 	else()
+# 		add_custom_target(check-whitespace-${name}
+# 			COMMAND ${PERL_EXECUTABLE}
+# 			${CMAKE_SOURCE_DIR}/utils/check_whitespace ${ARGN})
+# 	endif()
+# 	add_dependencies(check-whitespace check-whitespace-${name})
+# endfunction()
+
+# add_custom_target(checkers ALL)
+# add_custom_target(cstyle)
+# add_custom_target(check-whitespace)
+# add_custom_target(check-license
+#	COMMAND ${CMAKE_SOURCE_DIR}/utils/check_license/check-headers.sh
+#	${CMAKE_SOURCE_DIR}
+#	${CMAKE_BINARY_DIR}/check_license
+#	${CMAKE_SOURCE_DIR}/LICENSE
+#	-a)
+
+#add_custom_target(md2man
+#	COMMAND ${CMAKE_SOURCE_DIR}/utils/md2man/md2man.sh
+#	${CMAKE_SOURCE_DIR}/doc/pmdk-convert/pmdk-convert.1.md
+#	${CMAKE_SOURCE_DIR}/utils/md2man/default.man
+#	${CMAKE_SOURCE_DIR}/doc/generated/pmdk-convert.1
+#	)
+
+#if (NOT WIN32)
+#	install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/doc/generated/pmdk-convert.1
+#		DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
+#endif()
+
+# add_dependencies(check-license check_license)
+
+#add_cstyle(main)
+#add_cstyle(check_license ${CMAKE_SOURCE_DIR}/utils/check_license/*.c)
+
+#add_check_whitespace(check_license ${CMAKE_SOURCE_DIR}/utils/check_license/*.c)
+#add_check_whitespace(src)
+#add_check_whitespace(other
+#	${CMAKE_SOURCE_DIR}/utils/check_license/*.sh
+#	${CMAKE_SOURCE_DIR}/README.md
+	#			${CMAKE_SOURCE_DIR}/utils/*.sh
+	#			${CMAKE_SOURCE_DIR}/*.spec
+	#			${CMAKE_SOURCE_DIR}/debian/*
+	#			${CMAKE_SOURCE_DIR}/debian/*/*
+	#			${CMAKE_SOURCE_DIR}/doc/*.md
+#	)
+
+option(DEVELOPER_MODE "enable developer checks" OFF)
+if(DEVELOPER_MODE)
+#	add_dependencies(checkers cstyle)
+#	add_dependencies(checkers check-whitespace)
+#	add_dependencies(checkers check-license)
+endif(DEVELOPER_MODE)
+
+set(SOURCES main.c)
+
+add_library(vmemcache SHARED ${SOURCES})
+target_link_libraries(vmemcache PRIVATE -Wl,--version-script=${CMAKE_SOURCE_DIR}/libvmemcache.map)
+
+target_compile_definitions(vmemcache PRIVATE SRCVERSION="${NVML15}")
+
+install(TARGETS vmemcache
+	DESTINATION ${CMAKE_INSTALL_LIBDIR}/)
+
+
+
+ option(TRACE_TESTS
+ 	"more verbose test outputs" OFF)
+ enable_testing()
+ add_subdirectory(tests)
+
+if(NOT "${CPACK_GENERATOR}" STREQUAL "")
+	include(${CMAKE_SOURCE_DIR}/packages.cmake)
+endif()

cmake_uninstall.cmake.in

@@ -0,0 +1,22 @@
+# From: https://cmake.org/Wiki/CMake_FAQ
+
+if(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt")
+	message(FATAL_ERROR "Cannot find install manifest: @CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt")
+endif(NOT EXISTS "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt")
+
+file(READ "@CMAKE_CURRENT_BINARY_DIR@/install_manifest.txt" files)
+string(REGEX REPLACE "\n" ";" files "${files}")
+foreach(file ${files})
+	message(STATUS "Uninstalling $ENV{DESTDIR}${file}")
+	if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}")
+		exec_program("@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\""
+			OUTPUT_VARIABLE rm_out
+			RETURN_VALUE rm_retval
+		)
+		if(NOT "${rm_retval}" STREQUAL 0)
+			message(FATAL_ERROR "Problem when removing $ENV{DESTDIR}${file}")
+		endif(NOT "${rm_retval}" STREQUAL 0)
+	else(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}")
+		message(STATUS "File $ENV{DESTDIR}${file} does not exist.")
+	endif(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}")
+endforeach(file)

libvmemcache.map

@@ -0,0 +1,38 @@
+#
+# Copyright 2018, 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 the copyright holder 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.
+#
+
+{
+	global:
+		function;
+	local:
+		*;
+};

main.c

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2018, 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 the copyright holder 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.
+ */
+
+/* an example library */
+#include <stdio.h>
+#include "main.h"
+
+int function()
+{
+	printf("hello world\n)");
+	return 0;
+}

main.h

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2018, 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 the copyright holder 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.
+ */
+
+/* an example library */
+int function(void);