Home Research Papers Posters Manuals Talks Download People Help Wiki Internal

arch/cell/cell_lib/spert_ppu.h

Go to the documentation of this file.

#ifndef __SPE_RUNTIME_PPU_H__
#define __SPE_RUNTIME_PPU_H__



//#ifdef __cplusplus
//extern "C" {
//#endif
#include <libspe2.h>
//#ifdef __cplusplus
//}
//#endif

#include "pthread.h"

#include "spert.h"

#include <stdio.h>


// Defines

#define DEBUG_DISPLAY  0   // Set to non-zero to have Offload API display debug info (also see SPE_DEBUG_DISPLAY in spert.h)

#define NUM_SPE_THREADS  0

#define CREATE_EACH_THREAD_ONE_BY_ONE   0  // Set this to non-zero to create and wait for each SPE thread one-by-one


#ifdef __cplusplus
  #define DEFAULT_TO_NULL   = NULL
  #define DEFAULT_TO_NONE   = WORK_REQUEST_FLAGS_NONE
  #define DEFAULT_TO_ALLSET = 0xFFFFFFFF
#else
  #define DEFAULT_TO_NULL
  #define DEFAULT_TO_NONE
  #define DEFAULT_TO_ALLSET
#endif


// WORK_REQUEST_STATE_xxx Defines
#define WORK_REQUEST_STATE_MIN       (0)
#define WORK_REQUEST_STATE_FREE      (0)
#define WORK_REQUEST_STATE_INUSE     (1)
#define WORK_REQUEST_STATE_FINISHED  (2)
#define WORK_REQUEST_STATE_MAX       (2)

// WRGROUP_STATE_xxx Defines
#define WRGROUP_STATE_MIN      (0)
#define WRGROUP_STATE_FREE     (1)  // Available to use
#define WRGROUP_STATE_FILLING  (2)  // Work Requests are being added to it
#define WRGROUP_STATE_FULL     (3)  // All Work Requests have been added, waiting for all Work Requests to complete
#define WRGROUP_STATE_FINISHED (4)  // All Work Requests have completed
#define WRGROUP_STATE_MAX      (4)


// Externals

extern spe_program_handle_t spert_main;


// Data Structures

typedef struct __wr_group {

  int numWRs;               
  int finishedCount;        
  int state;                

  void* userData;               
  void (*callbackFunc)(void*);  

  struct __wr_group *next;  

} WRGroup;

typedef WRGroup* WRGroupHandle;

#define INVALID_WRGroupHandle (NULL)


typedef struct __work_request {

  int isFirstInSet;  
  int state; 
  unsigned int speAffinityMask; 

  int speIndex;   
  int entryIndex; 

  int funcIndex;      
  void* readWritePtr; 
  int readWriteLen;   
  void* readOnlyPtr;  
  int readOnlyLen;    
  void* writeOnlyPtr; 
  int writeOnlyLen;   
  unsigned int flags; 
  void *userData;     
  volatile void (*callbackFunc)(void*);  // A pointer to a work request specific callback function

  DMAListEntry dmaList[SPE_DMA_LIST_LENGTH];

  WRGroupHandle wrGroupHandle;  

  struct __work_request *next;  

  int id;        // DEBUG
  int traceFlag; // DEBUG

} WorkRequest;

typedef WorkRequest* WRHandle;

#define INVALID_WRHandle (NULL)


typedef struct __spe_thread {

  SPEData *speData;   
  unsigned int messageQueuePtr;  
  int msgIndex;       
  int counter;        

  //speid_t speID;      ///< The ID for the thread

  spe_context_ptr_t speContext;
  unsigned int speEntry;
  spe_stop_info_t stopInfo;
  pthread_t pThread;

} SPEThread;


// Function Prototypes (Offload API)

