0cfb2cc6d9355c2ef92c9b3fd126fa756c01faa8
[oonf.git] / src / core / os_system.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2011, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #ifndef OS_SYSTEM_H_
43 #define OS_SYSTEM_H_
44
45 #include <stdio.h>
46 #include <sys/time.h>
47
48 #include "common/common_types.h"
49 #include "olsr_logging.h"
50 #include "olsr_interface.h"
51
52 #define MSEC_PER_SEC 1000
53 #define USEC_PER_MSEC 1000
54
55 /*
56  * Set one of the following defines in the os specific os_net includes
57  * to OS_SPECIFIC to define that the os code is implementing the function
58  * itself and does not use the generic function
59  * Set it to OS_GENERIC to define that the code use the default implementation.
60  *
61  * Example from os_system_linux.h:
62  *
63  * #define OS_SYSTEM_INIT         OS_SPECIFIC
64  * #define OS_SYSTEM_INIT_IF      OS_SPECIFIC
65  * #define OS_SYSTEM_SET_IFSTATE  OS_SPECIFIC
66  * #define OS_SYSTEM_GETTIMEOFDAY OS_GENERIC
67  * #define OS_SYSTEM_LOG          OS_GENERIC
68  */
69
70 struct olsr_system_feedback;
71
72 /* set the guard macro so we can include the os specific settings */
73 #define OS_NET_SPECIFIC_INCLUDE
74 #include "os_helper.h"
75
76 #ifdef OS_LINUX
77 #include "os_linux/os_system_linux.h"
78 #endif
79
80 #ifdef OS_BSD
81 #include "os_bsd/os_system_bsd.h"
82 #endif
83
84 #ifdef OS_WIN32
85 #include "os_win32/os_system_win32.h"
86 #endif
87
88 #undef OS_NET_SPECIFIC_INCLUDE
89
90 struct olsr_system_feedback {
91   struct list_entity _node;
92
93   uint32_t seq_min, seq_max;
94   int outstanding_fb;
95
96   void (*cb_ack)(struct olsr_system_feedback *, uint32_t seq, int error);
97   void (*cb_timeout)(struct olsr_system_feedback *);
98
99   struct olsr_timer_entry *timeout;
100
101   void *custom;
102 };
103
104 /* prototypes for all os_system functions */
105 EXPORT int os_system_init(void);
106 EXPORT void os_system_cleanup(void);
107
108 EXPORT int os_system_set_interface_state(const char *dev, bool up);
109
110 EXPORT void os_system_openlog(void);
111 EXPORT void os_system_closelog(void);
112 EXPORT void os_system_log(enum log_severity, const char *);
113
114 EXPORT void os_system_feedback_add(struct olsr_system_feedback *feedback);
115 EXPORT void os_system_feedback_remove(struct olsr_system_feedback *feedback);
116
117 /*
118  * INLINE implementations for generic os_net functions
119  */
120
121 #if OS_SYSTEM_GETTIMEOFDAY == OS_GENERIC
122 /**
123  * Inline wrapper around gettimeofday
124  * @param tv pointer to target timeval object
125  * @return -1 if an error happened, 0 otherwise
126  */
127 static INLINE int
128 os_system_gettimeofday(struct timeval *tv) {
129   return gettimeofday(tv, NULL);
130 }
131 #endif
132
133
134 #endif /* OS_SYSTEM_H_ */