summaryrefslogtreecommitdiff
path: root/src/node.d
blob: fae2378437ead9653d0b0d627f4bfd169f0a8afe (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
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
/* Copyright Joyent, Inc. and other Node contributors.
 *
 * 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 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.
 */

/*
 * This is the DTrace library file for the node provider, which includes
 * the necessary translators to get from the args[] to something useful.
 * Be warned:  the mechanics here are seriously ugly -- and one must always
 * keep in mind that clean abstractions often require filthy systems.
 */
#pragma D depends_on library procfs.d

typedef struct {
	int32_t fd;
	int32_t port;
	uint32_t remote;
	uint32_t buffered;
} node_dtrace_connection_t;

typedef struct {
	int32_t fd;
	int32_t port;
	uint64_t remote;
	uint32_t buffered;
} node_dtrace_connection64_t;

typedef struct {
	int fd;
	string remoteAddress;
	int remotePort;
	int bufferSize;
} node_connection_t;

translator node_connection_t <node_dtrace_connection_t *nc> {
	fd = *(int32_t *)copyin((uintptr_t)&nc->fd, sizeof (int32_t));
	remotePort =
	    *(int32_t *)copyin((uintptr_t)&nc->port, sizeof (int32_t));
	remoteAddress = curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
	    copyinstr((uintptr_t)*(uint32_t *)copyin((uintptr_t)&nc->remote,
	    sizeof (int32_t))) :
	    copyinstr((uintptr_t)*(uint64_t *)copyin((uintptr_t)
	    &((node_dtrace_connection64_t *)nc)->remote, sizeof (int64_t)));
	bufferSize = curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
	    *(uint32_t *)copyin((uintptr_t)&nc->buffered, sizeof (int32_t)) :
	    *(uint32_t *)copyin((uintptr_t)
	    &((node_dtrace_connection64_t *)nc)->buffered, sizeof (int32_t));
};

/*
 * 32-bit and 64-bit structures received from node for HTTP client request
 * probe.
 */
typedef struct {
	uint32_t url;
	uint32_t method;
} node_dtrace_http_client_request_t;

typedef struct {
	uint64_t url;
	uint64_t method;
} node_dtrace_http_client_request64_t;

/*
 * The following structures are never used directly, but must exist to bind the
 * types specified in the provider to the translators defined here.
 * Ultimately, they always get cast to a more specific type inside the
 * translator.  To add to the confusion, the DTrace compiler does not allow
 * declaring two translators with the same destination type if the source types
 * are structures with the same size (because libctf says they're compatible,
 * so dtrace considers them equivalent).  Since we must define translators from
 * node_dtrace_http_client_request_t (above), node_dtrace_http_request_t, and
 * node_dtrace_http_server_request_t (both below), each of these three structs
 * must be declared with a different size.
 */
typedef struct {
	uint32_t version;
	uint64_t dummy1;
} node_dtrace_http_request_t;

typedef struct {
	uint32_t version;
	uint64_t dummy2;
	uint64_t dummy3;
} node_dtrace_http_server_request_t;

/*
 * Actual 32-bit and 64-bit, v0 and v1 structures received from node for the
 * HTTP server request probe.
 */
typedef struct {
	uint32_t url;
	uint32_t method;
} node_dtrace_http_server_request_v0_t;

typedef struct {
	uint32_t version;
	uint32_t url;
	uint32_t method;
	uint32_t forwardedFor;
} node_dtrace_http_server_request_v1_t;

typedef struct {
	uint64_t url;
	uint64_t method;
} node_dtrace_http_server_request64_v0_t;

typedef struct {
	uint32_t version;
	uint32_t pad;
	uint64_t url;
	uint64_t method;
	uint64_t forwardedFor;
} node_dtrace_http_server_request64_v1_t;

/*
 * In the end, both client and server request probes from both old and new
 * binaries translate their arguments to node_http_request_t, which is what the
 * user's D script ultimately sees.
 */
typedef struct {
	string url;
	string method;
	string forwardedFor;
} node_http_request_t;

/*
 * The following translators are particularly filthy for reasons of backwards
 * compatibility.  Stable versions of node prior to 0.6 used a single
 * http_request struct with fields for "url" and "method" for both client and
 * server probes.  0.6 added a "forwardedFor" field intended for the server
 * probe only, and the http_request struct passed by the application was split
 * first into client_http_request and server_http_request and the latter was
 * again split for v0 (the old struct) and v1.
 *
 * To distinguish the binary representations of the two versions of these
 * structs, the new version prepends a "version" member (where the old one has
 * a "url" pointer).  Each field that we're translating below first switches on
 * the value of this "version" field: if it's larger than 4096, we know we must
 * be looking at the "url" pointer of the older structure version.  Otherwise,
 * we must be looking at the new version.  Besides this, we have the usual
 * switch based on the userland process data model.  This would all be simpler
 * with macros, but those aren't available in D library files since we cannot
 * rely on cpp being present at runtime.
 *
 * In retrospect, the versioning bit might have been unnecessary since the type
 * of the object passed in should allow DTrace to select which translator to
 * use.  However, DTrace does sometimes use translators whose source types
 * don't quite match, and since we know this versioning logic works, we just
 * leave it alone.  Each of the translators below is functionally identical
 * (except that the client -> client translator doesn't bother translating
 * forwardedFor) and should actually work with any version of any of the client
 * or server structs transmitted by the application up to this point.
 */

/*
 * Translate from node_dtrace_http_server_request_t (received from node 0.6 and
 * later versions) to node_http_request_t.
 */
translator node_http_request_t <node_dtrace_http_server_request_t *nd> {
	url = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd,
		sizeof (uint32_t))) >= 4096 ?
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v0_t *)nd)->url,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v0_t *)nd)->url,
		    sizeof (uint64_t)))) :
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v1_t *)nd)->url,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v1_t *)nd)->url,
		    sizeof (uint64_t))));

	method = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd,
		sizeof (uint32_t))) >= 4096 ?
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v0_t *)nd)->method,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v0_t *)nd)->method,
		    sizeof (uint64_t)))) :
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v1_t *)nd)->method,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v1_t *)nd)->method,
		    sizeof (uint64_t))));

	forwardedFor = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd,
		sizeof (uint32_t))) >= 4096 ? "" :
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v1_t *)nd)->forwardedFor,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v1_t *)nd)->
		    forwardedFor, sizeof (uint64_t))));
};

