disksim_global.h

目前最精确的磁盘模拟器的第3版

/*
 * DiskSim Storage Subsystem Simulation Environment (Version 3.0)
 * Revision Authors: John Bucy, Greg Ganger
 * Contributors: John Griffin, Jiri Schindler, Steve Schlosser
 *
 * Copyright (c) of Carnegie Mellon University, 2001, 2002, 2003.
 *
 * This software is being provided by the copyright holders under the
 * following license. By obtaining, using and/or copying this software,
 * you agree that you have read, understood, and will comply with the
 * following terms and conditions:
 *
 * Permission to reproduce, use, and prepare derivative works of this
 * software is granted provided the copyright and "No Warranty" statements
 * are included with all reproductions and derivative works and associated
 * documentation. This software may also be redistributed without charge
 * provided that the copyright and "No Warranty" statements are included
 * in all redistributions.
 *
 * NO WARRANTY. THIS SOFTWARE IS FURNISHED ON AN "AS IS" BASIS.
 * CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER
 * EXPRESSED OR IMPLIED AS TO THE MATTER INCLUDING, BUT NOT LIMITED
 * TO: WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY, EXCLUSIVITY
 * OF RESULTS OR RESULTS OBTAINED FROM USE OF THIS SOFTWARE. CARNEGIE
 * MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF ANY KIND WITH RESPECT
 * TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
 * COPYRIGHT HOLDERS WILL BEAR NO LIABILITY FOR ANY USE OF THIS SOFTWARE
 * OR DOCUMENTATION.
 *
 */



/*
 * DiskSim Storage Subsystem Simulation Environment (Version 2.0)
 * Revision Authors: Greg Ganger
 * Contributors: Ross Cohen, John Griffin, Steve Schlosser
 *
 * Copyright (c) of Carnegie Mellon University, 1999.
 *
 * Permission to reproduce, use, and prepare derivative works of
 * this software for internal use is granted provided the copyright
 * and "No Warranty" statements are included with all reproductions
 * and derivative works. This software may also be redistributed
 * without charge provided that the copyright and "No Warranty"
 * statements are included in all redistributions.
 *
 * NO WARRANTY. THIS SOFTWARE IS FURNISHED ON AN "AS IS" BASIS.
 * CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER
 * EXPRESSED OR IMPLIED AS TO THE MATTER INCLUDING, BUT NOT LIMITED
 * TO: WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY, EXCLUSIVITY
 * OF RESULTS OR RESULTS OBTAINED FROM USE OF THIS SOFTWARE. CARNEGIE
 * MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF ANY KIND WITH RESPECT
 * TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
 */

/*
 * DiskSim Storage Subsystem Simulation Environment
 * Authors: Greg Ganger, Bruce Worthington, Yale Patt
 *
 * Copyright (C) 1993, 1995, 1997 The Regents of the University of Michigan 
 *
 * This software is being provided by the copyright holders under the
 * following license. By obtaining, using and/or copying this software,
 * you agree that you have read, understood, and will comply with the
 * following terms and conditions:
 *
 * Permission to use, copy, modify, distribute, and sell this software
 * and its documentation for any purpose and without fee or royalty is
 * hereby granted, provided that the full text of this NOTICE appears on
 * ALL copies of the software and documentation or portions thereof,
 * including modifications, that you make.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO
 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE,
 * BUT NOT LIMITATION, COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR
 * WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR
 * THAT THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY
 * THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. COPYRIGHT
 * HOLDERS WILL BEAR NO LIABILITY FOR ANY USE OF THIS SOFTWARE OR
 * DOCUMENTATION.
 *
 *  This software is provided AS IS, WITHOUT REPRESENTATION FROM THE
 * UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY PURPOSE, AND
 * WITHOUT WARRANTY BY THE UNIVERSITY OF MICHIGAN OF ANY KIND, EITHER
 * EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE REGENTS
 * OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE LIABLE FOR ANY DAMAGES,
 * INCLUDING SPECIAL , INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
 * WITH RESPECT TO ANY CLAIM ARISING OUT OF OR IN CONNECTION WITH THE
 * USE OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN IF IT HAS
 * BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
 *
 * The names and trademarks of copyright holders or authors may NOT be
 * used in advertising or publicity pertaining to the software without
 * specific, written prior permission. Title to copyright in this software
 * and any associated documentation will at all times remain with copyright
 * holders.
 */

#ifndef DISKSIM_GLOBAL_H
#define DISKSIM_GLOBAL_H

#include "disksim_rand48.h"
#include "disksim_malloc.h"
#include "disksim_bitstring.h"
#include "inline.h"

#include <sys/types.h>
#include <stdio.h>

#ifdef _WIN32
#define u_int		unsigned int
#define u_int64_t	unsigned __int64
#endif

/* must enable this on Suns and Alphas */
#ifndef _WIN32
#define u_int32_t	unsigned int
#define int32_t		int
#else
#define u_int32_t       unsigned long
#define int32_t         long
#endif

#ifndef _WIN32
#define SUPPORT_CHECKPOINTS
#endif

#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <time.h>

#define DISKSIM_time()		time(NULL)

