Skip to contentSkip to conversation

Avoid filename truncation in numastat

PATCH In review Ross Zwisler 1 participant 4 messages Mar 22, 2018 – Apr 5, 2018

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/3 Avoid filename truncation in numastat

gcc 7.3.1 provides the following warning when compiling numastat.c:

numastat.c: In function ‘add_pids_from_pattern_search’:
numastat.c:1316:41: warning: ‘%s’ directive output may be truncated writing up to 255 bytes into a region of size 58 [-Wformat-truncation=]

   snprintf(fname, sizeof(fname), "/proc/%s/cmdline", namelist[ix]->d_name);
                                         ^~

numastat.c:1316:3: note: ‘snprintf’ output between 15 and 270 bytes into a destination of size 64
snprintf(fname, sizeof(fname), "/proc/%s/cmdline", namelist[ix]->d_name); ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This is valid - namelist[ix]->d_name is size 256 bytes, we have some extra bytes as part of our format string. Our destination buffer, 'fname', is only 64 bytes wide.

---
 numastat.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
numastat.c +1 -1
index e0a5639..2d413df 100644
@@ -1312,7 +1312,7 @@ void add_pids_from_pattern_search(char *pattern) {
 		}
 		// Next copy cmdline file contents onto end of buffer.  Do it a
 		// character at a time to convert nulls to spaces.
