channel_mgmt.c 15.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/*
 * Copyright (c) 2009, Microsoft Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope 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.
 *
 * Authors:
 *   Haiyang Zhang <haiyangz@microsoft.com>
 *   Hank Janssen  <hjanssen@microsoft.com>
 */
21
22
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

23
#include <linux/kernel.h>
24
25
#include <linux/sched.h>
#include <linux/wait.h>
26
#include <linux/mm.h>
27
#include <linux/slab.h>
28
#include <linux/list.h>
29
#include <linux/module.h>
30
#include <linux/completion.h>
31
#include <linux/hyperv.h>
32

33
#include "hyperv_vmbus.h"
34

35
struct vmbus_channel_message_table_entry {
36
	enum vmbus_channel_message_type message_type;
37
	void (*message_handler)(struct vmbus_channel_message_header *msg);
38
};
39

40
41

/**
42
 * vmbus_prep_negotiate_resp() - Create default response for Hyper-V Negotiate message
43
44
45
46
47
48
49
50
51
52
53
54
55
 * @icmsghdrp: Pointer to msg header structure
 * @icmsg_negotiate: Pointer to negotiate message structure
 * @buf: Raw buffer channel data
 *
 * @icmsghdrp is of type &struct icmsg_hdr.
 * @negop is of type &struct icmsg_negotiate.
 * Set up and fill in default negotiate response message. This response can
 * come from both the vmbus driver and the hv_utils driver. The current api
 * will respond properly to both Windows 2008 and Windows 2008-R2 operating
 * systems.
 *
 * Mainly used by Hyper-V drivers.
 */
56
57
void vmbus_prep_negotiate_resp(struct icmsg_hdr *icmsghdrp,
			       struct icmsg_negotiate *negop, u8 *buf)
58
{
59
	icmsghdrp->icmsgsize = 0x10;
60

61
62
63
	negop = (struct icmsg_negotiate *)&buf[
		sizeof(struct vmbuspipe_hdr) +
		sizeof(struct icmsg_hdr)];
64

65
66
67
68
69
70
71
72
73
74
75
	if (negop->icframe_vercnt == 2 &&
	   negop->icversion_data[1].major == 3) {
		negop->icversion_data[0].major = 3;
		negop->icversion_data[0].minor = 0;
		negop->icversion_data[1].major = 3;
		negop->icversion_data[1].minor = 0;
	} else {
		negop->icversion_data[0].major = 1;
		negop->icversion_data[0].minor = 0;
		negop->icversion_data[1].major = 1;
		negop->icversion_data[1].minor = 0;
76
	}
77
78
79

	negop->icframe_vercnt = 1;
	negop->icmsg_vercnt = 1;
80
}
81

82
EXPORT_SYMBOL_GPL(vmbus_prep_negotiate_resp);
83

84
/*
85
 * alloc_channel - Allocate and initialize a vmbus channel object
86
 */
87
static struct vmbus_channel *alloc_channel(void)
88
{
89
	struct vmbus_channel *channel;
90

91
	channel = kzalloc(sizeof(*channel), GFP_ATOMIC);
92
93
94
	if (!channel)
		return NULL;

95
	spin_lock_init(&channel->inbound_lock);
96

97
98
	channel->controlwq = create_workqueue("hv_vmbus_ctl");
	if (!channel->controlwq) {
99
		kfree(channel);
100
101
102
103
104
105
		return NULL;
	}

	return channel;
}

106
/*
107
 * release_hannel - Release the vmbus channel object itself
108
 */
109
static void release_channel(struct work_struct *work)
110
{
111
112
113
	struct vmbus_channel *channel = container_of(work,
						     struct vmbus_channel,
						     work);
114

115
	destroy_workqueue(channel->controlwq);
116

117
	kfree(channel);
118
119
}

120
/*
121
 * free_channel - Release the resources used by the vmbus channel object
122
 */
