opal_progress guidelines

Per discussion at OMPI dev meeting, we agreed to move forward to make opal_progress() multithreaded. This is the guideline to make your component in compliance with this change.

What is this change?

OMPI will not serialize call to opal_progress() anymore. This means your component's progress function might get invoked from multiple threads at the same time. This change allows your component to be more efficient in multithreaded scenario if you choose to (ie, parallelize your component by creating multiple working lanes).

At this state, we still serialize opal_progress() to give grace period for the components to adjust. We will be informing you via mailing list for the deadline that this change will take effect.

Do I have to modify my component?

This depends on how your component works. Let's break it down.

• If your component is thread-safe.
  • If you want to enhance your multithreaded performance, YES, take a look at btl/uct or btl/ofi to really take advantage of this change.
  • If you just want to get by.
    • If calling progress from multiple threads will not affect performance, NO.
    • If calling progress from multiple threads will affect performance, Yes, goto HOW.
• If your component is not thread-safe.
  • Maybe it is time to make it so?
  • If you want your component to be compliance, Yes, goto HOW.
  • If not, your component will have a bad time running in multithreaded mode. You might not care but someone will. Your component might create problem for others.

How?

Again, this is the minimum requirement from the component.

• create a component mutex.
• Do a trylock in your progress function.

typedef struct yourcomponent_t {
...
...
...
opal_mutex_t component_lock; /* Add a new mutex_t here and initialize it at init. */
} yourcomponent_t;

void yourcomponent_component_progress(void)
{
    if (!OPAL_THREAD_TRYLOCK(&component->component_lock)) {
        /* YOUR ORIGINAL PROGRESS ROUTINES HERE*/
        /* YOUR ORIGINAL PROGRESS ROUTINES HERE*/
        /* YOUR ORIGINAL PROGRESS ROUTINES HERE*/

        OPAL_THREAD_UNLOCK(&component->component_lock);
    }
}

Don't forget to initialize/cleanup the mutex!