examples: explain <pmem-path> in PMEM_USAGE

examples/03-read-to-persistent/README.md

@@ -29,3 +29,7 @@ an out-of-band or the in-band channel.
 ```bash
 [user@client]$ ./client $server_address $port [<pmem-path>]
 ```
+
+where `<pmem-path>` can be:
+  - a Device DAX (`/dev/dax0.0` for example) or
+  - a file on File System DAX (`/mnt/pmem/file` for example).

examples/03-read-to-persistent/client.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020-2021, Intel Corporation */
+/* Copyright 2020-2022, Intel Corporation */
 
 /*
  * client.c -- a client of the read-to-persistent example
@@ -10,17 +10,16 @@
 #include <librpma.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include "common-conn.h"
+#include "hello.h"
 
 #ifdef USE_LIBPMEM
 #include <libpmem.h>
-#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"
+#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"PMEM_USAGE
 #else
 #define USAGE_STR "usage: %s <server_address> <port>\n"
 #endif /* USE_LIBPMEM */
 
-#include "common-conn.h"
-#include "hello.h"
-
 static inline void
 write_hello_str(struct hello_t *hello, enum lang_t lang)
 {

examples/03-read-to-persistent/server.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020, Intel Corporation */
+/* Copyright 2020-2022, Intel Corporation */
 /* Copyright 2021, Fujitsu */
 
 /*
@@ -12,16 +12,15 @@
 #include <librpma.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include "common-conn.h"
 
 #ifdef USE_LIBPMEM
 #include <libpmem.h>
-#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"
+#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"PMEM_USAGE
 #else
 #define USAGE_STR "usage: %s <server_address> <port>\n"
 #endif /* USE_LIBPMEM */
 
-#include "common-conn.h"
-
 int
 main(int argc, char *argv[])
 {

examples/04-write-to-persistent/README.md

@@ -28,3 +28,7 @@ an out-of-band or the in-band channel.
 ```bash
 [user@client]$ ./client $server_address $port [<pmem-path>]
 ```
+
+where `<pmem-path>` can be:
+  - a Device DAX (`/dev/dax0.0` for example) or
+  - a file on File System DAX (`/mnt/pmem/file` for example).

examples/04-write-to-persistent/client.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020-2021, Intel Corporation */
+/* Copyright 2020-2022, Intel Corporation */
 /* Copyright 2021, Fujitsu */
 
 /*
@@ -11,17 +11,16 @@
 #include <librpma.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include "common-conn.h"
+#include "hello.h"
 
 #ifdef USE_LIBPMEM
 #include <libpmem.h>
-#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"
+#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"PMEM_USAGE
 #else
 #define USAGE_STR "usage: %s <server_address> <port>\n"
 #endif /* USE_LIBPMEM */
 
-#include "common-conn.h"
-#include "hello.h"
-
 static inline void
 write_hello_str(struct hello_t *hello, enum lang_t lang)
 {

examples/04-write-to-persistent/server.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020-2021, Intel Corporation */
+/* Copyright 2020-2022, Intel Corporation */
 
 /*
  * server.c -- a server of the write-to-persistent example
@@ -11,16 +11,15 @@
 #include <librpma.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include "common-conn.h"
 
 #ifdef USE_LIBPMEM
 #include <libpmem.h>
-#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"
+#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"PMEM_USAGE
 #else
 #define USAGE_STR "usage: %s <server_address> <port>\n"
 #endif /* USE_LIBPMEM */
 
-#include "common-conn.h"
-
 #ifdef TEST_USE_CMOCKA
 #include "cmocka_headers.h"
 #include "cmocka_alloc.h"

examples/05-flush-to-persistent/README.md

@@ -34,3 +34,7 @@ channel.
 ```bash
 [user@client]$ ./client $server_address $port [<pmem-path>]
 ```
+
+where `<pmem-path>` can be:
+  - a Device DAX (`/dev/dax0.0` for example) or
+  - a file on File System DAX (`/mnt/pmem/file` for example).

examples/05-flush-to-persistent/client.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020, Intel Corporation */
+/* Copyright 2020-2022, Intel Corporation */
 /* Copyright 2021, Fujitsu */
 
 /*
@@ -12,17 +12,16 @@
 #include <inttypes.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include "common-conn.h"
+#include "hello.h"
 
 #ifdef USE_LIBPMEM
 #include <libpmem.h>
-#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"
+#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"PMEM_USAGE
 #else
 #define USAGE_STR "usage: %s <server_address> <port>\n"
 #endif /* USE_LIBPMEM */
 
-#include "common-conn.h"
-#include "hello.h"
-
 #define FLUSH_ID	(void *)0xF01D /* a random identifier */
 
 static inline void

examples/05-flush-to-persistent/server.c

@@ -11,11 +11,13 @@
 #include <librpma.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include "common-conn.h"
 
 #ifdef USE_LIBPMEM
 #include <libpmem.h>
-#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>] " \
-	"[direct-pmem-write]\n"
+#define USAGE_STR \
+	"usage: %s <server_address> <port> [<pmem-path>] [direct-pmem-write]\n"\
+	PMEM_USAGE
 #else
 #define USAGE_STR "usage: %s <server_address> <port>\n"
 #endif /* USE_LIBPMEM */
@@ -24,8 +26,6 @@
 #define ON_STR "on"
 #endif /* USE_LIBPMEM */
 
-#include "common-conn.h"
-
 int
 main(int argc, char *argv[])
 {

examples/07-atomic-write/README.md

@@ -45,3 +45,7 @@ an out-of-band or the in-band channel.
 ```bash
 [user@client]$ ./client $server_address $port $word1 [<word2>] [<...>]
 ```
+
+where `<pmem-path>` can be:
+  - a Device DAX (`/dev/dax0.0` for example) or
+  - a file on File System DAX (`/mnt/pmem/file` for example).

examples/07-atomic-write/server.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020-2021, Intel Corporation */
+/* Copyright 2020-2022, Intel Corporation */
 
 /*
  * server.c -- a server of the atomic-write example
@@ -12,19 +12,16 @@
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
+#include "common-conn.h"
 
 #ifdef USE_LIBPMEM
 #include <libpmem.h>
-#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"
+#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"PMEM_USAGE
+#define LOG_HDR_SIGNATURE "LOG"
 #else
 #define USAGE_STR "usage: %s <server_address> <port>\n"
 #endif /* USE_LIBPMEM */
 
-#include "common-conn.h"
-
-#ifdef USE_LIBPMEM
-#define LOG_HDR_SIGNATURE "LOG"
-#endif
 #define LOG_SIGNATURE_SIZE 8
 #define LOG_DATA_SIZE 1024
 

examples/09-flush-to-persistent-GPSPM/README.md

@@ -41,3 +41,7 @@ via an out-of-band or the in-band channel.
 ```bash
 [user@client]$ ./client $server_address $port [<pmem-path>]
 ```
+
+where `<pmem-path>` can be:
+  - a Device DAX (`/dev/dax0.0` for example) or
+  - a file on File System DAX (`/mnt/pmem/file` for example).

examples/09-flush-to-persistent-GPSPM/client.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020, Intel Corporation */
+/* Copyright 2020-2022, Intel Corporation */
 /* Copyright 2021, Fujitsu */
 
 /*
@@ -12,21 +12,20 @@
 #include <inttypes.h>
 #include <stdlib.h>
 #include <stdio.h>
-
-#ifdef USE_LIBPMEM
-#include <libpmem.h>
-#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"
-#else
-#define USAGE_STR "usage: %s <server_address> <port>\n"
-#endif /* USE_LIBPMEM */
-
 #include "common-conn.h"
 #include "flush-to-persistent-GPSPM.h"
 
 /* Generated by the protocol buffer compiler from: GPSPM_flush.proto */
 #include "GPSPM_flush.pb-c.h"
 #include "hello.h"
 
+#ifdef USE_LIBPMEM
+#include <libpmem.h>
+#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"PMEM_USAGE
+#else
+#define USAGE_STR "usage: %s <server_address> <port>\n"
+#endif /* USE_LIBPMEM */
+
 #define FLUSH_ID	(void *)0xF01D /* a random identifier */
 
 static inline void

examples/09-flush-to-persistent-GPSPM/server.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2020-2021, Intel Corporation */
+/* Copyright 2020-2022, Intel Corporation */
 /* Copyright 2021, Fujitsu */
 
 /*
@@ -12,20 +12,19 @@
 #include <librpma.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include "common-conn.h"
+#include "flush-to-persistent-GPSPM.h"
+
+/* Generated by the protocol buffer compiler from: GPSPM_flush.proto */
+#include "GPSPM_flush.pb-c.h"
 
 #ifdef USE_LIBPMEM
 #include <libpmem.h>
-#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"
+#define USAGE_STR "usage: %s <server_address> <port> [<pmem-path>]\n"PMEM_USAGE
 #else
 #define USAGE_STR "usage: %s <server_address> <port>\n"
 #endif /* USE_LIBPMEM */
 
-#include "common-conn.h"
-#include "flush-to-persistent-GPSPM.h"
-
-/* Generated by the protocol buffer compiler from: GPSPM_flush.proto */
-#include "GPSPM_flush.pb-c.h"
-
 int
 main(int argc, char *argv[])
 {

examples/common/common-conn.h

@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: BSD-3-Clause */
-/* Copyright 2020-2021, Intel Corporation */
+/* Copyright 2020-2022, Intel Corporation */
 
 /*
  * common-conn.h -- a common connection functions declarations for examples
@@ -13,12 +13,17 @@
 
 #ifdef USE_LIBPMEM
 
+#define PMEM_USAGE \
+"where <pmem-path> can be:\n\
+  - a Device DAX (/dev/dax0.0 for example) or\n\
+  - a file on File System DAX (/mnt/pmem/file for example)\n"
 /* signature marking the persistent contents as valid */
 #define SIGNATURE_STR "RPMA_EXAMPLE_SIG"
 #define SIGNATURE_LEN (strlen(SIGNATURE_STR) + 1)
 
 #define NO_PMEM_MSG "No <pmem-path> provided. Using DRAM instead.\n"
 #else
+#define PMEM_USAGE ""
 #define NO_PMEM_MSG \
 	"The example is unable to use libpmem. If unintended please check the build log. Using DRAM instead.\n"
 #endif