#ifdef __cplusplus
extern "C" {
#endif

extern int InitOffloadAPI(void(*cbFunc)(void*) DEFAULT_TO_NULL,   
                          void(*gcbFunc)(void*) DEFAULT_TO_NULL,  
                          void(*errorFunc)(int,void*,WRHandle) DEFAULT_TO_NULL, 
                          char* timingFileName DEFAULT_TO_NULL    
                         );
#ifndef __cplusplus
//#define InitOffloadAPI() InitOffloadAPI(NULL, NULL, NULL, NULL)
//#define InitOffloadAPI(cbf) InitOffloadAPI(cbf, NULL, NULL, NULL)
//#define InitOffloadAPI(cbf, gcbf) InitOffloadAPI(cbf, gcbf, NULL, NULL)
//#define InitOffloadAPI(cbf, gcbf, ef) InitOffloadAPI(cbf, gcbf, ef, NULL)
#endif


extern void CloseOffloadAPI();

extern WRHandle sendWorkRequest(int funcIndex,      
                                void* readWritePtr, 
                                int readWriteLen,   
                                void* readOnlyPtr,  
                                int readOnlyLen,    
                                void* writeOnlyPtr, 
                                int writeOnlyLen,   
                                void* userData DEFAULT_TO_NULL, 
                                unsigned int flags DEFAULT_TO_NONE, 
                                void (*callbackFunc)(void*) DEFAULT_TO_NULL, 
                                WRGroupHandle wrGroupHandle DEFAULT_TO_NULL, 
                                unsigned int speAffinityMask DEFAULT_TO_ALLSET  
                               );
#ifndef __cplusplus
#define sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol) sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol, NULL, WORK_REQUEST_FLAGS_NONE, NULL, NULL, -1)
#define sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol, ud) sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol, ud, WORK_REQUEST_FLAGS_NONE, NULL, NULL, -1)
#define sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol, ud, f) sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol, ud, f, NULL, NULL, -1)
#define sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol, ud, f, cb) sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol, ud, f, cb, NULL, -1)
#define sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol, ud, f, cb, gh) sendWorkRequest(fi, rwp, rwl, rop, rol, wop, wol, ud, f, cb, gh, -1)
#endif

extern WRHandle sendWorkRequest_list(int funcIndex,         
                                     unsigned int eah,      
                                     DMAListEntry* dmaList, 
                                     int numReadOnly,       
                                     int numReadWrite,      
                                     int numWriteOnly,      
                                     void* userData DEFAULT_TO_NULL, 
                                     unsigned int flags DEFAULT_TO_NONE, 
                                     void (*callbackFunc)(void*) DEFAULT_TO_NULL, 
                                     WRGroupHandle wrGroupHandle DEFAULT_TO_NULL, 
                                     unsigned int speAffinityMask DEFAULT_TO_ALLSET 
                                    );
// Create some defines that will allow sendWorkRequest_list() to be called more easily
#ifndef __cplusplus
#define sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo) sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo, NULL, WORK_REQUEST_FLAGS_NONE, NULL, NULL, -1)
#define sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo, ud) sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo, ud, WORK_REQUEST_FLAGS_NONE, NULL, NULL, -1)
#define sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo, ud, f) sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo, ud, f, NULL, NULL, -1)
#define sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo, ud, f, cb) sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo, ud, f, cb, NULL, -1)
#define sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo, ud, f, cb, gh) sendWorkRequest_list(fi, eah, dmal, nro, nrw, nwo, ud, f, cb, gh, -1)
#endif


extern int isFinished(WRHandle wrHandle    
                     );

void waitForWRHandle(WRHandle wrHandle     
                    );


extern WRGroupHandle createWRGroup(void* userData DEFAULT_TO_NULL,              
                                   void (*callbackFunc)(void*) DEFAULT_TO_NULL  
                                  );
#ifndef __cplusplus
#define createWRGroup()    createWRGroup(NULL, NULL);
#define createWRGroup(ud)  createWRGroup(ud, NULL);
#endif


extern void completeWRGroup(WRGroupHandle wrGroupHandle);


extern int isWRGroupFinished(WRGroupHandle wrGroupHandle);


extern void waitForWRGroupHandle(WRGroupHandle wrGroupHandle);


extern void OffloadAPIProgress();


extern void OffloadAPIDisplayConfig(FILE* fout);

// DEBUG
extern int getWorkRequestID(WRHandle wrHandle);
extern void enableTrace();
extern void disableTrace();

// DEBUG
extern void displayLastWRTimes();


#ifdef __cplusplus
}  // end extern "C"
#endif


#endif //__SPE_RUNTIME_PPU_H__

---