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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
|
/*
* Copyright © 2019 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*/
#include <assert.h>
#include <fcntl.h>
#include <limits.h>
#include <stdbool.h>
#include <stdio.h>
#include <sys/ioctl.h>
#include <sys/stat.h>
#include <i915_drm.h>
#include "igt_core.h"
#include "igt_params.h"
#include "igt_sysfs.h"
#include "igt_debugfs.h"
struct module_param_data {
char *path;
char *name;
char *original_value;
struct module_param_data *next;
};
struct module_param_data *module_params = NULL;
static void igt_params_exit_handler(int sig)
{
struct module_param_data *data;
int dir;
for (data = module_params; data != NULL; data = data->next) {
dir = open(data->path, O_RDONLY);
if (!igt_sysfs_set(dir, data->name, data->original_value)) {
const char msg[] = "WARNING: Module parameters "
"may not have been reset to their "
"original values\n";
assert(write(STDERR_FILENO, msg, sizeof(msg))
== sizeof(msg));
}
close(dir);
}
/* free() is not AS-Safe, so we can't call it here. */
}
/**
* igt_params_save:
* @dir: file handle for path
* @path: full path to the sysfs directory
* @name: name of the sysfs attribute
*
* Reads the current value of a sysfs attribute, saves it on an array, then
* installs an exit handler to restore it when the program exits.
*
* It is safe to call this function multiple times for the same parameter.
*
* Notice that this function is called by igt_set_module_param(), so that one -
* or one of its wrappers - is the only function the test programs need to call.
*/
static void igt_params_save(int dir, const char *name)
{
struct module_param_data *data;
char path[PATH_MAX];
char buf[80];
int len;
snprintf(buf, sizeof(buf), "/proc/self/fd/%d", dir);
len = readlink(buf, path, sizeof(path) - 1);
if (len < 0)
return;
path[len] = '\0';
/* Check if this parameter is already saved. */
for (data = module_params; data != NULL; data = data->next)
if (strcmp(data->path, path) == 0 &&
strcmp(data->name, name) == 0)
return;
if (!module_params)
igt_install_exit_handler(igt_params_exit_handler);
data = calloc(1, sizeof (*data));
igt_assert(data);
data->path = strdup(path);
igt_assert(data->path);
data->name = strdup(name);
igt_assert(data->name);
data->original_value = igt_sysfs_get(dir, name);
igt_assert(data->original_value);
data->next = module_params;
module_params = data;
}
/**
* igt_params_open:
* @device: fd of the device
*
* This opens the module parameters directory (under sysfs) corresponding
* to the device for use with igt_sysfs_set() and igt_sysfs_get().
*
* Returns:
* The directory fd, or -1 on failure.
*/
int igt_params_open(int device)
{
drm_version_t version;
int dir, params = -1;
char path[PATH_MAX];
char name[32] = "";
memset(&version, 0, sizeof(version));
version.name_len = sizeof(name);
version.name = name;
if (ioctl(device, DRM_IOCTL_VERSION, &version))
return -1;
dir = igt_debugfs_dir(device);
if (dir >= 0) {
snprintf(path, PATH_MAX, "%s_params", name);
params = openat(dir, path, O_RDONLY);
close(dir);
}
if (params < 0) { /* builtin? */
snprintf(path, sizeof(path), "/sys/module/%s/parameters", name);
params = open(path, O_RDONLY);
}
return params;
}
/**
* __igt_params_get:
* @device: fd of the device
* @parameter: the name of the parameter to get
*
* This reads the value of the modparam.
*
* Returns:
* A nul-terminated string, must be freed by caller after use, or NULL
* on failure.
*/
char *__igt_params_get(int device, const char *parameter)
{
char *str;
int dir;
dir = igt_params_open(device);
if (dir < 0)
return NULL;
str = igt_sysfs_get(dir, parameter);
close(dir);
return str;
}
__attribute__((format(printf, 3, 0)))
static bool __igt_params_set(int device, const char *parameter,
const char *fmt, va_list ap, bool save)
{
int dir;
int ret;
dir = igt_params_open(device);
if (dir < 0)
return false;
if (save)
igt_params_save(dir, parameter);
ret = igt_sysfs_vprintf(dir, parameter, fmt, ap);
close(dir);
return ret > 0;
}
/**
* igt_params_set:
* @device: fd of the device
* @parameter: the name of the parameter to set
* @fmt: printf-esque format string
*
* Returns true on success
*/
bool igt_params_set(int device, const char *parameter, const char *fmt, ...)
{
va_list ap;
bool ret;
va_start(ap, fmt);
ret = __igt_params_set(device, parameter, fmt, ap, false);
va_end(ap);
return ret;
}
/**
* igt_params_save_and_set:
* @device: fd of the device or -1 to default.
* @parameter: the name of the parameter to set
* @fmt: printf-esque format string
*
* Save original value to be restored by exit handler. Parameter is first
* searched at debugfs/dri/N/<device>_params and if not found will look for
* parameter at /sys/module/<device>/parameters.
*
* Giving -1 here for default device will search for matching device from
* debugfs/dri/N where N go from 0 to 63. First device found from debugfs
* which exist also at /sys/module/<device> will be 'default'.
*
* Returns true on success
*/
bool igt_params_save_and_set(int device, const char *parameter, const char *fmt, ...)
{
va_list ap;
bool ret;
va_start(ap, fmt);
ret = __igt_params_set(device, parameter, fmt, ap, true);
va_end(ap);
return ret;
}
/**
* igt_set_module_param:
* @name: i915.ko parameter name
* @val: i915.ko parameter value
*
* This function sets the desired value for the given i915.ko parameter. It also
* takes care of saving and restoring the values that were already set before
* the test was run.
*
* Please consider using igt_set_module_param_int() for the integer and bool
* parameters.
*/
void igt_set_module_param(int device, const char *name, const char *val)
{
igt_assert(igt_params_save_and_set(device, name, "%s", val));
}
/**
* igt_set_module_param_int:
* @name: i915.ko parameter name
* @val: i915.ko parameter value
*
* This is a wrapper for igt_set_module_param() that takes an integer instead of
* a string. Please see igt_set_module_param().
*/
void igt_set_module_param_int(int device, const char *name, int val)
{
igt_assert(igt_params_save_and_set(device, name, "%d", val));
}
|