xref: /openbmc/linux/tools/perf/tests/attr.c (revision 7211ec63)
1 /*
2  * The struct perf_event_attr test support.
3  *
4  * This test is embedded inside into perf directly and is governed
5  * by the PERF_TEST_ATTR environment variable and hook inside
6  * sys_perf_event_open function.
7  *
8  * The general idea is to store 'struct perf_event_attr' details for
9  * each event created within single perf command. Each event details
10  * are stored into separate text file. Once perf command is finished
11  * these files can be checked for values we expect for command.
12  *
13  * Besides 'struct perf_event_attr' values we also store 'fd' and
14  * 'group_fd' values to allow checking for groups created.
15  *
16  * This all is triggered by setting PERF_TEST_ATTR environment variable.
17  * It must contain name of existing directory with access and write
18  * permissions. All the event text files are stored there.
19  */
20 
21 #include <debug.h>
22 #include <errno.h>
23 #include <inttypes.h>
24 #include <stdlib.h>
25 #include <stdio.h>
26 #include <linux/types.h>
27 #include <linux/kernel.h>
28 #include <sys/param.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
31 #include <unistd.h>
32 #include "../perf.h"
33 #include <subcmd/exec-cmd.h>
34 #include "tests.h"
35 
36 #define ENV "PERF_TEST_ATTR"
37 
38 static char *dir;
39 static bool ready;
40 
41 void test_attr__init(void)
42 {
43 	dir = getenv(ENV);
44 	test_attr__enabled = (dir != NULL);
45 }
46 
47 #define BUFSIZE 1024
48 
49 #define __WRITE_ASS(str, fmt, data)					\
50 do {									\
51 	char buf[BUFSIZE];						\
52 	size_t size;							\
53 									\
54 	size = snprintf(buf, BUFSIZE, #str "=%"fmt "\n", data);		\
55 	if (1 != fwrite(buf, size, 1, file)) {				\
56 		perror("test attr - failed to write event file");	\
57 		fclose(file);						\
58 		return -1;						\
59 	}								\
60 									\
61 } while (0)
62 
63 #define WRITE_ASS(field, fmt) __WRITE_ASS(field, fmt, attr->field)
64 
65 static int store_event(struct perf_event_attr *attr, pid_t pid, int cpu,
66 		       int fd, int group_fd, unsigned long flags)
67 {
68 	FILE *file;
69 	char path[PATH_MAX];
70 
71 	if (!ready)
72 		return 0;
73 
74 	snprintf(path, PATH_MAX, "%s/event-%d-%llu-%d", dir,
75 		 attr->type, attr->config, fd);
76 
77 	file = fopen(path, "w+");
78 	if (!file) {
79 		perror("test attr - failed to open event file");
80 		return -1;
81 	}
82 
83 	if (fprintf(file, "[event-%d-%llu-%d]\n",
84 		    attr->type, attr->config, fd) < 0) {
85 		perror("test attr - failed to write event file");
86 		fclose(file);
87 		return -1;
88 	}
89 
90 	/* syscall arguments */
91 	__WRITE_ASS(fd,       "d", fd);
92 	__WRITE_ASS(group_fd, "d", group_fd);
93 	__WRITE_ASS(cpu,      "d", cpu);
94 	__WRITE_ASS(pid,      "d", pid);
95 	__WRITE_ASS(flags,   "lu", flags);
96 
97 	/* struct perf_event_attr */
98 	WRITE_ASS(type,   PRIu32);
99 	WRITE_ASS(size,   PRIu32);
100 	WRITE_ASS(config,  "llu");
101 	WRITE_ASS(sample_period, "llu");
102 	WRITE_ASS(sample_type,   "llu");
103 	WRITE_ASS(read_format,   "llu");
104 	WRITE_ASS(disabled,       "d");
105 	WRITE_ASS(inherit,        "d");
106 	WRITE_ASS(pinned,         "d");
107 	WRITE_ASS(exclusive,      "d");
108 	WRITE_ASS(exclude_user,   "d");
109 	WRITE_ASS(exclude_kernel, "d");
110 	WRITE_ASS(exclude_hv,     "d");
111 	WRITE_ASS(exclude_idle,   "d");
112 	WRITE_ASS(mmap,           "d");
113 	WRITE_ASS(comm,           "d");
114 	WRITE_ASS(freq,           "d");
115 	WRITE_ASS(inherit_stat,   "d");
116 	WRITE_ASS(enable_on_exec, "d");
117 	WRITE_ASS(task,           "d");
118 	WRITE_ASS(watermark,      "d");
119 	WRITE_ASS(precise_ip,     "d");
120 	WRITE_ASS(mmap_data,      "d");
121 	WRITE_ASS(sample_id_all,  "d");
122 	WRITE_ASS(exclude_host,   "d");
123 	WRITE_ASS(exclude_guest,  "d");
124 	WRITE_ASS(exclude_callchain_kernel, "d");
125 	WRITE_ASS(exclude_callchain_user, "d");
126 	WRITE_ASS(wakeup_events, PRIu32);
127 	WRITE_ASS(bp_type, PRIu32);
128 	WRITE_ASS(config1, "llu");
129 	WRITE_ASS(config2, "llu");
130 	WRITE_ASS(branch_sample_type, "llu");
131 	WRITE_ASS(sample_regs_user,   "llu");
132 	WRITE_ASS(sample_stack_user,  PRIu32);
133 
134 	fclose(file);
135 	return 0;
136 }
137 
138 void test_attr__open(struct perf_event_attr *attr, pid_t pid, int cpu,
139 		     int fd, int group_fd, unsigned long flags)
140 {
141 	int errno_saved = errno;
142 
143 	if ((fd != -1) && store_event(attr, pid, cpu, fd, group_fd, flags)) {
144 		pr_err("test attr FAILED");
145 		exit(128);
146 	}
147 
148 	errno = errno_saved;
149 }
150 
151 void test_attr__ready(void)
152 {
153 	if (unlikely(test_attr__enabled) && !ready)
154 		ready = true;
155 }
156 
157 static int run_dir(const char *d, const char *perf)
158 {
159 	char v[] = "-vvvvv";
160 	int vcnt = min(verbose, (int) sizeof(v) - 1);
161 	char cmd[3*PATH_MAX];
162 
163 	if (verbose > 0)
164 		vcnt++;
165 
166 	snprintf(cmd, 3*PATH_MAX, PYTHON " %s/attr.py -d %s/attr/ -p %s %.*s",
167 		 d, d, perf, vcnt, v);
168 
169 	return system(cmd);
170 }
171 
172 int test__attr(struct test *test __maybe_unused, int subtest __maybe_unused)
173 {
174 	struct stat st;
175 	char path_perf[PATH_MAX];
176 	char path_dir[PATH_MAX];
177 
178 	/* First try developement tree tests. */
179 	if (!lstat("./tests", &st))
180 		return run_dir("./tests", "./perf");
181 
182 	/* Then installed path. */
183 	snprintf(path_dir,  PATH_MAX, "%s/tests", get_argv_exec_path());
184 	snprintf(path_perf, PATH_MAX, "%s/perf", BINDIR);
185 
186 	if (!lstat(path_dir, &st) &&
187 	    !lstat(path_perf, &st))
188 		return run_dir(path_dir, path_perf);
189 
190 	return TEST_SKIP;
191 }
192