pmem · wlemkows · Mar 14, 2023 · Mar 9, 2023 · wlemkows · Mar 14, 2023
diff --git a/README.md b/README.md
@@ -47,7 +47,11 @@ Libraries available in this repository:
 
 - [libpmemobj](https://pmem.io/pmdk/libpmemobj/):  provides a transactional object store, providing memory allocation, transactions, and general facilities for persistent memory programming.
 
-- [libpmemblk](https://pmem.io/pmdk/libpmemblk/):  supports arrays of pmem-resident blocks, all the same size, that are atomically updated.
+- [libpmemblk](https://pmem.io/pmdk/libpmemblk/):  supports arrays of pmem-resident blocks, all the same size, that are atomically updated. (DEPRECATED)
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release
+and will be removed in the PMDK 1.14.0 release.
 
 - [libpmemlog](https://pmem.io/pmdk/libpmemlog/):  provides a pmem-resident log file.
 

diff --git a/doc/README b/doc/README
@@ -22,7 +22,7 @@ document subdirectories:
 
 libpmem -- low-level persistent memory support
 libpmem2 -- low-level persistent memory support
-libpmemblk -- pmem-resident arrays of blocks
+libpmemblk -- pmem-resident arrays of blocks (DEPRECATED)
 libpmemlog -- pmem-resident log files
 libpmemobj -- transactional object store
 libpmempool -- persistent memory pool management library

diff --git a/doc/libpmemblk/libpmemblk.7.md b/doc/libpmemblk/libpmemblk.7.md
@@ -9,7 +9,7 @@ header: "pmemblk API version 1.1"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2018, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (libpmemblk.7 -- man page for libpmemblk)
 
@@ -26,7 +26,7 @@ header: "pmemblk API version 1.1"
 
 # NAME #
 
-**libpmemblk** - persistent memory resident array of blocks
+**libpmemblk** - persistent memory resident array of blocks (DEPRECATED)
 
 # SYNOPSIS #
 
@@ -300,6 +300,12 @@ See <https://pmem.io/pmdk/libpmemblk> for more examples using the **libpmemblk**
 Unlike **libpmemobj**(7), data replication is not supported in **libpmemblk**.
 Thus, specifying replica sections in pool set files is not allowed.
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release
+and will be removed in the PMDK 1.14.0 release.
+
 # ACKNOWLEDGEMENTS #
 
 **libpmemblk** builds on the persistent memory programming model recommended

diff --git a/doc/libpmemblk/pmemblk_bsize.3.md b/doc/libpmemblk/pmemblk_bsize.3.md
@@ -9,7 +9,7 @@ header: "pmemblk API version 1.1"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2017-2018, Intel Corporation)
+[comment]: <> (Copyright 2017-2023, Intel Corporation)
 
 [comment]: <> (pmemblk_bsize.3 -- man page for functions that check number of available blocks or usable space in block memory pool)
 
@@ -21,7 +21,7 @@ header: "pmemblk API version 1.1"
 
 # NAME #
 
-**pmemblk_bsize**(), **pmemblk_nblock**() - check number of available blocks or
+**pmemblk_bsize**()(DEPRECATED), **pmemblk_nblock**()(DEPRECATED) - check number of available blocks or
 usable space in block memory pool
 
 # SYNOPSIS #

diff --git a/doc/libpmemblk/pmemblk_create.3.md b/doc/libpmemblk/pmemblk_create.3.md
@@ -9,7 +9,7 @@ header: "pmemblk API version 1.1"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2017-2018, Intel Corporation)
+[comment]: <> (Copyright 2017-2023, Intel Corporation)
 
 [comment]: <> (pmemblk_create.3 -- man page for libpmemblk create, open, close and validate functions)
 
@@ -21,8 +21,8 @@ header: "pmemblk API version 1.1"
 
 # NAME #
 
-_UW(pmemblk_create), _UW(pmemblk_open),
-**pmemblk_close**(), _UW(pmemblk_check)
+_UW(pmemblk_create)(DEPRECATED), _UW(pmemblk_open)(DEPRECATED),
+**pmemblk_close**()(DEPRECATED), _UW(pmemblk_check)(DEPRECATED)
 - create, open, close and validate block pool
 
 # SYNOPSIS #

diff --git a/doc/libpmemblk/pmemblk_ctl_get.3.md b/doc/libpmemblk/pmemblk_ctl_get.3.md
@@ -9,7 +9,7 @@ header: "pmemblk API version 1.1"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2018-2019, Intel Corporation)
+[comment]: <> (Copyright 2018-2023, Intel Corporation)
 
 [comment]: <> (pmemblk_ctl_get.3 -- man page for libpmemblk CTL)
 
@@ -22,9 +22,9 @@ header: "pmemblk API version 1.1"
 
 # NAME #
 
-_UW(pmemblk_ctl_get),
-_UW(pmemblk_ctl_set),
-_UW(pmemblk_ctl_exec)
+_UW(pmemblk_ctl_get)(DEPRECATED),
+_UW(pmemblk_ctl_set)(DEPRECATED),
+_UW(pmemblk_ctl_exec)(DEPRECATED)
 - Query and modify libpmemblk internal behavior (EXPERIMENTAL)
 
 # SYNOPSIS #

diff --git a/doc/libpmemblk/pmemblk_read.3.md b/doc/libpmemblk/pmemblk_read.3.md
@@ -9,7 +9,7 @@ header: "pmemblk API version 1.1"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2017-2018, Intel Corporation)
+[comment]: <> (Copyright 2017-2023, Intel Corporation)
 
 [comment]: <> (pmemblk_read.3 -- man page for libpmemblk read and write functions)
 
