pip.h

/*
 * $PIP_license: <Simplified BSD License>
 * Redistribution and use 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.
 * 
 * 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 HOLDER 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.
 * $
 * $RIKEN_copyright: Riken Center for Computational Sceience (R-CCS),
 * System Software Development Team, 2016-2021
 * $
 * $PIP_VERSION: Version 3.1.0$
 *
 * $Author: Atsushi Hori (R-CCS)
 * Query:   procinproc-info@googlegroups.com
 * User ML: procinproc-users@googlegroups.com
 * $
 */

#ifndef _pip_h_
#define _pip_h_

#ifndef DOXYGEN_INPROGRESS

#include <stdint.h>
#include <stddef.h>
#include <string.h>
#include <signal.h>
#include <stdio.h>
#include <errno.h>

#define PIP_OPTS_NONE           (0x0)

#define PIP_MODE_PTHREAD        (0x1000U)
#define PIP_MODE_PROCESS        (0x2000U)
/* the following two modes are a submode of PIP_MODE_PROCESS */
#define PIP_MODE_PROCESS_PRELOAD    (0x2100U)
#define PIP_MODE_PROCESS_PIPCLONE   (0x2200U)
#define PIP_MODE_PROCESS_GOT        (0x2400U)
#define PIP_MODE_MASK           (0xFF00U)

#define PIP_ENV_MODE            "PIP_MODE"
#define PIP_ENV_MODE_THREAD     "thread"
#define PIP_ENV_MODE_PTHREAD        "pthread"
#define PIP_ENV_MODE_PROCESS        "process"
#define PIP_ENV_MODE_PROCESS_PRELOAD    "process:preload"
#define PIP_ENV_MODE_PROCESS_PIPCLONE   "process:pipclone"
#define PIP_ENV_MODE_PROCESS_GOT    "process:got"

#define PIP_ENV_STOP_ON_START       "PIP_STOP_ON_START"

#define PIP_ENV_GDB_PATH        "PIP_GDB_PATH"
#define PIP_ENV_GDB_COMMAND     "PIP_GDB_COMMAND"
#define PIP_ENV_GDB_SIGNALS     "PIP_GDB_SIGNALS"
#define PIP_ENV_SHOW_MAPS       "PIP_SHOW_MAPS"
#define PIP_ENV_SHOW_PIPS       "PIP_SHOW_PIPS"

#define PIP_VALID_OPTS  \
  ( PIP_MODE_PTHREAD | PIP_MODE_PROCESS_PRELOAD | \
    PIP_MODE_PROCESS_PIPCLONE | PIP_MODE_PROCESS_GOT )

#define PIP_ENV_STACKSZ         "PIP_STACKSZ"

#define PIP_MAGIC_NUM           (-747) /* "PIP" P=7, I=4 */

#define PIP_PIPID_ROOT          (PIP_MAGIC_NUM-1)
#define PIP_PIPID_MYSELF        (PIP_MAGIC_NUM-2)
#define PIP_PIPID_ANY           (PIP_MAGIC_NUM-3)
#define PIP_PIPID_NULL          (PIP_MAGIC_NUM-4)
#define PIP_PIPID_SELF          PIP_PIPID_MYSELF

#define PIP_NTASKS_MAX          (300)

#define PIP_CPUCORE_FLAG_SHIFT      (24)
#define PIP_CPUCORE_FLAG_MASK       (0xFFU<<PIP_CPUCORE_FLAG_SHIFT)
#define PIP_CPUCORE_CORENO_MAX      ((1U<<20)-1)
#define PIP_CPUCORE_ASIS        (0x1U<<PIP_CPUCORE_FLAG_SHIFT)
#define PIP_CPUCORE_ABS         (0x2U<<PIP_CPUCORE_FLAG_SHIFT)
#define PIP_CPUCORE_CORENO_MASK     ((0x1U<<PIP_CPUCORE_FLAG_SHIFT)-1)

#define PIP_YIELD_DEFAULT       (0x0U)
#define PIP_YIELD_USER          (0x1U)
#define PIP_YIELD_SYSTEM        (0x2U)

typedef struct {
  char      *prog;
  char      **argv;
  char      **envv;
  char      *funcname;
  void      *arg;
  void      *exp;
  void      *aux;
  void      *reserved[2];
} pip_spawn_program_t;

typedef int (*pip_spawnhook_t)( void* );

