2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
25 #include <palacios/vmm_types.h>
26 #include <palacios/vmm_list.h>
27 #include <palacios/vmm_string.h>
28 #include <palacios/vmm_hashtable.h>
29 #include <palacios/vmm_msr.h>
30 #include <palacios/vmm_config.h>
31 #include <palacios/vmm_ethernet.h>
32 #include <palacios/vmm_keyed_stream.h>
38 typedef void * v3_dev_data_t;
47 struct v3_device_ops * ops;
49 struct v3_vm_info * vm;
51 struct list_head dev_link;
54 struct list_head res_hooks;
60 struct list_head dev_list;
61 struct hashtable * dev_table;
63 struct list_head blk_list;
64 struct hashtable * blk_table;
66 struct list_head net_list;
67 struct hashtable * net_table;
69 struct list_head char_list;
70 struct hashtable * char_table;
72 struct list_head cons_list;
73 struct hashtable * cons_table;
77 int v3_create_device(struct v3_vm_info * vm, const char * dev_name, v3_cfg_tree_t * cfg);
79 struct vm_device * v3_find_dev(struct v3_vm_info * info, const char * dev_name);
82 // Registration of devices
85 // The following device manager functions should only be called
86 // when the guest is stopped
91 int v3_init_dev_mgr(struct v3_vm_info * vm);
92 int v3_deinit_dev_mgr(struct v3_vm_info * vm);
94 int v3_free_vm_devices(struct v3_vm_info * vm);
102 int V3_init_devices();
103 int V3_deinit_devices();
106 struct v3_device_ops {
107 int (*free)(void * private_data);
109 int (*checkpoint)(struct vm_device *dev, v3_keyed_stream_t stream);
110 int (*restore)(struct vm_device *dev, v3_keyed_stream_t stream);
118 int v3_dev_hook_io(struct vm_device * dev,
120 int (*read)(struct guest_info * core, uint16_t port, void * dst, uint_t length, void * priv_data),
121 int (*write)(struct guest_info * core, uint16_t port, void * src, uint_t length, void * priv_data));
123 int v3_dev_unhook_io(struct vm_device * dev,
127 int v3_dev_hook_msr(struct vm_device * dev,
129 int (*read)(struct guest_info * core, uint32_t msr, struct v3_msr * dst, void * priv_data),
130 int (*write)(struct guest_info * core, uint32_t msr, struct v3_msr src, void * priv_data));
132 int v3_dev_unhook_msr(struct vm_device * dev,
138 struct vm_device * v3_add_device(struct v3_vm_info * vm, char * name,
139 struct v3_device_ops * ops, void * private_data);
140 int v3_remove_device(struct vm_device * dev);
143 int v3_attach_device(struct v3_vm_info * vm, struct vm_device * dev);
144 int v3_detach_device(struct vm_device * dev);
145 struct vm_device * v3_allocate_device(char * name, struct v3_device_ops * ops, void * private_data);
148 struct v3_device_info {
150 int (*init)(struct v3_vm_info * info, v3_cfg_tree_t * cfg);
154 #define device_register(name, init_dev_fn) \
155 static char _v3_device_name[] = name; \
156 static struct v3_device_info _v3_device \
157 __attribute__((__used__)) \
158 __attribute__((unused, __section__ ("_v3_devices"), \
159 aligned(sizeof(addr_t)))) \
160 = {_v3_device_name , init_dev_fn};
165 void v3_print_dev_mgr(struct v3_vm_info * vm);
168 struct v3_dev_blk_ops {
169 uint64_t (*get_capacity)(void * private_data);
170 // Reads always operate on 2048 byte blocks
171 int (*read)(uint8_t * buf, uint64_t lba, uint64_t num_bytes, void * private_data);
172 int (*write)(uint8_t * buf, uint64_t lba, uint64_t num_bytes, void * private_data);
175 struct v3_dev_net_ops {
176 /* Backend implemented functions */
177 int (*send)(uint8_t * buf, uint32_t count, void * private_data);
178 void (*start_rx)(void * back_data);
179 void (*stop_rx)(void * back_data);
181 /* Frontend implemented functions */
182 int (*recv)(uint8_t * buf, uint32_t count, void * frnt_data);
183 void (*poll)(struct v3_vm_info * vm, void * frnt_data);
184 void (*start_tx)(void * frnt_data);
185 void (*stop_tx)(void * frnt_data);
187 /* This is ugly... */
188 void * frontend_data;
189 char fnt_mac[ETH_ALEN];
192 struct v3_dev_console_ops {
193 int (*update_screen)(uint_t x, uint_t y, uint_t length, uint8_t * fb_data, void * private_data);
194 int (*update_cursor)(uint_t x, uint_t y, void * private_data);
195 int (*scroll)(int rows, void * private_data);
196 int (*set_text_resolution)(int cols, int rows, void * private_data);
198 /* frontend implemented functions */
199 int (*get_screen)(uint_t x, uint_t y, uint_t length, void * frontend_data);
203 struct v3_dev_char_ops {
204 /* Backend implemented functions */
205 int (*write)(uint8_t * buf, uint64_t len, void * private_data);
206 // int (*read)(uint8_t * buf, uint64_t len, void * private_data);
208 /* Frontend Implemented functions */
209 int (*push)(struct v3_vm_info * vm, uint8_t * buf, uint64_t len, void * private_data);
213 int v3_dev_add_blk_frontend(struct v3_vm_info * vm,
215 int (*connect)(struct v3_vm_info * vm,
216 void * frontend_data,
217 struct v3_dev_blk_ops * ops,
219 void * private_data),
222 int v3_dev_connect_blk(struct v3_vm_info * vm,
223 char * frontend_name,
224 struct v3_dev_blk_ops * ops,
226 void * private_data);
228 int v3_dev_add_net_frontend(struct v3_vm_info * vm,
230 int (*connect)(struct v3_vm_info * vm,
231 void * frontend_data,
232 struct v3_dev_net_ops * ops,
234 void * private_data),
237 int v3_dev_connect_net(struct v3_vm_info * vm,
238 char * frontend_name,
239 struct v3_dev_net_ops * ops,
241 void * private_data);
246 int v3_dev_add_console_frontend(struct v3_vm_info * vm,
248 int (*connect)(struct v3_vm_info * vm,
249 void * frontend_data,
250 struct v3_dev_console_ops * ops,
252 void * private_data),
255 int v3_dev_connect_console(struct v3_vm_info * vm,
256 char * frontend_name,
257 struct v3_dev_console_ops * ops,
259 void * private_data);
263 int v3_dev_add_char_frontend(struct v3_vm_info * vm,
265 int (*connect)(struct v3_vm_info * vm,
266 void * frontend_data,
267 struct v3_dev_char_ops * ops,
270 void ** push_fn_arg),
273 int v3_dev_connect_char(struct v3_vm_info * vm,
274 char * frontend_name,
275 struct v3_dev_char_ops * ops,
278 void ** push_fn_arg);
281 #endif // ! __V3VEE__