Mercurial > hg > freeDiameter
view freeDiameter/p_psm.c @ 33:e6fcdf12b9a0
Added a lot of TODOs :)
author | Sebastien Decugis <sdecugis@nict.go.jp> |
---|---|
date | Thu, 29 Oct 2009 18:05:45 +0900 |
parents | 5ba91682f0bc |
children | 0e2b57789361 |
line wrap: on
line source
/********************************************************************************************************* * Software License Agreement (BSD License) * * Author: Sebastien Decugis <sdecugis@nict.go.jp> * * * * Copyright (c) 2009, WIDE Project and NICT * * All rights reserved. * * * * Redistribution and use of this software in source and binary forms, with or without modification, are * * permitted provided that the following conditions are met: * * * * * Redistributions of source code must retain the above * * copyright notice, this list of conditions and the * * following disclaimer. * * * * * Redistributions in binary form must reproduce the above * * copyright notice, this list of conditions and the * * following disclaimer in the documentation and/or other * * materials provided with the distribution. * * * * * Neither the name of the WIDE Project or NICT nor the * * names of its contributors may be used to endorse or * * promote products derived from this software without * * specific prior written permission of WIDE Project and * * NICT. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED * * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A * * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR * * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR * * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * *********************************************************************************************************/ #include "fD.h" /* The actual declaration of peer_state_str */ DECLARE_STATE_STR(); /* Helper for next macro */ #define case_str( _val ) \ case _val : return #_val DECLARE_PEV_STR(); /************************************************************************/ /* Delayed startup */ /************************************************************************/ static int started = 0; static pthread_mutex_t started_mtx = PTHREAD_MUTEX_INITIALIZER; static pthread_cond_t started_cnd = PTHREAD_COND_INITIALIZER; /* Wait for start signal */ static int fd_psm_waitstart() { TRACE_ENTRY(""); CHECK_POSIX( pthread_mutex_lock(&started_mtx) ); awake: if (! started) { pthread_cleanup_push( fd_cleanup_mutex, &started_mtx ); CHECK_POSIX( pthread_cond_wait(&started_cnd, &started_mtx) ); pthread_cleanup_pop( 0 ); goto awake; } CHECK_POSIX( pthread_mutex_unlock(&started_mtx) ); return 0; } /* Allow the state machines to start */ int fd_psm_start() { TRACE_ENTRY(""); CHECK_POSIX( pthread_mutex_lock(&started_mtx) ); started = 1; CHECK_POSIX( pthread_cond_broadcast(&started_cnd) ); CHECK_POSIX( pthread_mutex_unlock(&started_mtx) ); return 0; } /************************************************************************/ /* Manage the list of active peers */ /************************************************************************/ /* Enter/leave OPEN state */ static int enter_open_state(struct fd_peer * peer) { CHECK_POSIX( pthread_rwlock_wrlock(&fd_g_activ_peers_rw) ); TODO(" insert in fd_g_activ_peers "); CHECK_POSIX( pthread_rwlock_unlock(&fd_g_activ_peers_rw) ); /* Start the thread to handle outgoing messages */ CHECK_FCT( fd_out_start(peer) ); return ENOTSUP; } static int leave_open_state(struct fd_peer * peer) { TODO("Remove from active list"); /* Stop the "out" thread */ CHECK_FCT( fd_out_stop(peer) ); TODO("Failover pending messages: requeue in global structures"); return ENOTSUP; } /************************************************************************/ /* Helpers for state changes */ /************************************************************************/ /* Change state */ static int change_state(struct fd_peer * peer, int new_state) { int old; TRACE_ENTRY("%p %d(%s)", peer, new_state, STATE_STR(new_state)); CHECK_PARAMS( CHECK_PEER(peer) ); old = peer->p_hdr.info.pi_state; if (old == new_state) return 0; TRACE_DEBUG(FULL, "'%s'\t-> '%s'\t'%s'", STATE_STR(old), STATE_STR(new_state), peer->p_hdr.info.pi_diamid); if (old == STATE_OPEN) { CHECK_FCT( leave_open_state(peer) ); } peer->p_hdr.info.pi_state = new_state; if (new_state == STATE_OPEN) { CHECK_FCT( enter_open_state(peer) ); } return 0; } /* Set timeout timer of next event */ static void psm_next_timeout(struct fd_peer * peer, int add_random, int delay) { /* Initialize the timer */ CHECK_POSIX_DO( clock_gettime( CLOCK_REALTIME, &peer->p_psm_timer ), ASSERT(0) ); if (add_random) { if (delay > 2) delay -= 2; else delay = 0; /* Add a random value between 0 and 4sec */ peer->p_psm_timer.tv_sec += random() % 4; peer->p_psm_timer.tv_nsec+= random() % 1000000000L; if (peer->p_psm_timer.tv_nsec > 1000000000L) { peer->p_psm_timer.tv_nsec -= 1000000000L; peer->p_psm_timer.tv_sec ++; } } peer->p_psm_timer.tv_sec += delay; #if 0 /* temporary for debug */ peer->p_psm_timer.tv_sec += 10; #endif } /************************************************************************/ /* The PSM thread */ /************************************************************************/ /* Cancelation cleanup : set ZOMBIE state in the peer */ void cleanup_state(void * arg) { struct fd_peer * peer = (struct fd_peer *)arg; CHECK_PARAMS_DO( CHECK_PEER(peer), return ); peer->p_hdr.info.pi_state = STATE_ZOMBIE; return; } /* The state machine thread (controler) */ static void * p_psm_th( void * arg ) { struct fd_peer * peer = (struct fd_peer *)arg; int created_started = started; int event; size_t ev_sz; void * ev_data; CHECK_PARAMS_DO( CHECK_PEER(peer), ASSERT(0) ); pthread_cleanup_push( cleanup_state, arg ); /* Set the thread name */ { char buf[48]; sprintf(buf, "PSM/%.*s", sizeof(buf) - 5, peer->p_hdr.info.pi_diamid); fd_log_threadname ( buf ); } /* The state machine starts in CLOSED state */ peer->p_hdr.info.pi_state = STATE_CLOSED; /* Wait that the PSM are authorized to start in the daemon */ CHECK_FCT_DO( fd_psm_waitstart(), goto psm_end ); /* Initialize the timer */ if (peer->p_flags.pf_responder) { psm_next_timeout(peer, 0, INCNX_TIMEOUT); } else { psm_next_timeout(peer, created_started ? 0 : 1, 0); } psm_loop: /* Get next event */ CHECK_FCT_DO( fd_event_timedget(peer->p_events, &peer->p_psm_timer, FDEVP_PSM_TIMEOUT, &event, &ev_sz, &ev_data), goto psm_end ); TRACE_DEBUG(FULL, "'%s'\t<-- '%s'\t(%p,%zd)\t'%s'", STATE_STR(peer->p_hdr.info.pi_state), fd_pev_str(event), ev_data, ev_sz, peer->p_hdr.info.pi_diamid); /* Now, the action depends on the current state and the incoming event */ /* The following states are impossible */ ASSERT( peer->p_hdr.info.pi_state != STATE_NEW ); ASSERT( peer->p_hdr.info.pi_state != STATE_ZOMBIE ); ASSERT( peer->p_hdr.info.pi_state != STATE_OPEN_HANDSHAKE ); /* because it exists only between two loops */ /* Purge invalid events */ if (!CHECK_PEVENT(event)) { TRACE_DEBUG(INFO, "Invalid event received in PSM '%s' : %d", peer->p_hdr.info.pi_diamid, event); goto psm_loop; } /* Call the extension callback if needed */ if (peer->p_cb) { /* Check if we must call it */ /* */ /* OK */ TODO("Call CB"); TODO("Clear CB"); } /* Handle the (easy) debug event now */ if (event == FDEVP_DUMP_ALL) { fd_peer_dump(peer, ANNOYING); goto psm_loop; } /* Requests to terminate the peer object */ if (event == FDEVP_TERMINATE) { switch (peer->p_hdr.info.pi_state) { case STATE_CLOSING: case STATE_WAITCNXACK: case STATE_WAITCNXACK_ELEC: case STATE_WAITCEA: case STATE_SUSPECT: /* In these cases, we just cleanup the peer object and terminate now */ TODO("Cleanup the PSM: terminate connection object, ..."); case STATE_CLOSED: /* Then we just terminate the PSM */ goto psm_end; case STATE_OPEN: case STATE_REOPEN: /* We cannot just close the conenction, we have to send a DPR first */ TODO("Send DPR, mark the peer as CLOSING"); goto psm_loop; } } /* A message was received */ if (event == FDEVP_CNX_MSG_RECV) { TODO("Parse the buffer into a message"); /* parse_and_get_local_ccode */ TODO("Check if it is a local message (CER, DWR, ...)"); TODO("If not, check we are in OPEN state"); TODO("Update expiry timer if needed"); TODO("Handle the message"); } /* The connection object is broken */ if (event == FDEVP_CNX_ERROR) { TODO("Destroy the connection object"); TODO("Mark the error in the peer (pf_cnx_pb)"); TODO("Move to closed state, Requeue all messages to a different connection (failover)"); TODO("If pi_flags.exp, terminate the peer"); } /* The connection notified a change in endpoints */ if (event == FDEVP_CNX_EP_CHANGE) { /* Cleanup the remote LL and primary addresses */ CHECK_FCT_DO( fd_ep_filter( &peer->p_hdr.info.pi_endpoints, EP_FL_CONF | EP_FL_DISC | EP_FL_ADV ), /* ignore the error */); CHECK_FCT_DO( fd_ep_clearflags( &peer->p_hdr.info.pi_endpoints, EP_FL_PRIMARY ), /* ignore the error */); /* Get the new ones */ CHECK_FCT_DO( fd_cnx_getendpoints(peer->p_cnxctx, NULL, &peer->p_hdr.info.pi_endpoints), /* ignore the error */); if (TRACE_BOOL(ANNOYING)) { fd_log_debug("New remote endpoint(s):\n"); fd_ep_dump(6, &peer->p_hdr.info.pi_endpoints); } /* Done */ goto psm_loop; } /* A new connection was established and CER containing this peer id was received */ if (event == FDEVP_CNX_INCOMING) { struct cnx_incoming * params = ev_data; ASSERT(params); switch (peer->p_hdr.info.pi_state) { case STATE_CLOSED: TODO("Handle the CER, validate the peer if needed (and set expiry), set the alt_fifo in the connection, reply a CEA, eventually handshake, move to OPEN or REOPEN state"); break; case STATE_WAITCNXACK: case STATE_WAITCEA: TODO("Election"); break; default: TODO("Reply with error CEA"); TODO("Close the connection"); /* reject_incoming_connection */ } free(ev_data); goto psm_loop; } /* The timeout for the current state has been reached */ if (event == FDEVP_PSM_TIMEOUT) { switch (peer->p_hdr.info.pi_state) { } } /* Default action : the handling has not yet been implemented. [for debug only] */ TODO("Missing handler in PSM : '%s'\t<-- '%s'", STATE_STR(peer->p_hdr.info.pi_state), fd_pev_str(event)); if (event == FDEVP_PSM_TIMEOUT) { /* We have not handled timeout in this state, let's postpone next alert */ psm_next_timeout(peer, 0, 60); } goto psm_loop; psm_end: pthread_cleanup_pop(1); /* set STATE_ZOMBIE */ peer->p_psm = (pthread_t)NULL; pthread_detach(pthread_self()); return NULL; } /************************************************************************/ /* Functions to control the PSM */ /************************************************************************/ /* Create the PSM thread of one peer structure */ int fd_psm_begin(struct fd_peer * peer ) { TRACE_ENTRY("%p", peer); /* Check the peer and state are OK */ CHECK_PARAMS( CHECK_PEER(peer) && (peer->p_hdr.info.pi_state == STATE_NEW) ); /* Create the PSM controler thread */ CHECK_POSIX( pthread_create( &peer->p_psm, NULL, p_psm_th, peer ) ); /* We're done */ return 0; } /* End the PSM (clean ending) */ int fd_psm_terminate(struct fd_peer * peer ) { TRACE_ENTRY("%p", peer); CHECK_PARAMS( CHECK_PEER(peer) ); if (peer->p_hdr.info.pi_state != STATE_ZOMBIE) { CHECK_FCT( fd_event_send(peer->p_events, FDEVP_TERMINATE, 0, NULL) ); } else { TRACE_DEBUG(FULL, "Peer '%s' was already terminated", peer->p_hdr.info.pi_diamid); } return 0; } /* End the PSM & cleanup the peer structure */ void fd_psm_abord(struct fd_peer * peer ) { TRACE_ENTRY("%p", peer); TODO("Cancel PSM thread"); TODO("Cancel OUT thread"); TODO("Cleanup the peer connection object"); TODO("Cleanup the message queues (requeue)"); TODO("Call p_cb with NULL parameter if needed"); return; }