typedef struct {
  pip_spawnhook_t   before;
  pip_spawnhook_t   after;
  void          *hookarg;
  void          *reserved[5];
} pip_spawn_hook_t;

typedef uintptr_t   pip_id_t;

#ifdef __cplusplus
extern "C" {
#endif

#ifndef INLINE
#define INLINE          inline static
#endif

#endif /* DOXYGEN */

  int pip_init( int *pipidp, int *ntasks, void **root_expp, uint32_t opts );

  int pip_fin( void );

#ifndef DOXYGEN_INPROGRESS
INLINE
#endif
void pip_spawn_from_main( pip_spawn_program_t *progp,
              char *prog, char **argv, char **envv,
              void *exp, void *aux ) {
  memset( progp, 0, sizeof(pip_spawn_program_t) );
  if( prog != NULL ) {
    progp->prog = prog;
  } else {
    progp->prog = argv[0];
  }
  progp->argv   = argv;
  if( envv == NULL ) {
    extern char **environ;
    progp->envv = environ;
  } else {
    progp->envv = envv;
  }
  progp->exp = exp;
  progp->aux = aux;
}

#ifndef DOXYGEN_INPROGRESS
INLINE
#endif
void pip_spawn_from_func( pip_spawn_program_t *progp,
              char *prog, char *funcname, void *arg, char **envv,
              void *exp, void *aux ) {
  memset( progp, 0, sizeof(pip_spawn_program_t) );
  progp->prog     = prog;
  progp->funcname = funcname;
  progp->arg      = arg;
  if( envv == NULL ) {
    extern char **environ;
    progp->envv = environ;
  } else {
    progp->envv = envv;
  }
  progp->exp = exp;
  progp->aux = aux;
}

#ifndef DOXYGEN_INPROGRESS
INLINE
#endif
void pip_spawn_hook( pip_spawn_hook_t *hook,
             pip_spawnhook_t before,
             pip_spawnhook_t after,
             void *hookarg ) {
  hook->before  = before;
  hook->after   = after;
  hook->hookarg = hookarg;
}

int pip_task_spawn( pip_spawn_program_t *progp,
            uint32_t coreno,
            uint32_t opts,
            int *pipidp,
            pip_spawn_hook_t *hookp );

  int pip_spawn( char *filename, char **argv, char **envv,
         uint32_t coreno, int *pipidp,
         pip_spawnhook_t before, pip_spawnhook_t after, void *hookarg);

  int pip_named_export( void *exp, const char *format, ... )
    __attribute__ ((format (printf, 2, 3)));

  int pip_named_import( int pipid, void **expp, const char *format, ... )
    __attribute__ ((format (printf, 3, 4)));

  int pip_named_tryimport( int pipid, void **expp, const char *format, ... )
    __attribute__ ((format (printf, 3, 4)));

  int pip_export( void *exp );

  int pip_import( int pipid, void **expp );

  int pip_set_aux( void *aux );

  int pip_get_aux( void **auxp );

  int pip_get_dlmopen_info( int pipid, void **handlep, long *lmidp );

  int pip_wait( int pipid, int *status );

  int pip_trywait( int pipid, int *status );

  int pip_wait_any( int *pipid, int *status );

  int pip_trywait_any( int *pipid, int *status );

  int pip_get_pipid( int *pipidp );

  int pip_is_initialized( void );

  int pip_get_ntasks( int *ntasksp );

  int pip_get_mode( int *modep );

  const char *pip_get_mode_str( void );

  int pip_get_system_id( int pipid, pip_id_t *idp );

  int  pip_isa_root( void );

  int  pip_isa_task( void );

  int pip_is_threaded( int *flagp );

  int pip_is_shared_fd( int *flagp );

  void pip_exit( int status );

  int pip_kill_all_tasks( void );

  void pip_abort(void);

#ifndef DOXYGEN_INPROGRESS

  pid_t  pip_gettid( void );
  void   pip_glibc_lock( void );
  void   pip_glibc_unlock( void );
  void   pip_debug_info( void );
  size_t pip_idstr( char*, size_t );
  int    pip_check_pie( const char*, int );

#ifdef __cplusplus
}
#endif

#include <pip/pip_blt.h>
#include <pip/pip_dlfcn.h>
#include <pip/pip_signal.h>

#endif /* DOXYGEN */

#endif  /* _pip_h_ */