@@ -21,7 +21,7 @@ header: "pmemblk API version 1.1"
 
 # NAME #
 
-**pmemblk_read**(), **pmemblk_write**() - read or write a block from a block
+**pmemblk_read**()(DEPRECATED), **pmemblk_write**()(DEPRECATED) - read or write a block from a block
 memory pool
 
 # SYNOPSIS #

diff --git a/doc/libpmemblk/pmemblk_set_zero.3.md b/doc/libpmemblk/pmemblk_set_zero.3.md
@@ -9,7 +9,7 @@ header: "pmemblk API version 1.1"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2017-2018, Intel Corporation)
+[comment]: <> (Copyright 2017-2023, Intel Corporation)
 
 [comment]: <> (pmemblk_set_zero.3 -- man page for block management functions)
 
@@ -21,7 +21,7 @@ header: "pmemblk API version 1.1"
 
 # NAME #
 
-**pmemblk_set_zero**(), **pmemblk_set_error**() - block management functions
+**pmemblk_set_zero**()(DEPRECATED), **pmemblk_set_error**()(DEPRECATED) - block management functions
 
 # SYNOPSIS #
 

diff --git a/doc/pmempool/pmempool-check.1.md b/doc/pmempool/pmempool-check.1.md
@@ -9,7 +9,7 @@ header: "pmem Tools version 1.4"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2018, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (pmempool-check.1 -- man page for pmempool-check)
 
@@ -29,6 +29,11 @@ header: "pmem Tools version 1.4"
 $ pmempool check [<options>] <file>
 ```
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release.
+
 # DESCRIPTION #
 
 The **pmempool** invoked with *check* command checks consistency of a given pool file.

diff --git a/doc/pmempool/pmempool-convert.1.md b/doc/pmempool/pmempool-convert.1.md
@@ -9,7 +9,7 @@ header: "pmem Tools version 1.4"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2018, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (pmempool-convert.1 -- man page for pmempool-convert)
 
@@ -24,6 +24,11 @@ header: "pmem Tools version 1.4"
 **pmempool-convert** - this is a wrapper around pmdk-convert tool. More information
 can be found in **pmdk-convert**(1) man page.
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release.
+
 # SEE ALSO #
 
 **pmdk-convert**(1), **pmempool**(1), **libpmemblk**(7), **libpmemlog**(7),

diff --git a/doc/pmempool/pmempool-create.1.md b/doc/pmempool/pmempool-create.1.md
@@ -9,7 +9,7 @@ header: "pmem Tools version 1.4"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2019, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (pmempool-create.1 -- man page for pmempool-create)
 
@@ -29,6 +29,11 @@ header: "pmem Tools version 1.4"
 $ pmempool create [<options>] [<type>] [<bsize>] <file>
 ```
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release.
+
 # DESCRIPTION #
 
 The **pmempool** invoked with *create* command creates a pool file

diff --git a/doc/pmempool/pmempool-dump.1.md b/doc/pmempool/pmempool-dump.1.md
@@ -9,7 +9,7 @@ header: "pmem Tools version 1.4"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2018, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (pmempool-dump.1 -- man page for pmempool-dump)
 
@@ -30,6 +30,11 @@ header: "pmem Tools version 1.4"
 $ pmempool dump [<options>] <file>
 ```
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release.
+
 # DESCRIPTION #
 
 The **pmempool** invoked with *dump* command dumps user data from specified pool file.

diff --git a/doc/pmempool/pmempool-info.1.md b/doc/pmempool/pmempool-info.1.md
@@ -9,7 +9,7 @@ header: "pmem Tools version 1.4"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2022, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (pmempool-info.1 -- man page for pmempool-info)
 
@@ -31,6 +31,12 @@ header: "pmem Tools version 1.4"
 $ pmempool info [<options>] <file>
 ```
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated (this affects pool types **blk** and **btt**)
+since PMDK 1.13.0 release.
+
 # DESCRIPTION #
 
 The **pmempool** invoked with *info* command analyzes an existing pool

