Add three main components

1. virtio-qcuda.c for qCUdevice
2. qcuda_driver.c for qCUdriver
3. qcu-library/libcudart.c for qCUlibrary

Author: coldfunction

README.md

@@ -1,18 +1,39 @@
-# qCUDA
+##qCUDA
+qCUDA is based on the virtio framework to provide the para-virtualized driver as “front-end”, 
+and the device module as “back-end” for performing the interaction with API remoting and memory management. 
+In our test environment, qCUDA can achieve above 95% of the bandwidth efficiency for most results by comparing with the native. In addition, by comparing with prior work, qCUDA has more flexibility and interposition that it can execute CUDA-compatible programs in the Linux and Windows VMs, respectively, on QEMU-KVM hypervisor for GPGPU virtualization.
 
-In start qemu vm's command, add "device virtio-hm-pci".
+##System Components
 
+The framework of qCUDA has three components, including qCUlibrary, qCUdriver and qCUdevice; the functions of 
+these three components are defined as follows:
 
-qcu-device:
-	QEMU Hypervisior with virtio device. Using in host.
+* qCUlibrary (`qcu-library`) – The interposer library in VM (guest OS) provided CUDA runtime access, interface of memory allocation, qCUDA command (qCUcmd), and passing the qCUcmd to the qCUdriver.
 
-qcu-driver:
-	virtio device driver. Using in guest.
+* qCUdriver (`qcu-driver`) – The front-end driver was responsible for the memory management, data movement, analyzing the qCUcmd from the qCUlibrary, and passing the qCUcmd by the control channel which is connected to the qCUdevice.
 
-qcu-library:
-	cuda API. Using in guest.
-	Note: before using this library, you should add "--enable-cuda" when compiler hypervisior. At Host side, it is using nvidia official driver.
+* qCUdevice (`qcu-device`) – The virtual device as the back-end was responsible for receiving/sending the qCUcmd through the control channel; it depended on receiving the qCUcmd to active related operations in the host, including to register GPU binary, convert guest physical addresses (GPA) into host virtual addresses (HVA), and handle the CUDA runtime/driver APIs for accessing the GPU.
 
-test:
-	sample code for write, read and cuda.
-	
+##Installation
+###Prerequisites
+* CUDA 7.5
+* Ubuntu 14.04.3 LTS (GNU/Linux 3.19.0-25-generic x86_64)
+* Ubuntu 14.04 image (guest OS)
+* Windows 8 image (guest OS)
+
+###How to install
+* qcu-device was modified from QEMU 2.4.0, under this forder add the "--enable-cuda option" in the configure: 
+./configure --enable-cuda and then follow the installation steps of QEMU.
+
+* Download qcu-driver and qcu-library in guest OS.
+* Enter qcu-driver and execute the commands:
+    * make all
+    * make i
+* Enter qcu-library and execute the commands:
+    * make all
+    * make install
+
+## Contributors
+* Yu-Shiang Lin
+* Luis Herrera
+* Jia-Chi Chen

qcu-device/Makefile

@@ -239,7 +239,7 @@ qemu-img-cmds.h: $(SRC_PATH)/qemu-img-cmds.hx
 	$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -h < $< > $@,"  GEN   $@")
 
 qemu-ga$(EXESUF): LIBS = $(LIBS_QGA)
-qemu-ga$(EXESUF): QEMU_CFLAGS += -I qga/qapi-generated
+qemu-ga$(EXESUF): QEMU_CFLAGS += -I qga/qapi-generated 
 
 gen-out-type = $(subst .,-,$(suffix $@))