/usr/share/systemtap/tapset/uconversions.stp is in systemtap-common 1.7-1+deb7u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 | // userspace conversions tapset
// Copyright (C) 2005-2011 Red Hat Inc.
// Copyright (C) 2007 Intel Corporation.
//
// This file is part of systemtap, and is free software. You can
// redistribute it and/or modify it under the terms of the GNU General
// Public License (GPL); either version 2, or (at your option) any
// later version.
%{
#define __STP_GET_USER(t, warn) \
do { \
__label__ deref_fault; \
t *_ptr = (t*) (intptr_t) THIS->addr; \
assert_is_myproc(); \
if (! access_ok(VERIFY_READ, _ptr, sizeof(t))) \
goto deref_fault; \
if (__stp_get_user(THIS->__retvalue, _ptr)) { \
deref_fault: \
THIS->__retvalue = 0; \
CONTEXT->last_error = NULL; \
if (warn) { \
snprintf(CONTEXT->error_buffer, \
sizeof(CONTEXT->error_buffer), \
"user %s copy fault %p", #t, _ptr); \
_stp_warn(CONTEXT->error_buffer); \
} \
} \
} while (0)
#define STP_GET_USER(t) __STP_GET_USER(t, 0)
#define STP_GET_USER_WARN(t) __STP_GET_USER(t, 1)
%}
/**
* sfunction user_string - Retrieves string from user space
*
* @addr: the user space address to retrieve the string from
*
* Description: Returns the null terminated C string from a given user space
* memory address. Reports "<unknown>" on the rare cases when userspace
* data is not accessible.
*/
function user_string:string (addr:long) { return user_string2 (addr, "<unknown>") }
/**
* sfunction user_string2 - Retrieves string from user space with alternative error string
*
* @addr: the user space address to retrieve the string from
* @err_msg: the error message to return when data isn't available
*
* Description: Returns the null terminated C string from a given user space
* memory address. Reports the given error message on the rare cases when
* userspace data is not accessible.
*/
function user_string2:string (addr:long, err_msg:string) %{ /* pure */ /* myproc-unprivileged */
if (_stp_strncpy_from_user (THIS->__retvalue,
(const char __user*) (uintptr_t) THIS->addr,
MAXSTRINGLEN) < 0)
strlcpy (THIS->__retvalue, THIS->err_msg, MAXSTRINGLEN);
%}
/**
* sfunction user_string_warn - Retrieves string from user space
*
* @addr: the user space address to retrieve the string from
*
* Description: Returns the null terminated C string from a given user space
* memory address. Reports "<unknown>" on the rare cases when userspace
* data is not accessible and warns (but does not abort) about the failure.
*/
function user_string_warn:string (addr:long) %{ /* pure */ /* myproc-unprivileged */
long rc;
rc = _stp_strncpy_from_user (THIS->__retvalue,
(const char __user*) (uintptr_t) THIS->addr, MAXSTRINGLEN);
if (rc < 0) {
// NB: using error_buffer to get local space for the warning, but we're
// not aborting, so leave last_error alone.
snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
"user string copy fault %ld at %p", rc,
(void *) (uintptr_t) THIS->addr);
_stp_warn(CONTEXT->error_buffer);
strlcpy (THIS->__retvalue, "<unknown>", MAXSTRINGLEN);
}
%}
/**
* sfunction user_string_quoted - Retrieves and quotes string from user space
*
* @addr: the user space address to retrieve the string from
*
* Description: Returns the null terminated C string from a given user space
* memory address where any ASCII characters that are not printable are
* replaced by the corresponding escape sequence in the returned string.
* Reports "NULL" for address zero. Returns "<unknown>" on the rare
* cases when userspace data is not accessible at the given address.
*/
function user_string_quoted:string (addr:long) %{ /* pure */ /* myproc-unprivileged */
if (THIS->addr == 0)
strlcpy (THIS->__retvalue, "NULL", MAXSTRINGLEN);
else
/* XXX: stp_text_str uses sleepy __get_user() => unsafe ?! */
_stp_text_str(THIS->__retvalue, (char *)(uintptr_t)THIS->addr,
MAXSTRINGLEN, 1, 1);
%}
/**
* sfunction user_string_n - Retrieves string of given length from user space
*
* @addr: the user space address to retrieve the string from
* @n: the maximum length of the string (if not null terminated)
*
* Description: Returns the C string of a maximum given length from a
* given user space address. Returns "<unknown>" on the rare cases
* when userspace data is not accessible at the given address.
*/
function user_string_n:string (addr:long, n:long) {
return user_string_n2(addr, n, "<unknown>")
}
/**
* sfunction user_string_n2 - Retrieves string of given length from user space
*
* @addr: the user space address to retrieve the string from
* @n: the maximum length of the string (if not null terminated)
* @err_msg: the error message to return when data isn't available
*
* Description: Returns the C string of a maximum given length from a
* given user space address. Returns the given error message string on
* the rare cases when userspace data is not accessible at the given
* address.
*/
function user_string_n2:string (addr:long, n:long, err_msg:string) %{ /* pure */ /* myproc-unprivileged */
int64_t len = clamp_t(int64_t, THIS->n + 1, 1, MAXSTRINGLEN);
if (_stp_strncpy_from_user(THIS->__retvalue,
(char __user *) (uintptr_t) THIS->addr,
len) < 0)
strlcpy(THIS->__retvalue, THIS->err_msg, MAXSTRINGLEN);
else
THIS->__retvalue[len - 1] = '\0';
%}
/**
* sfunction user_string_n_warn - Retrieves string from user space
*
* @addr: the user space address to retrieve the string from
* @n: the maximum length of the string (if not null terminated)
*
* Description: Returns up to n characters of a C string from a given
* user space memory address. Reports "<unknown>" on the rare cases
* when userspace data is not accessible and warns (but does not abort)
* about the failure.
*/
function user_string_n_warn:string (addr:long, n:long) %{ /* pure */ /* myproc-unprivileged */
int64_t len = clamp_t(int64_t, THIS->n + 1, 1, MAXSTRINGLEN);
long rc;
rc = _stp_strncpy_from_user(THIS->__retvalue,
(char __user *) (uintptr_t) THIS->addr, len);
if (rc < 0) {
// NB: using error_buffer to get local space for the warning, but we're
// not aborting, so leave last_error alone.
snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
"user string copy fault %ld at %p", rc,
(void *) (uintptr_t) THIS->addr);
_stp_warn(CONTEXT->error_buffer);
strlcpy (THIS->__retvalue, "<unknown>", MAXSTRINGLEN);
} else
THIS->__retvalue[len - 1] = '\0';
%}
/**
* sfunction user_string_n_quoted - Retrieves and quotes string from user space
*
* @addr: the user space address to retrieve the string from
* @n: the maximum length of the string (if not null terminated)
*
* Description: Returns up to n characters of a C string from the given
* user space memory address where any ASCII characters that are not
* printable are replaced by the corresponding escape sequence in the
* returned string. Reports "NULL" for address zero. Returns "<unknown>"
* on the rare cases when userspace data is not accessible at the given
* address.
*/
function user_string_n_quoted:string (addr:long, n:long) %{ /* pure */ /* myproc-unprivileged */
int64_t len = clamp_t(int64_t, THIS->n + 1, 1, MAXSTRINGLEN);
if (THIS->addr == 0)
strlcpy(THIS->__retvalue, "NULL", MAXSTRINGLEN);
else
/* XXX: stp_text_str uses sleepy __get_user() => unsafe ?! */
_stp_text_str(THIS->__retvalue, (char *)(uintptr_t)THIS->addr,
len, 1, 1);
%}
/**
* sfunction user_char - Retrieves a char value stored in user space
*
* @addr: the user space address to retrieve the char from
*
* Description: Returns the char value from a given user space address.
* Returns zero when user space data is not accessible.
*/
function user_char:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(char);
%}
/**
* sfunction user_char_warn - Retrieves a char value stored in user space
*
* @addr: the user space address to retrieve the char from
*
* Description: Returns the char value from a given user space address.
* Returns zero when user space and warns (but does not abort) about the
* failure.
*/
function user_char_warn:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER_WARN(char);
%}
/**
* sfunction user_short - Retrieves a short value stored in user space
*
* @addr: the user space address to retrieve the short from
*
* Description: Returns the short value from a given user space address.
* Returns zero when user space data is not accessible.
*/
function user_short:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(short);
%}
/**
* sfunction user_short_warn - Retrieves a short value stored in user space
*
* @addr: the user space address to retrieve the short from
*
* Description: Returns the short value from a given user space address.
* Returns zero when user space and warns (but does not abort) about the
* failure.
*/
function user_short_warn:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER_WARN(short);
%}
/**
* sfunction user_ushort - Retrieves an unsigned short value stored in user space
*
* @addr: the user space address to retrieve the unsigned short from
*
* Description: Returns the unsigned short value from a given user
* space address. Returns zero when user space data is not accessible.
*/
function user_ushort:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(unsigned short);
%}
/**
* sfunction user_ushort_warn - Retrieves an unsigned short value stored in user space
*
* @addr: the user space address to retrieve the unsigned short from
*
* Description: Returns the unsigned short value from a given user
* space address. Returns zero when user space and warns (but does
* not abort) about the failure.
*/
function user_ushort_warn:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER_WARN(unsigned short);
%}
/**
* sfunction user_int - Retrieves an int value stored in user space
*
* @addr: the user space address to retrieve the int from
*
* Description: Returns the int value from a given user space address.
* Returns zero when user space data is not accessible.
*/
function user_int:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(int);
%}
/**
* sfunction user_int_warn - Retrieves an int value stored in user space
*
* @addr: the user space address to retrieve the int from
*
* Description: Returns the int value from a given user space address.
* Returns zero when user space and warns (but does not abort) about the
* failure.
*/
function user_int_warn:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER_WARN(int);
%}
/**
* sfunction user_long - Retrieves a long value stored in user space
*
* @addr: the user space address to retrieve the long from
*
* Description: Returns the long value from a given user space address.
* Returns zero when user space data is not accessible. Note that the
* size of the long depends on the architecture of the current user space
* task (for those architectures that support both 64/32 bit compat tasks).
*/
function user_long:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
#ifdef CONFIG_COMPAT
if (_stp_is_compat_task())
STP_GET_USER(compat_long_t);
else
#endif
STP_GET_USER(long);
%}
/**
* sfunction user_long_warn - Retrieves a long value stored in user space
*
* @addr: the user space address to retrieve the long from
*
* Description: Returns the long value from a given user space address.
* Returns zero when user space and warns (but does not abort) about the
* failure. Note that the size of the long depends on the architecture
* of the current user space task (for those architectures that support
* both 64/32 bit compat tasks).
*/
function user_long_warn:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
#ifdef CONFIG_COMPAT
if (_stp_is_compat_task())
STP_GET_USER_WARN(compat_long_t);
else
#endif
STP_GET_USER_WARN(long);
%}
/**
* sfunction user_int8 - Retrieves a 8-bit integer value stored in user space
*
* @addr: the user space address to retrieve the 8-bit integer from
*
* Description: Returns the 8-bit integer value from a given user space
* address. Returns zero when user space data is not accessible.
*/
function user_int8:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(int8_t);
%}
/**
* sfunction user_uint8 - Retrieves an unsigned 8-bit integer value stored in user space
*
* @addr: the user space address to retrieve the unsigned 8-bit integer from
*
* Description: Returns the unsigned 8-bit integer value from a given user
* space address. Returns zero when user space data is not accessible.
*/
function user_uint8:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(uint8_t);
%}
/**
* sfunction user_int16 - Retrieves a 16-bit integer value stored in user space
*
* @addr: the user space address to retrieve the 16-bit integer from
*
* Description: Returns the 16-bit integer value from a given user space
* address. Returns zero when user space data is not accessible.
*/
function user_int16:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(int16_t);
%}
/**
* sfunction user_uint16 - Retrieves an unsigned 16-bit integer value stored in user space
*
* @addr: the user space address to retrieve the unsigned 16-bit integer from
*
* Description: Returns the unsigned 16-bit integer value from a given user
* space address. Returns zero when user space data is not accessible.
*/
function user_uint16:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(uint16_t);
%}
/**
* sfunction user_int32 - Retrieves a 32-bit integer value stored in user space
*
* @addr: the user space address to retrieve the 32-bit integer from
*
* Description: Returns the 32-bit integer value from a given user space
* address. Returns zero when user space data is not accessible.
*/
function user_int32:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(int32_t);
%}
/**
* sfunction user_uint32 - Retrieves an unsigned 32-bit integer value stored in user space
*
* @addr: the user space address to retrieve the unsigned 32-bit integer from
*
* Description: Returns the unsigned 32-bit integer value from a given user
* space address. Returns zero when user space data is not accessible.
*/
function user_uint32:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(uint32_t);
%}
/**
* sfunction user_int64 - Retrieves a 64-bit integer value stored in user space
*
* @addr: the user space address to retrieve the 64-bit integer from
*
* Description: Returns the 64-bit integer value from a given user space
* address. Returns zero when user space data is not accessible.
*/
function user_int64:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
#if defined (__i386__) || defined (__arm__)
/* As with kread() on i386 and arm, we must split 64-bit in two.
* STP_GET_USER isn't well designed for that, but I don't
* want to complicate all the other callers. */
uint32_t value[2];
STP_GET_USER(uint32_t);
value[0] = THIS->__retvalue;
if (!CONTEXT->last_error) {
THIS->addr += 4;
STP_GET_USER(uint32_t);
value[1] = THIS->__retvalue;
THIS->__retvalue = *(int64_t*)value;
}
#else
STP_GET_USER(int64_t);
#endif
%}
/**
* sfunction user_uint64 - Retrieves an unsigned 64-bit integer value stored in user space
*
* @addr: the user space address to retrieve the unsigned 64-bit integer from
*
* Description: Returns the unsigned 64-bit integer value from a given user
* space address. Returns zero when user space data is not accessible.
*/
function user_uint64:long (addr:long) {
/* NB: We have no script-level notion of 64-bit unsigned,
* but we keep user_uint64 anyway for API completeness. */
return user_int64 (addr);
}
|