diff --git a/doc/pmempool/pmempool-rm.1.md b/doc/pmempool/pmempool-rm.1.md
@@ -9,7 +9,7 @@ header: "pmem Tools version 1.4"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2022, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (pmempool-rm.1 -- man page for pmempool-rm)
 
@@ -29,6 +29,11 @@ header: "pmem Tools version 1.4"
 $ pmempool rm [<options>] <file>..
 ```
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release.
+
 # DESCRIPTION #
 
 The **pmempool rm** command removes each specified file. If the specified file

diff --git a/doc/pmempool/pmempool-sync.1.md b/doc/pmempool/pmempool-sync.1.md
@@ -9,7 +9,7 @@ header: "pmem Tools version 1.4"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2018, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (pmempool-sync.1 -- man page for pmempool-sync)
 
@@ -32,6 +32,11 @@ pmempool sync [options] <poolset_file>
 NOTE: Only the pool set file used to create the pool should be used
 for syncing the pool.
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release.
+
 # DESCRIPTION #
 
 The **pmempool sync** command synchronizes data between replicas within

diff --git a/doc/pmempool/pmempool-transform.1.md b/doc/pmempool/pmempool-transform.1.md
@@ -9,7 +9,7 @@ header: "pmem Tools version 1.4"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2022, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (pmempool-transform.1 -- man page for pmempool-transform)
 
@@ -29,6 +29,11 @@ header: "pmem Tools version 1.4"
 pmempool transform [options] <poolset_file_src> <poolset_file_dst>
 ```
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release.
+
 # DESCRIPTION #
 
 The **pmempool transform** command modifies internal structure of a pool set

diff --git a/doc/pmempool/pmempool.1.md b/doc/pmempool/pmempool.1.md
@@ -9,7 +9,7 @@ header: "pmem Tools version 1.4"
 ---
 
 [comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
-[comment]: <> (Copyright 2016-2020, Intel Corporation)
+[comment]: <> (Copyright 2016-2023, Intel Corporation)
 
 [comment]: <> (pmempool.1 -- man page for pmempool)
 
@@ -31,6 +31,11 @@ header: "pmem Tools version 1.4"
 $ pmempool [--help] [--version] <command> [<args>]
 ```
 
+# NOTE #
+
+> NOTICE:
+The **libpmemblk** library is deprecated since PMDK 1.13.0 release.
+
 # DESCRIPTION #
 
 The **pmempool** is a management tool for *Persistent Memory* pool files

diff --git a/src/benchmarks/Makefile b/src/benchmarks/Makefile
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2014-2022, Intel Corporation
+# Copyright 2014-2023, Intel Corporation
 
 #
 # src/benchmarks/Makefile -- build all benchmarks
@@ -102,6 +102,10 @@ CXXFLAGS += -I../core
 CXXFLAGS += -I../examples/libpmemobj/map
 CXXFLAGS += $(OS_INCS)
 CXXFLAGS += -DSRCVERSION='"$(SRCVERSION)"'
+# Libpmemblk is deprecated.
+# This flag allows to build tests, examples and benchmarks
+# using pmemblk despite the deprecated state.
+CXXFLAGS += -Wno-deprecated-declarations
 
 ifeq ($(OS_DIMM),ndctl)
 CXXFLAGS += -DSDS_ENABLED

diff --git a/src/examples/libpmemblk/Makefile b/src/examples/libpmemblk/Makefile
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2014-2016, Intel Corporation
+# Copyright 2014-2023, Intel Corporation
 
 #
 # examples/libpmemblk/Makefile -- build the libpmemblk examples
@@ -11,4 +11,9 @@ LIBS = -lpmemblk -lpmem -pthread
 
 include ../Makefile.inc
 
+# Libpmemblk is deprecated.
+# This flag allows to build tests, examples and benchmarks
+# using pmemblk despite the deprecated state.
+CFLAGS += -Wno-deprecated-declarations
+
 manpage: manpage.o
diff --git a/src/examples/libpmemblk/assetdb/Makefile b/src/examples/libpmemblk/assetdb/Makefile
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2014-2016, Intel Corporation
+# Copyright 2014-2023, Intel Corporation
 
 #
 # examples/libpmemblk/assetdb/Makefile -- build the assetdb example
@@ -10,6 +10,11 @@ LIBS = -lpmemblk -lpmem -pthread
 
 include ../../Makefile.inc
 
+# Libpmemblk is deprecated.
+# This flag allows to build tests, examples and benchmarks
+# using pmemblk despite the deprecated state.
+CFLAGS += -Wno-deprecated-declarations
+
 asset_load: asset_load.o
 
 asset_list: asset_list.o