Merge pull request #5411 from lplewa/master

miniasync update

src/deps/miniasync/CMakeLists.txt

@@ -99,8 +99,7 @@ if(WIN32)
 # It looks like the issue is still unfixed:
 # https://developercommunity.visualstudio.com/t/several-warnings-in-windows-sdk-100177630-in-windo/435362
 	add_flag(-DWIN32_LEAN_AND_MEAN)
-# Enable when all Warnings are fixed.
-	#add_flag(-WX)
+	add_compile_options(/W3 /WX)
 endif()
 
 if(USE_ASAN)

src/deps/miniasync/doc/CMakeLists.txt

@@ -42,53 +42,30 @@ find_program(PANDOC NAMES pandoc)
 if(PANDOC)
 	message(STATUS "Found pandoc: ${PANDOC}")
 
-	## Manpages without any examples
-	# miniasync.7
-	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/miniasync.7.md.in
-		${MAN_DIR}/tmp/miniasync.7.md)
-	configure_man(miniasync.7 ${MAN_DIR}/tmp/miniasync.7.md)
+	file(STRINGS ${CMAKE_CURRENT_SOURCE_DIR}/manuals.txt man_list)
 
-	# miniasync_future.3
-	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/miniasync_future.3.md.in
-		${MAN_DIR}/tmp/miniasync_future.3.md)
-	configure_man(miniasync_future.3 ${MAN_DIR}/tmp/miniasync_future.3.md)
-	add_manpage_links(miniasync_future.3
-		future_context_get_data future_context_get_output future_context_get_size
-		FUTURE FUTURE_INIT FUTURE_AS_RUNNABLE FUTURE_OUTPUT FUTURE_CHAIN_ENTRY
-		FUTURE_CHAIN_ENTRY_INIT FUTURE_BUSY_POLL FUTURE_CHAIN_INIT)
+	foreach(man ${man_list})
+		configure_man(${man} ${CMAKE_CURRENT_SOURCE_DIR}/${man}.md)
+	endforeach(man man_list)
+
+	add_manpage_links(data_mover_dml_new.3
+		data_mover_dml_delete)
 
-	# miniasync_runtime.3
-	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/miniasync_runtime.3.md.in
-		${MAN_DIR}/tmp/miniasync_runtime.3.md)
-	configure_man(miniasync_runtime.3 ${MAN_DIR}/tmp/miniasync_runtime.3.md)
-	add_manpage_links(miniasync_runtime.3
-		runtime_new runtime_delete runtime_wait_multiple runtime_wait)
+	add_manpage_links(data_mover_sync_new.3
+		data_mover_sync_delete)
 
-	# miniasync_vdm.3
-	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/miniasync_vdm.3.md.in
-		${MAN_DIR}/tmp/miniasync_vdm.3.md)
-	configure_man(miniasync_vdm.3 ${MAN_DIR}/tmp/miniasync_vdm.3.md)
-	add_manpage_links(miniasync_vdm.3 vdm_memcpy vdm_new vdm_delete)
+	add_manpage_links(data_mover_threads_new.3
+		data_mover_threads_delete)
 
-	# miniasync_vdm_synchronous.3
-	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/miniasync_vdm_synchronous.3.md.in
-			${MAN_DIR}/tmp/miniasync_vdm_synchronous.3.md)
-	configure_man(miniasync_vdm_synchronous.3 ${MAN_DIR}/tmp/miniasync_vdm_synchronous.3.md)
-	add_manpage_links(miniasync_vdm_synchronous.3 vdm_descriptor_synchronous)
+	add_manpage_links(miniasync_future.7
+		FUTURE FUTURE_INIT FUTURE_AS_RUNNABLE FUTURE_OUTPUT FUTURE_CHAIN_ENTRY
+		FUTURE_CHAIN_ENTRY_INIT FUTURE_BUSY_POLL FUTURE_CHAIN_INIT)
 
-	# miniasync_vdm_threads.3
-	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/miniasync_vdm_threads.3.md.in
-			${MAN_DIR}/tmp/miniasync_vdm_threads.3.md)
-	configure_man(miniasync_vdm_threads.3 ${MAN_DIR}/tmp/miniasync_vdm_threads.3.md)
-	add_manpage_links(miniasync_vdm_threads.3
-		vdm_descriptor_threads vdm_descriptor_threads_polled)
+	add_manpage_links(runtime_new.3
+		runtime_delete)
 