#ifndef MAXINT
#define MAXINT	0x7FFFFFFF
#endif

#include "disksim_assertlib.h"

#define ALLOCSIZE	8192

#ifndef TRUE
#define TRUE	1
#endif
#ifndef FALSE
#define FALSE	0
#endif

#define BITS_PER_INT_MASK	0x0000001F
#define INV_BITS_PER_INT_MASK	0xFFFFFFE0

#define _BIG_ENDIAN	1
#define _LITTLE_ENDIAN	2

/* Trace Formats */

#define ASCII		1
#define HPL		2
#define DEC		3
#define VALIDATE	4
#define RAW		5
#define ATABUS          6
#define IPEAK           7
#define POSTGRES        8
#define EMCSYMM         9
#define DEFAULT		ASCII

/* Time conversions */

#define MILLI	1000
#define MICRO	1000000
#define NANO	1000000000

#define SECONDS_PER_MINUTE	60
#define SECONDS_PER_HOUR	3600
#define SECONDS_PER_DAY		86400

/* Flags components */

#define WRITE		0x00000000
#define READ		0x00000001
#define TIME_CRITICAL	0x00000002
#define TIME_LIMITED	0x00000004
#define TIMED_OUT	0x00000008
#define HALF_OUT	0x00000010
#define MAPPED		0x00000020
#define READ_AFTR_WRITE 0x00000040
#define SYNCHRONOUS	0x00000080
#define ASYNCHRONOUS	0x00000100
#define IO_FLAG_PAGEIO	0x00000200
#define SEQ		0x40000000
#define LOCAL		0x20000000

/* Event Type Ranges */

#define NULL_EVENT      	0
#define PF_MIN_EVENT    	1
#define PF_MAX_EVENT    	97
#define INTR_EVENT		98
#define INTEND_EVENT		99
#define IO_MIN_EVENT		100
#define IO_MAX_EVENT		120
#define TIMER_EXPIRED		121
#define CHECKPOINT		122
#define STOP_SIM		123
#define EXIT_DISKSIM		124
#define MEMS_MIN_EVENT		200
#define MEMS_MAX_EVENT		220

/* Interrupt vector types */

#define CLOCK_INTERRUPT		100
#define SUBCLOCK_INTERRUPT	101
#define IO_INTERRUPT    	102
#define CPUSWAP_INTERRUPT    	103

#define MSECS_PER_MIN		60000

/* 
   this threshold allows some difference between disksim's
   internal time and simos' time.  it was determined by
   trial and error and may require some adjustment.
*/
#define DISKSIM_TIME_THRESHOLD  0.0013

typedef union {
   u_int32_t	value;
   char		byte[4];
} intchar;

#define StaticAssert(c) switch (c) case 0: case (c):

typedef struct foo {
   double time;
   int type;
   struct ev *next;
   struct ev *prev;
   int    temp;
} foo;

#define DISKSIM_EVENT_SIZE	128
#define DISKSIM_EVENT_SPACESIZE	(DISKSIM_EVENT_SIZE - sizeof(struct foo))

typedef struct ev {
   double time;
   int type;
   struct ev *next;
   struct ev *prev;
   int    temp;
   char space[DISKSIM_EVENT_SPACESIZE];
} event;

typedef struct ioreq_ev {
   double time;
   int    type;
   struct ioreq_ev *next;
   struct ioreq_ev *prev;
   int    bcount;
   int    blkno;
   u_int  flags;
   u_int  busno;
   u_int  slotno;
   int    devno;
   int    opid;
   void  *buf;
   int    cause;
   int    tempint1;
   int    tempint2;
   void  *tempptr1;
   void  *tempptr2;
   void  *mems_sled;	 /* mems sled associated with a particular event */
   void  *mems_reqinfo; /* per-request info for mems subsystem */
   double start_time;    /* temporary; used for memulator timing */
} ioreq_event;

typedef struct timer_ev {
   double time;
   int type;
   struct timer_ev *next;
   struct timer_ev *prev;
   void (**func)(struct timer_ev *);
   int    val;
   void  *ptr;
} timer_event;

typedef struct intr_ev {
   double time;
   int    type;
   struct intr_ev * next;
   struct intr_ev * prev;
   int    vector;
   int    oldstate;
   int    flags;
   event  *eventlist;
   event  *infoptr;
   double runtime;
} intr_event;


/* place-holding definitions for structure types; placed here because */
/* some compilers can't handle them being inside other structure defs */

struct cacheevent;
struct ioq;
struct iosim_info;
struct device_info;
struct disk_info;
struct simpledisk_info;
struct mems_info;
struct iodriver_info;
struct businfo;
struct ctlrinfo;
struct pf_info;
struct synthio_info;
struct iotrace_info;
struct rand48_info;


