2 * Copyright (c) 2012, Microsoft Corporation.
5 * K. Y. Srinivasan <kys@microsoft.com>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License version 2 as published
9 * by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
14 * NON INFRINGEMENT. See the GNU General Public License for more
19 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 #include <linux/kernel.h>
22 #include <linux/mman.h>
23 #include <linux/delay.h>
24 #include <linux/init.h>
25 #include <linux/module.h>
26 #include <linux/slab.h>
27 #include <linux/kthread.h>
28 #include <linux/completion.h>
29 #include <linux/memory_hotplug.h>
30 #include <linux/memory.h>
31 #include <linux/notifier.h>
32 #include <linux/percpu_counter.h>
34 #include <linux/hyperv.h>
37 * We begin with definitions supporting the Dynamic Memory protocol
40 * Begin protocol definitions.
46 * Protocol versions. The low word is the minor version, the high word the major
51 * Changed to 0.1 on 2009/03/25
52 * Changes to 0.2 on 2009/05/14
53 * Changes to 0.3 on 2009/12/03
54 * Changed to 1.0 on 2011/04/05
57 #define DYNMEM_MAKE_VERSION(Major, Minor) ((__u32)(((Major) << 16) | (Minor)))
58 #define DYNMEM_MAJOR_VERSION(Version) ((__u32)(Version) >> 16)
59 #define DYNMEM_MINOR_VERSION(Version) ((__u32)(Version) & 0xff)
62 DYNMEM_PROTOCOL_VERSION_1 = DYNMEM_MAKE_VERSION(0, 3),
63 DYNMEM_PROTOCOL_VERSION_2 = DYNMEM_MAKE_VERSION(1, 0),
65 DYNMEM_PROTOCOL_VERSION_WIN7 = DYNMEM_PROTOCOL_VERSION_1,
66 DYNMEM_PROTOCOL_VERSION_WIN8 = DYNMEM_PROTOCOL_VERSION_2,
68 DYNMEM_PROTOCOL_VERSION_CURRENT = DYNMEM_PROTOCOL_VERSION_WIN8
77 enum dm_message_type {
82 DM_VERSION_REQUEST = 1,
83 DM_VERSION_RESPONSE = 2,
84 DM_CAPABILITIES_REPORT = 3,
85 DM_CAPABILITIES_RESPONSE = 4,
87 DM_BALLOON_REQUEST = 6,
88 DM_BALLOON_RESPONSE = 7,
89 DM_UNBALLOON_REQUEST = 8,
90 DM_UNBALLOON_RESPONSE = 9,
91 DM_MEM_HOT_ADD_REQUEST = 10,
92 DM_MEM_HOT_ADD_RESPONSE = 11,
93 DM_VERSION_03_MAX = 11,
103 * Structures defining the dynamic memory management
125 union dm_mem_page_range {
128 * The PFN number of the first page in the range.
129 * 40 bits is the architectural limit of a PFN
134 * The number of pages in the range.
144 * The header for all dynamic memory messages:
146 * type: Type of the message.
147 * size: Size of the message in bytes; including the header.
148 * trans_id: The guest is responsible for manufacturing this ID.
158 * A generic message format for dynamic memory.
159 * Specific message formats are defined later in the file.
163 struct dm_header hdr;
164 __u8 data[]; /* enclosed message */
169 * Specific message types supporting the dynamic memory protocol.
173 * Version negotiation message. Sent from the guest to the host.
174 * The guest is free to try different versions until the host
175 * accepts the version.
177 * dm_version: The protocol version requested.
178 * is_last_attempt: If TRUE, this is the last version guest will request.
179 * reservedz: Reserved field, set to zero.
182 struct dm_version_request {
183 struct dm_header hdr;
184 union dm_version version;
185 __u32 is_last_attempt:1;
190 * Version response message; Host to Guest and indicates
191 * if the host has accepted the version sent by the guest.
193 * is_accepted: If TRUE, host has accepted the version and the guest
194 * should proceed to the next stage of the protocol. FALSE indicates that
195 * guest should re-try with a different version.
197 * reservedz: Reserved field, set to zero.
200 struct dm_version_response {
201 struct dm_header hdr;
207 * Message reporting capabilities. This is sent from the guest to the
211 struct dm_capabilities {
212 struct dm_header hdr;
215 __u64 max_page_number;
219 * Response to the capabilities message. This is sent from the host to the
220 * guest. This message notifies if the host has accepted the guest's
221 * capabilities. If the host has not accepted, the guest must shutdown
224 * is_accepted: Indicates if the host has accepted guest's capabilities.
225 * reservedz: Must be 0.
228 struct dm_capabilities_resp_msg {
229 struct dm_header hdr;
235 * This message is used to report memory pressure from the guest.
236 * This message is not part of any transaction and there is no
237 * response to this message.
239 * num_avail: Available memory in pages.
240 * num_committed: Committed memory in pages.
241 * page_file_size: The accumulated size of all page files
242 * in the system in pages.
243 * zero_free: The nunber of zero and free pages.
244 * page_file_writes: The writes to the page file in pages.
245 * io_diff: An indicator of file cache efficiency or page file activity,
246 * calculated as File Cache Page Fault Count - Page Read Count.
247 * This value is in pages.
249 * Some of these metrics are Windows specific and fortunately
250 * the algorithm on the host side that computes the guest memory
251 * pressure only uses num_committed value.
255 struct dm_header hdr;
258 __u64 page_file_size;
260 __u32 page_file_writes;
266 * Message to ask the guest to allocate memory - balloon up message.
267 * This message is sent from the host to the guest. The guest may not be
268 * able to allocate as much memory as requested.
270 * num_pages: number of pages to allocate.
274 struct dm_header hdr;
281 * Balloon response message; this message is sent from the guest
282 * to the host in response to the balloon message.
284 * reservedz: Reserved; must be set to zero.
285 * more_pages: If FALSE, this is the last message of the transaction.
286 * if TRUE there will atleast one more message from the guest.
288 * range_count: The number of ranges in the range array.
290 * range_array: An array of page ranges returned to the host.
294 struct dm_balloon_response {
295 struct dm_header hdr;
298 __u32 range_count:31;
299 union dm_mem_page_range range_array[];
303 * Un-balloon message; this message is sent from the host
304 * to the guest to give guest more memory.
306 * more_pages: If FALSE, this is the last message of the transaction.
307 * if TRUE there will atleast one more message from the guest.
309 * reservedz: Reserved; must be set to zero.
311 * range_count: The number of ranges in the range array.
313 * range_array: An array of page ranges returned to the host.
317 struct dm_unballoon_request {
318 struct dm_header hdr;
322 union dm_mem_page_range range_array[];
326 * Un-balloon response message; this message is sent from the guest
327 * to the host in response to an unballoon request.
331 struct dm_unballoon_response {
332 struct dm_header hdr;
337 * Hot add request message. Message sent from the host to the guest.
339 * mem_range: Memory range to hot add.
341 * On Linux we currently don't support this since we cannot hot add
342 * arbitrary granularity of memory.
346 struct dm_header hdr;
347 union dm_mem_page_range range;
351 * Hot add response message.
352 * This message is sent by the guest to report the status of a hot add request.
353 * If page_count is less than the requested page count, then the host should
354 * assume all further hot add requests will fail, since this indicates that
355 * the guest has hit an upper physical memory barrier.
357 * Hot adds may also fail due to low resources; in this case, the guest must
358 * not complete this message until the hot add can succeed, and the host must
359 * not send a new hot add request until the response is sent.
360 * If VSC fails to hot add memory DYNMEM_NUMBER_OF_UNSUCCESSFUL_HOTADD_ATTEMPTS
361 * times it fails the request.
364 * page_count: number of pages that were successfully hot added.
366 * result: result of the operation 1: success, 0: failure.
370 struct dm_hot_add_response {
371 struct dm_header hdr;
377 * Types of information sent from host to the guest.
381 INFO_TYPE_MAX_PAGE_CNT = 0,
387 * Header for the information message.
390 struct dm_info_header {
391 enum dm_info_type type;
396 * This message is sent from the host to the guest to pass
397 * some relevant information (win8 addition).
400 * info_size: size of the information blob.
401 * info: information blob.
405 struct dm_header hdr;
412 * End protocol definitions.
416 static bool do_hot_add;
418 module_param(hot_add, bool, (S_IRUGO | S_IWUSR));
419 MODULE_PARM_DESC(hot_add, "If set attempt memory hot_add");
421 static atomic_t trans_id = ATOMIC_INIT(0);
423 static int dm_ring_size = (5 * PAGE_SIZE);
426 * Driver specific state.
439 static __u8 recv_buffer[PAGE_SIZE];
440 static __u8 *send_buffer;
441 #define PAGES_IN_2M 512
443 struct hv_dynmem_device {
444 struct hv_device *dev;
445 enum hv_dm_state state;
446 struct completion host_event;
447 struct completion config_event;
450 * Number of pages we have currently ballooned out.
452 unsigned int num_pages_ballooned;
455 * This thread handles both balloon/hot-add
456 * requests from the host as well as notifying
457 * the host with regards to memory pressure in
460 struct task_struct *thread;
463 * We start with the highest version we can support
464 * and downgrade based on the host; we save here the
465 * next version to try.
470 static struct hv_dynmem_device dm_device;
472 static void hot_add_req(struct hv_dynmem_device *dm, struct dm_hot_add *msg)
475 struct dm_hot_add_response resp;
479 pr_info("Memory hot add not supported\n");
482 * Currently we do not support hot add.
483 * Just fail the request.
487 memset(&resp, 0, sizeof(struct dm_hot_add_response));
488 resp.hdr.type = DM_MEM_HOT_ADD_RESPONSE;
489 resp.hdr.size = sizeof(struct dm_hot_add_response);
490 resp.hdr.trans_id = atomic_inc_return(&trans_id);
495 dm->state = DM_INITIALIZED;
496 vmbus_sendpacket(dm->dev->channel, &resp,
497 sizeof(struct dm_hot_add_response),
499 VM_PKT_DATA_INBAND, 0);
503 static void process_info(struct hv_dynmem_device *dm, struct dm_info_msg *msg)
505 struct dm_info_header *info_hdr;
507 info_hdr = (struct dm_info_header *)msg->info;
509 switch (info_hdr->type) {
510 case INFO_TYPE_MAX_PAGE_CNT:
511 pr_info("Received INFO_TYPE_MAX_PAGE_CNT\n");
512 pr_info("Data Size is %d\n", info_hdr->data_size);
515 pr_info("Received Unknown type: %d\n", info_hdr->type);
520 * Post our status as it relates memory pressure to the
521 * host. Host expects the guests to post this status
522 * periodically at 1 second intervals.
524 * The metrics specified in this protocol are very Windows
525 * specific and so we cook up numbers here to convey our memory
529 static void post_status(struct hv_dynmem_device *dm)
531 struct dm_status status;
534 memset(&status, 0, sizeof(struct dm_status));
535 status.hdr.type = DM_STATUS_REPORT;
536 status.hdr.size = sizeof(struct dm_status);
537 status.hdr.trans_id = atomic_inc_return(&trans_id);
540 status.num_committed = vm_memory_committed();
542 vmbus_sendpacket(dm->dev->channel, &status,
543 sizeof(struct dm_status),
545 VM_PKT_DATA_INBAND, 0);
551 static void free_balloon_pages(struct hv_dynmem_device *dm,
552 union dm_mem_page_range *range_array)
554 int num_pages = range_array->finfo.page_cnt;
555 __u64 start_frame = range_array->finfo.start_page;
559 for (i = 0; i < num_pages; i++) {
560 pg = pfn_to_page(i + start_frame);
562 dm->num_pages_ballooned--;
568 static int alloc_balloon_pages(struct hv_dynmem_device *dm, int num_pages,
569 struct dm_balloon_response *bl_resp, int alloc_unit,
575 if (num_pages < alloc_unit)
578 for (i = 0; (i * alloc_unit) < num_pages; i++) {
579 if (bl_resp->hdr.size + sizeof(union dm_mem_page_range) >
581 return i * alloc_unit;
584 * We execute this code in a thread context. Furthermore,
585 * we don't want the kernel to try too hard.
587 pg = alloc_pages(GFP_HIGHUSER | __GFP_NORETRY |
588 __GFP_NOMEMALLOC | __GFP_NOWARN,
589 get_order(alloc_unit << PAGE_SHIFT));
593 return i * alloc_unit;
597 dm->num_pages_ballooned += alloc_unit;
599 bl_resp->range_count++;
600 bl_resp->range_array[i].finfo.start_page =
602 bl_resp->range_array[i].finfo.page_cnt = alloc_unit;
603 bl_resp->hdr.size += sizeof(union dm_mem_page_range);
612 static void balloon_up(struct hv_dynmem_device *dm, struct dm_balloon *req)
614 int num_pages = req->num_pages;
615 int num_ballooned = 0;
616 struct dm_balloon_response *bl_resp;
619 bool alloc_error = false;
625 * Currently, we only support 4k allocations.
630 bl_resp = (struct dm_balloon_response *)send_buffer;
631 memset(send_buffer, 0, PAGE_SIZE);
632 bl_resp->hdr.type = DM_BALLOON_RESPONSE;
633 bl_resp->hdr.trans_id = atomic_inc_return(&trans_id);
634 bl_resp->hdr.size = sizeof(struct dm_balloon_response);
635 bl_resp->more_pages = 1;
638 num_pages -= num_ballooned;
639 num_ballooned = alloc_balloon_pages(dm, num_pages,
643 if ((alloc_error) || (num_ballooned == num_pages)) {
644 bl_resp->more_pages = 0;
646 dm->state = DM_INITIALIZED;
650 * We are pushing a lot of data through the channel;
651 * deal with transient failures caused because of the
652 * lack of space in the ring buffer.
656 ret = vmbus_sendpacket(dm_device.dev->channel,
660 VM_PKT_DATA_INBAND, 0);
665 } while (ret == -EAGAIN);
669 * Free up the memory we allocatted.
671 pr_info("Balloon response failed\n");
673 for (i = 0; i < bl_resp->range_count; i++)
674 free_balloon_pages(dm,
675 &bl_resp->range_array[i]);
683 static void balloon_down(struct hv_dynmem_device *dm,
684 struct dm_unballoon_request *req)
686 union dm_mem_page_range *range_array = req->range_array;
687 int range_count = req->range_count;
688 struct dm_unballoon_response resp;
691 for (i = 0; i < range_count; i++)
692 free_balloon_pages(dm, &range_array[i]);
694 if (req->more_pages == 1)
697 memset(&resp, 0, sizeof(struct dm_unballoon_response));
698 resp.hdr.type = DM_UNBALLOON_RESPONSE;
699 resp.hdr.trans_id = atomic_inc_return(&trans_id);
700 resp.hdr.size = sizeof(struct dm_unballoon_response);
702 vmbus_sendpacket(dm_device.dev->channel, &resp,
703 sizeof(struct dm_unballoon_response),
705 VM_PKT_DATA_INBAND, 0);
707 dm->state = DM_INITIALIZED;
710 static void balloon_onchannelcallback(void *context);
712 static int dm_thread_func(void *dm_dev)
714 struct hv_dynmem_device *dm = dm_dev;
716 unsigned long scan_start;
718 while (!kthread_should_stop()) {
719 t = wait_for_completion_timeout(&dm_device.config_event, 1*HZ);
721 * The host expects us to post information on the memory
722 * pressure every second.
728 scan_start = jiffies;
731 balloon_up(dm, (struct dm_balloon *)recv_buffer);
735 hot_add_req(dm, (struct dm_hot_add *)recv_buffer);
741 if (!time_in_range(jiffies, scan_start, scan_start + HZ))
750 static void version_resp(struct hv_dynmem_device *dm,
751 struct dm_version_response *vresp)
753 struct dm_version_request version_req;
756 if (vresp->is_accepted) {
758 * We are done; wakeup the
759 * context waiting for version
762 complete(&dm->host_event);
766 * If there are more versions to try, continue
767 * with negotiations; if not
768 * shutdown the service since we are not able
769 * to negotiate a suitable version number
772 if (dm->next_version == 0)
775 dm->next_version = 0;
776 memset(&version_req, 0, sizeof(struct dm_version_request));
777 version_req.hdr.type = DM_VERSION_REQUEST;
778 version_req.hdr.size = sizeof(struct dm_version_request);
779 version_req.hdr.trans_id = atomic_inc_return(&trans_id);
780 version_req.version.version = DYNMEM_PROTOCOL_VERSION_WIN7;
781 version_req.is_last_attempt = 1;
783 ret = vmbus_sendpacket(dm->dev->channel, &version_req,
784 sizeof(struct dm_version_request),
786 VM_PKT_DATA_INBAND, 0);
794 dm->state = DM_INIT_ERROR;
795 complete(&dm->host_event);
798 static void cap_resp(struct hv_dynmem_device *dm,
799 struct dm_capabilities_resp_msg *cap_resp)
801 if (!cap_resp->is_accepted) {
802 pr_info("Capabilities not accepted by host\n");
803 dm->state = DM_INIT_ERROR;
805 complete(&dm->host_event);
808 static void balloon_onchannelcallback(void *context)
810 struct hv_device *dev = context;
813 struct dm_message *dm_msg;
814 struct dm_header *dm_hdr;
815 struct hv_dynmem_device *dm = hv_get_drvdata(dev);
817 memset(recv_buffer, 0, sizeof(recv_buffer));
818 vmbus_recvpacket(dev->channel, recv_buffer,
819 PAGE_SIZE, &recvlen, &requestid);
822 dm_msg = (struct dm_message *)recv_buffer;
823 dm_hdr = &dm_msg->hdr;
825 switch (dm_hdr->type) {
826 case DM_VERSION_RESPONSE:
828 (struct dm_version_response *)dm_msg);
831 case DM_CAPABILITIES_RESPONSE:
833 (struct dm_capabilities_resp_msg *)dm_msg);
836 case DM_BALLOON_REQUEST:
837 dm->state = DM_BALLOON_UP;
838 complete(&dm->config_event);
841 case DM_UNBALLOON_REQUEST:
842 dm->state = DM_BALLOON_DOWN;
844 (struct dm_unballoon_request *)recv_buffer);
847 case DM_MEM_HOT_ADD_REQUEST:
848 dm->state = DM_HOT_ADD;
849 complete(&dm->config_event);
852 case DM_INFO_MESSAGE:
853 process_info(dm, (struct dm_info_msg *)dm_msg);
857 pr_err("Unhandled message: type: %d\n", dm_hdr->type);
864 static int balloon_probe(struct hv_device *dev,
865 const struct hv_vmbus_device_id *dev_id)
868 struct dm_version_request version_req;
869 struct dm_capabilities cap_msg;
871 do_hot_add = hot_add;
874 * First allocate a send buffer.
877 send_buffer = kmalloc(PAGE_SIZE, GFP_KERNEL);
881 ret = vmbus_open(dev->channel, dm_ring_size, dm_ring_size, NULL, 0,
882 balloon_onchannelcallback, dev);
888 dm_device.state = DM_INITIALIZING;
889 dm_device.next_version = DYNMEM_PROTOCOL_VERSION_WIN7;
890 init_completion(&dm_device.host_event);
891 init_completion(&dm_device.config_event);
894 kthread_run(dm_thread_func, &dm_device, "hv_balloon");
895 if (IS_ERR(dm_device.thread)) {
896 ret = PTR_ERR(dm_device.thread);
900 hv_set_drvdata(dev, &dm_device);
902 * Initiate the hand shake with the host and negotiate
903 * a version that the host can support. We start with the
904 * highest version number and go down if the host cannot
907 memset(&version_req, 0, sizeof(struct dm_version_request));
908 version_req.hdr.type = DM_VERSION_REQUEST;
909 version_req.hdr.size = sizeof(struct dm_version_request);
910 version_req.hdr.trans_id = atomic_inc_return(&trans_id);
911 version_req.version.version = DYNMEM_PROTOCOL_VERSION_WIN8;
912 version_req.is_last_attempt = 0;
914 ret = vmbus_sendpacket(dev->channel, &version_req,
915 sizeof(struct dm_version_request),
918 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
922 t = wait_for_completion_timeout(&dm_device.host_event, 5*HZ);
929 * If we could not negotiate a compatible version with the host
930 * fail the probe function.
932 if (dm_device.state == DM_INIT_ERROR) {
937 * Now submit our capabilities to the host.
939 memset(&cap_msg, 0, sizeof(struct dm_capabilities));
940 cap_msg.hdr.type = DM_CAPABILITIES_REPORT;
941 cap_msg.hdr.size = sizeof(struct dm_capabilities);
942 cap_msg.hdr.trans_id = atomic_inc_return(&trans_id);
944 cap_msg.caps.cap_bits.balloon = 1;
946 * While we currently don't support hot-add,
947 * we still advertise this capability since the
948 * host requires that guests partcipating in the
949 * dynamic memory protocol support hot add.
951 cap_msg.caps.cap_bits.hot_add = 1;
954 * Currently the host does not use these
955 * values and we set them to what is done in the
958 cap_msg.min_page_cnt = 0;
959 cap_msg.max_page_number = -1;
961 ret = vmbus_sendpacket(dev->channel, &cap_msg,
962 sizeof(struct dm_capabilities),
965 VMBUS_DATA_PACKET_FLAG_COMPLETION_REQUESTED);
969 t = wait_for_completion_timeout(&dm_device.host_event, 5*HZ);
976 * If the host does not like our capabilities,
977 * fail the probe function.
979 if (dm_device.state == DM_INIT_ERROR) {
984 dm_device.state = DM_INITIALIZED;
989 kthread_stop(dm_device.thread);
992 vmbus_close(dev->channel);
998 static int balloon_remove(struct hv_device *dev)
1000 struct hv_dynmem_device *dm = hv_get_drvdata(dev);
1002 if (dm->num_pages_ballooned != 0)
1003 pr_warn("Ballooned pages: %d\n", dm->num_pages_ballooned);
1005 vmbus_close(dev->channel);
1006 kthread_stop(dm->thread);
1012 static const struct hv_vmbus_device_id id_table[] = {
1013 /* Dynamic Memory Class ID */
1014 /* 525074DC-8985-46e2-8057-A307DC18A502 */
1019 MODULE_DEVICE_TABLE(vmbus, id_table);
1021 static struct hv_driver balloon_drv = {
1022 .name = "hv_balloon",
1023 .id_table = id_table,
1024 .probe = balloon_probe,
1025 .remove = balloon_remove,
1028 static int __init init_balloon_drv(void)
1031 return vmbus_driver_register(&balloon_drv);
1034 static void exit_balloon_drv(void)
1037 vmbus_driver_unregister(&balloon_drv);
1040 module_init(init_balloon_drv);
1041 module_exit(exit_balloon_drv);
1043 MODULE_DESCRIPTION("Hyper-V Balloon");
1044 MODULE_VERSION(HV_DRV_VERSION);
1045 MODULE_LICENSE("GPL");