123
static void free_channel(struct vmbus_channel *channel)
124
125
{

126
127
128
129
130
	/*
	 * We have to release the channel's workqueue/thread in the vmbus's
	 * workqueue/thread context
	 * ie we can't destroy ourselves.
	 */
131
	INIT_WORK(&channel->work, release_channel);
132
	queue_work(vmbus_connection.work_queue, &channel->work);
133
134
}

135
136


137
138
139
140
141
142
143
144
145
146
/*
 * vmbus_process_rescind_offer -
 * Rescind the offer by initiating a device removal
 */
static void vmbus_process_rescind_offer(struct work_struct *work)
{
	struct vmbus_channel *channel = container_of(work,
						     struct vmbus_channel,
						     work);

147
	vmbus_device_unregister(channel->device_obj);
148
}
149

150
151
152
153
154
155
156
157
158
159
160
void vmbus_free_channels(void)
{
	struct vmbus_channel *channel;

	list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
		vmbus_device_unregister(channel->device_obj);
		kfree(channel->device_obj);
		free_channel(channel);
	}
}

161
/*
162
 * vmbus_process_offer - Process the offer by creating a channel/device
163
 * associated with this offer
164
 */
165
static void vmbus_process_offer(struct work_struct *work)
166
{
167
168
169
	struct vmbus_channel *newchannel = container_of(work,
							struct vmbus_channel,
							work);
170
	struct vmbus_channel *channel;
171
	bool fnew = true;
172
	int ret;
173
	unsigned long flags;
174

175
176
177
	/* The next possible work is rescind handling */
	INIT_WORK(&newchannel->work, vmbus_process_rescind_offer);

178
	/* Make sure this is a new offer */
179
	spin_lock_irqsave(&vmbus_connection.channel_lock, flags);
180

181
	list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
182
183
184
185
		if (!uuid_le_cmp(channel->offermsg.offer.if_type,
			newchannel->offermsg.offer.if_type) &&
			!uuid_le_cmp(channel->offermsg.offer.if_instance,
				newchannel->offermsg.offer.if_instance)) {
186
			fnew = false;
187
188
189
190
			break;
		}
	}

191
	if (fnew)
192
		list_add_tail(&newchannel->listentry,
193
			      &vmbus_connection.chn_list);
194

195
	spin_unlock_irqrestore(&vmbus_connection.channel_lock, flags);
196

197
	if (!fnew) {
198
		free_channel(newchannel);
199
200
201
		return;
	}

202
203
204
	/*
	 * Start the process of binding this offer to the driver
	 * We need to set the DeviceObject field before calling
205
	 * vmbus_child_dev_add()
206
	 */
207
	newchannel->device_obj = vmbus_device_create(
208
209
		&newchannel->offermsg.offer.if_type,
		&newchannel->offermsg.offer.if_instance,
210
		newchannel);
211

212
213
214
215
216
	/*
	 * Add the new device to the bus. This will kick off device-driver
	 * binding which eventually invokes the device driver's AddDevice()
	 * method.
	 */
217
	ret = vmbus_device_register(newchannel->device_obj);
218
	if (ret != 0) {
219
		pr_err("unable to add child device object (relid %d)\n",
220
			   newchannel->offermsg.child_relid);
221

222
		spin_lock_irqsave(&vmbus_connection.channel_lock, flags);
223
		list_del(&newchannel->listentry);
224
		spin_unlock_irqrestore(&vmbus_connection.channel_lock, flags);
225
		kfree(newchannel->device_obj);
226

227
		free_channel(newchannel);
228
	} else {
229
230
231
232
233
		/*
		 * This state is used to indicate a successful open
		 * so that when we do close the channel normally, we
		 * can cleanup properly
		 */
234
		newchannel->state = CHANNEL_OPEN_STATE;
235
236
237
	}
}

238
/*
239
 * vmbus_onoffer - Handler for channel offers from vmbus in parent partition.
240
241
 *
 */
