diff mbox series

[1/2] tst_safe_macros: Move implementations into C file, rename

Message ID 20240318162539.407214-1-pvorel@suse.cz
State Accepted
Headers show
Series [1/2] tst_safe_macros: Move implementations into C file, rename | expand

Commit Message

Petr Vorel March 18, 2024, 4:25 p.m. UTC 
9120d8a22 ("safe_macros: turn functions with off_t parameter into static inline")
noted:

    Some functions used to implement safe macros have parameters
    of type off_t or structures containing off_t fields.

But that's not the case of safe_mprotect() and helper safe_prot_to_str().
Therefore move their implementations into C file (following the approach
we don't want static inline implementations in the API headers).

Also rename safe_prot_to_str() to tst_prot_to_str() (safe_ functions
take const char *file, const int lineno and call tst_brk_() on error).

Fixes: b366afb64 ("Add SAFE_MPROTECT() macro")
Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 include/tst_safe_macros.h | 74 +++++++--------------------------------
 lib/tst_safe_macros.c     | 55 +++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+), 61 deletions(-)

Comments

Cyril Hrubis March 26, 2024, 1:24 p.m. UTC | #1 
Hi!
Reviewed-by: Cyril Hrubis <chrubis@suse.cz>
diff mbox series

Patch

diff --git a/include/tst_safe_macros.h b/include/tst_safe_macros.h
index 7178a842d..1c2decadd 100644
--- a/include/tst_safe_macros.h
+++ b/include/tst_safe_macros.h
@@ -1,5 +1,5 @@ 
 /* SPDX-License-Identifier: GPL-2.0-or-later
- * Copyright (c) 2010-2018 Linux Test Project
+ * Copyright (c) 2010-2024 Linux Test Project
  * Copyright (c) 2011-2015 Cyril Hrubis <chrubis@suse.cz>
  */
 
@@ -264,49 +264,15 @@  int safe_getgroups(const char *file, const int lineno, int size, gid_t list[]);
 	            "fcntl(%i,%s,...) failed", fd, #cmd), 0 \
 	 : tst_ret_;})
 
