bridging using libbridge
[strongswan.git] / src / dumm / dumm.h
1 /*
2 * Copyright (C) 2007 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 #ifndef DUMM_H
17 #define DUMM_H
18
19 #include <signal.h>
20
21 #include <library.h>
22 #include <utils/linked_list.h>
23
24 #include "guest.h"
25 #include "bridge.h"
26
27 typedef struct dumm_t dumm_t;
28
29 /**
30 * @brief dumm - Dynamic Uml Mesh Modeler
31 *
32 * Controls a group of UML guests and their networks.
33 */
34 struct dumm_t {
35
36 /**
37 * @brief Starts a new UML guest
38 *
39 * @param name name of the guest
40 * @param kernel UML kernel to use for guest
41 * @param master mounted read only master filesystem
42 * @param mem amount of memory for guest, in MB
43 * @return guest if started, NULL if failed
44 */
45 guest_t* (*create_guest) (dumm_t *this, char *name, char *kernel,
46 char *master, int mem);
47
48 /**
49 * @brief Create an iterator over all guests.
50 *
51 * @return iteraotor over guest_t's
52 */
53 iterator_t* (*create_guest_iterator) (dumm_t *this);
54
55 /**
56 * @brief Create a new bridge.
57 *
58 * @param name name of the bridge to create
59 * @return created bridge
60 */
61 bridge_t* (*create_bridge)(dumm_t *this, char *name);
62
63 /**
64 * @brief Create an iterator over all bridges.
65 *
66 * @return iterator over bridge_t's
67 */
68 iterator_t* (*create_bridge_iterator)(dumm_t *this);
69
70 /**
71 * @brief Handler for received SIG_CHILD signals.
72 *
73 * Dumm spans children, UML kernels. To track and cleanup these kernel
74 * processes, it is required that this method is called whenever a SIG_CHILD
75 * is received. The user is responsible to call sigchild_handler on each
76 * dumm_t instance with the signals siginfo_t.
77 *
78 * @param info siginfo associated to the SIG_CHILD signal
79 */
80 void (*sigchild_handler)(dumm_t *this, siginfo_t *info);
81
82 /**
83 * @brief stop all guests and destroy the modeler
84 */
85 void (*destroy) (dumm_t *this);
86 };
87
88 /**
89 * @brief Create a group of UML hosts and networks.
90 *
91 * @param dir directory to create guests/load from
92 * @return created UML group, or NULL if failed.
93 */
94 dumm_t *dumm_create(char *dir);
95
96 #endif /* DUMM_H */
97