acsim.h

Go to the documentation of this file.

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/*  ArchC simulator generator generates simulators for the described arquitecture
    Copyright (C) 2002-2004  The ArchC Team

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
*/

/********************************************************/
/* acsim.h: The ArchC simulator generator.              */
/* Author: Sandro Rigo                                  */
/* Date: 16-07-2002                                     */
/*                                                      */
/* The ArchC Team                                       */
/* Computer Systems Laboratory (LSC)                    */
/* IC-UNICAMP                                           */
/* http://www.lsc.ic.unicamp.br                         */



#ifndef _ACSIM_H_
#define _ACSIM_H_

#include <stdlib.h>
#include <stdio.h>
#include "ac_decoder.h"

/*Defining indentation */
#define INDENT0  ""
#define INDENT1  "  "
#define INDENT2  "    "
#define INDENT3  "      "
#define INDENT4  "        "
#define INDENT5  "          "
static const char *INDENT[]={"","  ","    ","      ","        ","          ","            ","              "};

#define CONF_MAX_LINE 256   


#define WRITE_THROUGH   0x01    
#define WRITE_BACK      0x02    
#define WRITE_AROUND    0x20    
#define WRITE_ALLOCATE  0x10    


char *ARCHC_PATH;     
char *SYSTEMC_PATH;   
char *TARGET_ARCH;    
char *CC_PATH;        
char *OPT_FLAGS;      
char *DEBUG_FLAGS;    
char *OTHER_FLAGS;    


#define COMMENT( I, args... )   fprintf( output, "%s


#define COMMENT_MAKE( args... ) fprintf( output, "# "); fprintf( output, args);fprintf( output, "\n");

#define AC_INTERNAL_ERROR( str ) fprintf(stderr, "ArchC ERROR: %s. File: %s Line: %d\n", str, __FILE__, __LINE__);

#define AC_ERROR( str, ...) fprintf(stderr, "ArchC ERROR: " str, ##__VA_ARGS__);
//#define AC_ERROR( str ) fprintf(stderr, "ArchC ERROR: %s ", str );

#define AC_MSG( str, ...) fprintf(stdout, "ArchC: " str, ##__VA_ARGS__);
//#define AC_MSG( str ) printf("ArchC: ");printf str;

enum _ac_cmd_options {
  OPABI,
  OPDasm,
  OPDebug,
  OPDelay,
  OPDDecoder,
  OPHelp,
  /*OPQuiet,*/
  OPDecCache,
  OPStats,
  OPVerbose,
  /*OPVerify,*/
  /*OPVerifyTimed,*/
  OPVersion,
  OPEncoder,
  OPGDBIntegration,
  ACNumberOfOptions
};

typedef enum  _ac_cmd_options_ ac_cmd_options;

enum _ac_sto_types { MEM, CACHE, ICACHE, DCACHE, REG, REGBANK};

typedef enum _ac_sto_types ac_sto_types;

typedef struct _ac_cache_parms{
  char *str;                    
  unsigned value;                       
  struct _ac_cache_parms *next; 
} ac_cache_parms;

typedef struct _ac_sto_list{
  char *name;                   
  char *format;                 
  unsigned size;                
  unsigned width;               
  unsigned level;               
  ac_sto_types type;            
  struct _ac_sto_list* higher;  
  ac_cache_parms *parms;        
  struct _ac_sto_list *next;    
} ac_sto_list;

typedef struct _ac_stg_list{
  char *name;                   
  unsigned id;                  
  struct _ac_stg_list *next;    
} ac_stg_list;

typedef struct _ac_pipe_list{
  char *name;                   
  unsigned id;                  
  ac_stg_list *stages;          
  struct _ac_pipe_list *next;   
} ac_pipe_list;

typedef union  {
  int i;
  char c[4];
}endian;


// Function Prototypes               //

void print_comment( FILE* output, char* description);

void CreateResourceHeader(void);                  
void CreateTypeHeader(void);                      
void CreateISAHeader(void);                       
void CreateARCHHeader(void);                      
void CreateStgHeader(ac_stg_list* stage_list, char* pipe_name);  
void CreateProcessorHeader(void);                 
void CreateParmHeader(void);                      
void CreateRegsHeader(void);                      
void CreateCoverifHeader(void);                   
void CreateStatsHeader(void);                     
void CreateArchSyscallHeader(void);               
void CreateMakefile(void);                        

void CreateResourceImpl(void);                    
void CreateStgImpl(ac_stg_list* stage_list, char* pipe_name); 
void CreateRegsImpl(void);                        
void CreateImplTmpl(void);                        
void CreateMainTmpl(void);                        
void CreateProcessorImpl(void);                   
void CreateARCHImpl(void);                        


void EmitGenInstrClass(FILE *output);             
void EmitFormatClasses(FILE *output);             
void EmitInstrClasses(FILE *output);              
void EmitDecStruct( FILE* output);                
void EmitPipeUpdateMethod( FILE *output);         
void EmitMultiPipeUpdateMethod( FILE *output);    
void EmitUpdateMethod( FILE *output);             
void EmitMultiCycleProcessorBhv(FILE *output);    
void EmitProcessorBhv( FILE *output);             
void EmitProcessorBhv_ABI( FILE *output);         
void EmitABIAddrList( FILE *output, int base_indent);           
void EmitABIDefine( FILE *output);                
void EmitPipeABIDefine( FILE *output);            
void EmitInstrExec(FILE *output, int base_indent);              
void EmitDecodification(FILE *output, int base_indent);         
void EmitFetchInit(FILE *output, int base_indent);              
void EmitCacheDeclaration(FILE *output, ac_sto_list* pstorage, int base_indent);       


void ReadConfFile(void);                          



#endif /*_ACSIM_H_*/

 
//   This is used by DoxyGen !!! 

---