-/*
- * following functions are inline because the behaviour may depend on
- * -D_FILE_OFFSET_BITS=64 compile flag
- */
-
-#define PROT_FLAG_STR(f) #f " | "
-
-static void safe_prot_to_str(const int prot, char *buf)
-{
-	char *ptr = buf;
-
-	if (prot == PROT_NONE) {
-		strcpy(buf, "PROT_NONE");
-		return;
-	}
-
-	if (prot & PROT_READ) {
-		strcpy(ptr, PROT_FLAG_STR(PROT_READ));
-		ptr += sizeof(PROT_FLAG_STR(PROT_READ)) - 1;
-	}
-
-	if (prot & PROT_WRITE) {
-		strcpy(ptr, PROT_FLAG_STR(PROT_WRITE));
-		ptr += sizeof(PROT_FLAG_STR(PROT_WRITE)) - 1;
-	}
-
-	if (prot & PROT_EXEC) {
-		strcpy(ptr, PROT_FLAG_STR(PROT_EXEC));
-		ptr += sizeof(PROT_FLAG_STR(PROT_EXEC)) - 1;
-	}
-
-	if (buf != ptr)
-		ptr[-3] = 0;
-}
+void tst_prot_to_str(const int prot, char *buf);
 
 static inline void *safe_mmap(const char *file, const int lineno,
-                              void *addr, size_t length,
-                              int prot, int flags, int fd, off_t offset)
+	void *addr, size_t length, int prot, int flags, int fd, off_t offset)
 {
 	void *rval;
 	char prot_buf[512];
 
-	safe_prot_to_str(prot, prot_buf);
+	tst_prot_to_str(prot, prot_buf);
 
 	tst_res_(file, lineno, TDEBUG,
 		"mmap(%p, %ld, %s(%x), %d, %d, %ld)",
@@ -321,37 +287,23 @@  static inline void *safe_mmap(const char *file, const int lineno,
 
 	return rval;
 }
+
+
 #define SAFE_MMAP(addr, length, prot, flags, fd, offset) \
 	safe_mmap(__FILE__, __LINE__, (addr), (length), (prot), \
 	(flags), (fd), (offset))
 
-static inline int safe_mprotect(const char *file, const int lineno,
-	char *addr, size_t len, int prot)
-{
-	int rval;
-	char prot_buf[512];
-
-	safe_prot_to_str(prot, prot_buf);
-
-	tst_res_(file, lineno, TDEBUG,
-		"mprotect(%p, %ld, %s(%x))", addr, len, prot_buf, prot);
+int safe_mprotect(const char *file, const int lineno,
+	char *addr, size_t len, int prot);
 
-	rval = mprotect(addr, len, prot);
-
-	if (rval == -1) {
-		tst_brk_(file, lineno, TBROK | TERRNO,
-			"mprotect(%p, %ld, %s(%x))", addr, len, prot_buf, prot);
-	} else if (rval) {
-		tst_brk_(file, lineno, TBROK | TERRNO,
-			"mprotect(%p, %ld, %s(%x)) return value %d",
-			addr, len, prot_buf, prot, rval);
-	}
-
-	return rval;
-}
 #define SAFE_MPROTECT(addr, len, prot) \
 	safe_mprotect(__FILE__, __LINE__, (addr), (len), (prot))
 
+/*
+ * Following functions are inline because the behaviour may depend on
+ * -D_FILE_OFFSET_BITS=64 compile flag.
+ */
+
 static inline int safe_ftruncate(const char *file, const int lineno,
                                  int fd, off_t length)
 {
diff --git a/lib/tst_safe_macros.c b/lib/tst_safe_macros.c
index 498e45a74..907675afe 100644
--- a/lib/tst_safe_macros.c
+++ b/lib/tst_safe_macros.c
@@ -1,6 +1,7 @@ 
 // SPDX-License-Identifier: GPL-2.0-or-later
 /*
  * Copyright (c) 2017 Cyril Hrubis <chrubis@suse.cz>
+ * Copyright (c) 2017-2024 Linux Test Project
  */
 
 #define _GNU_SOURCE
@@ -622,3 +623,57 @@  void safe_print_file(const char *file, const int lineno, char *path)
 
 	safe_fclose(file, lineno, NULL, pfile);
 }
+
+#define PROT_FLAG_STR(f) #f " | "
+void tst_prot_to_str(const int prot, char *buf)
+{
+	char *ptr = buf;
+
+	if (prot == PROT_NONE) {
+		strcpy(buf, "PROT_NONE");
+		return;
+	}
+
+	if (prot & PROT_READ) {
+		strcpy(ptr, PROT_FLAG_STR(PROT_READ));
+		ptr += sizeof(PROT_FLAG_STR(PROT_READ)) - 1;
+	}
+
+	if (prot & PROT_WRITE) {
+		strcpy(ptr, PROT_FLAG_STR(PROT_WRITE));
+		ptr += sizeof(PROT_FLAG_STR(PROT_WRITE)) - 1;
+	}
+
+	if (prot & PROT_EXEC) {
+		strcpy(ptr, PROT_FLAG_STR(PROT_EXEC));
+		ptr += sizeof(PROT_FLAG_STR(PROT_EXEC)) - 1;
+	}
+
+	if (buf != ptr)
+		ptr[-3] = 0;
+}
+
+int safe_mprotect(const char *file, const int lineno,
+	char *addr, size_t len, int prot)
+{
+	int rval;
+	char prot_buf[512];
+
+	tst_prot_to_str(prot, prot_buf);
+
+	tst_res_(file, lineno, TDEBUG,
+		"mprotect(%p, %ld, %s(%x))", addr, len, prot_buf, prot);
+
+	rval = mprotect(addr, len, prot);
+
+	if (rval == -1) {
+		tst_brk_(file, lineno, TBROK | TERRNO,
+			"mprotect(%p, %ld, %s(%x))", addr, len, prot_buf, prot);
+	} else if (rval) {
+		tst_brk_(file, lineno, TBROK | TERRNO,
+			"mprotect(%p, %ld, %s(%x)) return value %d",
+			addr, len, prot_buf, prot, rval);
+	}
+
+	return rval;
+}