channel_mgmt.c 16.1 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
 * @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.
49
50
51
52
53
54
55
 * Set up and fill in default negotiate response message.
 *
 * The max_fw_version specifies the maximum framework version that
 * we can support and max _srv_version specifies the maximum service
 * version we can support. A special value MAX_SRV_VER can be
 * specified to indicate that we can handle the maximum version
 * exposed by the host.
56
57
58
 *
 * Mainly used by Hyper-V drivers.
 */
59
void vmbus_prep_negotiate_resp(struct icmsg_hdr *icmsghdrp,
60
61
				struct icmsg_negotiate *negop, u8 *buf,
				int max_fw_version, int max_srv_version)
62
{
63
64
65
66
	int icframe_vercnt;
	int icmsg_vercnt;
	int i;

67
	icmsghdrp->icmsgsize = 0x10;
68

69
70
71
	negop = (struct icmsg_negotiate *)&buf[
		sizeof(struct vmbuspipe_hdr) +
		sizeof(struct icmsg_hdr)];
72

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
	icframe_vercnt = negop->icframe_vercnt;
	icmsg_vercnt = negop->icmsg_vercnt;

	/*
	 * Select the framework version number we will
	 * support.
	 */

	for (i = 0; i < negop->icframe_vercnt; i++) {
		if (negop->icversion_data[i].major <= max_fw_version)
			icframe_vercnt = negop->icversion_data[i].major;
	}

	for (i = negop->icframe_vercnt;
		 (i < negop->icframe_vercnt + negop->icmsg_vercnt); i++) {
		if (negop->icversion_data[i].major <= max_srv_version)
			icmsg_vercnt = negop->icversion_data[i].major;
90
	}
91

92
93
94
95
	/*
	 * Respond with the maximum framework and service
	 * version numbers we can support.
	 */
96
97
	negop->icframe_vercnt = 1;
	negop->icmsg_vercnt = 1;
98
99
100
101
	negop->icversion_data[0].major = icframe_vercnt;
	negop->icversion_data[0].minor = 0;
	negop->icversion_data[1].major = icmsg_vercnt;
	negop->icversion_data[1].minor = 0;
102
}
103

104
EXPORT_SYMBOL_GPL(vmbus_prep_negotiate_resp);
105

106
/*
107
 * alloc_channel - Allocate and initialize a vmbus channel object
108
 */
109
static struct vmbus_channel *alloc_channel(void)
110
{
111
	struct vmbus_channel *channel;
112

113
	channel = kzalloc(sizeof(*channel), GFP_ATOMIC);
114
115
116
	if (!channel)
		return NULL;

117
	spin_lock_init(&channel->inbound_lock);
118

119
120
	channel->controlwq = create_workqueue("hv_vmbus_ctl");
	if (!channel->controlwq) {
121
		kfree(channel);
122
123
124
125
126
127
		return NULL;
	}

	return channel;
}

128
/*
129
 * release_hannel - Release the vmbus channel object itself
130
 */
131
static void release_channel(struct work_struct *work)
132
{
133
134
135
	struct vmbus_channel *channel = container_of(work,
						     struct vmbus_channel,
						     work);
136

137
	destroy_workqueue(channel->controlwq);
138

139
	kfree(channel);
140
141
}

142
/*
143
 * free_channel - Release the resources used by the vmbus channel object
144
 */
145
static void free_channel(struct vmbus_channel *channel)
146
147
{

148
149
150
151
152
	/*
	 * We have to release the channel's workqueue/thread in the vmbus's
	 * workqueue/thread context
	 * ie we can't destroy ourselves.
	 */
153
	INIT_WORK(&channel->work, release_channel);
154
	queue_work(vmbus_connection.work_queue, &channel->work);
155
156
}

157
158


159
160
161
162
163
164
165
166
167
168
/*
 * 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);

169
	vmbus_device_unregister(channel->device_obj);
170
}
171

172
173
174
175
176
177
178
179
180
181
182
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);
	}
}

183
/*
184
 * vmbus_process_offer - Process the offer by creating a channel/device
185
 * associated with this offer
186
 */
