summaryrefslogtreecommitdiffstats
path: root/tapset/conversions.stp
blob: 70725e9d327e244313354fecd6d8f410288f7f4a (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
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
// conversions tapset
// Copyright (C) 2005-2008 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.

function kernel_string:string (addr:long) %{ /* pure */
  char *destination = THIS->__retvalue;
  deref_string (destination, THIS->addr, MAXSTRINGLEN);
  if (0) {
deref_fault: /* branched to from deref_string() */
    snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
        "kernel string copy fault at 0x%p", (void *) (uintptr_t) THIS->addr);
    CONTEXT->last_error = CONTEXT->error_buffer;
  }
%}

function kernel_string_n:string (addr:long, n:long) %{ /* pure */
  char *destination = THIS->__retvalue;
  long len = THIS->n + 1;
  len = (len > MAXSTRINGLEN) ? MAXSTRINGLEN : len;
  deref_string (destination, THIS->addr, len);
  if (0) {
deref_fault: /* branched to from deref_string() */
    snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
        "kernel string copy fault at 0x%p", (void *) (uintptr_t) THIS->addr);
    CONTEXT->last_error = CONTEXT->error_buffer;
  }
%}

function kernel_long:long (addr:long) %{ /* pure */
  THIS->__retvalue = kread((long *) (intptr_t) THIS->addr);
  if (0) {
deref_fault: /* branched to from deref() */
    snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
        "kernel long copy fault at 0x%p", (void *) (uintptr_t) THIS->addr);
    CONTEXT->last_error = CONTEXT->error_buffer;
  }
%}

function kernel_int:long (addr:long) %{ /* pure */
  THIS->__retvalue = kread((int *) (intptr_t) THIS->addr);
  if (0) {
deref_fault: /* branched to from deref() */
    snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
        "kernel int copy fault at 0x%p", (void *) (uintptr_t) THIS->addr);
    CONTEXT->last_error = CONTEXT->error_buffer;
  }
%}

function kernel_short:long (addr:long) %{ /* pure */
  THIS->__retvalue = kread((short *) (intptr_t) THIS->addr);
  if (0) {
deref_fault: /* branched to from deref() */
    snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
        "kernel short copy fault at 0x%p", (void *) (uintptr_t) THIS->addr);
    CONTEXT->last_error = CONTEXT->error_buffer;
  }
%}

function kernel_char:long (addr:long) %{ /* pure */
  THIS->__retvalue = kread((char *) (intptr_t) THIS->addr);
  if (0) {
deref_fault: /* branched to from deref() */
    snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
        "kernel char copy fault at 0x%p", (void *) (uintptr_t) THIS->addr);
    CONTEXT->last_error = CONTEXT->error_buffer;
  }
%}




// On rare cases when userspace data is not accessible, 
// this function returns "<unknown>"

function user_string:string (addr:long) { return user_string2 (addr, "<unknown>") }

function user_string2:string (addr:long, err_msg:string) %{ /* pure */
  if (_stp_strncpy_from_user (THIS->__retvalue, 
        (const char __user*) (uintptr_t) THIS->addr,
        MAXSTRINGLEN) < 0)
    strlcpy (THIS->__retvalue, THIS->err_msg, MAXSTRINGLEN);
%}

function user_string_warn:string (addr:long) %{ /* pure */
  long 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);
  }
%}

function user_string_quoted:string (addr:long) %{ /* pure */
  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);
%}

function user_string_n:string (addr:long, n:long) {
	return user_string_n2(addr, n, "<unknown>")
}
	
function user_string_n2:string (addr:long, n:long, err_msg:string) %{ /* pure */
	long len = THIS->n + 1;
	len = (len > MAXSTRINGLEN) ? MAXSTRINGLEN : len;
	if (_stp_strncpy_from_user(THIS->__retvalue,
				(char __user *) (uintptr_t) THIS->addr,
				len) < 0)
		strlcpy(THIS->__retvalue, THIS->err_msg, MAXSTRINGLEN);
%}

