1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/* Quagga Pthreads support -- header
* Copyright (C) 2009 Chris Hall (GMCH), Highwayman
*
* This file is part of GNU Zebra.
*
* GNU Zebra 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, or (at your
* option) any later version.
*
* GNU Zebra 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.
*
* You should have received a copy of the GNU General Public License
* along with GNU Zebra; see the file COPYING. If not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef _ZEBRA_QPNEXUS_H
#define _ZEBRA_QPNEXUS_H
#include <stdint.h>
#include <time.h>
#include <pthread.h>
#include <unistd.h>
#include <errno.h>
#include "zassert.h"
#include "qpthreads.h"
#include "qtimers.h"
#include "mqueue.h"
#include "qpselect.h"
#ifndef Inline
#define Inline static inline
#endif
/*==============================================================================
* Quagga Nexus Interface -- qpn_xxxx
*
* Object to hold, a qpthread, a qps_selection, a qtimer_pile, a mqueue_queue
* together with the thread routine to poll and dispatch their respective
* action routines.
*
*/
/* maximum time in seconds to sit in a pselect */
#define MAX_PSELECT_TIMOUT 10
/* signal for message queues */
#define SIGMQUEUE SIGUSR2
/* number of event hooks */
#define NUM_EVENT_HOOK 2
/* Work priorities */
enum qpn_priority
{
qpn_pri_highest = 1,
qpn_pri_first = 1,
qpn_pri_second = 2,
qpn_pri_third = 3,
qpn_pri_fourth = 4,
qpn_pri_lowest = 4,
};
/*==============================================================================
* Data Structures.
*/
typedef struct qpn_nexus* qpn_nexus ;
struct qpn_nexus
{
/* set true to terminate the thread (eventually) */
int terminate;
/* true if this is the main thread */
int main_thread;
/* thread ID */
qpt_thread_t thread_id;
/* pselect handler */
qps_selection selection;
/* timer pile */
qtimer_pile pile;
/* message queue */
mqueue_queue queue;
mqueue_thread_signal mts;
/* qpthread routine, can override */
void* (*start)(void*);
/* in-thread initialize, can override. Called within the thread
* after all other initializion just before thread loop */
void (*in_thread_init)(void);
/* in-thread finalize, can override. Called within thread
* just before thread dies. Nexus components all exist but
* thread loop is no longer executed */
void (*in_thread_final)(void);
/* thread loop events, can override. Called before and after message queue,
* and before I/O and timers.
* Hook should perform all work <= given priority.
* Returns the time to try again, 0 means default to maximum.
*/
qtime_mono_t (*event_hook[NUM_EVENT_HOOK])(enum qpn_priority);
};
/*==============================================================================
* Functions
*/
extern qpn_nexus qpn_init_new(qpn_nexus qtn, int main_thread);
extern void qpn_exec(qpn_nexus qtn);
extern void qpn_terminate(qpn_nexus qpn);
extern qpn_nexus qpn_free(qpn_nexus qpn);
#endif /* _ZEBRA_QPNEXUS_H */
|
