aboutsummaryrefslogtreecommitdiffstats
path: root/packet-nlm.c
blob: b9d204d2a90c4de8a303f4ebec0fef878cca690f (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
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
/* packet-nlm.c
 * Routines for nlm dissection
 *
 * $Id: packet-nlm.c,v 1.9 2000/08/14 11:36:02 girlich Exp $
 *
 * Ethereal - Network traffic analyzer
 * By Gerald Combs <gerald@zing.org>
 * Copyright 1998 Gerald Combs
 *
 * Copied from packet-mount.c
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */


#ifdef HAVE_CONFIG_H
#include "config.h"
#endif


#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif


#include "packet-rpc.h"
#include "packet-nfs.h"
#include "packet-nlm.h"

/*
 * NFS Lock Manager protocol specs can only be found in actual
 * implementations or in the nice book:
 * Brent Callaghan: "NFS Illustrated", Addison-Wesley, ISBN 0-201-32570-5
 * which I use here as reference (BC).
 */

static int proto_nlm = -1;

static int hf_nlm_cookie = -1;
static int hf_nlm_block = -1;
static int hf_nlm_exclusive = -1;
static int hf_nlm_lock = -1;
static int hf_nlm_lock_caller_name = -1;
static int hf_nlm_lock_owner = -1;
static int hf_nlm_lock_svid = -1;
static int hf_nlm_lock_l_offset = -1;
static int hf_nlm_lock_l_len = -1;
static int hf_nlm_reclaim = -1;
static int hf_nlm_state = -1;

static gint ett_nlm = -1;
static gint ett_nlm_lock = -1;


const value_string names_nlm_state[] =
{
	/* NLM_GRANTED is the function number 5 and the state code 0.
	 * So we use for the state the postfix _S.
	 */
#define NLM_GRANTED_S		0
		{	NLM_GRANTED_S,	"NLM_GRANTED"	},
#define NLM_DENIED		1
		{	NLM_DENIED,	"NLM_DENIED"	},
#define NLM_DENIED_NOLOCKS	2
		{	NLM_DENIED_NOLOCKS,	"NLM_DENIED_NOLOCKS"	},
#define NLM_BLOCKED		3
		{	NLM_BLOCKED,	"NLM_BLOCKED"		},
#define NLM_DENIED_GRACE_PERIOD	4
		{	NLM_DENIED_GRACE_PERIOD,	"NLM_DENIED_GRACE_PERIOD"	},
#define NLM_DEADLCK		5
		{	NLM_DEADLCK,	"NLM_DEADLCK"	},
#define NLM_ROFS		6
		{	NLM_ROFS,	"NLM_ROFS"	},
#define NLM_STALE_FH		7
		{	NLM_STALE_FH,	"NLM_STALE_FH"	},
#define NLM_BIG			8
		{	NLM_BIG,	"NLM_BIG"	},
#define NLM_FAILED		9
		{	NLM_FAILED,	"NLM_FAILED"	},
		{	0,		NULL		}
};


/* generic dissecting functions */

static int
dissect_nlm_lock(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int version, int offset)
{
	proto_item* lock_item = NULL;
	proto_tree* lock_tree = NULL;
	const guint8 *pd;
	int compat_offset;

	tvb_compat(tvb, &pd, &compat_offset);

	if (tree) {
		lock_item = proto_tree_add_item(tree, hf_nlm_lock, tvb,
				offset, tvb_length_remaining(tvb, offset), FALSE);
		if (lock_item)
			lock_tree = proto_item_add_subtree(lock_item, ett_nlm_lock);
	}

	offset = dissect_rpc_string_tvb(tvb,pinfo,lock_tree,
			hf_nlm_lock_caller_name, offset, NULL);
	offset = dissect_nfs_fh3(pd, compat_offset+offset, pinfo->fd, lock_tree,"fh") - compat_offset;

	offset = dissect_rpc_data_tvb(tvb, pinfo, lock_tree, hf_nlm_lock_owner, offset);

	offset = dissect_rpc_uint32_tvb(tvb, pinfo, lock_tree, hf_nlm_lock_svid, offset);

	if (version == 4) {
		offset = dissect_rpc_uint64_tvb(tvb, pinfo, lock_tree, hf_nlm_lock_l_offset, offset);
		offset = dissect_rpc_uint64_tvb(tvb, pinfo, lock_tree, hf_nlm_lock_l_len, offset);
	}
	else {
		offset = dissect_rpc_uint32_tvb(tvb, pinfo, lock_tree, hf_nlm_lock_l_offset, offset);
		offset = dissect_rpc_uint32_tvb(tvb, pinfo, lock_tree, hf_nlm_lock_l_len, offset);
	}

	return offset;
}


/* RPC functions */

#if 0
static int
dissect_nlm1_lock_call(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
{
#else
int
dissect_nlm1_lock_call(const u_char* pd, int offset, frame_data* fd, proto_tree* tree)
{
	tvbuff_t *tvb = tvb_create_from_top(offset);
	packet_info *pinfo = &pi;
#endif
	int noffset;

	noffset = dissect_rpc_data_tvb(tvb, pinfo, tree, hf_nlm_cookie, 0);
	noffset = dissect_rpc_bool_tvb(tvb, pinfo, tree, hf_nlm_block, noffset);
	noffset = dissect_rpc_bool_tvb(tvb, pinfo, tree, hf_nlm_exclusive, noffset);
	noffset = dissect_nlm_lock(tvb, pinfo, tree, 1, noffset);
	noffset = dissect_rpc_bool_tvb(tvb, pinfo, tree, hf_nlm_reclaim, noffset);
	noffset = dissect_rpc_uint32_tvb(tvb, pinfo, tree, hf_nlm_state, noffset);
	return tvb_raw_offset(tvb) + noffset;
}


#if 0
static int
dissect_nlm1_unlock_call(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
{
#else
int
dissect_nlm1_unlock_call(const u_char* pd, int offset, frame_data* fd, proto_tree* tree)
{
	tvbuff_t *tvb = tvb_create_from_top(offset);
	packet_info *pinfo = &pi;
#endif
	int noffset;

	noffset = dissect_rpc_data_tvb(tvb, pinfo, tree, hf_nlm_cookie, 0);
	noffset = dissect_nlm_lock(tvb, pinfo, tree, 1, noffset);
	return tvb_raw_offset(tvb) + noffset;
}


#if 0
static int
dissect_nlm1_gen_reply(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
{
#else
int
dissect_nlm1_gen_reply(const u_char* pd, int offset, frame_data* fd, proto_tree* tree)
{
	tvbuff_t *tvb = tvb_create_from_top(offset);
	packet_info *pinfo = &pi;
#endif
	int noffset;

	noffset = dissect_rpc_data_tvb(tvb, pinfo, tree, hf_nlm_cookie, 0);
	noffset = dissect_rpc_uint32_tvb(tvb, pinfo, tree, hf_nlm_state, noffset);
	return tvb_raw_offset(tvb) + noffset;
}


/* proc number, "proc name", dissect_request, dissect_reply */
/* NULL as function pointer means: take the generic one. */
/* NLM protocol version 1 */
const vsff nlm1_proc[] = {
	{ NLM_NULL,		"NULL",		/* OK */
	NULL,				NULL },
	{ NLM_TEST,		"TEST",
	NULL,				NULL },
	{ NLM_LOCK,		"LOCK",		/* OK */
	dissect_nlm1_lock_call,		dissect_nlm1_gen_reply },
	{ NLM_CANCEL,		"CANCEL",
	NULL,				dissect_nlm1_gen_reply },
	{ NLM_UNLOCK,		"UNLOCK",	/* OK */
	dissect_nlm1_unlock_call,	dissect_nlm1_gen_reply },
	{ NLM_GRANTED,		"GRANTED",
	NULL,				NULL },
	{ NLM_TEST_MSG,		"TEST_MSG",
	NULL,				NULL },
	{ NLM_LOCK_MSG,		"LOCK_MSG",	/* OK */
	dissect_nlm1_lock_call,		NULL },
	{ NLM_CANCEL_MSG,	"CANCEL_MSG",
	NULL,				NULL },
	{ NLM_UNLOCK_MSG,	"UNLOCK_MSG",	/* OK */
	dissect_nlm1_unlock_call,	NULL },
	{ NLM_GRANTED_MSG,	"GRANTED_MSG",
	NULL,				dissect_nlm1_gen_reply },
	{ NLM_TEST_RES,		"TEST_RES",
	NULL,				NULL },
	{ NLM_LOCK_RES,		"LOCK_RES",	/* OK */
	dissect_nlm1_gen_reply,		NULL },
	{ NLM_CANCEL_RES,	"CANCEL_RES",	/* OK */
	dissect_nlm1_gen_reply,		NULL },
	{ NLM_UNLOCK_RES,	"UNLOCK_RES",	/* OK */
	dissect_nlm1_gen_reply,		NULL },
	{ NLM_GRANTED_RES,	"GRANTED_RES",	/* OK */
	dissect_nlm1_gen_reply,		NULL },
	{ 0,			NULL,		NULL,	NULL }
};
/* end of NLM protocol version 1 */

/* NLM protocol version 2 */
const vsff nlm2_proc[] = {
	{ NLM_NULL,		"NULL",		NULL,	NULL },
	{ NLM_TEST,		"TEST",		NULL,	NULL },
	{ NLM_LOCK,		"LOCK",		NULL,	NULL },
	{ NLM_CANCEL,		"CANCEL",	NULL,	NULL },
	{ NLM_UNLOCK,		"UNLOCK",	NULL,	NULL },
	{ NLM_GRANTED,		"GRANTED",	NULL,	NULL },
	{ NLM_TEST_MSG,		"TEST_MSG",	NULL,	NULL },
	{ NLM_LOCK_MSG,		"LOCK_MSG",	NULL,	NULL },
	{ NLM_CANCEL_MSG,	"CANCEL_MSG",	NULL,	NULL },
	{ NLM_UNLOCK_MSG,	"UNLOCK_MSG",	NULL,	NULL },
	{ NLM_GRANTED_MSG,	"GRANTED_MSG",	NULL,	NULL },
	{ NLM_TEST_RES,		"TEST_RES",	NULL,	NULL },
	{ NLM_LOCK_RES,		"LOCK_RES",	NULL,	NULL },
	{ NLM_CANCEL_RES,	"CANCEL_RES",	NULL,	NULL },
	{ NLM_UNLOCK_RES,	"UNLOCK_RES",	NULL,	NULL },
	{ NLM_GRANTED_RES,	"GRANTED_RES",	NULL,	NULL },
	{ 0,			NULL,		NULL,	NULL }
};
/* end of NLM protocol version 2 */

/* NLM protocol version 3 */
const vsff nlm3_proc[] = {
	{ NLM_NULL,		"NULL",		NULL,	NULL },
	{ NLM_TEST,		"TEST",		NULL,	NULL },
	{ NLM_LOCK,		"LOCK",		NULL,	NULL },
	{ NLM_CANCEL,		"CANCEL",	NULL,	NULL },
	{ NLM_UNLOCK,		"UNLOCK",	NULL,	NULL },
	{ NLM_GRANTED,		"GRANTED",	NULL,	NULL },
	{ NLM_TEST_MSG,		"TEST_MSG",	NULL,	NULL },
	{ NLM_LOCK_MSG,		"LOCK_MSG",	NULL,	NULL },
	{ NLM_CANCEL_MSG,	"CANCEL_MSG",	NULL,	NULL },
	{ NLM_UNLOCK_MSG,	"UNLOCK_MSG",	NULL,	NULL },
	{ NLM_GRANTED_MSG,	"GRANTED_MSG",	NULL,	NULL },
	{ NLM_TEST_RES,		"TEST_RES",	NULL,	NULL },
	{ NLM_LOCK_RES,		"LOCK_RES",	NULL,	NULL },
	{ NLM_CANCEL_RES,	"CANCEL_RES",	NULL,	NULL },
	{ NLM_UNLOCK_RES,	"UNLOCK_RES",	NULL,	NULL },
	{ NLM_GRANTED_RES,	"GRANTED_RES",	NULL,	NULL },
	{ NLM_SHARE,		"SHARE",	NULL,	NULL },
	{ NLM_UNSHARE,		"UNSHARE",	NULL,	NULL },
	{ NLM_NM_LOCK,		"NM_LOCK",	NULL,	NULL },
	{ NLM_FREE_ALL,		"FREE_ALL",	NULL,	NULL },
	{ 0,			NULL,		NULL,	NULL }
};
/* end of NLM protocol version 3 */


#if 0
static int
dissect_nlm4_test_call(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
{
#else
int
dissect_nlm4_test_call(const u_char* pd, int offset, frame_data* fd, proto_tree* tree)
{
	tvbuff_t *tvb = tvb_create_from_top(offset);
	packet_info *pinfo = &pi;
#endif
	int noffset;

	noffset = dissect_rpc_data_tvb(tvb, pinfo, tree, hf_nlm_cookie, 0);
	dissect_rpc_bool_tvb(tvb, pinfo, tree, hf_nlm_exclusive, noffset);
	noffset += 4;
	noffset = dissect_nlm_lock(tvb, pinfo, tree, 4, noffset);

	return tvb_raw_offset(tvb) + noffset;
}


/* NLM protocol version 4 */
const vsff nlm4_proc[] = {
	{ NLM_NULL,		"NULL",		NULL,	NULL },
	{ NLM_TEST,		"TEST",		dissect_nlm4_test_call,	NULL },
	{ NLM_LOCK,		"LOCK",		NULL,	NULL },
	{ NLM_CANCEL,		"CANCEL",	NULL,	NULL },
	{ NLM_UNLOCK,		"UNLOCK",	NULL,	NULL },
	{ NLM_GRANTED,		"GRANTED",	NULL,	NULL },
	{ NLM_TEST_MSG,		"TEST_MSG",	NULL,	NULL },
	{ NLM_LOCK_MSG,		"LOCK_MSG",	NULL,	NULL },
	{ NLM_CANCEL_MSG,	"CANCEL_MSG",	NULL,	NULL },
	{ NLM_UNLOCK_MSG,	"UNLOCK_MSG",	NULL,	NULL },
	{ NLM_GRANTED_MSG,	"GRANTED_MSG",	NULL,	NULL },
	{ NLM_TEST_RES,		"TEST_RES",	NULL,	NULL },
	{ NLM_LOCK_RES,		"LOCK_RES",	NULL,	NULL },
	{ NLM_CANCEL_RES,	"CANCEL_RES",	NULL,	NULL },
	{ NLM_UNLOCK_RES,	"UNLOCK_RES",	NULL,	NULL },
	{ NLM_GRANTED_RES,	"GRANTED_RES",	NULL,	NULL },
	{ NLM_SHARE,		"SHARE",	NULL,	NULL },
	{ NLM_UNSHARE,		"UNSHARE",	NULL,	NULL },
	{ NLM_NM_LOCK,		"NM_LOCK",	NULL,	NULL },
	{ NLM_FREE_ALL,		"FREE_ALL",	NULL,	NULL },
	{ 0,			NULL,		NULL,	NULL }
};
/* end of NLM protocol version 4 */


static struct true_false_string yesno = { "Yes", "No" };


void
proto_register_nlm(void)
{
	static hf_register_info hf[] = {
		{ &hf_nlm_cookie, {
			"cookie", "nlm.cookie", FT_STRING, BASE_DEC,
			NULL, 0, "cookie" }},
		{ &hf_nlm_block, {
			"block", "nlm.block", FT_BOOLEAN, BASE_NONE,
			&yesno, 0, "block" }},
		{ &hf_nlm_exclusive, {
			"exclusive", "nlm.exclusive", FT_BOOLEAN, BASE_NONE,
			&yesno, 0, "exclusive" }},
		{ &hf_nlm_lock, {
			"lock", "nlm.lock", FT_NONE, 0,
			NULL, 0, "lock" }},
		{ &hf_nlm_lock_caller_name, {
			"caller_name", "nlm.lock.caller_name", FT_STRING, BASE_NONE,
			NULL, 0, "caller_name" }},
		{ &hf_nlm_lock_owner, {
			"owner", "nlm.lock.owner", FT_STRING, BASE_DEC,
			NULL, 0, "owner" }},
		{ &hf_nlm_lock_svid, {
			"svid", "nlm.lock.svid", FT_UINT32, BASE_DEC,
			NULL, 0, "svid" }},
		{ &hf_nlm_lock_l_offset, {
			"l_offset", "nlm.lock.l_offset", FT_UINT32, BASE_DEC,
			NULL, 0, "l_offset" }},
		{ &hf_nlm_lock_l_len, {
			"l_len", "nlm.lock.l_len", FT_UINT32, BASE_DEC,
			NULL, 0, "l_len" }},
		{ &hf_nlm_reclaim, {
			"reclaim", "nlm.reclaim", FT_BOOLEAN, BASE_NONE,
			&yesno, 0, "reclaim" }},
		{ &hf_nlm_state, {
			"state", "nlm.state", FT_UINT32, BASE_DEC,
			VALS(names_nlm_state), 0, "state" }},
		};

	static gint *ett[] = {
		&ett_nlm,
		&ett_nlm_lock,
	};

	proto_nlm = proto_register_protocol("Network Lock Manager Protocol", "nlm");
	proto_register_field_array(proto_nlm, hf, array_length(hf));
	proto_register_subtree_array(ett, array_length(ett));
}

void
proto_reg_handoff_nlm(void)
{
	/* Register the protocol as RPC */
	rpc_init_prog(proto_nlm, NLM_PROGRAM, ett_nlm);
	/* Register the procedure tables */
	rpc_init_proc_table(NLM_PROGRAM, 1, nlm1_proc);
	rpc_init_proc_table(NLM_PROGRAM, 2, nlm2_proc);
	rpc_init_proc_table(NLM_PROGRAM, 3, nlm3_proc);
	rpc_init_proc_table(NLM_PROGRAM, 4, nlm4_proc);
}