187
static void vmbus_process_offer(struct work_struct *work)
188
{
189
190
191
	struct vmbus_channel *newchannel = container_of(work,
							struct vmbus_channel,
							work);
192
	struct vmbus_channel *channel;
193
	bool fnew = true;
194
	int ret;
195
	unsigned long flags;
196

197
198
199
	/* The next possible work is rescind handling */
	INIT_WORK(&newchannel->work, vmbus_process_rescind_offer);

200
	/* Make sure this is a new offer */
201
	spin_lock_irqsave(&vmbus_connection.channel_lock, flags);
202

203
	list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
204
205
206
207
		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)) {
208
			fnew = false;
209
210
211
212
			break;
		}
	}

213
	if (fnew)
214
		list_add_tail(&newchannel->listentry,
215
			      &vmbus_connection.chn_list);
216

217
	spin_unlock_irqrestore(&vmbus_connection.channel_lock, flags);
218

219
	if (!fnew) {
220
		free_channel(newchannel);
221
222
223
		return;
	}

224
225
226
	/*
	 * Start the process of binding this offer to the driver
	 * We need to set the DeviceObject field before calling
227
	 * vmbus_child_dev_add()
228
	 */
229
	newchannel->device_obj = vmbus_device_create(
230
231
		&newchannel->offermsg.offer.if_type,
		&newchannel->offermsg.offer.if_instance,
232
		newchannel);
233

234
235
236
237
238
	/*
	 * Add the new device to the bus. This will kick off device-driver
	 * binding which eventually invokes the device driver's AddDevice()
	 * method.
	 */
239
	ret = vmbus_device_register(newchannel->device_obj);
240
	if (ret != 0) {
241
		pr_err("unable to add child device object (relid %d)\n",
242
			   newchannel->offermsg.child_relid);
243

244
		spin_lock_irqsave(&vmbus_connection.channel_lock, flags);
245
		list_del(&newchannel->listentry);
246
		spin_unlock_irqrestore(&vmbus_connection.channel_lock, flags);
247
		kfree(newchannel->device_obj);
248

249
		free_channel(newchannel);
250
	} else {
251
252
253
254
255
		/*
		 * This state is used to indicate a successful open
		 * so that when we do close the channel normally, we
		 * can cleanup properly
		 */
256
		newchannel->state = CHANNEL_OPEN_STATE;
257
258
259
	}
}

260
/*
261
 * vmbus_onoffer - Handler for channel offers from vmbus in parent partition.
262
263
 *
 */
264
static void vmbus_onoffer(struct vmbus_channel_message_header *hdr)
265
{
266
	struct vmbus_channel_offer_channel *offer;
267
	struct vmbus_channel *newchannel;
268
269
	uuid_le *guidtype;
	uuid_le *guidinstance;
270

271
	offer = (struct vmbus_channel_offer_channel *)hdr;
272

273
274
	guidtype = &offer->offer.if_type;
	guidinstance = &offer->offer.if_instance;
275

276
	/* Allocate the channel object and save this offer. */
277
	newchannel = alloc_channel();
278
	if (!newchannel) {
279
		pr_err("Unable to allocate channel object\n");
280
281
282
		return;
	}

283
	memcpy(&newchannel->offermsg, offer,
284
	       sizeof(struct vmbus_channel_offer_channel));
285
286
	newchannel->monitor_grp = (u8)offer->monitorid / 32;
	newchannel->monitor_bit = (u8)offer->monitorid % 32;
287

288
289
	INIT_WORK(&newchannel->work, vmbus_process_offer);
	queue_work(newchannel->controlwq, &newchannel->work);
290
291
}

292
/*
293
 * vmbus_onoffer_rescind - Rescind offer handler.
294
295
296
 *
 * We queue a work item to process this offer synchronously
 */
297
static void vmbus_onoffer_rescind(struct vmbus_channel_message_header *hdr)
298
{
299
	struct vmbus_channel_rescind_offer *rescind;
300
	struct vmbus_channel *channel;
301

302
	rescind = (struct vmbus_channel_rescind_offer *)hdr;
303
	channel = relid2channel(rescind->child_relid);
304
305
306

	if (channel == NULL)
		/* Just return here, no channel found */
307
308
		return;

309
310
311
	/* work is initialized for vmbus_process_rescind_offer() from
	 * vmbus_process_offer() where the channel got created */
	queue_work(channel->controlwq, &channel->work);
312
313
}