typedef struct disksim {
   void * startaddr;
   int    totallength;
   int    curroffset;
   int    totalreqs;
   int    closedios;
   double closedthinktime;
   int    warmup_iocnt;
   double warmuptime;
   timer_event *warmup_event;
   double simtime;
   int    checkpoint_disable;
   int    checkpoint_iocnt;
   double checkpoint_interval;
   event *checkpoint_event;
   int    traceformat;
   int    endian;
   int    traceendian;
   int    traceheader;
   int    iotrace;
   int    synthgen;
   int    external_control;
   void   (*external_io_done_notify)(ioreq_event *curr);
   FILE * parfile;
   FILE * iotracefile;
   FILE * statdeffile;
   FILE * outputfile;
   FILE * outios;
   char   iotracefilename[256];
   char   outputfilename[256];
   char   outiosfilename[256];
   char   checkpointfilename[256];
   fpos_t iotracefileposition;
   fpos_t outputfileposition;
   fpos_t outiosfileposition;
   event *intq;
   event *intqhint;
   event *extraq;
   int    intqlen;
   int    extraqlen;
   int    stop_sim;
   int    seedval;
   double lastphystime;

/* call-back indirections for allowing checkpoint restores to deal with */
/* functions whose addresses change on recompilation.                   */
   void         (*issuefunc_ctlrsmart)     (void *, ioreq_event *);
   struct ioq * (*queuefind_ctlrsmart)     (void *, int);
   void         (*wakeupfunc_ctlrsmart)    (void *, struct cacheevent *);
   void         (*donefunc_ctlrsmart_read) (void *, ioreq_event *);
   void         (*donefunc_ctlrsmart_write)(void *, ioreq_event *);
   void         (*donefunc_cachemem_empty) (void *, ioreq_event *);
   void         (*donefunc_cachedev_empty) (void *, ioreq_event *);
   void         (*idlework_cachemem)       (void *, int);
   void         (*idlework_cachedev)       (void *, int);
   int          (*concatok_cachemem)       (void *, int, int, int, int);
   int          (*enablement_disk)         (ioreq_event *);
   void         (*timerfunc_disksim)       (timer_event *);
   void         (*timerfunc_ioqueue)       (timer_event *);
   void         (*timerfunc_cachemem)      (timer_event *);
   void         (*timerfunc_cachedev)      (timer_event *);

/* opaque structures for different modules */
   struct iosim_info *iosim_info;
   struct device_info *deviceinfo;
   struct disk_info *diskinfo;
   struct simpledisk_info *simplediskinfo;
   struct mems_info *memsinfo;
   struct iodriver_info *iodriver_info;
   struct businfo *businfo;
   struct ctlrinfo *ctlrinfo;
   struct pf_info *pf_info;
   struct synthio_info *synthio_info;
   struct iotrace_info *iotrace_info;
   struct rand48_info *rand48_info;

   char **overrides;
   int overrides_len;
   int verbosity;

  int tracepipes[2];
  enum { DISKSIM_MASTER, DISKSIM_SLAVE, DISKSIM_NONE } trace_mode;
} disksim_t;

extern disksim_t *disksim;

/* remapping #defines for some of the variables in disksim_t */
#define warmuptime       (disksim->warmuptime)
#define simtime	         (disksim->simtime)
#define statdeffile      (disksim->statdeffile)
#define outputfile       (disksim->outputfile)
#define outios           (disksim->outios)


#ifndef _WIN32
#define	min(x,y)	((x) < (y) ? (x) : (y))

#define	max(x,y)	((x) < (y) ? (y) : (x))
#endif

#define	wrap(x,y)	((y) < (x) ? 1 : 0)

#define diff(x,y)	((x) < (y) ? (y)-(x) : (x)-(y))

#define rounduptomult(val,mult)	((val) + ((mult) - (((val)-1) % (mult))) - 1)

/* translate from the deprecated but convenient bzero function to memset */
#define bzero(ptr,size)  memset(ptr,0,size)


/* Global disksim_intr.c functions */

void intr_request(event *curr);
void intr_acknowledge (event *intrp);


/* Global disksim.c functions */

void resetstats (void);
void disksim_simstop (void);
void disksim_register_checkpoint (double atsimtime);
INLINE void addtoextraq (event *temp);
void addlisttoextraq (event **headptr);
INLINE event * getfromextraq (void);
event * event_copy (event *orig);
INLINE void addtointq (event *temp);
INLINE int removefromintq (event *curr);
void scanparam_int (char *parline, char *parname, int *parptr, int parchecks, int parminval, int parmaxval);
void getparam_int (FILE *parfile, char *parname, int *parptr, int parchecks, int parminval, int parmaxval);
void getparam_double (FILE *parfile, char *parname, double *parptr, int parchecks, double parminval, double parmaxval);
void getparam_bool (FILE *parfile, char *parname, int *parptr);
event * io_done_notify (ioreq_event *curr);


/* disksim.c functions used for external control */

struct disksim * disksim_initialize_disksim_structure (void *addr, int len);
int disksim_loadparams(char *inputfile, int synthgen);
void disksim_setup_disksim (int argc, char **argv);
void disksim_set_external_io_done_notify (void (*func)(ioreq_event *));
void disksim_cleanup_and_printstats (void);
void disksim_cleanstats (void);
void disksim_printstats (void);
void disksim_simulate_event (int);
void disksim_restore_from_checkpoint (char *filename);
void disksim_run_simulation ();


#endif  /* DISKSIM_GLOBAL_H */