palacios/include/palacios/vmm_dev_mgr.h

   1 /*
   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.
   5  *
   6  * The V3VEE Project is a joint project between Northwestern University
   7  * and the University of New Mexico.  You can find out more at
   8  * http://www.v3vee.org
   9  *
  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.
  13  *
  14  * Author: Jack Lange <jarusl@cs.northwestern.edu>
  15  *
  16  * This is free software.  You are permitted to use,
  17  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  18  */
  19
  20 #ifndef _VMM_DEV_MGR
  21 #define _VMM_DEV_MGR
  22
  23 #ifdef __V3VEE__
  24
  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_config.h>
  30 #include <palacios/vmm_ethernet.h>
  31
  32
  33 struct v3_vm_info;
  34
  35 struct v3_device_ops;
  36
  37 typedef void * v3_dev_data_t;
  38
  39 struct vm_device;
  40
  41 struct vm_device {
  42     char name[32];
  43
  44     void * private_data;
  45
  46     struct v3_device_ops * ops;
  47
  48     struct v3_vm_info * vm;
  49
  50     struct list_head dev_link;
  51
  52
  53     uint_t num_io_hooks;
  54     struct list_head io_hooks;
  55 };
  56
  57
  58 struct vmm_dev_mgr {
  59     uint_t num_devs;
  60     struct list_head dev_list;
  61     struct hashtable * dev_table;
  62
  63     struct list_head blk_list;
  64     struct hashtable * blk_table;
  65
  66     struct list_head net_list;
  67     struct hashtable * net_table;
  68
  69     struct list_head char_list;
  70     struct hashtable * char_table;
  71
  72     struct list_head cons_list;
  73     struct hashtable * cons_table;
  74
  75 };
  76
  77 int v3_create_device(struct v3_vm_info * vm, const char * dev_name, v3_cfg_tree_t * cfg);
  78
  79 struct vm_device * v3_find_dev(struct v3_vm_info * info, const char * dev_name);
  80
  81
  82 // Registration of devices
  83
  84 //
  85 // The following device manager functions should only be called
  86 // when the guest is stopped
  87 //
  88
  89
  90
  91 int v3_init_dev_mgr(struct v3_vm_info * vm);
  92 int v3_deinit_dev_mgr(struct v3_vm_info * vm);
  93
  94 int v3_free_vm_devices(struct v3_vm_info * vm);
  95
  96
  97
  98
  99
 100
 101
 102 int V3_init_devices();
 103 int V3_deinit_devices();
 104
 105
 106 struct v3_device_ops {
 107     int (*free)(void * private_data);
 108
 109     //int (*save)(struct vm_device *dev, struct *iostream);
 110     //int (*restore)(struct vm_device *dev, struct *iostream);
 111 };
 112
 113
 114
 115
 116
 117
 118 int v3_dev_hook_io(struct vm_device   * dev,
 119                    ushort_t            port,
 120                    int (*read)(struct guest_info * core, ushort_t port, void * dst, uint_t length, void * priv_data),
 121                    int (*write)(struct guest_info * core, ushort_t port, void * src, uint_t length, void * priv_data));
 122
 123 int v3_dev_unhook_io(struct vm_device   * dev,
 124                      ushort_t            port);
 125
 126
 127
 128 struct vm_device * v3_add_device(struct v3_vm_info * vm, char * name,
 129                                  struct v3_device_ops * ops, void * private_data);
 130 int v3_remove_device(struct vm_device * dev);
 131
 132
 133 int v3_attach_device(struct v3_vm_info * vm, struct vm_device * dev);
 134 int v3_detach_device(struct vm_device * dev);
 135 struct vm_device * v3_allocate_device(char * name, struct v3_device_ops * ops, void * private_data);
 136
 137
 138 struct v3_device_info {
 139     char * name;
 140     int (*init)(struct v3_vm_info * info, v3_cfg_tree_t * cfg);
 141 };
 142
 143
 144 #define device_register(name, init_dev_fn)                              \
 145     static char _v3_device_name[] = name;                               \
 146     static struct v3_device_info _v3_device                             \
 147     __attribute__((__used__))                                           \
 148         __attribute__((unused, __section__ ("_v3_devices"),             \
 149                        aligned(sizeof(addr_t))))                        \
 150         = {_v3_device_name , init_dev_fn};
 151
 152
 153
 154
 155 void v3_print_dev_mgr(struct v3_vm_info * vm);
 156
 157
 158 struct v3_dev_blk_ops {
 159     uint64_t (*get_capacity)(void * private_data);
 160     // Reads always operate on 2048 byte blocks
 161     int (*read)(uint8_t * buf, uint64_t lba, uint64_t num_bytes, void * private_data);
 162     int (*write)(uint8_t * buf, uint64_t lba, uint64_t num_bytes, void * private_data);
 163 };
 164
 165 struct v3_dev_net_ops {
 166     /* Backend implemented functions */
 167     int (*send)(uint8_t * buf, uint32_t count, void * private_data);
 168     void (*start_rx)(void * back_data);
 169     void (*stop_rx)(void * back_data);
 170
 171     /* Frontend implemented functions */
 172     int (*recv)(uint8_t * buf, uint32_t count, void * frnt_data);
 173     void (*poll)(struct v3_vm_info * vm, void * frnt_data);
 174     void (*start_tx)(void * frnt_data);
 175     void (*stop_tx)(void * frnt_data);
 176
 177     /* This is ugly... */
 178     void * frontend_data;
 179     char fnt_mac[ETH_ALEN];
 180 };
 181
 182 struct v3_dev_console_ops {
 183     int (*update_screen)(uint_t x, uint_t y, uint_t length, uint8_t * fb_data, void * private_data);
 184     int (*update_cursor)(uint_t x, uint_t y, void * private_data);
 185     int (*scroll)(int rows, void * private_data);
 186     int (*set_text_resolution)(int cols, int rows, void * private_data);
 187
 188     /* frontend implemented functions */
 189     int (*get_screen)(uint_t x, uint_t y, uint_t length, void * frontend_data);
 190     void * push_fn_arg;
 191 };
 192
 193 struct v3_dev_char_ops {
 194     /* Backend implemented functions */
 195     int (*write)(uint8_t * buf, uint64_t len, void * private_data);
 196     //  int (*read)(uint8_t * buf, uint64_t len, void * private_data);
 197
 198     /* Frontend Implemented functions */
 199     int (*push)(struct v3_vm_info * vm, uint8_t * buf, uint64_t len, void * private_data);
 200 };
 201
 202
 203 int v3_dev_add_blk_frontend(struct v3_vm_info * vm,
 204                             char * name,
 205                             int (*connect)(struct v3_vm_info * vm,
 206                                             void * frontend_data,
 207                                             struct v3_dev_blk_ops * ops,
 208                                             v3_cfg_tree_t * cfg,
 209                                             void * private_data),
 210                             void * priv_data);
 211
 212 int v3_dev_connect_blk(struct v3_vm_info * vm,
 213                        char * frontend_name,
 214                        struct v3_dev_blk_ops * ops,
 215                        v3_cfg_tree_t * cfg,
 216                        void * private_data);
 217
 218 int v3_dev_add_net_frontend(struct v3_vm_info * vm,
 219                             char * name,
 220                             int (*connect)(struct v3_vm_info * vm,
 221                                             void * frontend_data,
 222                                             struct v3_dev_net_ops * ops,
 223                                             v3_cfg_tree_t * cfg,
 224                                             void * private_data),
 225                             void * priv_data);
 226
 227 int v3_dev_connect_net(struct v3_vm_info * vm,
 228                        char * frontend_name,
 229                        struct v3_dev_net_ops * ops,
 230                        v3_cfg_tree_t * cfg,
 231                        void * private_data);
 232
 233
 234
 235
 236 int v3_dev_add_console_frontend(struct v3_vm_info * vm,
 237                                 char * name,
 238                                 int (*connect)(struct v3_vm_info * vm,
 239                                                void * frontend_data,
 240                                                struct v3_dev_console_ops * ops,
 241                                                v3_cfg_tree_t * cfg,
 242                                                void * private_data),
 243                                 void * priv_data);
 244
 245 int v3_dev_connect_console(struct v3_vm_info * vm,
 246                            char * frontend_name,
 247                            struct v3_dev_console_ops * ops,
 248                            v3_cfg_tree_t * cfg,
 249                            void * private_data);
 250
 251
 252
 253 int v3_dev_add_char_frontend(struct v3_vm_info * vm,
 254                              char * name,
 255                              int (*connect)(struct v3_vm_info * vm,
 256                                             void * frontend_data,
 257                                             struct v3_dev_char_ops * ops,
 258                                             v3_cfg_tree_t * cfg,
 259                                             void * private_data,
 260                                             void ** push_fn_arg),
 261                              void * priv_data);
 262
 263 int v3_dev_connect_char(struct v3_vm_info * vm,
 264                         char * frontend_name,
 265                         struct v3_dev_char_ops * ops,
 266                         v3_cfg_tree_t * cfg,
 267                         void * private_data,
 268                         void ** push_fn_arg);
 269
 270
 271 #endif // ! __V3VEE__
 272
 273 #endif