typo
[strongswan.git] / src / dumm / guest.h
index 39a72c0..10b37aa 100644 (file)
+/*
+ * Copyright (C) 2007 Martin Willi
+ * Hochschule fuer Technik Rapperswil
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation; either version 2 of the License, or (at your
+ * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * This program 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 General Public License
+ * for more details.
+ */
+
 #ifndef GUEST_H
 #define GUEST_H
 
 #include <library.h>
-#include <utils/linked_list.h>
+#include <utils/iterator.h>
+
+#include "iface.h"
+
+typedef enum guest_state_t guest_state_t;
+
+/**
+ * @brief State of a guest (started, stopped, ...)
+ */
+enum guest_state_t {
+       /** guest kernel not running at all */
+       GUEST_STOPPED,
+       /** kernel started, but not yet available */
+       GUEST_STARTING,
+       /** guest is up and running */
+       GUEST_RUNNING,
+       /** guest has been paused */
+       GUEST_PAUSED,
+       /** guest is stopping (shutting down) */
+       GUEST_STOPPING,
+};
+
+/**
+ * string mappings for guest_state_t
+ */
+extern enum_name_t *guest_state_names;
 
 typedef struct guest_t guest_t;
 
+/**
+ * @brief A guest is a UML instance running on the host.
+ **/
 struct guest_t {
        
+       /**
+        * @brief Get the name of this guest.
+        *
+        * @return              name of the guest
+        */
        char* (*get_name) (guest_t *this);
        
+       /**
+        * @brief Get the process ID of the guest child process.
+        *
+        * @return              name of the guest
+        */
+       pid_t (*get_pid) (guest_t *this);
+       
+       /**
+        * @brief Get the state of the guest (stopped, started, etc.).
+        *
+        * @return              guests state
+        */
+       guest_state_t (*get_state)(guest_t *this);      
+       
+       /**
+        * @brief Start the guest.
+        *
+        * @return              TRUE if guest successfully started
+        */
        bool (*start) (guest_t *this);
        
+       /**
+        * @brief Kill the guest.
+        *
+        * @return              TRUE if guest was running and killed
+        */
        bool (*stop) (guest_t *this);
        
+       /**
+        * @brief Get a console pts device.
+        *
+        * Every guest has 5 consoles, numbered from 1 to 5. These are associated
+        * to a unique pts device on the host. 
+        *
+        * @param console       console number to get (1-5)
+        * @return                      pts device file name, NULL if failed
+        */
+       char* (*get_console) (guest_t *this, int console);
+       
+       /**
+        * @brief Create a new interface in the current scenario.
+        *
+        * @param name  name of the interface in the guest
+        * @return              created interface, or NULL if failed
+        */
+       iface_t* (*create_iface)(guest_t *this, char *name);
+       
+       /**
+        * @brief Create an iterator over all guest interfaces.
+        *
+        * @return              iterator over iface_t's
+        */
+       iterator_t* (*create_iface_iterator)(guest_t *this);
+       
+       /**
+        * @brief Set the template COWFS overlay to use.
+        *
+        * @param parent        parent directory where template diff should point to
+        * @return                      FALSE if failed
+        */
+       bool (*load_template)(guest_t *this, char *parent);
+
+       /**
+        * @brief Called whenever a SIGCHILD for the guests PID is received.
+        */
+       void (*sigchild)(guest_t *this);
+       
+       /**
+        * @brief Close and destroy a guest with all interfaces
+        */     
        void (*destroy) (guest_t *this);
 };
 
-guest_t *guest_create(char *name, char *kernel, char *master, int mem);
+/**
+ * @brief Create a new, unstarted guest.
+ *
+ * @param parent       parent directory to create the guest in
+ * @param name         name of the guest to create
+ * @param kernel       kernel this guest uses
+ * @param master       read-only master filesystem for guest
+ * @param mem          amount of memory to give the guest
+ */
+guest_t *guest_create(char *parent, char *name, char *kernel,
+                                         char *master, int mem);
 
+/**
+ * @brief Load a guest created with guest_create().
+ *
+ * @param parent       parent directory to look for a guest
+ * @param name         name of the guest directory
+ */
+guest_t *guest_load(char *parent, char *name);
 
 #endif /* GUEST_H */
+