Merge branch 'pmem-develop' into develop

Author: byrnedj

.clang-format

@@ -0,0 +1,45 @@
+---
+AccessModifierOffset: -1
+AlignEscapedNewlinesLeft: true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: true
+BasedOnStyle: Google
+BinPackParameters: false
+BreakBeforeBinaryOperators: false
+BreakBeforeBraces: Attach
+BreakConstructorInitializersBeforeComma: false
+ColumnLimit:     80
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+ExperimentalAutoDetectBinPacking: true
+IndentCaseLabels: false
+IndentFunctionDeclarationAfterType: false
+IndentWidth:     2
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCSpaceBeforeProtocolList: false
+PenaltyBreakBeforeFirstCallParameter: 10
+PenaltyBreakComment: 60
+PenaltyBreakFirstLessLess: 20
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Left
+SpaceAfterControlStatementKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+Standard:        Cpp11
+TabWidth:        8
+UseTab:          Never
+...

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,10 @@
+---
+name: General Question
+about: General Questions about CacheLib usage, compilation, and anything else
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/general-question.md

@@ -8,7 +8,7 @@ jobs:
     name: "CentOS/latest - Build CacheLib with all dependencies"
     runs-on: ubuntu-latest
     # Docker container image name
-    container: "ghcr.io/igchor/cachelib-deps:centos8"
+    container: "ghcr.io/igchor/cachelib-deps:streams8"
     steps:
       - name: "System Information"
         run: |

.github/workflows/build-cachelib-centos.yml

@@ -0,0 +1,19 @@
+# From: https://github.com/marketplace/actions/clang-format-check#multiple-paths
+name: clang-format Check
+on: []
+jobs:
+  formatting-check:
+    name: Formatting Check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        path:
+          - 'cachelib'
+          - 'examples'
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run clang-format style check for C/C++ programs.
+      uses: jidicula/[email protected]
+      with:
+        clang-format-version: '11'
+        check-path: ${{ matrix.path }}

.github/workflows/clang-format-check.yml

@@ -243,6 +243,10 @@ Use the `-O` option to skip the installation of system packages, e.g.
 As all dependencies use `git/cmake/make`, rebuilding the same code (if there
 were no updates) will be very fast.
 
+Note - fmt library might fail a static assert - in this case it is recommended
+to use commit c5dce1caf9fc8dff4e309683252fee5fbc0b6c2b from the fmt repository
+with the following command in the cachelib/external/fmt directory:
+`git reset --hard c5dce1caf9fc8dff4e309683252fee5fbc0b6c2b`
 
 ## Downloading the source code without building
 

BUILD.md

@@ -1,8 +1,8 @@
 # Changelog
 
-## V14
+## V16
 
-Inception version when Cachelib goes open source.
+This version is incompatible with versions below 15. Downgrading from this version directly to a version below 15 will require the cache to be dropped. If you need to downgrade from this version, please make sure you downgrade to version 15 first to avoid dropping the cache.
 
 ## V15
 
@@ -13,3 +13,7 @@ Updating to this version may cause compliation error because:
 1. CacheAllocator::allocatePermanent_deprecated.
 
 Updating to this version will not require dropping the cache.
+
+## V14
+
+Inception version when Cachelib goes open source.

CHANGELOG.md

@@ -17,21 +17,25 @@
 # refer to the root source directory of the project as ${HELLO_SOURCE_DIR} and
 # to the root binary directory of the project as ${HELLO_BINARY_DIR}.
 
-cmake_minimum_required (VERSION 3.10)
+cmake_minimum_required (VERSION 3.19)
 
 ## TODO: get version from variable
 project (CacheLib VERSION 0.1)
 
 #configure_file(cachelib/cachelib_config.h.in cachelib_config.h)
 
-set(CACHELIB_MAJOR_VERSION 0)
+if (NOT DEFINED CACHELIB_MAJOR_VERSION)
+  set(CACHELIB_MAJOR_VERSION 0)
+endif ()
 set(CACHELIB_MINOR_VERSION 1)
 set(CACHELIB_PATCH_VERSION 0)
 set(CACHELIB_VERSION
  ${CACHELIB_MAJOR_VERSION}.${CACHELIB_MINOR_VERSION}.${CACHELIB_PATCH_VERSION})
 
 set(PACKAGE_NAME      "cachelib")
-set(PACKAGE_VERSION   "${CACHELIB_VERSION}")
+if (NOT DEFINED PACKAGE_VERSION)
+  set(PACKAGE_VERSION   "${CACHELIB_VERSION}")
+endif ()
 set(PACKAGE_STRING    "${PACKAGE_NAME} ${PACKAGE_VERSION}")
 set(PACKAGE_TARNAME   "${PACKAGE_NAME}-${PACKAGE_VERSION}")
 set(PACKAGE_BUGREPORT "https://github.com/facebook/TBD")
@@ -314,7 +318,7 @@ install(
     PATTERN "CMakeFiles" EXCLUDE
 )
 
-
+include(sanitizers)
 # Install CMake package configuration files for cachelib
 # TODO: @ONLY?
 include(CMakePackageConfigHelpers)
@@ -361,6 +365,20 @@ install(EXPORT cachelib-exports
         #NAMESPACE cachelib::
         DESTINATION ${CMAKE_INSTALL_DIR})
 
+if (BUILD_SHARED_LIBS)
+  set_target_properties(
+    cachelib_allocator
+    cachelib_cachebench
+    cachelib_common
+    cachelib_datatype
+    cachelib_navy
+    cachelib_shm
+    PROPERTIES
+    SOVERSION ${CACHELIB_MAJOR_VERSION}
+    VERSION ${PACKAGE_VERSION}
+  )
+endif ()
+
 if (BUILD_TESTS)
   get_property(TEST_BINARIES GLOBAL PROPERTY TEST_BINARIES)
   #message(STATUS "=== Test binaries : ${TEST_BINARIES} ===")