[M] Change in flashrom[master]: tests: Add unmock_io.c

[Evan Benn (Code Review)]

Attention is currently required from: Thomas Heijligen, Anastasia Klimchuk.

Evan Benn has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/69539 )

Change subject: tests: Add unmock_io.c
......................................................................

tests: Add unmock_io.c

Add functions and a struct that defer the io functions mocked by
mock_io to the real implementations. This is to support code coverage.

BUG=None
BRANCH=None
TEST=None

Change-Id: I0817fce6ea0f53a4c127794a0d8246504675f805
Signed-off-by: Evan Benn 
---
M tests/meson.build
A tests/unmock_io.c
A tests/unmock_io.h
M tests/wraps.h
4 files changed, 104 insertions(+), 0 deletions(-)

git pull ssh://review.coreboot.org:29418/flashrom refs/changes/39/69539/1

diff --git a/tests/meson.build b/tests/meson.build
index 66adb92..36b2db2 100644
--- a/tests/meson.build
+++ b/tests/meson.build
@@ -31,6 +31,7 @@
   'layout.c',
   'chip.c',
   'chip_wp.c',
+  'unmock_io.c',
 )

if not programmer.get('dummy').get('active')
diff --git a/tests/unmock_io.c b/tests/unmock_io.c
new file mode 100644
index 0000000..83892e5
--- /dev/null
+++ b/tests/unmock_io.c
@@ -0,0 +1,65 @@
+/*
+ * This file is part of the flashrom project.
+ *
+ * Copyright 2022 Google LLC
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#include "io_mock.h"
+#include "wraps.h"
+
+#include "unmock_io.h"
+#include <string.h>
+
+static int unwrap_open(void *state, const char *pathname, int flags, mode_t mode)
+{
+	LOG_ME;
+	(void)state;
+	return __real_open(pathname, flags, mode);
+}
+
+static FILE *unwrap_fdopen(void *state, int fd, const char *mode)
+{
+	LOG_ME;
+	(void)state;
+	return __real_fdopen(fd, mode);
+}
+
+static size_t unwrap_fwrite(void *state, const void *ptr, size_t size, size_t nmemb, FILE *fp)
+{
+	LOG_ME;
+	(void)state;
+	return __real_fwrite(ptr, size, nmemb, fp);
+}
+
+// Mock ios that defer to the real io functions.
+// These exist so that code coverage can print to real files on disk.
+static const struct io_mock real_io = {
+	.iom_open = unwrap_open,
+	.iom_fwrite = unwrap_fwrite,
+	.iom_fdopen = unwrap_fdopen,
+};
+
+// Return 0 if string ends with suffix.
+static int check_suffix(const char *string, const char *suffix)
+{
+	int len_l = strlen(string);
+	int len_r = strlen(suffix);
+	if (len_l > len_r)
+		return strcmp(string + len_l - len_r, suffix);
+	return 1;
+}
+
+void maybe_unmock_io(const char* pathname) {
+
+    if (!check_suffix(pathname, ".gcda"))
+		io_mock_register(&real_io);
+}
diff --git a/tests/unmock_io.h b/tests/unmock_io.h
new file mode 100644
index 0000000..5d964c7
--- /dev/null
+++ b/tests/unmock_io.h
@@ -0,0 +1,18 @@
+/*
+ * This file is part of the flashrom project.
+ *
+ * Copyright 2022 Google LLC
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+// Detect file io that should not be mocked, for example code coverage writing
+// gcda files. Call io_mock_register with functions that defer to real io.
+void maybe_unmock_io(const char* pathname);
diff --git a/tests/wraps.h b/tests/wraps.h
index e224d79..92b0c42 100644
--- a/tests/wraps.h
+++ b/tests/wraps.h
@@ -29,6 +29,7 @@
 void __wrap_sio_write(uint16_t port, uint8_t reg, uint8_t data);
 uint8_t __wrap_sio_read(uint16_t port, uint8_t reg);
 int __wrap_open(const char *pathname, int flags, ...);
+int __real_open(const char *pathname, int flags, ...);
 int __wrap_open64(const char *pathname, int flags, ...);
 int __wrap___open64_2(const char *pathname, int flags, ...);
 int __wrap_ioctl(int fd, unsigned long int request, ...);
@@ -37,6 +38,7 @@
 FILE *__wrap_fopen(const char *pathname, const char *mode);
 FILE *__wrap_fopen64(const char *pathname, const char *mode);
 FILE *__wrap_fdopen(int fd, const char *mode);
+FILE *__real_fdopen(int fd, const char *mode);
 int __wrap_stat(const char *path, void *buf);
 int __wrap_stat64(const char *path, void *buf);
 int __wrap___xstat(const char *path, void *buf);
@@ -49,6 +51,7 @@
 char *__wrap___fgets_chk(char *buf, int len, FILE *fp);
 size_t __wrap_fread(void *ptr, size_t size, size_t nmemb, FILE *fp);
 size_t __wrap_fwrite(const void *ptr, size_t size, size_t nmemb, FILE *fp);
+size_t __real_fwrite(const void *ptr, size_t size, size_t nmemb, FILE *fp);
 int __wrap_fflush(FILE *fp);
 int __wrap_fileno(FILE *fp);
 int __wrap_fsync(int fd);