-		char fname[64];
+		char fname[272];
 		snprintf(fname, sizeof(fname), "/proc/%s/cmdline", namelist[ix]->d_name);
 		FILE *fs = fopen(fname, "r");
 		if (fs) {
Signature · 6 lines
2.14.3

_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm
#1 lore raw

PATCH 2/3 readdir_r(3) is deprecated, use readdir(3) instead

gcc 7.3.1 provides the following warning when compiling affinity.c:

affinity.c: In function ‘affinity_file’:
affinity.c:158:2: warning: ‘readdir_r’ is deprecated [-Wdeprecated-declarations]
while (readdir_r(dir, &de, &dep) == 0 && dep) {
^~~~~
In file included from affinity.c:39:0:
/usr/include/dirent.h:183:12: note: declared here
extern int readdir_r (DIR *__restrict __dirp,

            ^~~~~~~~~

According to the man page for readdir_r(3), calls this function should be fixed to instead use readdir(3).

One interesting note: I had to move the affinity_class() call above the closedir(dir) call in affinity_file() because with readdir(3) the string stored in 'name' is cleared on closedir(). This doesn't happen with readdir_r() for some reason.

---
 affinity.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
affinity.c +6 -3
index 85597fc..06784f7 100644
@@ -131,7 +131,7 @@ static int affinity_file(struct bitmask *mask, char *cls, const char *file)
 	int n;
 	unsigned maj = 0, min = 0;
 	dev_t d;
-	struct dirent de, *dep;
+	struct dirent *dep;
 
 	cls = "block";
 	char fn[sizeof("/sys/class/") + strlen(cls)];
@@ -155,8 +155,10 @@ static int affinity_file(struct bitmask *mask, char *cls, const char *file)
 			  cls);
 		return -1;
 	}
-	while (readdir_r(dir, &de, &dep) == 0 && dep) {
+	while ((dep = readdir(dir)) != NULL) {
 		char *name = dep->d_name;
+		int ret;
+
 		if (*name == '.')
 			continue;
 		char *dev;
@@ -179,8 +181,9 @@ static int affinity_file(struct bitmask *mask, char *cls, const char *file)
 		if (major(d) != maj || minor(d) != min)
 			continue;
 
+		ret = affinity_class(mask, "block", name);
 		closedir(dir);
-		return affinity_class(mask, "block", name);
+		return ret;
 	}
 	closedir(dir);
 	numa_warn(W_blockdev5, "Cannot find block device %x:%x in sysfs for `%s'",
Signature · 6 lines
2.14.3

_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm
#2 lore raw

PATCH 3/3 Add pkg-config file for NUMA library

In reply to Ross Zwisler

This is needed so that other projects can add a dependency on libnuma via PKG_CHECK_MODULES([NUMA], [numa]). This enabling makes 'make install' do the right thing, and of course individual distros will need to add enabling to their associated packages (rpm, deb, etc.) so the package manager installs do the right thing.

---
 .gitignore  |  3 +++
 Makefile.am | 18 ++++++++++++++++++
 numa.pc.in  | 10 ++++++++++
 3 files changed, 31 insertions(+)
 create mode 100644 numa.pc.in
.gitignore +3 -0
index 68d5235..8cfe9f8 100644
@@ -59,3 +59,6 @@
 /test-suite.log
 /test/*.log
 /test/*.trs
+
+# pkg-config file
+numa.pc
Makefile.am +18 -0
index b6db339..ac4dc3c 100644
@@ -1,5 +1,6 @@
 
 ACLOCAL_AMFLAGS = -I m4
+CLEANFILES =
 
 AM_CPPFLAGS = -Wall
 
@@ -141,3 +142,20 @@ TESTS = \
 # These are known to be broken:
 #	test/prefered
 #	test/randmap
+
+SED_PROCESS = \
+        $(AM_V_GEN)$(SED) \
+        -e 's,@VERSION\@,$(VERSION),g' \
+        -e 's,@prefix\@,$(prefix),g' \
+        -e 's,@exec_prefix\@,$(exec_prefix),g' \
+        -e 's,@libdir\@,$(libdir),g' \
+        -e 's,@includedir\@,$(includedir),g' \
+        < $< > $@ || rm $@
+
+%.pc: %.pc.in Makefile
+	$(SED_PROCESS)
+
+pkgconfigdir = $(libdir)/pkgconfig
+pkgconfig_DATA = numa.pc
+EXTRA_DIST += numa.pc.in
+CLEANFILES += numa.pc
numa.pc.in new file +10 -0
new file mode 100644
index 0000000..8a0f202
@@ -0,0 +1,10 @@
+prefix=@prefix@
+exec_prefix=@exec_prefix@
+libdir=@libdir@
+includedir=@includedir@
+
+Name: numa
+Description: NUMA policy library
+Version: @VERSION@
+Cflags: -I${includedir}
+Libs: -L${libdir} -lnuma
Signature · 6 lines
2.14.3

_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm
#3 lore raw
In reply to Ross Zwisler

Ping on this series.

Quoted 37 lines · Ross Zwisler

gcc 7.3.1 provides the following warning when compiling numastat.c:

numastat.c: In function ‘add_pids_from_pattern_search’:
numastat.c:1316:41: warning: ‘%s’ directive output may be truncated writing up to 255 bytes into a region of size 58 [-Wformat-truncation=]

   snprintf(fname, sizeof(fname), "/proc/%s/cmdline", namelist[ix]->d_name);
                                         ^~
numastat.c:1316:3: note: ‘snprintf’ output between 15 and 270 bytes into a
destination of size 64
   snprintf(fname, sizeof(fname), "/proc/%s/cmdline", namelist[ix]->d_name);
   ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This is valid - namelist[ix]->d_name is size 256 bytes, we have some extra bytes as part of our format string. Our destination buffer, 'fname', is only 64 bytes wide.

---
 numastat.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
numastat.c +1 -1
index e0a5639..2d413df 100644
@@ -1312,7 +1312,7 @@ void add_pids_from_pattern_search(char *pattern) {
 		}
 		// Next copy cmdline file contents onto end of buffer.  Do it a
 		// character at a time to convert nulls to spaces.
-		char fname[64];
+		char fname[272];
 		snprintf(fname, sizeof(fname), "/proc/%s/cmdline", namelist[ix]->d_name);
 		FILE *fs = fopen(fname, "r");
 		if (fs) {
Signature · 1 line
2.14.3

_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm