aboutsummaryrefslogtreecommitdiffstats
path: root/tools/perf/tests/builtin-test-list.c
blob: a65b9e547d82665384cc4b598caee0357474f7f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/* SPDX-License-Identifier: GPL-2.0 */
#include <dirent.h>
#include <errno.h>
#include <fcntl.h>
#include <linux/ctype.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/zalloc.h>
#include <string.h>
#include <stdlib.h>
#include <sys/types.h>
#include <unistd.h>
#include <subcmd/exec-cmd.h>
#include <subcmd/parse-options.h>
#include <sys/wait.h>
#include <sys/stat.h>
#include "builtin.h"
#include "builtin-test-list.h"
#include "color.h"
#include "debug.h"
#include "hist.h"
#include "intlist.h"
#include "string2.h"
#include "symbol.h"
#include "tests.h"
#include "util/rlimit.h"


/*
 * As this is a singleton built once for the run of the process, there is
 * no value in trying to free it and just let it stay around until process
 * exits when it's cleaned up.
 */
static size_t files_num = 0;
static struct script_file *files = NULL;
static int files_max_width = 0;

static const char *shell_tests__dir(char *path, size_t size)
{
	const char *devel_dirs[] = { "./tools/perf/tests", "./tests", };
	char *exec_path;
	unsigned int i;

	for (i = 0; i < ARRAY_SIZE(devel_dirs); ++i) {
		struct stat st;

		if (!lstat(devel_dirs[i], &st)) {
			scnprintf(path, size, "%s/shell", devel_dirs[i]);
			if (!lstat(devel_dirs[i], &st))
				return path;
		}
	}

	/* Then installed path. */
	exec_path = get_argv_exec_path();
	scnprintf(path, size, "%s/tests/shell", exec_path);
	free(exec_path);
	return path;
}

static const char *shell_test__description(char *description, size_t size,
                                           const char *path, const char *name)
{
	FILE *fp;
	char filename[PATH_MAX];
	int ch;

	path__join(filename, sizeof(filename), path, name);
	fp = fopen(filename, "r");
	if (!fp)
		return NULL;

	/* Skip first line - should be #!/bin/sh Shebang */
	do {
		ch = fgetc(fp);
	} while (ch != EOF && ch != '\n');

	description = fgets(description, size, fp);
	fclose(fp);

	/* Assume first char on line is omment everything after that desc */
	return description ? strim(description + 1) : NULL;
}

/* Is this full file path a shell script */
static bool is_shell_script(const char *path)
{
	const char *ext;

	ext = strrchr(path, '.');
	if (!ext)
		return false;
	if (!strcmp(ext, ".sh")) { /* Has .sh extension */
		if (access(path, R_OK | X_OK) == 0) /* Is executable */
			return true;
	}
	return false;
}

/* Is this file in this dir a shell script (for test purposes) */
static bool is_test_script(const char *path, const char *name)
{
	char filename[PATH_MAX];

	path__join(filename, sizeof(filename), path, name);
	if (!is_shell_script(filename)) return false;
	return true;
}

/* Duplicate a string and fall over and die if we run out of memory */
static char *strdup_check(const char *str)
{
	char *newstr;

	newstr = strdup(str);
	if (!newstr) {
		pr_err("Out of memory while duplicating test script string\n");
		abort();
	}
	return newstr;
}

static void append_script(const char *dir, const char *file, const char *desc)
{
	struct script_file *files_tmp;
	size_t files_num_tmp;
	int width;

	files_num_tmp = files_num + 1;
	if (files_num_tmp >= SIZE_MAX) {
		pr_err("Too many script files\n");
		abort();
	}
	/* Realloc is good enough, though we could realloc by chunks, not that
	 * anyone will ever measure performance here */
	files_tmp = realloc(files,
			    (files_num_tmp + 1) * sizeof(struct script_file));
	if (files_tmp == NULL) {
		pr_err("Out of memory while building test list\n");
		abort();
	}
	/* Add file to end and NULL terminate the struct array */
	files = files_tmp;
	files_num = files_num_tmp;
	files[files_num - 1].dir = strdup_check(dir);
	files[files_num - 1].file = strdup_check(file);
	files[files_num - 1].desc = strdup_check(desc);
	files[files_num].dir = NULL;
	files[files_num].file = NULL;
	files[files_num].desc = NULL;

	width = strlen(desc); /* Track max width of desc */
	if (width > files_max_width)
		files_max_width = width;
}

static void append_scripts_in_dir(const char *path)
{
	struct dirent **entlist;
	struct dirent *ent;
	int n_dirs, i;
	char filename[PATH_MAX];

	/* List files, sorted by alpha */
	n_dirs = scandir(path, &entlist, NULL, alphasort);
	if (n_dirs == -1)
		return;
	for (i = 0; i < n_dirs && (ent = entlist[i]); i++) {
		if (ent->d_name[0] == '.')
			continue; /* Skip hidden files */
		if (is_test_script(path, ent->d_name)) { /* It's a test */
			char bf[256];
			const char *desc = shell_test__description
				(bf, sizeof(bf), path, ent->d_name);

			if (desc) /* It has a desc line - valid script */
				append_script(path, ent->d_name, desc);
		} else if (is_directory(path, ent)) { /* Scan the subdir */
			path__join(filename, sizeof(filename),
				   path, ent->d_name);
			append_scripts_in_dir(filename);
		}
	}
	for (i = 0; i < n_dirs; i++) /* Clean up */
		zfree(&entlist[i]);
	free(entlist);
}

const struct script_file *list_script_files(void)
{
	char path_dir[PATH_MAX];
	const char *path;

	if (files)
		return files; /* Singleton - we already know our list */

	path = shell_tests__dir(path_dir, sizeof(path_dir)); /* Walk  dir */
	append_scripts_in_dir(path);

	return files;
}

int list_script_max_width(void)
{
	list_script_files(); /* Ensure we have scanned all scripts */
	return files_max_width;
}