summaryrefslogtreecommitdiff
path: root/src/dumm/dumm.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/dumm/dumm.h')
-rw-r--r--src/dumm/dumm.h95
1 files changed, 95 insertions, 0 deletions
diff --git a/src/dumm/dumm.h b/src/dumm/dumm.h
new file mode 100644
index 000000000..5414f9993
--- /dev/null
+++ b/src/dumm/dumm.h
@@ -0,0 +1,95 @@
+/*
+ * 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 "guest.h"
+#include "bridge.h"
+
+typedef struct dumm_t dumm_t;
+
+/**
+ * @brief dumm - Dynamic Uml Mesh Modeler
+ *
+ * Controls a group of UML guests and their networks.
+ * Dumm catches SIGCHD and SIGHUP to trace UML child processes and the FUSE
+ * filesystem. Do not overwrite these signal handlers!
+ */
+struct dumm_t {
+
+ /**
+ * @brief Starts a new UML guest
+ *
+ * @param name name of the guest
+ * @param kernel UML kernel to use for guest
+ * @param master mounted read only master filesystem
+ * @param mem amount of memory for guest, in MB
+ * @return guest if started, NULL if failed
+ */
+ guest_t* (*create_guest) (dumm_t *this, char *name, char *kernel,
+ char *master, int mem);
+
+ /**
+ * @brief Create an iterator over all guests.
+ *
+ * @return iteraotor over guest_t's
+ */
+ iterator_t* (*create_guest_iterator) (dumm_t *this);
+
+ /**
+ * @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 iterator over all bridges.
+ *
+ * @return iterator over bridge_t's
+ */
+ iterator_t* (*create_bridge_iterator)(dumm_t *this);
+
+ /**
+ * @brief Loads a template, create a new one if it does not exist.
+ *
+ * @param name name of the template, NULL to close
+ * @return FALSE if load/create failed
+ */
+ bool (*load_template)(dumm_t *this, char *name);
+
+ /**
+ * @brief stop all guests and destroy the modeler
+ */
+ void (*destroy) (dumm_t *this);
+};
+
+/**
+ * @brief Create a group of UML hosts and networks.
+ *
+ * @param dir directory to create guests/load from
+ * @return created UML group, or NULL if failed.
+ */
+dumm_t *dumm_create(char *dir);
+
+#endif /* DUMM_H */
+