242
static void vmbus_onoffer(struct vmbus_channel_message_header *hdr)
243
{
244
	struct vmbus_channel_offer_channel *offer;
245
	struct vmbus_channel *newchannel;
246
247
	uuid_le *guidtype;
	uuid_le *guidinstance;
248

249
	offer = (struct vmbus_channel_offer_channel *)hdr;
250

251
252
	guidtype = &offer->offer.if_type;
	guidinstance = &offer->offer.if_instance;
253

254
	/* Allocate the channel object and save this offer. */
255
	newchannel = alloc_channel();
256
	if (!newchannel) {
257
		pr_err("Unable to allocate channel object\n");
258
259
260
		return;
	}

261
	memcpy(&newchannel->offermsg, offer,
262
	       sizeof(struct vmbus_channel_offer_channel));
263
264
	newchannel->monitor_grp = (u8)offer->monitorid / 32;
	newchannel->monitor_bit = (u8)offer->monitorid % 32;
265

266
267
	INIT_WORK(&newchannel->work, vmbus_process_offer);
	queue_work(newchannel->controlwq, &newchannel->work);
268
269
}

270
/*
271
 * vmbus_onoffer_rescind - Rescind offer handler.
272
273
274
 *
 * We queue a work item to process this offer synchronously
 */
275
static void vmbus_onoffer_rescind(struct vmbus_channel_message_header *hdr)
276
{
277
	struct vmbus_channel_rescind_offer *rescind;
278
	struct vmbus_channel *channel;
279

280
	rescind = (struct vmbus_channel_rescind_offer *)hdr;
281
	channel = relid2channel(rescind->child_relid);
282
283
284

	if (channel == NULL)
		/* Just return here, no channel found */
285
286
		return;

287
288
289
	/* work is initialized for vmbus_process_rescind_offer() from
	 * vmbus_process_offer() where the channel got created */
	queue_work(channel->controlwq, &channel->work);
290
291
}

292
/*
293
294
 * vmbus_onoffers_delivered -
 * This is invoked when all offers have been delivered.
295
296
297
 *
 * Nothing to do here.
 */
298
static void vmbus_onoffers_delivered(
299
			struct vmbus_channel_message_header *hdr)
300
301
302
{
}

303
/*
304
 * vmbus_onopen_result - Open result handler.
305
306
307
308
309
 *
 * This is invoked when we received a response to our channel open request.
 * Find the matching request, copy the response and signal the requesting
 * thread.
 */
310
static void vmbus_onopen_result(struct vmbus_channel_message_header *hdr)
311
{
312
	struct vmbus_channel_open_result *result;
313
314
315
	struct vmbus_channel_msginfo *msginfo;
	struct vmbus_channel_message_header *requestheader;
	struct vmbus_channel_open_channel *openmsg;
316
	unsigned long flags;
317

318
	result = (struct vmbus_channel_open_result *)hdr;
319

320
321
322
	/*
	 * Find the open msg, copy the result and signal/unblock the wait event
	 */
323
	spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
324

325
326
	list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
				msglistentry) {
327
		requestheader =
328
			(struct vmbus_channel_message_header *)msginfo->msg;
329

330
		if (requestheader->msgtype == CHANNELMSG_OPENCHANNEL) {
331
			openmsg =
332
333
334
335
			(struct vmbus_channel_open_channel *)msginfo->msg;
			if (openmsg->child_relid == result->child_relid &&
			    openmsg->openid == result->openid) {
				memcpy(&msginfo->response.open_result,
336
				       result,
337
338
339
				       sizeof(
					struct vmbus_channel_open_result));
				complete(&msginfo->waitevent);
340
341
342
343
				break;
			}
		}
	}
344
	spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
345
346
}

347
/*
348
 * vmbus_ongpadl_created - GPADL created handler.
349
350
351
352
353
 *
 * This is invoked when we received a response to our gpadl create request.
 * Find the matching request, copy the response and signal the requesting
 * thread.
 */
