added a Dumm template enumerator
[strongswan.git] / src / dumm / dumm.h
index f18817a..b368259 100644 (file)
@@ -1,15 +1,29 @@
+/*
+ * Copyright (C) 2008 Tobias Brunner
+ * 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 DUMM_H
 #define DUMM_H
 
+#include <signal.h>
+
 #include <library.h>
-#include <utils/linked_list.h>
+#include <utils/enumerator.h>
 
 #include "guest.h"
-
-#define HOST_DIR "host"
-#define MOUNT_DIR "mount"
-#define RUN_DIR "run"
-
+#include "bridge.h"
 
 typedef struct dumm_t dumm_t;
 
@@ -24,20 +38,64 @@ struct dumm_t {
         * @brief Starts a new UML guest
         *
         * @param name          name of the guest
-        * @param kernel        kernel to boot
+        * @param kernel        UML kernel to use for guest
         * @param master        mounted read only master filesystem
-        * @param mem           amount of memory for guest, in MB
+        * @param args          additional args to pass to kernel
         * @return                      guest if started, NULL if failed
         */
-       guest_t* (*start_guest) (dumm_t *this, char *name, char *kernel,
-                                                        char *master, int mem);
+       guest_t* (*create_guest) (dumm_t *this, char *name, char *kernel, 
+                                                         char *master, char *args);
+       
+       /**
+        * @brief Create an enumerator over all guests.
+        *
+        * @return                      enumerator over guest_t's
+        */
+       enumerator_t* (*create_guest_enumerator) (dumm_t *this);
        
        /**
-        * @brief Create an iterator over all guests.
+        * @brief Delete a guest from disk.
         *
-        * @return                      iteraotor over guest_t's
+        * @param guest         guest to destroy
         */
-       iterator_t* (*create_guest_iterator) (dumm_t *this);
+       void (*delete_guest) (dumm_t *this, guest_t *guest);
+       
+       /**
+        * @brief Create a new bridge.
+        *
+        * @param name          name of the bridge to create
+        * @return                      created bridge
+        */
+       bridge_t* (*create_bridge)(dumm_t *this, char *name);
+       
+       /**
+        * @brief Create an enumerator over all bridges.
+        *
+        * @return                      enumerator over bridge_t's
+        */
+       enumerator_t* (*create_bridge_enumerator)(dumm_t *this);
+       
+       /**
+        * @brief Delete a bridge.
+        *
+        * @param bridge        bridge to destroy
+        */
+       void (*delete_bridge) (dumm_t *this, bridge_t *bridge);
+       
+       /**
+        * @brief Loads a template, create a new one if it does not exist.
+        *
+        * @param name          dir to the template, NULL to close
+        * @return                      FALSE if load/create failed
+        */
+       bool (*load_template)(dumm_t *this, char *dir);
+       
+       /**
+        * @brief Create an enumerator over all available templates.
+        *
+        * @return                      enumerator over char*
+        */
+       enumerator_t* (*create_template_enumerator)(dumm_t *this);
        
        /**
         * @brief stop all guests and destroy the modeler
@@ -45,6 +103,13 @@ struct dumm_t {
        void (*destroy) (dumm_t *this);
 };
 
-dumm_t *dumm_create();
+/**
+ * @brief Create a group of UML hosts and networks.
+ *
+ * @param dir                  directory to create guests/load from, NULL for cwd
+ * @return                             created UML group, or NULL if failed.
+ */
+dumm_t *dumm_create(char *dir);
 
 #endif /* DUMM_H */
+