boinc/samples/vboxwrapper/vbox.h

115 lines
3.5 KiB
C++

// This file is part of BOINC.
// http://boinc.berkeley.edu
// Copyright (C) 2010 University of California
//
// BOINC is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation,
// either version 3 of the License, or (at your option) any later version.
//
// BOINC is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with BOINC. If not, see <http://www.gnu.org/licenses/>.
// Provide cross-platform interfaces for making changes to VirtualBox
#ifndef _VBOX_H_
#define _VBOX_H_
// raw floppy drive device
class FloppyIO;
// represents a VirtualBox VM
struct VBOX_VM {
VBOX_VM();
~VBOX_VM();
// Floppy IO abstraction
FloppyIO* pFloppy;
// name of the OS the VM runs
std::string os_name;
// size of the memory allocation for the VM, in megabytes
std::string memory_size_mb;
// name of the virtual machine disk image file
std::string image_filename;
// name of the virtual machine floppy disk image file
std::string floppy_image_filename;
// unique name for the VM
std::string vm_name;
// required CPU core count
std::string vm_cpu_count;
// maximum amount of wall-clock time this VM is allowed to run before
// considering itself done.
double job_duration;
// is the VM suspended?
bool suspended;
// is network access temporarily suspended?
bool network_suspended;
// is VM even online?
bool online;
// Has the VM crashed?
bool crashed;
// whether to use CERN specific data structures
bool enable_cern_dataformat;
// whether to use shared directory infrastructure at all
bool enable_shared_directory;
// whether to use floppy io infrastructure at all
bool enable_floppyio;
// whether we were instructed to only register the VM.
// useful for debugging VMs.
bool register_only;
// whether to allow network access at all
bool enable_network;
// the following for optional port forwarding
int pf_host_port;
// dynamically assigned
int pf_guest_port;
// specified in config file
int run();
int stop();
int pause();
int resume();
void cleanup();
void poll(bool log_state = true);
bool is_running();
bool is_paused();
int register_vm();
int register_vm_firewall_rules();
bool is_hdd_registered();
bool is_registered();
int deregister_stale_vm();
int deregister_vm();
int start();
int set_network_access(bool enabled);
int set_cpu_usage_fraction(double);
int set_network_max_bytes_sec(double);
int get_process_id(int& process_id);
int get_network_bytes_sent(double& sent);
int get_network_bytes_received(double& received);
int get_system_log(std::string& log);
int get_vm_log(std::string& log);
int read_floppy(std::string& data);
int write_floppy(std::string& data);
int get_port_forwarding_port();
int initialize();
int get_install_directory(std::string& dir);
int get_slot_directory(std::string& dir);
int vbm_popen(
std::string& command, std::string& output, const char* item, bool log_error = true, bool retry_failures = true
);
int vbm_popen_raw(
std::string& command, std::string& output
);
};
#endif