root/orte/mca/errmgr/base/base.h

INCLUDED FROM

   1 /*
   2  * Copyright (c) 2004-2010 The Trustees of Indiana University and Indiana
   3  *                         University Research and Technology
   4  *                         Corporation.  All rights reserved.
   5  * Copyright (c) 2004-2011 The University of Tennessee and The University
   6  *                         of Tennessee Research Foundation.  All rights
   7  *                         reserved.
   8  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
   9  *                         University of Stuttgart.  All rights reserved.
  10  * Copyright (c) 2004-2005 The Regents of the University of California.
  11  *                         All rights reserved.
  12  * Copyright (c) 2012-2013 Los Alamos National Security, Inc.  All rights reserved.
  13  * $COPYRIGHT$
  14  *
  15  * Additional copyrights may follow
  16  *
  17  * $HEADER$
  18  */
  19 /** @file:
  20  */
  21 
  22 #ifndef ORTE_MCA_ERRMGR_BASE_H
  23 #define ORTE_MCA_ERRMGR_BASE_H
  24 
  25 /*
  26  * includes
  27  */
  28 #include "orte_config.h"
  29 #include "orte/constants.h"
  30 
  31 #include "opal/class/opal_list.h"
  32 
  33 #include "orte/mca/mca.h"
  34 #include "orte/mca/snapc/base/base.h"
  35 #include "orte/mca/errmgr/errmgr.h"
  36 
  37 
  38 BEGIN_C_DECLS
  39 
  40 /*
  41  * MCA Framework
  42  */
  43 ORTE_DECLSPEC extern mca_base_framework_t orte_errmgr_base_framework;
  44 /* select a component */
  45 ORTE_DECLSPEC    int orte_errmgr_base_select(void);
  46 
  47 /**
  48  * Interfaces for orte-migrate tool
  49  */
  50 #if OPAL_ENABLE_FT_CR
  51 /**
  52  * Migrating States
  53  */
  54 #define ORTE_ERRMGR_MIGRATE_STATE_ERROR          (ORTE_SNAPC_CKPT_MAX + 1)
  55 #define ORTE_ERRMGR_MIGRATE_STATE_ERR_INPROGRESS (ORTE_SNAPC_CKPT_MAX + 2)
  56 #define ORTE_ERRMGR_MIGRATE_STATE_NONE           (ORTE_SNAPC_CKPT_MAX + 3)
  57 #define ORTE_ERRMGR_MIGRATE_STATE_REQUEST        (ORTE_SNAPC_CKPT_MAX + 4)
  58 #define ORTE_ERRMGR_MIGRATE_STATE_RUNNING        (ORTE_SNAPC_CKPT_MAX + 5)
  59 #define ORTE_ERRMGR_MIGRATE_STATE_RUN_CKPT       (ORTE_SNAPC_CKPT_MAX + 6)
  60 #define ORTE_ERRMGR_MIGRATE_STATE_STARTUP        (ORTE_SNAPC_CKPT_MAX + 7)
  61 #define ORTE_ERRMGR_MIGRATE_STATE_FINISH         (ORTE_SNAPC_CKPT_MAX + 8)
  62 #define ORTE_ERRMGR_MIGRATE_MAX                  (ORTE_SNAPC_CKPT_MAX + 9)
  63 
  64 /*
  65  * Commands for command line tool and ErrMgr interaction
  66  */
  67 typedef uint8_t orte_errmgr_tool_cmd_flag_t;
  68 #define ORTE_ERRMGR_MIGRATE_TOOL_CMD  OPAL_UINT8
  69 #define ORTE_ERRMGR_MIGRATE_TOOL_INIT_CMD    1
  70 #define ORTE_ERRMGR_MIGRATE_TOOL_UPDATE_CMD  2
  71 
  72 /*  Initialize/Finalize the orte-migrate communication functionality */
  73 ORTE_DECLSPEC int orte_errmgr_base_tool_init(void);
  74 ORTE_DECLSPEC int orte_errmgr_base_tool_finalize(void);
  75 
  76 ORTE_DECLSPEC void orte_errmgr_base_migrate_state_notify(int state);
  77 ORTE_DECLSPEC int orte_errmgr_base_migrate_state_str(char ** state_str, int state);
  78 
  79 ORTE_DECLSPEC int orte_errmgr_base_migrate_update(int status);
  80 
  81 /*
  82  * Interfaces for C/R related recovery
  83  */
  84 ORTE_DECLSPEC int orte_errmgr_base_update_app_context_for_cr_recovery(orte_job_t *jobdata,
  85                                                                       orte_proc_t *proc,
  86                                                                       opal_list_t *local_snapshots);
  87 
  88 ORTE_DECLSPEC int orte_errmgr_base_restart_job(orte_jobid_t jobid, char * global_handle, int seq_num);
  89 ORTE_DECLSPEC int orte_errmgr_base_migrate_job(orte_jobid_t jobid, orte_snapc_base_request_op_t *datum);
  90 
  91 /* Interface to report process state to the notifier */
  92 ORTE_DECLSPEC void orte_errmgr_base_proc_state_notify(orte_proc_state_t state, orte_process_name_t *proc);
  93 
  94 #endif /* OPAL_ENABLE_FT_CR */
  95 
  96 END_C_DECLS
  97 
  98 #endif