/usr/share/systemtap/tapset/uconversions.stp is in systemtap-common 3.1-3ubuntu0.1.
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 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 | // userspace conversions tapset
// Copyright (C) 2005-2015 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.
// implement in terms of runtime/loc2c-runtime.h macro uread()
%{
#define STP_GET_USER(t) \
do { \
t *_ptr = (t*) (intptr_t) STAP_ARG_addr; \
STAP_RETVALUE = uread (_ptr); \
} while (0)
%}
/**
* 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 an error on the rare cases when userspace
* data is not accessible.
*/
function user_string:string (addr:long) {
return user_string_n(addr, @MAXSTRINGLEN)
}
/**
* sfunction user_string - 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_string:string (addr:long, err_msg:string) {
return user_string_n(addr, @MAXSTRINGLEN, err_msg)
}
%(systemtap_v <= "3.0" %?
function user_string2:string (addr:long, err_msg:string) {
return user_string_n(addr, @MAXSTRINGLEN, err_msg)
}
%)
/**
* 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 "" 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) {
%(systemtap_v < "2.3" %? // PR15044
return user_string_warn(addr, "<unknown>")
%:
return user_string_warn(addr, "")
%)
}
/**
* sfunction user_string_warn - Retrieves string from user space with alternative warning string
*
* @addr: the user space address to retrieve the string from
* @warn_msg: the warning 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 warning message 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, warn_msg:string) {
return user_string_n_warn(addr, @MAXSTRINGLEN, warn_msg)
}
%(systemtap_v <= "3.0" %?
function user_string2_warn:string (addr:long, warn_msg:string) {
return user_string_n_warn(addr, @MAXSTRINGLEN, warn_msg)
}
%)
/**
* 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. Note
* that the string will be surrounded by double quotes. On the rare cases when
* userspace data is not accessible at the given address, the address itself is
* returned as a string, without double quotes.
*/
function user_string_quoted:string (addr:long) {
try { return string_quoted(user_string(addr)) } catch { return sprintf("0x%x", addr) }
}
/**
* 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. Reports an error on the rare cases
* when userspace data is not accessible at the given address.
*/
function user_string_n:string (addr:long, n:long)
%( systemtap_v < "2.3" %? // PR15044
{ return user_string_n(addr, n, "<unknown>") }
%:
%{ /* pure */ /* myproc-unprivileged */
long rc;
int64_t len = clamp_t(int64_t, STAP_ARG_n + 1, 1, MAXSTRINGLEN);
rc = _stp_strncpy_from_user(STAP_RETVALUE,
(char __user *) (uintptr_t) STAP_ARG_addr, len);
if (rc < 0) {
strlcpy(STAP_RETVALUE, "<unknown>", MAXSTRINGLEN);
snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
"user string copy fault %ld at %p [man error::fault]", rc,
(void *) (uintptr_t) STAP_ARG_addr);
CONTEXT->last_error = CONTEXT->error_buffer;
} else
STAP_RETVALUE[len - 1] = '\0';
%}
%)
/**
* 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)
* @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_n:string (addr:long, n:long, err_msg:string)
%{ /* pure */ /* myproc-unprivileged */ /* unmodified-fnargs */
int64_t len = clamp_t(int64_t, STAP_ARG_n + 1, 1, MAXSTRINGLEN);
if (_stp_strncpy_from_user(STAP_RETVALUE,
(char __user *) (uintptr_t) STAP_ARG_addr, len) < 0)
strlcpy(STAP_RETVALUE, STAP_ARG_err_msg, MAXSTRINGLEN);
else
STAP_RETVALUE[len - 1] = '\0';
%}
%(systemtap_v <= "3.0" %?
function user_string_n2:string (addr:long, n:long, err_msg:string)
%{ /* pure */ /* myproc-unprivileged */ /* unmodified-fnargs */
int64_t len = clamp_t(int64_t, STAP_ARG_n + 1, 1, MAXSTRINGLEN);
if (_stp_strncpy_from_user(STAP_RETVALUE,
(char __user *) (uintptr_t) STAP_ARG_addr, len) < 0)
strlcpy(STAP_RETVALUE, STAP_ARG_err_msg, MAXSTRINGLEN);
else
STAP_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) {
%(systemtap_v < "2.3" %? // PR15044
return user_string_n_warn(addr, n, "<unknown>")
%:
return user_string_n_warn(addr, n, "")
%)
}
/**
* sfunction user_string_n_warn - Retrieves string from user space with alternative warning string
*
* @addr: the user space address to retrieve the string from
* @n: the maximum length of the string (if not null terminated)
* @warn_msg: the warning message to return when data isn't available
*
* Description: Returns up to n characters of a C string from a given
* user space memory address. Reports the given warning message 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, warn_msg:string)
%{ /* pure */ /* myproc-unprivileged */ /* unmodified-fnargs */
int64_t len = clamp_t(int64_t, STAP_ARG_n + 1, 1, MAXSTRINGLEN);
long rc;
rc = _stp_strncpy_from_user(STAP_RETVALUE,
(char __user *) (uintptr_t) STAP_ARG_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 [man error::fault]", rc,
(void *) (uintptr_t) STAP_ARG_addr);
_stp_warn(CONTEXT->error_buffer);
strlcpy (STAP_RETVALUE, STAP_ARG_warn_msg, MAXSTRINGLEN);
} else
STAP_RETVALUE[len - 1] = '\0';
%}
%(systemtap_v <= "3.0" %?
function user_string2_n_warn:string (addr:long, n:long, warn_msg:string)
%{ /* pure */ /* myproc-unprivileged */ /* unmodified-fnargs */
int64_t len = clamp_t(int64_t, STAP_ARG_n + 1, 1, MAXSTRINGLEN);
long rc;
rc = _stp_strncpy_from_user(STAP_RETVALUE,
(char __user *) (uintptr_t) STAP_ARG_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 [man error::fault]", rc,
(void *) (uintptr_t) STAP_ARG_addr);
_stp_warn(CONTEXT->error_buffer);
strlcpy (STAP_RETVALUE, STAP_ARG_warn_msg, MAXSTRINGLEN);
} else
STAP_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. Note that the string will be surrounded by double quotes.
* On the rare cases when userspace data is not accessible at the given address,
* the address itself is returned as a string, without double quotes.
*/
function user_string_n_quoted:string (addr:long, n:long) {
%(systemtap_v < "2.4" %?
// We used to count n by output characters
return user_string_n_quoted(addr, @MAXSTRINGLEN, n)
%:
return user_string_n_quoted(addr, n, @MAXSTRINGLEN)
%)
}
/**
* sfunction user_string_n_quoted - Retrieves and quotes string from user space
*
* @addr: the user space address to retrieve the string from
* @inlen: the maximum length of the string to read (if not null terminated)
* @outlen: the maximum length of the output string
*
* Description: Reads up to inlen characters of a C string from the given user
* space memory address, and returns up to outlen characters, where any ASCII
* characters that are not printable are replaced by the corresponding escape
* sequence in the returned string. Note that the string will be surrounded by
* double quotes. On the rare cases when userspace data is not accessible at
* the given address, the address itself is returned as a string, without
* double quotes.
*/
function user_string_n_quoted:string (addr:long, inlen:long, outlen:long)
%( systemtap_v >= "3.0" %?
{
try
{
__str = string_quoted(user_string_n(addr, inlen))
if (strlen(__str) > outlen-2) // room for the double-quotes plus \ldots
__str = (substr(__str,0,outlen-4) . "\"...")
return __str
}
catch
{
return sprintf("0x%x", addr)
}
}
%:
%{ /* pure */ /* myproc-unprivileged */
// Note the lack of STAP_ARG_n+1 as in other funcs() -- PR15617
int64_t inlen = clamp_t(int64_t, STAP_ARG_inlen, 0, MAXSTRINGLEN);
int64_t outlen = clamp_t(int64_t, STAP_ARG_outlen, 0, MAXSTRINGLEN);
if (STAP_ARG_addr == 0)
#if STAP_COMPAT_VERSION < STAP_VERSION(2,3) // PR15044
strlcpy(STAP_RETVALUE, "NULL", MAXSTRINGLEN);
#else
snprintf(STAP_RETVALUE, MAXSTRINGLEN, "%p", (void *)(long)STAP_ARG_addr);
#endif
else {
int rc = _stp_text_str(STAP_RETVALUE,
(char *)(uintptr_t)STAP_ARG_addr, inlen, outlen, 1, 1, 0);
if (rc < 0) {
#if STAP_COMPAT_VERSION < STAP_VERSION(2,3) // PR15044
strlcpy(STAP_RETVALUE, "<unknown>", MAXSTRINGLEN);
#else
#ifdef CONFIG_COMPAT
if (_stp_is_compat_task())
snprintf(STAP_RETVALUE, MAXSTRINGLEN, "%x",
(compat_long_t)STAP_ARG_addr);
else
#endif
snprintf(STAP_RETVALUE, MAXSTRINGLEN, "%p",
(void *)(long)STAP_ARG_addr);
#endif
}
}
%}
%)
%(systemtap_v <= "3.0" %?
function user_string_n2_quoted:string (addr:long, inlen:long, outlen:long)
%( systemtap_v >= "3.0" %?
{
try
{
__str = string_quoted(user_string_n(addr, inlen))
if (strlen(__str) > outlen-2) // room for the double-quotes plus \ldots
__str = (substr(__str,0,outlen-4) . "\"...")
return __str
}
catch
{
return sprintf("0x%x", addr)
}
}
%:
%{ /* pure */ /* myproc-unprivileged */
// Note the lack of STAP_ARG_n+1 as in other funcs() -- PR15617
int64_t inlen = clamp_t(int64_t, STAP_ARG_inlen, 0, MAXSTRINGLEN);
int64_t outlen = clamp_t(int64_t, STAP_ARG_outlen, 0, MAXSTRINGLEN);
if (STAP_ARG_addr == 0)
#if STAP_COMPAT_VERSION < STAP_VERSION(2,3) // PR15044
strlcpy(STAP_RETVALUE, "NULL", MAXSTRINGLEN);
#else
snprintf(STAP_RETVALUE, MAXSTRINGLEN, "%p", (void *)(long)STAP_ARG_addr);
#endif
else {
int rc = _stp_text_str(STAP_RETVALUE,
(char *)(uintptr_t)STAP_ARG_addr, inlen, outlen, 1, 1, 0);
if (rc < 0) {
#if STAP_COMPAT_VERSION < STAP_VERSION(2,3) // PR15044
strlcpy(STAP_RETVALUE, "<unknown>", MAXSTRINGLEN);
#else
#ifdef CONFIG_COMPAT
if (_stp_is_compat_task())
snprintf(STAP_RETVALUE, MAXSTRINGLEN, "%x",
(compat_long_t)STAP_ARG_addr);
else
#endif
snprintf(STAP_RETVALUE, MAXSTRINGLEN, "%p",
(void *)(long)STAP_ARG_addr);
#endif
}
}
%}
%)
%)
/**
* sfunction user_string_utf32 - Retrieves UTF-32 string from user memory
* @addr: The user address to retrieve the string from
*
* Description: This function returns a null terminated UTF-8 string converted
* from the UTF-32 string at a given user memory address. Reports an error on
* string copy fault or conversion error.
*/
function user_string_utf32:string (addr:long) %{ /* pure */ /* myproc-unprivileged */
int rc = 0, len = MAXSTRINGLEN;
uint32_t c32, *source = (uint32_t*)(intptr_t)STAP_ARG_addr;
char *destination = STAP_RETVALUE;
*destination = '\0';
while (len > 1 && (c32 = uread(source))) {
if ((rc = _stp_convert_utf32(destination, len, c32)) <= 0) {
if (rc < 0) {
snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
"invalid UTF-32 character U+%X at 0x%p", c32, source);
CONTEXT->last_error = CONTEXT->error_buffer;
}
break;
}
++source;
destination += rc;
len -= rc;
}
if (0) {
deref_fault: /* branched to from deref_string() */
snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
"user string copy fault at 0x%p [man error::fault]", source);
CONTEXT->last_error = CONTEXT->error_buffer;
}
%}
/**
* sfunction user_string_utf32 - Retrieves UTF-32 string from user memory with alternative error string
* @addr: The user address to retrieve the string from
* @err_msg: The error message to return when data isn't available
*
* Description: This function returns a null terminated UTF-8 string converted
* from the UTF-32 string at a given user memory address. Reports the given
* error message on string copy fault or conversion error.
*/
function user_string_utf32:string (addr:long, err_msg:string) {
try { return user_string_utf32(addr) } catch { return err_msg }
}
%(systemtap_v <= "3.0" %?
function user_string2_utf32:string (addr:long, err_msg:string) {
try { return user_string_utf32(addr) } catch { return err_msg }
}
%)
/**
* sfunction user_string_quoted_utf32 - Quote given user UTF-32 string.
* @addr: The user address to retrieve the string from
*
* Description: This function combines quoting as per @string_quoted
* and UTF-32 decoding as per @user_string_utf32.
*/
function user_string_quoted_utf32:string (addr:long) {
try { return string_quoted(user_string_utf32(addr)) } catch { return sprintf("0x%x", addr) }
}
/**
* sfunction user_string_utf16 - Retrieves UTF-16 string from user memory
* @addr: The user address to retrieve the string from
*
* Description: This function returns a null terminated UTF-8 string converted
* from the UTF-16 string at a given user memory address. Reports an error on
* string copy fault or conversion error.
*/
function user_string_utf16:string (addr:long) %{ /* pure */ /* myproc-unprivileged */
int rc = 0, len = MAXSTRINGLEN;
uint32_t c32;
uint16_t c16low, *source = (uint16_t*)(intptr_t)STAP_ARG_addr;
char *destination = STAP_RETVALUE;
*destination = '\0';
while (len > 1 && (c32 = uread(source))) {
/* Check for a UTF-16 high surrogate, then its low pair, and combine them.
* Broken surrogates will just fall through to _stp_convert_utf32 and get
* flagged as an error there. (Or even allowed, if we decide to be lax.)
*/
if (c32 >= 0xD800 && c32 <= 0xDBFF) {
++source;
c16low = uread(source);
if (c16low >= 0xDC00 && c16low <= 0xDFFF)
c32 = 0x10000 + ((c32 & 0x3FF) << 10) + (c16low & 0x3FF);
else
--source;
}
if ((rc = _stp_convert_utf32(destination, len, c32)) <= 0) {
if (rc < 0) {
snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
"invalid UTF-16 character U+%X at 0x%p", c32, source);
CONTEXT->last_error = CONTEXT->error_buffer;
}
break;
}
++source;
destination += rc;
len -= rc;
}
if (0) {
deref_fault: /* branched to from deref_string() */
snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
"user string copy fault at 0x%p [man error::fault]", source);
CONTEXT->last_error = CONTEXT->error_buffer;
}
%}
/**
* sfunction user_string_utf16 - Retrieves UTF-16 string from user memory with alternative error string
* @addr: The user address to retrieve the string from
* @err_msg: The error message to return when data isn't available
*
* Description: This function returns a null terminated UTF-8 string converted
* from the UTF-16 string at a given user memory address. Reports the given
* error message on string copy fault or conversion error.
*/
function user_string_utf16:string (addr:long, err_msg:string) {
try { return user_string_utf16(addr) } catch { return err_msg }
}
%(systemtap_v <= "3.0" %?
function user_string2_utf16:string (addr:long, err_msg:string) {
try { return user_string_utf16(addr) } catch { return err_msg }
}
%)
/**
* sfunction user_string_quoted_utf16 - Quote given user UTF-16 string.
* @addr: The user address to retrieve the string from
*
* Description: This function combines quoting as per @string_quoted
* and UTF-16 decoding as per @user_string_utf16.
*/
function user_string_quoted_utf16:string (addr:long) {
try { return string_quoted(user_string_utf16(addr)) } catch { return sprintf("0x%x", addr) }
}
/**
* sfunction user_char_error - 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.
* If the user space data is not accessible, an error will occur.
*/
function user_char_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(char);
CATCH_DEREF_FAULT();
%}
/**
* 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) {
try { return user_char_error(addr) } catch { return 0 }
}
/**
* 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 data is not accessible and
* warns about the failure (but does not error).
*/
function user_char_warn:long (addr:long) {
try {
return user_char_error(addr)
} catch {
warn(sprintf("user char copy fault %p [man error::fault]",
addr))
return 0
}
}
/**
* sfunction user_short_error - 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.
* If the user space data is not accessible, an error will occur.
*/
function user_short_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(short);
CATCH_DEREF_FAULT();
%}
/**
* 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) {
try { return user_short_error(addr) } catch { return 0 }
}
/**
* 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 data is not accessible and
* warns about the failure (but does not error).
*/
function user_short_warn:long (addr:long) {
try {
return user_short_error(addr)
} catch {
warn(sprintf("user short copy fault %p [man error::fault]",
addr))
return 0
}
}
/**
* sfunction user_ushort_error - 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. If the user space data is not accessible, an error
* will occur.
*/
function user_ushort_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(unsigned short);
CATCH_DEREF_FAULT();
%}
/**
* 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)
{
try { return user_ushort_error(addr) } catch { return 0 }
}
/**
* 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 data is not accessible
* and warns about the failure (but does not error).
*/
function user_ushort_warn:long (addr:long)
{
try {
return user_ushort_error(addr)
} catch {
warn(sprintf("user unsigned short copy fault %p [man error::fault]",
addr))
return 0
}
}
/**
* sfunction user_int_error - 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.
* If the user space data is not accessible, an error will occur.
*/
function user_int_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(int);
CATCH_DEREF_FAULT();
%}
/**
* 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)
{
try { return user_int_error(addr) } catch { return 0 }
}
/**
* 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 data is not accessible and warns about
* the failure (but does not error).
*/
function user_int_warn:long (addr:long)
{
try {
return user_int_error(addr)
} catch {
warn(sprintf("user int copy fault %p [man error::fault]",
addr))
return 0
}
}
/**
* sfunction user_long_error - 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. If the user space data is not accessible, an error will
* occur. 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_error: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);
CATCH_DEREF_FAULT();
%}
/**
* 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) {
try { return user_long_error(addr) } catch { return 0 }
}
/**
* 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 data is not accessible and
* warns about the failure (but does not error). 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) {
try {
return user_long_error(addr)
} catch {
warn(sprintf("user long copy fault %p [man error::fault]",
addr))
return 0
}
}
/**
* sfunction user_ulong_error - Retrieves a unsigned long value stored in user space
*
* @addr: the user space address to retrieve the unsigned long from
*
* Description: Returns the unsigned long value from a given user space
* address. If the user space data is not accessible, an error will
* occur. Note that the size of the unsigned long depends on the architecture
* of the current user space task (for those architectures that
* support both 64/32 bit compat tasks).
*/
function user_ulong_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
#ifdef CONFIG_COMPAT
if (_stp_is_compat_task())
STP_GET_USER(compat_ulong_t);
else
#endif
STP_GET_USER(unsigned long);
CATCH_DEREF_FAULT();
%}
/**
* sfunction user_ulong - Retrieves an unsigned long value stored in user space
*
* @addr: the user space address to retrieve the unsigned long from
*
* Description: Returns the unsigned long value from a given user
* space address. Returns zero when user space data is not
* accessible. Note that the size of the unsigned long depends on the
* architecture of the current user space task (for those
* architectures that support both 64/32 bit compat tasks).
*/
function user_ulong:long (addr:long) {
try { return user_ulong_error(addr) } catch { return 0 }
}
/**
* sfunction user_ulong_warn - Retrieves an unsigned long value stored in user space
*
* @addr: the user space address to retrieve the unsigned long from
*
* Description: Returns the unsigned long value from a given user
* space address. Returns zero when user space data is not accessible
* and warns about the failure (but does not error). Note that the
* size of the unsigned long depends on the architecture of the
* current user space task (for those architectures that support both
* 64/32 bit compat tasks).
*/
function user_ulong_warn:long (addr:long) {
try {
return user_ulong_error(addr)
} catch {
warn(sprintf("user unsigned long copy fault %p [man error::fault]",
addr))
return 0
}
}
/**
* sfunction user_int8_error - 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. If the user space data is not accessible, an error
* will occur.
*/
function user_int8_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(int8_t);
CATCH_DEREF_FAULT();
%}
/**
* 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) {
try { return user_int8_error(addr) } catch { return 0 }
}
/**
* sfunction user_uint8_error - Retrieves a 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. If the user space data is not accessible, an
* error will occur.
*/
function user_uint8_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(uint8_t);
CATCH_DEREF_FAULT();
%}
/**
* sfunction user_uint8 - Retrieves a 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) {
try { return user_uint8_error(addr) } catch { return 0 }
}
/**
* sfunction user_int16_error - 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. If the user space data is not accessible, an error
* will occur.
*/
function user_int16_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(int16_t);
CATCH_DEREF_FAULT();
%}
/**
* 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) {
try { return user_int16_error(addr) } catch { return 0 }
}
/**
* sfunction user_uint16_error - 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. If the user space data is not accessible, an error
* will occur.
*/
function user_uint16_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(uint16_t);
CATCH_DEREF_FAULT();
%}
/**
* 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) {
try { return user_uint16_error(addr) } catch { return 0 }
}
/**
* sfunction user_int32_error - 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. If the user space data is not accessible, an error
* will occur.
*/
function user_int32_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(int32_t);
CATCH_DEREF_FAULT();
%}
/**
* 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) {
try { return user_int32_error(addr) } catch { return 0 }
}
/**
* sfunction user_uint32_error - 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. If the user space data is not accessible, an
* error will occur.
*/
function user_uint32_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(uint32_t);
CATCH_DEREF_FAULT();
%}
/**
* 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) {
try { return user_uint32_error(addr) } catch { return 0 }
}
/**
* sfunction user_int64_error - 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. If the user space data is not accessible, an error
* will occur.
*/
function user_int64_error:long (addr:long) %{ /* pure */ /* myproc-unprivileged */
STP_GET_USER(int64_t);
CATCH_DEREF_FAULT();
%}
/**
* 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) {
try { return user_int64_error(addr) } catch { return 0 }
}
/**
* sfunction user_uint64_error - 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. If the user space data is not accessible, an
* error will occur.
*/
function user_uint64_error:long (addr:long) {
/* NB: We have no script-level notion of 64-bit unsigned, but
* we keep user_uint64_error anyway for API completeness. */
return user_int64_error(addr)
}
/**
* 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)
}
/**
* sfunction user_buffer_quoted - Retrieves and quotes buffer from user space
*
* @addr: the user space address to retrieve the buffer from
* @inlen: the exact length of the buffer to read
* @outlen: the maximum length of the output string
*
* Description: Reads inlen characters of a buffer from the given user space
* memory address, and returns up to outlen characters, where any ASCII
* characters that are not printable are replaced by the corresponding escape
* sequence in the returned string. Note that the string will be surrounded by
* double quotes. On the rare cases when user space data is not accessible at
* the given address, the address itself is returned as a string, without
* double quotes.
*/
function user_buffer_quoted:string (addr:long, inlen:long, outlen:long)
%{
size_t outlen = (size_t)clamp_t(int, STAP_ARG_outlen, 0, MAXSTRINGLEN);
if (outlen == 0)
return;
if ( _stp_text_str(STAP_RETVALUE, (char *)(uintptr_t)STAP_ARG_addr,
STAP_ARG_inlen, outlen, 1, 1, 1) < 0)
snprintf(STAP_RETVALUE, outlen, "0x%lx",
(unsigned long)(void *)(uintptr_t)STAP_ARG_addr);
%}
/**
* sfunction user_buffer_quoted_error - Retrieves and quotes buffer from user space
*
* @addr: the user space address to retrieve the buffer from
* @inlen: the exact length of the buffer to read
* @outlen: the maximum length of the output string
*
* Description: Reads inlen characters of a buffer from the given user space
* memory address, and returns up to outlen characters, where any ASCII
* characters that are not printable are replaced by the corresponding escape
* sequence in the returned string. Note that the string will be surrounded by
* double quotes. On the rare cases when user space data is not accessible at
* the given address, an error is thrown.
*/
function user_buffer_quoted_error:string (addr:long, inlen:long, outlen:long)
%{
size_t outlen = (size_t)clamp_t(int, STAP_ARG_outlen, 0, MAXSTRINGLEN);
if (outlen == 0
|| _stp_text_str(STAP_RETVALUE,
(char *) (uintptr_t) STAP_ARG_addr,
STAP_ARG_inlen, outlen, 1, 1, 1) < 0)
STAP_ERROR("Unable to access user space data at 0x%lx",
(unsigned long)(void *)(uintptr_t)STAP_ARG_addr);
%}
|