cd.h

Go to the documentation of this file.

/*
Copyright 2014, The University of Texas at Austin 
All rights reserved.

THIS FILE IS PART OF THE CONTAINMENT DOMAINS RUNTIME LIBRARY

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 the copyright holder 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 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.
*/

#ifndef _CD_H 
#define _CD_H
#include <vector>

namespace cd { 

  class CDEvent; // explained later
  class CDHandle; //explained later
  
  struct CDNameT {
    uint level;   
    uint number;  
  };
    
  enum CDModeT  { kStrict=0, 
      kRelaxed   
  };

  enum CDExecutionModeT  {kExec=0,  
       kReexec   
  };

  enum PreserveUseT {
    kUnsure =0, 
    kReadOnly = 1, 
    kReadWrite = 2 
  };
 // End group cd_defs

  enum PGASUsageT {
    kShared = 0,      
    kPotentiallyShared, 
    kPrivatized,     
    kPrivate          
  };
 // end PGAS_funcs

  enum SysErrNameT { kOK=0, 
           kSoftMem=         0b1, 
           kDegradedMem=     0b01, 
           kSoftComm=        0b001, 
           kDegradedComm=    0b0001, 
           kSoftComp=        0b00001, 
           kDegradedResource=0b000001, 
           kHardResource=    0b0000001, 
           kFileSys=         0b00000001, 
  };
  
  uint DeclareErrName(const char* name_string 
          );

  CDErrT UndeclareErrName(uint error_name_id 
            );

  enum SysErrLocT { kOK=0, 
          kIntraCore=   0b1, 
          kCore=        0b01, 
          kProc=        0b001, 
          kNode=        0b0001, 
          kModule=      0b00001, 
          kCabinet=     0b000001, 
          kCabinetGroup=0b0000001, 
          kSystem=      0b00000001, 
  };

  uint DeclareErrLoc(const char* name_string 
          );

  CDErrT UndeclareErrLoc(uint error_name_id 
            )

  
  class SysErrInfo { 
  public:
    SysErrInfo() { };
  };

  class SoftMemErrInfo {
  public:
    uint64_t get_pa_start(); 
    uint64_t get_va_start(); 
    uint64_t get_length(); 
    char[]   get_data(); 
    uint64_t get_syndrome_len(); 
    char[]   get_syndrome(); 

  protected:
    uint64_t pa_start_; 
    uint64_t va_start_; 
    uint64_t length_; 
    char*    data_; 
    uint64_t syndrome_len_; 
    char*    syndrome_; 
  };

  class DegradedMemErrInfo {
  public:
    std::vector<uint64_t> get_pa_starts(); 
    std::vector<uint64_t> get_va_starts(); 
    std::vector<uint64_t> get_lengths(); 

  protected:
    std::vector<uint64_t> pa_starts_; 
    std::vector<uint64_t> va_starts_; 
    std::vector<uint64_t> lengths_; 
  };

  struct SysErrT {
    SysErrNameT error_name_; 
    SysErrLocT error_location_; 
    SysErrInfo error_info_; 
  };


  enum CDErrT { kOK=0, 
       kAlreadyInit, 
       kError 
  };

  //* \todo Missing error injection API */

  enum PreserveMechanismT { kCopy=0b001, 
          kRef=0b010,  
          kRegen=0b100 
  };             

  class RegenObject {
  public:
    virtual CDErrT Regenerate(void* data_ptr, 
         uint64_t len    
         ) = 0;
  };
 // End preservation_funcs group, but more methods later in CDHandle

 
  CDHandle* Init(bool collective=true 
     CDErrT* error=0    
     );
 // End cd_init_funcs group

  CDHandle* GetRootCD(); 

  CDHandle* GetCurrentCD(); 

  CDErrT SetCurrentCD(const CDHandle* cd 
       );

 // End cd_accessor_funcs group
};





class cd::CDHandle {
public:
  CDHandle* Create(char* name=0, 
       CDModeT type=kStrict,  
       uint error_name_mask=0, 
       uint error_loc_mask=0, 
       CDErrT* error=0    
       );