354
static void vmbus_ongpadl_created(struct vmbus_channel_message_header *hdr)
355
{
356
357
358
359
	struct vmbus_channel_gpadl_created *gpadlcreated;
	struct vmbus_channel_msginfo *msginfo;
	struct vmbus_channel_message_header *requestheader;
	struct vmbus_channel_gpadl_header *gpadlheader;
360
	unsigned long flags;
361

362
	gpadlcreated = (struct vmbus_channel_gpadl_created *)hdr;
363

364
365
366
367
	/*
	 * Find the establish msg, copy the result and signal/unblock the wait
	 * event
	 */
368
	spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
369

370
371
	list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
				msglistentry) {
372
		requestheader =
373
			(struct vmbus_channel_message_header *)msginfo->msg;
374

375
		if (requestheader->msgtype == CHANNELMSG_GPADL_HEADER) {
376
377
378
			gpadlheader =
			(struct vmbus_channel_gpadl_header *)requestheader;

379
380
381
382
			if ((gpadlcreated->child_relid ==
			     gpadlheader->child_relid) &&
			    (gpadlcreated->gpadl == gpadlheader->gpadl)) {
				memcpy(&msginfo->response.gpadl_created,
383
				       gpadlcreated,
384
385
386
				       sizeof(
					struct vmbus_channel_gpadl_created));
				complete(&msginfo->waitevent);
387
388
389
390
				break;
			}
		}
	}
391
	spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
392
393
}

394
/*
395
 * vmbus_ongpadl_torndown - GPADL torndown handler.
396
397
398
399
400
 *
 * This is invoked when we received a response to our gpadl teardown request.
 * Find the matching request, copy the response and signal the requesting
 * thread.
 */
401
static void vmbus_ongpadl_torndown(
402
			struct vmbus_channel_message_header *hdr)
403
{
404
405
406
407
	struct vmbus_channel_gpadl_torndown *gpadl_torndown;
	struct vmbus_channel_msginfo *msginfo;
	struct vmbus_channel_message_header *requestheader;
	struct vmbus_channel_gpadl_teardown *gpadl_teardown;
408
	unsigned long flags;
409

410
	gpadl_torndown = (struct vmbus_channel_gpadl_torndown *)hdr;
411
412
413
414

	/*
	 * Find the open msg, copy the result and signal/unblock the wait event
	 */
415
	spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
416

417
418
	list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
				msglistentry) {
419
		requestheader =
420
			(struct vmbus_channel_message_header *)msginfo->msg;
421

422
		if (requestheader->msgtype == CHANNELMSG_GPADL_TEARDOWN) {
423
424
			gpadl_teardown =
			(struct vmbus_channel_gpadl_teardown *)requestheader;
425

426
427
			if (gpadl_torndown->gpadl == gpadl_teardown->gpadl) {
				memcpy(&msginfo->response.gpadl_torndown,
428
				       gpadl_torndown,
429
430
431
				       sizeof(
					struct vmbus_channel_gpadl_torndown));
				complete(&msginfo->waitevent);
432
433
434
435
				break;
			}
		}
	}
436
	spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
437
438
}

439
/*
440
 * vmbus_onversion_response - Version response handler
441
442
443
444
445
 *
 * This is invoked when we received a response to our initiate contact request.
 * Find the matching request, copy the response and signal the requesting
 * thread.
 */
446
static void vmbus_onversion_response(
447
		struct vmbus_channel_message_header *hdr)
448
{
449
450
	struct vmbus_channel_msginfo *msginfo;
	struct vmbus_channel_message_header *requestheader;
451
	struct vmbus_channel_initiate_contact *initiate;
452
	struct vmbus_channel_version_response *version_response;
453
	unsigned long flags;
454

455
	version_response = (struct vmbus_channel_version_response *)hdr;
456
	spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
457

458
459
	list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
				msglistentry) {
460
		requestheader =
461
			(struct vmbus_channel_message_header *)msginfo->msg;
462

463
464
		if (requestheader->msgtype ==
		    CHANNELMSG_INITIATE_CONTACT) {
465
466
			initiate =
			(struct vmbus_channel_initiate_contact *)requestheader;
467
			memcpy(&msginfo->response.version_response,
468
			      version_response,
469
			      sizeof(struct vmbus_channel_version_response));
470
			complete(&msginfo->waitevent);
471
472
		}
	}
