supervisor.h

Go to the documentation of this file.

/****************************************************************************
 * mpcomm/supervisor/supervisor.h
 *
 *   Copyright 2021 Sony Semiconductor Solutions Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
 *    the names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * 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.
 *
 ****************************************************************************/

 
#ifndef __MODULES_INCLUDE_MPCOMM_SUPERVISOR_H
#define __MODULES_INCLUDE_MPCOMM_SUPERVISOR_H
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <pthread.h>
 
#include <asmp/types.h>
#include <asmp/mptask.h>
#include <asmp/mpmq.h>
 
#include <mpcomm/mpcomm.h>
 
/****************************************************************************
 * Public Types
 ****************************************************************************/

 
typedef struct worker_info
{
 
  mptask_t mptask;

 
  mpmq_t mq;

 
  cpuid_t cpuid;
} worker_info_t;

 
typedef struct supervisor_context
{
 
  worker_info_t controller;

 
  worker_info_t helpers[MPCOMM_MAX_HELPERS];

 
  cpu_set_t helpers_cpuset;

 
  uint8_t helper_num;

 
  pthread_t controller_listener_pid;

 
  sem_t sem_done;
} mpcomm_supervisor_context_t;
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/

 
int mpcomm_supervisor_init(mpcomm_supervisor_context_t **ctx,
                           const char *filepath,
                           uint8_t helper_num);

 
int mpcomm_supervisor_deinit(mpcomm_supervisor_context_t *ctx);

 
int mpcomm_supervisor_send_controller(mpcomm_supervisor_context_t *ctx,
                                      void *data);

 
int mpcomm_supervisor_wait_controller_done(mpcomm_supervisor_context_t *ctx,
                                           const struct timespec *abstime);
 
#endif /* __MODULES_INCLUDE_MPCOMM_SUPERVISOR_H */