-	# miniasync_vdm_dml.3
-	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/miniasync_vdm_dml.3.md.in
-	${MAN_DIR}/tmp/miniasync_vdm_dml.3.md)
-	configure_man(miniasync_vdm_dml.3 ${MAN_DIR}/tmp/miniasync_vdm_dml.3.md)
-	add_manpage_links(miniasync_vdm_dml.3
-		vdm_descriptor_dml vdm_descriptor_dml_async)
+	add_manpage_links(runtime_wait.3
+		runtime_wait_multiple)
 
 	# install manpages
 	install(FILES ${MAN_DIR}/miniasync.7

src/deps/miniasync/doc/data_mover_dml_get_vdm.3.md

@@ -0,0 +1,56 @@
+---
+layout: manual
+Content-Style: 'text/css'
+title: _MP(DATA_MOVER_DML_GET_VDM, 3)
+collection: miniasync
+header: DATA_MOVER_DML_GET_VDM
+secondary_title: miniasync
+...
+
+[comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
+[comment]: <> (Copyright 2022, Intel Corporation)
+
+[comment]: <> (data_mover_dml_get_vdm.3 -- man page for miniasync data_mover_dml_get_vdm operation)
+
+[NAME](#name)<br />
+[SYNOPSIS](#synopsis)<br />
+[DESCRIPTION](#description)<br />
+[RETURN VALUE](#return-value)<br />
+[SEE ALSO](#see-also)<br />
+
+# NAME #
+
+**data_mover_dml_get_vdm**() - get virtual data mover structure from the **DML**
+data mover structure
+
+# SYNOPSIS #
+
+```c
+#include <libminiasync.h>
+
+struct vdm;
+struct data_mover_dml;
+
+struct vdm *data_mover_dml_get_vdm(struct data_mover_dml *dmd);
+```
+
+For general description of **DML** data mover API, see **miniasync_vdm_dml**(7).
+
+# DESCRIPTION #
+
+The **data_mover_dml_get_vdm**() function reads the virtual data mover structure
+from the **DML** data mover structure pointed by *dmd*. Virtual data mover
+structure *struct vdm* is needed by every **miniasync**(7) data mover operation.
+
+**DML** data mover implementation supports following operations:
+
+* **vdm_memcpy**(3) - memory copy operation
+
+# RETURN VALUE #
+
+The **data_mover_dml_get_vdm**() function returns a pointer to *struct vdm* structure.
+
+# SEE ALSO #
+
+**vdm_memcpy**(3), **miniasync**(7),
+**miniasync_vdm_dml**(7) and **<https://pmem.io>**

src/deps/miniasync/doc/data_mover_dml_new.3.md

@@ -0,0 +1,56 @@
+---
+layout: manual
+Content-Style: 'text/css'
+title: _MP(DATA_MOVER_DML_NEW, 3)
+collection: miniasync
+header: DATA_MOVER_DML_NEW
+secondary_title: miniasync
+...
+
+[comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
+[comment]: <> (Copyright 2022, Intel Corporation)
+
+[comment]: <> (data_mover_dml_new.3 -- man page for miniasync data_mover_dml_new operation)
+
+[NAME](#name)<br />
+[SYNOPSIS](#synopsis)<br />
+[DESCRIPTION](#description)<br />
+[RETURN VALUE](#return-value)<br />
+[SEE ALSO](#see-also)<br />
+
+# NAME #
+
+**data_mover_dml_new**(), **data_mover_dml_delete**() - allocate or free **DML**
+data mover structure
+
+# SYNOPSIS #
+
+```c
+#include <libminiasync.h>
+
+struct data_mover_dml;
+
+struct data_mover_dml *data_mover_dml_new(void);
+void data_mover_dml_delete(struct data_mover_dml *dmd);
+```
+
+For general description of **DML** data mover API, see **miniasync_vdm_dml**(7).
+
+# DESCRIPTION #
+
+The **data_mover_dml_new**() function allocates and initializes a new **DML** data mover structure.
+
+The **data_mover_dml_delete**() function frees and finalizes the **DML** data mover structure
+pointed by *dmd*.
+
+# RETURN VALUE #
+
+The **data_mover_dml_new**() function returns a pointer to *struct data_mover_dml* structure or
+**NULL** if the allocation or initialization failed.
+
+The **data_mover_dml_delete**() function does not return any value.
+
+# SEE ALSO #
+
+**miniasync**(7), **miniasync_vdm_dml**(7),
+**<https://github.com/intel/DML>** and **<https://pmem.io>**

src/deps/miniasync/doc/data_mover_sync_get_vdm.3.md

@@ -0,0 +1,56 @@
+---
+layout: manual
+Content-Style: 'text/css'
+title: _MP(DATA_MOVER_SYNC_GET_VDM, 3)
+collection: miniasync
+header: DATA_MOVER_SYNC_GET_VDM
+secondary_title: miniasync
+...
+
+[comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
+[comment]: <> (Copyright 2022, Intel Corporation)
+
+[comment]: <> (data_mover_sync_get_vdm.3 -- man page for miniasync data_mover_sync_get_vdm operation)
+
+[NAME](#name)<br />
+[SYNOPSIS](#synopsis)<br />
+[DESCRIPTION](#description)<br />
+[RETURN VALUE](#return-value)<br />
+[SEE ALSO](#see-also)<br />
+
+# NAME #
+
+**data_mover_sync_get_vdm**() - get virtual data mover structure from the synchronous
+data mover structure
+
+# SYNOPSIS #
+
+```c
+#include <libminiasync.h>
+
+struct vdm;
+struct data_mover_sync;
+
+struct vdm *data_mover_sync_get_vdm(struct data_mover_sync *dms);
+```
+
+For general description of synchronous data mover API, see **miniasync_vdm_synchronous**(7).
+
+# DESCRIPTION #
+
+The **data_mover_sync_get_vdm**() function reads the virtual data mover structure
+from the synchronous data mover structure pointed by *dms*. Virtual data mover
+structure *struct vdm* is needed by every **miniasync**(7) data mover operation.
+
+Synchronous data mover implementation supports following operations:
+
+* **vdm_memcpy**(3) - memory copy operation
+
+# RETURN VALUE #
+
+The **data_mover_sync_get_vdm**() function returns a pointer to *struct vdm* structure.
+
+# SEE ALSO #
+
+**vdm_memcpy**(3), **miniasync**(7),
+**miniasync_vdm_synchronous**(7) and **<https://pmem.io>**

src/deps/miniasync/doc/data_mover_sync_new.3.md

@@ -0,0 +1,56 @@
+---
+layout: manual
+Content-Style: 'text/css'
+title: _MP(DATA_MOVER_SYNC_NEW, 3)
+collection: miniasync
+header: DATA_MOVER_SYNC_NEW
+secondary_title: miniasync
+...
+
+[comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
+[comment]: <> (Copyright 2022, Intel Corporation)
+
+[comment]: <> (data_mover_sync_new.3 -- man page for miniasync data_mover_sync_new operation)
+
+[NAME](#name)<br />
+[SYNOPSIS](#synopsis)<br />
+[DESCRIPTION](#description)<br />
+[RETURN VALUE](#return-value)<br />
+[SEE ALSO](#see-also)<br />
+
+# NAME #
+
+**data_mover_sync_new**(), **data_mover_sync_delete**() - allocate or free synchronous
+data mover structure
+
+# SYNOPSIS #
+
+```c
+#include <libminiasync.h>
+
+struct data_mover_sync;
+
+struct data_mover_sync *data_mover_sync_new(void);
+void data_mover_sync_delete(struct data_mover_sync *dms);
+```
+
+For general description of synchronous data mover API, see **miniasync_vdm_synchronous**(7).
+
+# DESCRIPTION #
+
+The **data_mover_sync_new**() function allocates and initializes a new synchronous data mover structure.
+
+The **data_mover_sync_delete**() function frees and finalizes the synchronous data mover structure
+pointed by *dms*.
+
+# RETURN VALUE #
+
+The **data_mover_sync_new**() function returns a pointer to *struct data_mover_sync* structure or
+**NULL** if the allocation or initialization failed.
+
+The **data_mover_sync_delete**() function does not return any value.
+
+# SEE ALSO #
+
+**miniasync**(7), **miniasync_vdm_synchronous**(7)
+and **<https://pmem.io>**

src/deps/miniasync/doc/data_mover_threads_get_vdm.3.md

@@ -0,0 +1,56 @@
+---
+layout: manual
+Content-Style: 'text/css'
+title: _MP(DATA_MOVER_THREADS_GET_VDM, 3)
+collection: miniasync
+header: DATA_MOVER_THREADS_GET_VDM
+secondary_title: miniasync
+...
+
+[comment]: <> (SPDX-License-Identifier: BSD-3-Clause)
+[comment]: <> (Copyright 2022, Intel Corporation)
+
+[comment]: <> (data_mover_threads_get_vdm.3 -- man page for miniasync data_mover_threads_get_vdm operation)
+
+[NAME](#name)<br />
+[SYNOPSIS](#synopsis)<br />
+[DESCRIPTION](#description)<br />
+[RETURN VALUE](#return-value)<br />
+[SEE ALSO](#see-also)<br />
+
+# NAME #
+
+**data_mover_threads_get_vdm**() - get virtual data mover structure from the thread
+data mover structure
+
+# SYNOPSIS #
+
+```c
+#include <libminiasync.h>
+
+struct vdm;
+struct data_mover_threads;
+
+struct vdm *data_mover_threads_get_vdm(struct data_mover_threads *dmt);
+```
+
+For general description of thread data mover API, see **miniasync_vdm_threads**(7).
+
+# DESCRIPTION #
+
+The **data_mover_threads_get_vdm**() function reads the virtual data mover structure
+from the thread data mover structure pointed by *dms*. Virtual data mover structure
+*struct vdm* is needed by every **miniasync**(7) data mover operation.
+
+Thread data mover implementation supports following operations:
+
+* **vdm_memcpy**(3) - memory copy operation
+
+# RETURN VALUE #
+
+The **data_mover_threads_get_vdm**() function returns a pointer to *struct vdm* structure.
+
+# SEE ALSO #
+
+**vdm_memcpy**(3), **miniasync**(7),
+**miniasync_vdm_threads**(7) and **<https://pmem.io>**