473
	spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
474
475
}

476
477
/* Channel message dispatch table */
static struct vmbus_channel_message_table_entry
478
	channel_message_table[CHANNELMSG_COUNT] = {
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
	{CHANNELMSG_INVALID,			NULL},
	{CHANNELMSG_OFFERCHANNEL,		vmbus_onoffer},
	{CHANNELMSG_RESCIND_CHANNELOFFER,	vmbus_onoffer_rescind},
	{CHANNELMSG_REQUESTOFFERS,		NULL},
	{CHANNELMSG_ALLOFFERS_DELIVERED,	vmbus_onoffers_delivered},
	{CHANNELMSG_OPENCHANNEL,		NULL},
	{CHANNELMSG_OPENCHANNEL_RESULT,	vmbus_onopen_result},
	{CHANNELMSG_CLOSECHANNEL,		NULL},
	{CHANNELMSG_GPADL_HEADER,		NULL},
	{CHANNELMSG_GPADL_BODY,		NULL},
	{CHANNELMSG_GPADL_CREATED,		vmbus_ongpadl_created},
	{CHANNELMSG_GPADL_TEARDOWN,		NULL},
	{CHANNELMSG_GPADL_TORNDOWN,		vmbus_ongpadl_torndown},
	{CHANNELMSG_RELID_RELEASED,		NULL},
	{CHANNELMSG_INITIATE_CONTACT,		NULL},
	{CHANNELMSG_VERSION_RESPONSE,		vmbus_onversion_response},
	{CHANNELMSG_UNLOAD,			NULL},
496
497
};

498
/*
499
 * vmbus_onmessage - Handler for channel protocol messages.
500
501
502
 *
 * This is invoked in the vmbus worker thread context.
 */
503
void vmbus_onmessage(void *context)
504
{
505
	struct hv_message *msg = context;
506
	struct vmbus_channel_message_header *hdr;
507
508
	int size;

509
510
	hdr = (struct vmbus_channel_message_header *)msg->u.payload;
	size = msg->header.payload_size;
511

512
	if (hdr->msgtype >= CHANNELMSG_COUNT) {
513
		pr_err("Received invalid channel message type %d size %d\n",
514
			   hdr->msgtype, size);
515
		print_hex_dump_bytes("", DUMP_PREFIX_NONE,
516
				     (unsigned char *)msg->u.payload, size);
517
518
519
		return;
	}

520
521
	if (channel_message_table[hdr->msgtype].message_handler)
		channel_message_table[hdr->msgtype].message_handler(hdr);
522
	else
523
		pr_err("Unhandled channel message type %d\n", hdr->msgtype);
524
525
}

526
/*
527
 * vmbus_request_offers - Send a request to get all our pending offers.
528
 */
529
int vmbus_request_offers(void)
530
{
531
	struct vmbus_channel_message_header *msg;
532
	struct vmbus_channel_msginfo *msginfo;
533
	int ret, t;
534

535
	msginfo = kmalloc(sizeof(*msginfo) +
536
537
			  sizeof(struct vmbus_channel_message_header),
			  GFP_KERNEL);
538
	if (!msginfo)
539
		return -ENOMEM;
540

541
	init_completion(&msginfo->waitevent);
542

543
	msg = (struct vmbus_channel_message_header *)msginfo->msg;
544

545
	msg->msgtype = CHANNELMSG_REQUESTOFFERS;
546
547


548
	ret = vmbus_post_msg(msg,
549
550
			       sizeof(struct vmbus_channel_message_header));
	if (ret != 0) {
551
		pr_err("Unable to request offers - %d\n", ret);
552

553
554
		goto cleanup;
	}
555

556
	t = wait_for_completion_timeout(&msginfo->waitevent, 5*HZ);
557
	if (t == 0) {
558
559
		ret = -ETIMEDOUT;
		goto cleanup;
560
561
562
563
	}



564
cleanup:
565
	kfree(msginfo);
566
567
568
569

	return ret;
}

570
/* eof */