Navigation


source: freeDiameter/freeDiameter/p_psm.c @ 20:277ec00d793e

Last change on this file since 20:277ec00d793e was 20:277ec00d793e, checked in by Sebastien Decugis <sdecugis@nict.go.jp>, 12 years ago

Backup before typhoon... Progress on server side

File size: 8.7 KB
Line 
1/*********************************************************************************************************
2* Software License Agreement (BSD License)                                                               *
3* Author: Sebastien Decugis <sdecugis@nict.go.jp>                                                        *
4*                                                                                                        *
5* Copyright (c) 2009, WIDE Project and NICT                                                              *
6* All rights reserved.                                                                                   *
7*                                                                                                        *
8* Redistribution and use of this software in source and binary forms, with or without modification, are  *
9* permitted provided that the following conditions are met:                                              *
10*                                                                                                        *
11* * Redistributions of source code must retain the above                                                 *
12*   copyright notice, this list of conditions and the                                                    *
13*   following disclaimer.                                                                                *
14*                                                                                                        *
15* * Redistributions in binary form must reproduce the above                                              *
16*   copyright notice, this list of conditions and the                                                    *
17*   following disclaimer in the documentation and/or other                                               *
18*   materials provided with the distribution.                                                            *
19*                                                                                                        *
20* * Neither the name of the WIDE Project or NICT nor the                                                 *
21*   names of its contributors may be used to endorse or                                                  *
22*   promote products derived from this software without                                                  *
23*   specific prior written permission of WIDE Project and                                                *
24*   NICT.                                                                                                *
25*                                                                                                        *
26* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED *
27* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
28* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR *
29* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT     *
30* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS    *
31* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR *
32* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF   *
33* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                                                             *
34*********************************************************************************************************/
35
36#include "fD.h"
37
38const char *peer_state_str[] = { 
39          "STATE_NEW"
40        , "STATE_OPEN"
41        , "STATE_CLOSED"
42        , "STATE_CLOSING"
43        , "STATE_WAITCNXACK"
44        , "STATE_WAITCNXACK_ELEC"
45        , "STATE_WAITCEA"
46        , "STATE_OPEN_HANDSHAKE"
47        , "STATE_SUSPECT"
48        , "STATE_REOPEN"
49        , "STATE_ZOMBIE"
50        };
51
52const char * fd_pev_str(int event)
53{
54        switch (event) {
55        #define case_str( _val )\
56                case _val : return #_val
57                case_str(FDEVP_TERMINATE);
58                case_str(FDEVP_DUMP_ALL);
59                case_str(FDEVP_MSG_INCOMING);
60                case_str(FDEVP_PSM_TIMEOUT);
61               
62                default:
63                        TRACE_DEBUG(FULL, "Unknown event : %d", event);
64                        return "Unknown event";
65        }
66}
67
68
69static int started = 0;
70static pthread_mutex_t  started_mtx = PTHREAD_MUTEX_INITIALIZER;
71static pthread_cond_t   started_cnd = PTHREAD_COND_INITIALIZER;
72
73/* Wait for start signal */
74static int fd_psm_waitstart()
75{
76        TRACE_ENTRY("");
77        CHECK_POSIX( pthread_mutex_lock(&started_mtx) );
78awake: 
79        if (! started) {
80                pthread_cleanup_push( fd_cleanup_mutex, &started_mtx );
81                CHECK_POSIX( pthread_cond_wait(&started_cnd, &started_mtx) );
82                pthread_cleanup_pop( 0 );
83                goto awake;
84        }
85        CHECK_POSIX( pthread_mutex_unlock(&started_mtx) );
86        return 0;
87}
88
89/* Cancelation cleanup : set ZOMBIE state in the peer */
90void cleanup_state(void * arg) 
91{
92        struct fd_peer * peer = (struct fd_peer *)arg;
93        CHECK_PARAMS_DO( CHECK_PEER(peer), return );
94        peer->p_hdr.info.pi_state = STATE_ZOMBIE;
95        return;
96}
97
98/* Set timeout timer of next event */
99static void psm_next_timeout(struct fd_peer * peer, int add_random, int delay)
100{
101        /* Initialize the timer */
102        CHECK_POSIX_DO(  clock_gettime( CLOCK_REALTIME,  &peer->p_psm_timer ), ASSERT(0) );
103       
104        if (add_random) {
105                if (delay > 2)
106                        delay -= 2;
107                else
108                        delay = 0;
109
110                /* Add a random value between 0 and 4sec */
111                peer->p_psm_timer.tv_sec += random() % 4;
112                peer->p_psm_timer.tv_nsec+= random() % 1000000000L;
113                if (peer->p_psm_timer.tv_nsec > 1000000000L) {
114                        peer->p_psm_timer.tv_nsec -= 1000000000L;
115                        peer->p_psm_timer.tv_sec ++;
116                }
117        }
118       
119        peer->p_psm_timer.tv_sec += delay;
120       
121#if 0
122        /* temporary for debug */
123        peer->p_psm_timer.tv_sec += 10;
124#endif
125}
126
127/* Wait for the next event in the PSM, or timeout */
128static int psm_ev_timedget(struct fd_peer * peer, int *code, void ** data)
129{
130        struct fd_event * ev;
131        int ret = 0;
132       
133        TRACE_ENTRY("%p %p %p", peer, code, data);
134       
135        ret = fd_fifo_timedget(peer->p_events, &ev, &peer->p_psm_timer);
136        if (ret == ETIMEDOUT) {
137                *code = FDEVP_PSM_TIMEOUT;
138                *data = NULL;
139        } else {
140                CHECK_FCT( ret );
141                *code = ev->code;
142                *data = ev->data;
143                free(ev);
144        }
145       
146        return 0;
147}
148
149/* The state machine thread (controler) */
150static void * p_psm_th( void * arg )
151{
152        struct fd_peer * peer = (struct fd_peer *)arg;
153        int created_started = started;
154        int event;
155        void * ev_data;
156       
157        CHECK_PARAMS_DO( CHECK_PEER(peer), ASSERT(0) );
158       
159        pthread_cleanup_push( cleanup_state, arg );
160       
161        /* Set the thread name */
162        {
163                char buf[48];
164                sprintf(buf, "PSM/%.*s", sizeof(buf) - 5, peer->p_hdr.info.pi_diamid);
165                fd_log_threadname ( buf );
166        }
167       
168        /* The state machine starts in CLOSED state */
169        peer->p_hdr.info.pi_state = STATE_CLOSED;
170       
171        /* Wait that the PSM are authorized to start in the daemon */
172        CHECK_FCT_DO( fd_psm_waitstart(), goto psm_end );
173       
174        /* Initialize the timer */
175        if (peer->p_flags.pf_responder) {
176                psm_next_timeout(peer, 0, INCNX_TIMEOUT);
177        } else {
178                psm_next_timeout(peer, created_started ? 0 : 1, 0);
179        }
180       
181psm_loop:
182        /* Get next event */
183        CHECK_FCT_DO( psm_ev_timedget(peer, &event, &ev_data), goto psm_end );
184        TRACE_DEBUG(FULL, "'%s'\t<-- '%s'\t(%p)\t'%s'",
185                        STATE_STR(peer->p_hdr.info.pi_state),
186                        fd_pev_str(event), ev_data,
187                        peer->p_hdr.info.pi_diamid);
188
189        /* Now, the action depends on the current state and the incoming event */
190
191        /* The following two states are impossible */
192        ASSERT( peer->p_hdr.info.pi_state != STATE_NEW );
193        ASSERT( peer->p_hdr.info.pi_state != STATE_ZOMBIE );
194
195        /* Purge invalid events */
196        if (!CHECK_EVENT(event)) {
197                TRACE_DEBUG(INFO, "Invalid event received in PSM '%s' : %d", peer->p_hdr.info.pi_diamid, event);
198                goto psm_loop;
199        }
200
201        /* Handle the (easy) debug event now */
202        if (event == FDEVP_DUMP_ALL) {
203                fd_peer_dump(peer, ANNOYING);
204                goto psm_loop;
205        }
206
207        /* Requests to terminate the peer object */
208        if (event == FDEVP_TERMINATE) {
209                switch (peer->p_hdr.info.pi_state) {
210                        case STATE_CLOSING:
211                        case STATE_WAITCNXACK:
212                        case STATE_WAITCNXACK_ELEC:
213                        case STATE_WAITCEA:
214                        case STATE_SUSPECT:
215                                /* In these cases, we just cleanup the peer object and terminate now */
216                                TODO("Cleanup the PSM: terminate connection object, ...");
217                        case STATE_CLOSED:
218                                /* Then we just terminate the PSM */
219                                goto psm_end;
220                               
221                        case STATE_OPEN:
222                        case STATE_REOPEN:
223                                /* We cannot just close the conenction, we have to send a DPR first */
224                                TODO("Send DPR, mark the peer as CLOSING");
225                                goto psm_loop;
226                }
227        }
228       
229        /* MSG_RECEIVED: fd_p_expi_update(struct fd_peer * peer ) */
230        /* If timeout or OPEN : call cb if defined */
231
232        /* Default action : the handling has not yet been implemented. */
233        TODO("Missing handler in PSM : '%s'\t<-- '%s'", STATE_STR(peer->p_hdr.info.pi_state), fd_pev_str(event));
234        if (event == FDEVP_PSM_TIMEOUT) {
235                /* We have not handled timeout in this state, let's postpone next alert */
236                psm_next_timeout(peer, 0, 60);
237        }
238       
239        goto psm_loop;
240       
241psm_end:
242        pthread_cleanup_pop(1); /* set STATE_ZOMBIE */
243        return NULL;
244}       
245       
246       
247
248
249/* Create the PSM thread of one peer structure */
250int fd_psm_begin(struct fd_peer * peer )
251{
252        TRACE_ENTRY("%p", peer);
253       
254        /* Check the peer and state are OK */
255        CHECK_PARAMS( CHECK_PEER(peer) && (peer->p_hdr.info.pi_state == STATE_NEW) );
256       
257        /* Create the PSM controler thread */
258        CHECK_POSIX( pthread_create( &peer->p_psm, NULL, p_psm_th, peer ) );
259       
260        /* We're done */
261        return 0;
262}
263
264/* End the PSM (clean ending) */
265int fd_psm_terminate(struct fd_peer * peer )
266{
267        TRACE_ENTRY("%p", peer);
268        CHECK_PARAMS( CHECK_PEER(peer) );
269        if (peer->p_hdr.info.pi_state != STATE_ZOMBIE) {
270                CHECK_FCT( fd_event_send(peer->p_events, FDEVP_TERMINATE, NULL) );
271        } else {
272                TRACE_DEBUG(FULL, "Peer '%s' was already terminated", peer->p_hdr.info.pi_diamid);
273        }
274        return 0;
275}
276
277/* End the PSM violently */
278void fd_psm_abord(struct fd_peer * peer )
279{
280        TRACE_ENTRY("%p", peer);
281        TODO("Cancel PSM thread");
282        TODO("Cancel IN thread");
283        TODO("Cancel OUT thread");
284        TODO("Cleanup the peer connection object");
285        TODO("Cleanup the message queues (requeue)");
286        return;
287}
288
289/* Allow the state machines to start */
290int fd_psm_start()
291{
292        TRACE_ENTRY("");
293        CHECK_POSIX( pthread_mutex_lock(&started_mtx) );
294        started = 1;
295        CHECK_POSIX( pthread_cond_broadcast(&started_cnd) );
296        CHECK_POSIX( pthread_mutex_unlock(&started_mtx) );
297        return 0;
298}
299
Note: See TracBrowser for help on using the repository browser.