function user_string_n_warn:string (addr:long, n:long) %{ /* pure */
	long len = THIS->n + 1;
	long rc;

	len = (len > MAXSTRINGLEN) ? MAXSTRINGLEN : len;
	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);
	}
%}

function user_string_n_quoted:string (addr:long, n:long) %{ /* pure */
	long len = THIS->n + 1;
	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);
%}

// When userspace data is not accessible, the following functions return 0

function user_short:long (addr:long) %{ /* pure */
	if (!access_ok(VERIFY_READ, (short *) (intptr_t) THIS->addr, sizeof(short)))
		goto fault;
	if (__stp_get_user(THIS->__retvalue, (short *) (intptr_t) THIS->addr)) {
fault:
		THIS->__retvalue = 0;
	}
%}

function user_short_warn:long (addr:long) %{ /* pure */
	if (!access_ok(VERIFY_READ, (short *) (intptr_t) THIS->addr, sizeof(short)))
		goto fault;
	if (__stp_get_user(THIS->__retvalue, (short *) (intptr_t) THIS->addr)) {
fault:
		snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
				"user short copy fault %p", (void *) (uintptr_t) THIS->addr);
		_stp_warn(CONTEXT->error_buffer);
		THIS->__retvalue = 0;
	}
%}

function user_int:long (addr:long) %{ /* pure */
	if (!access_ok(VERIFY_READ, (int *) (intptr_t) THIS->addr, sizeof(int)))
		goto fault;
	if (__stp_get_user(THIS->__retvalue, (int *) (intptr_t) THIS->addr)) {
fault:
		THIS->__retvalue = 0;
	}
%}

function user_int_warn:long (addr:long) %{ /* pure */
	if (!access_ok(VERIFY_READ, (int *) (intptr_t) THIS->addr, sizeof(int)))
		goto fault;
	if (__stp_get_user(THIS->__retvalue, (int *) (intptr_t) THIS->addr)) {
fault:
		snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
				"user int copy fault %p", (void *) (uintptr_t) THIS->addr);
		_stp_warn(CONTEXT->error_buffer);
		THIS->__retvalue = 0;
	}
%}

function user_long:long (addr:long) %{ /* pure */
	if (!access_ok(VERIFY_READ, (long *) (intptr_t) THIS->addr, sizeof(long)))
		goto fault;
	if (__stp_get_user(THIS->__retvalue, (long *) (intptr_t) THIS->addr)) {
fault:
		THIS->__retvalue = 0;
	}
%}

function user_long_warn:long (addr:long) %{ /* pure */
	if (!access_ok(VERIFY_READ, (long *) (intptr_t) THIS->addr, sizeof(long)))
		goto fault;
	if (__stp_get_user(THIS->__retvalue, (long *) (intptr_t) THIS->addr)) {
fault:
		snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
				"user long copy fault %p", (void *) (uintptr_t) THIS->addr);
		_stp_warn(CONTEXT->error_buffer);
		THIS->__retvalue = 0;
	}
%}

function user_char:long (addr:long) %{ /* pure */
	if (!access_ok(VERIFY_READ, (char *) (intptr_t) THIS->addr, sizeof(char)))
		goto fault;
	if (__stp_get_user(THIS->__retvalue, (char *) (intptr_t) THIS->addr)) {
fault:
		THIS->__retvalue = 0;
	}
%}

function user_char_warn:long (addr:long) %{ /* pure */
	if (!access_ok(VERIFY_READ, (char *) (intptr_t) THIS->addr, sizeof(char)))
		goto fault;
	if (__stp_get_user(THIS->__retvalue, (char *) (intptr_t) THIS->addr)) {
fault:
		snprintf (CONTEXT->error_buffer, sizeof(CONTEXT->error_buffer),
				"user char copy fault %p", (void *) (uintptr_t) THIS->addr);
		_stp_warn(CONTEXT->error_buffer);
		THIS->__retvalue = 0;
	}
%}