/*
 * Translate from node_dtrace_http_client_request_t (received from node 0.6 and
 * later versions) to node_http_request_t.
 */
translator node_http_request_t <node_dtrace_http_client_request_t *nd> {
	url = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd,
		sizeof (uint32_t))) >= 4096 ?
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v0_t *)nd)->url,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v0_t *)nd)->url,
		    sizeof (uint64_t)))) :
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v1_t *)nd)->url,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v1_t *)nd)->url,
		    sizeof (uint64_t))));

	method = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd,
		sizeof (uint32_t))) >= 4096 ?
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v0_t *)nd)->method,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v0_t *)nd)->method,
		    sizeof (uint64_t)))) :
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v1_t *)nd)->method,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v1_t *)nd)->method,
		    sizeof (uint64_t))));

	forwardedFor = "";
};

/*
 * Translate from node_dtrace_http_request_t (received from versions of node
 * prior to 0.6) to node_http_request_t.  This is used for both the server and
 * client probes since these versions of node didn't distinguish between the
 * types used in these probes.
 */
translator node_http_request_t <node_dtrace_http_request_t *nd> {
	url = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd,
		sizeof (uint32_t))) >= 4096 ?
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v0_t *)nd)->url,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v0_t *)nd)->url,
		    sizeof (uint64_t)))) :
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v1_t *)nd)->url,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v1_t *)nd)->url,
		    sizeof (uint64_t))));

	method = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd,
		sizeof (uint32_t))) >= 4096 ?
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v0_t *)nd)->method,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v0_t *)nd)->method,
		    sizeof (uint64_t)))) :
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v1_t *)nd)->method,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v1_t *)nd)->method,
		    sizeof (uint64_t))));

	forwardedFor = (*(uint32_t *) copyin((uintptr_t)(uint32_t *)nd,
		sizeof (uint32_t))) >= 4096 ? "" :
	    (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ?
		copyinstr(*(uint32_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request_v1_t *)nd)->forwardedFor,
		    sizeof (uint32_t))) :
		copyinstr(*(uint64_t *)copyin((uintptr_t)
		    &((node_dtrace_http_server_request64_v1_t *)nd)->
		    forwardedFor, sizeof (uint64_t))));
};