Update libevent to the 2.0 series, currently at 2.0.7rc. We will update to their final release when it becomes available. Currently known errors exist in unused portions of the libevent code. This revision passes the IBM test suite on a Linux machine and on a standalone Mac.
This is a fairly intrusive change, but outside of the moving of opal/event to opal/mca/event, the only changes involved (a) changing all calls to opal_event functions to reflect the new framework instead, and (b) ensuring that all opal_event_t objects are properly constructed since they are now true opal_objects.
Note: Shiqing has just returned from vacation and has not yet had a chance to complete the Windows integration. Thus, this commit almost certainly breaks Windows support on the trunk. However, I want this to have a chance to soak for as long as possible before I become less available a week from today (going to be at a class for 5 days, and thus will only be sparingly available) so we can find and fix any problems.
Biggest change is moving the libevent code from opal/event to a new opal/mca/event framework. This was done to make it much easier to update libevent in the future. New versions can be inserted as a new component and tested in parallel with the current version until validated, then we can remove the earlier version if we so choose. This is a statically built framework ala installdirs, so only one component will build at a time. There is no selection logic - the sole compiled component simply loads its function pointers into the opal_event struct.
I have gone thru the code base and converted all the libevent calls I could find. However, I cannot compile nor test every environment. It is therefore quite likely that errors remain in the system. Please keep an eye open for two things:
1. compile-time errors: these will be obvious as calls to the old functions (e.g., opal_evtimer_new) must be replaced by the new framework APIs (e.g., opal_event.evtimer_new)
2. run-time errors: these will likely show up as segfaults due to missing constructors on opal_event_t objects. It appears that it became a typical practice for people to "init" an opal_event_t by simply using memset to zero it out. This will no longer work - you must either OBJ_NEW or OBJ_CONSTRUCT an opal_event_t. I tried to catch these cases, but may have missed some. Believe me, you'll know when you hit it.
There is also the issue of the new libevent "no recursion" behavior. As I described on a recent email, we will have to discuss this and figure out what, if anything, we need to do.
This commit was SVN r23925.
2010-10-24 18:35:54 +00:00
|
|
|
/*
|
|
|
|
|
* Copyright (c) 2010 Cisco Systems, Inc. All rights reserved.
|
|
|
|
|
* $COPYRIGHT$
|
|
|
|
|
*
|
|
|
|
|
* Additional copyrights may follow
|
|
|
|
|
*
|
|
|
|
|
* $HEADER$
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef OPAL_EVENT_BASE_H
|
|
|
|
|
#define OPAL_EVENT_BASE_H
|
|
|
|
|
|
|
|
|
|
#include "opal_config.h"
|
|
|
|
|
|
|
|
|
|
#include "opal/mca/event/event.h"
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Global functions for MCA overall event open and close
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
BEGIN_C_DECLS
|
|
|
|
|
|
2011-01-25 22:43:47 +00:00
|
|
|
extern int opal_event_base_inited;
|
|
|
|
|
|
Update libevent to the 2.0 series, currently at 2.0.7rc. We will update to their final release when it becomes available. Currently known errors exist in unused portions of the libevent code. This revision passes the IBM test suite on a Linux machine and on a standalone Mac.
This is a fairly intrusive change, but outside of the moving of opal/event to opal/mca/event, the only changes involved (a) changing all calls to opal_event functions to reflect the new framework instead, and (b) ensuring that all opal_event_t objects are properly constructed since they are now true opal_objects.
Note: Shiqing has just returned from vacation and has not yet had a chance to complete the Windows integration. Thus, this commit almost certainly breaks Windows support on the trunk. However, I want this to have a chance to soak for as long as possible before I become less available a week from today (going to be at a class for 5 days, and thus will only be sparingly available) so we can find and fix any problems.
Biggest change is moving the libevent code from opal/event to a new opal/mca/event framework. This was done to make it much easier to update libevent in the future. New versions can be inserted as a new component and tested in parallel with the current version until validated, then we can remove the earlier version if we so choose. This is a statically built framework ala installdirs, so only one component will build at a time. There is no selection logic - the sole compiled component simply loads its function pointers into the opal_event struct.
I have gone thru the code base and converted all the libevent calls I could find. However, I cannot compile nor test every environment. It is therefore quite likely that errors remain in the system. Please keep an eye open for two things:
1. compile-time errors: these will be obvious as calls to the old functions (e.g., opal_evtimer_new) must be replaced by the new framework APIs (e.g., opal_event.evtimer_new)
2. run-time errors: these will likely show up as segfaults due to missing constructors on opal_event_t objects. It appears that it became a typical practice for people to "init" an opal_event_t by simply using memset to zero it out. This will no longer work - you must either OBJ_NEW or OBJ_CONSTRUCT an opal_event_t. I tried to catch these cases, but may have missed some. Believe me, you'll know when you hit it.
There is also the issue of the new libevent "no recursion" behavior. As I described on a recent email, we will have to discuss this and figure out what, if anything, we need to do.
This commit was SVN r23925.
2010-10-24 18:35:54 +00:00
|
|
|
/**
|
|
|
|
|
* Initialize the event MCA framework
|
|
|
|
|
*
|
|
|
|
|
* @retval OPAL_SUCCESS Upon success
|
|
|
|
|
* @retval OPAL_ERROR Upon failure
|
|
|
|
|
*
|
|
|
|
|
* This must be the first function invoked in the event MCA
|
|
|
|
|
* framework. It initializes the event MCA framework, finds
|
|
|
|
|
* and opens event components, etc.
|
|
|
|
|
*
|
|
|
|
|
* This function is invoked during opal_init().
|
|
|
|
|
*
|
|
|
|
|
* This function fills in the internal global variable
|
|
|
|
|
* opal_event_base_components_opened, which is a list of all
|
|
|
|
|
* event components that were successfully opened. This
|
|
|
|
|
* variable should \em only be used by other event base
|
|
|
|
|
* functions -- it is not considered a public interface member --
|
|
|
|
|
* and is only mentioned here for completeness.
|
|
|
|
|
*/
|
|
|
|
|
OPAL_DECLSPEC int opal_event_base_open(void);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Select an available component.
|
|
|
|
|
*
|
|
|
|
|
* @return OPAL_SUCCESS Upon success.
|
|
|
|
|
* @return OPAL_NOT_FOUND If no component can be selected.
|
|
|
|
|
* @return OPAL_ERROR Upon other failure.
|
|
|
|
|
*
|
|
|
|
|
* This function invokes the selection process for event components,
|
|
|
|
|
* which works as follows:
|
|
|
|
|
*
|
|
|
|
|
* - If the \em event MCA parameter is not specified, the
|
|
|
|
|
* selection set is all available event components.
|
|
|
|
|
* - If the \em event MCA parameter is specified, the
|
|
|
|
|
* selection set is just that component.
|
|
|
|
|
* - All components in the selection set are queried to see if
|
|
|
|
|
* they want to run. All components that want to run are ranked
|
|
|
|
|
* by their priority and the highest priority component is
|
|
|
|
|
* selected. All non-selected components have their "close"
|
|
|
|
|
* function invoked to let them know that they were not selected.
|
|
|
|
|
* - The selected component will have its "init" function invoked to
|
|
|
|
|
* let it know that it was selected.
|
|
|
|
|
*
|
|
|
|
|
* If we fall through this entire process and no component is
|
|
|
|
|
* selected, then return OPAL_NOT_FOUND (this is not a fatal
|
|
|
|
|
* error).
|
|
|
|
|
*
|
|
|
|
|
* At the end of this process, we'll either have a single
|
|
|
|
|
* component that is selected and initialized, or no component was
|
|
|
|
|
* selected. If no component was selected, subsequent invocation
|
|
|
|
|
* of the event wrapper functions will return an error.
|
|
|
|
|
*/
|
|
|
|
|
OPAL_DECLSPEC int opal_event_base_select(void);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Shut down the event MCA framework.
|
|
|
|
|
*
|
|
|
|
|
* @retval OPAL_SUCCESS Always
|
|
|
|
|
*
|
|
|
|
|
* This function shuts down everything in the event MCA
|
|
|
|
|
* framework, and is called during opal_finalize().
|
|
|
|
|
*
|
|
|
|
|
* It must be the last function invoked on the event MCA
|
|
|
|
|
* framework.
|
|
|
|
|
*/
|
|
|
|
|
OPAL_DECLSPEC int opal_event_base_close(void);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Debugging output stream
|
|
|
|
|
*/
|
|
|
|
|
OPAL_DECLSPEC extern int opal_event_base_output;
|
|
|
|
|
OPAL_DECLSPEC extern opal_list_t opal_event_components;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
END_C_DECLS
|
|
|
|
|
|
|
|
|
|
#endif /* OPAL_BASE_EVENT_H */
|