314
/*
315
316
 * vmbus_onoffers_delivered -
 * This is invoked when all offers have been delivered.
317
318
319
 *
 * Nothing to do here.
 */
320
static void vmbus_onoffers_delivered(
321
			struct vmbus_channel_message_header *hdr)
322
323
324
{
}

325
/*
326
 * vmbus_onopen_result - Open result handler.
327
328
329
330
331
 *
 * 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.
 */
332
static void vmbus_onopen_result(struct vmbus_channel_message_header *hdr)
333
{
334
	struct vmbus_channel_open_result *result;
335
336
337
	struct vmbus_channel_msginfo *msginfo;
	struct vmbus_channel_message_header *requestheader;
	struct vmbus_channel_open_channel *openmsg;
338
	unsigned long flags;
339

340
	result = (struct vmbus_channel_open_result *)hdr;
341

342
343
344
	/*
	 * Find the open msg, copy the result and signal/unblock the wait event
	 */
345
	spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
346

347
348
	list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
				msglistentry) {
349
		requestheader =
350
			(struct vmbus_channel_message_header *)msginfo->msg;
351

352
		if (requestheader->msgtype == CHANNELMSG_OPENCHANNEL) {
353
			openmsg =
354
355
356
357
			(struct vmbus_channel_open_channel *)msginfo->msg;
			if (openmsg->child_relid == result->child_relid &&
			    openmsg->openid == result->openid) {
				memcpy(&msginfo->response.open_result,
358
				       result,
359
360
361
				       sizeof(
					struct vmbus_channel_open_result));
				complete(&msginfo->waitevent);
362
363
364
365
				break;
			}
		}
	}
366
	spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
367
368
}

369
/*
370
 * vmbus_ongpadl_created - GPADL created handler.
371
372
373
374
375
 *
 * 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.
 */
376
static void vmbus_ongpadl_created(struct vmbus_channel_message_header *hdr)
377
{
378
379
380
381
	struct vmbus_channel_gpadl_created *gpadlcreated;
	struct vmbus_channel_msginfo *msginfo;
	struct vmbus_channel_message_header *requestheader;
	struct vmbus_channel_gpadl_header *gpadlheader;
382
	unsigned long flags;
383

384
	gpadlcreated = (struct vmbus_channel_gpadl_created *)hdr;
385

386
387
388
389
	/*
	 * Find the establish msg, copy the result and signal/unblock the wait
	 * event
	 */
390
	spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
391

392
393
	list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
				msglistentry) {
394
		requestheader =
395
			(struct vmbus_channel_message_header *)msginfo->msg;
396

397
		if (requestheader->msgtype == CHANNELMSG_GPADL_HEADER) {
398
399
400
			gpadlheader =
			(struct vmbus_channel_gpadl_header *)requestheader;

401
402
403
404
			if ((gpadlcreated->child_relid ==
			     gpadlheader->child_relid) &&
			    (gpadlcreated->gpadl == gpadlheader->gpadl)) {
				memcpy(&msginfo->response.gpadl_created,
405
				       gpadlcreated,
406
407
408
				       sizeof(
					struct vmbus_channel_gpadl_created));
				complete(&msginfo->waitevent);
409
410
411
412
				break;
			}
		}
	}
413
	spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
414
415
}

416
/*
417
 * vmbus_ongpadl_torndown - GPADL torndown handler.
418
419
420
421
422
 *
 * 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.
 */
423
static void vmbus_ongpadl_torndown(
424
			struct vmbus_channel_message_header *hdr)
425
{
426
427
428
429
	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;
430
	unsigned long flags;
431

432
	gpadl_torndown = (struct vmbus_channel_gpadl_torndown *)hdr;
433
434
435
436

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

439
440
	list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
				msglistentry) {
441
		requestheader =
442
			(struct vmbus_channel_message_header *)msginfo->msg;
443

444
		if (requestheader->msgtype == CHANNELMSG_GPADL_TEARDOWN) {
445
446
			gpadl_teardown =
			(struct vmbus_channel_gpadl_teardown *)requestheader;
447

448
449
			if (gpadl_torndown->gpadl == gpadl_teardown->gpadl) {
				memcpy(&msginfo->response.gpadl_torndown,
450
				       gpadl_torndown,
451
452
453
				       sizeof(
					struct vmbus_channel_gpadl_torndown));
				complete(&msginfo->waitevent);
454
455
456
457
				break;
			}
		}
	}