  CDHandle* Create(uint_t color,         
       uint_t num_tasks_in_color, 
       char* name=0, 
       CDModeT type=kStrict,  
       uint error_name_mask=0, 
       uint error_loc_mask=0, 
       CDErrT* error=0    
       );

  CDHandle* CreateAndBegin(uint_t color, 
         uint_t num_tasks_in_color, 
         char* name=0, 
         CDModeT type=kStrict,  
         uint error_name_mask=0, 
         uint error_loc_mask=0, 
         CDErrT* error=0    
         );

  CDErrT Destroy(bool collective=false 
        );

  CDErrT Begin(bool collective=true 
      );

  CDErrT Complete(bool collective=true, 
         bool   update_preservations, 
         );

  CDNameT GetName(); 

  CDHandle* GetParent();
   // End cd_hierarchy

  CDErrT Preserve(void* data_ptr, 
         uint64_t len, 
         uint_t preserve_mask=kCopy, 
         const char* my_name=0, 
         const char* ref_name=0, 
         uint_64t ref_offset=0, 
         const RegenObject* regen_object=0,
         PreserveUseT data_usage=kUnsure 
         );

  CDErrT Preserve(
         CDEvent& cd_event, 
         void* data_ptr, 
         uint64_t len, 
         uint_t preserve_mask=kCopy, 
         const char* my_name=0, 
         const char* ref_name=0, 
         uint_64t ref_offset=0, 
         const RegenObject* regen_object=0,
         PreserveUseT data_usage=kUnsure 
         );
 // End preservation_funcs

  CDErrT CDAssert(bool test_true, 
         const SysErrT* error_to_report=0
         );

  CDErrT CDAssertFail(bool test_true, 
         const SysErrT* error_to_report=0
         );

  CDErrT CDAssertNotify(bool test_true, 
         const SysErrT* error_to_report=0
         );

  
  std::vector<SysErrT> Detect(CDErrT* err_ret_val=0 
         );

  CDErrT RegisterDetection(uint system_name_mask, 
            uint system_loc_mask, 
            );

  CDErrT RegisterRecovery(uint error_name_mask, 
           uint error_loc_mask, 
           RecoverObject* recover_object=0 
           );
  
 // End detection_recovery group

  float GetErrorProbability(SysErrT error_type, 
          uint error_num, 
          );

  float RequireErrorProbability(SysErrT error_type, 
        uint error_num, 
        float probability, 
        bool fail_over=true 
        );

  

 // End cd_error_probability group

  CDErrT SetPGASUsage(void* data_ptr,   
          uint64_t len, 
          PGASUsageT region_type=kShared 
          );
  
  CDErrT SetPGASOwnerWrites(void* data_ptr
          uint64_t len, 
          bool owner_writes=true 
          );
 // End PGAS_funcs    

  CDErrT CDProfileStartPhase(bool collective=true, 
           char* phase_name=0 
           );

protected:
  CDInternalPtr cd_instance_; 

  bool destroy_cd_object_hint_; 
};


class cd::CDEvent {
public:
  CDErrT Wait(void);
  
  bool Test(void);
  
protected:
  cd_internal::CDEvent event_; 
  
};

class CDInternalPtr {
public:
  bool virtual InternalCanRecover(uint error_name_mask, 
        unit error_location_mask
        );


  void virtual InternalReexecute();

  void virtual InternalEscalate(uint error_name_mask, 
    unit error_location_mask,
    std::vector<SysErrT> errors 
    uint error_name_mask,
    ); // End internal_recovery group
};

class RecoverObject {
public:
  virtual void Recover(CDInternalPtr* cd_instance, 
           uint error_name_mask, 
           unit error_location_mask,
           std::vector<SysErrT> errors 
           ) {
    if (cd_instance->InternalCanRecover(error_name_mask, error_location_mask)) {
      cd_instance->InternalReexecute();
    }
    else {
      cd_instance->InternalEscalate(error_name_mask, error_loc_mask, errors);
    }
  };
};




#endif



/*
Open issues:




 */