458
	spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
459
460
}

461
/*
462
 * vmbus_onversion_response - Version response handler
463
464
465
466
467
 *
 * 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.
 */
468
static void vmbus_onversion_response(
469
		struct vmbus_channel_message_header *hdr)
470
{
471
472
	struct vmbus_channel_msginfo *msginfo;
	struct vmbus_channel_message_header *requestheader;
473
	struct vmbus_channel_initiate_contact *initiate;
474
	struct vmbus_channel_version_response *version_response;
475
	unsigned long flags;
476

477
	version_response = (struct vmbus_channel_version_response *)hdr;
478
	spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
479

480
481
	list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
				msglistentry) {
482
		requestheader =
483
			(struct vmbus_channel_message_header *)msginfo->msg;
484

485
486
		if (requestheader->msgtype ==
		    CHANNELMSG_INITIATE_CONTACT) {
487
488
			initiate =
			(struct vmbus_channel_initiate_contact *)requestheader;
489
			memcpy(&msginfo->response.version_response,
490
			      version_response,
491
			      sizeof(struct vmbus_channel_version_response));
492
			complete(&msginfo->waitevent);
493
494
		}
	}
495
	spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
496
497
}

498
499
/* Channel message dispatch table */
static struct vmbus_channel_message_table_entry
500
	channel_message_table[CHANNELMSG_COUNT] = {
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
	{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},
518
519
};

520
/*
521
 * vmbus_onmessage - Handler for channel protocol messages.
522
523
524
 *
 * This is invoked in the vmbus worker thread context.
 */
525
void vmbus_onmessage(void *context)
526
{
527
	struct hv_message *msg = context;
528
	struct vmbus_channel_message_header *hdr;
529
530
	int size;

531
532
	hdr = (struct vmbus_channel_message_header *)msg->u.payload;
	size = msg->header.payload_size;
533

534
	if (hdr->msgtype >= CHANNELMSG_COUNT) {
535
		pr_err("Received invalid channel message type %d size %d\n",
536
			   hdr->msgtype, size);
537
		print_hex_dump_bytes("", DUMP_PREFIX_NONE,
538
				     (unsigned char *)msg->u.payload, size);
539
540
541
		return;
	}

542
543
	if (channel_message_table[hdr->msgtype].message_handler)
		channel_message_table[hdr->msgtype].message_handler(hdr);
544
	else
545
		pr_err("Unhandled channel message type %d\n", hdr->msgtype);
546
547
}

548
/*
549
 * vmbus_request_offers - Send a request to get all our pending offers.
550
 */
551
int vmbus_request_offers(void)
552
{
553
	struct vmbus_channel_message_header *msg;
554
	struct vmbus_channel_msginfo *msginfo;
555
	int ret, t;
556

557
	msginfo = kmalloc(sizeof(*msginfo) +
558
559
			  sizeof(struct vmbus_channel_message_header),
			  GFP_KERNEL);
560
	if (!msginfo)
561
		return -ENOMEM;
562

563
	init_completion(&msginfo->waitevent);
564

565
	msg = (struct vmbus_channel_message_header *)msginfo->msg;
566

567
	msg->msgtype = CHANNELMSG_REQUESTOFFERS;
568
569


570
	ret = vmbus_post_msg(msg,
571
572
			       sizeof(struct vmbus_channel_message_header));
	if (ret != 0) {
573
		pr_err("Unable to request offers - %d\n", ret);
574

575
576
		goto cleanup;
	}
577

578
	t = wait_for_completion_timeout(&msginfo->waitevent, 5*HZ);
579
	if (t == 0) {
580
581
		ret = -ETIMEDOUT;
		goto cleanup;
582
583
584
585
	}



586
cleanup:
587
	kfree(msginfo);
588
589
590
591

	return ret;
}

592
/* eof */