misc.c

/*
 * Miscellaneous functions for Dinero IV.
 * Written by Jan Edler and Mark D. Hill
 * 
 * Copyright (C) 1997 NEC Research Institute, Inc. and Mark D. Hill.
 * All rights reserved.
 * Copyright (C) 1985, 1989 Mark D. Hill.  All rights reserved.
 * 
 * Permission to use, copy, modify, and distribute this software and
 * its associated documentation for non-commercial purposes is hereby
 * granted (for commercial purposes see below), provided that the above
 * copyright notice appears in all copies, derivative works or modified
 * versions of the software and any portions thereof, and that both the
 * copyright notice and this permission notice appear in the documentation.
 * NEC Research Institute Inc. and Mark D. Hill shall be given a copy of
 * any such derivative work or modified version of the software and NEC
 * Research Institute Inc.  and any of its affiliated companies (collectively
 * referred to as NECI) and Mark D. Hill shall be granted permission to use,
 * copy, modify, and distribute the software for internal use and research.
 * The name of NEC Research Institute Inc. and its affiliated companies
 * shall not be used in advertising or publicity related to the distribution
 * of the software, without the prior written consent of NECI.  All copies,
 * derivative works, or modified versions of the software shall be exported
 * or reexported in accordance with applicable laws and regulations relating
 * to export control.  This software is experimental.  NECI and Mark D. Hill
 * make no representations regarding the suitability of this software for
 * any purpose and neither NECI nor Mark D. Hill will support the software.
 * 
 * Use of this software for commercial purposes is also possible, but only
 * if, in addition to the above requirements for non-commercial use, written
 * permission for such use is obtained by the commercial user from NECI or
 * Mark D. Hill prior to the fabrication and distribution of the software.
 * 
 * THE SOFTWARE IS PROVIDED AS IS.  NECI AND MARK D. HILL DO NOT MAKE
 * ANY WARRANTEES EITHER EXPRESS OR IMPLIED WITH REGARD TO THE SOFTWARE.
 * NECI AND MARK D. HILL ALSO DISCLAIM ANY WARRANTY THAT THE SOFTWARE IS
 * FREE OF INFRINGEMENT OF ANY INTELLECTUAL PROPERTY RIGHTS OF OTHERS.
 * NO OTHER LICENSE EXPRESS OR IMPLIED IS HEREBY GRANTED.  NECI AND MARK
 * D. HILL SHALL NOT BE LIABLE FOR ANY DAMAGES, INCLUDING GENERAL, SPECIAL,
 * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF THE USE OR INABILITY
 * TO USE THE SOFTWARE.
 *
 * $Header: /home/edler/dinero/d4/RCS/misc.c,v 1.7 1997/12/11 08:07:58 edler Exp $
 */

#include <stddef.h>
#include <stdlib.h>
#include <limits.h>
#include <stdio.h>
#include <assert.h>
#include "d4.h"


/*
 * Global variable definitions
 */
struct d4_stackhash_struct d4stackhash;
d4stacknode d4freelist;
int d4nnodes;
d4pendstack *d4pendfree;
d4cache *d4_allcaches;


/*
 * Private prototypes for this file
 */
extern void d4_invblock (d4cache *, int stacknum, d4stacknode *);
extern void d4_invinfcache (d4cache *, const d4memref *);


/*
 * Create a new cache
 * The new cache sits "above" the indicated larger cache in the
 * memory hierarchy, with memory at the bottom and processors at the top.
 */
d4cache *
d4new (d4cache *larger)
{
	static int nextcacheid = 1;
	d4cache *c = calloc (1, sizeof(d4cache));

	if (c == NULL)
		return NULL;
	c->cacheid = nextcacheid++;
	c->downstream = larger;
	c->ref = d4ref;	/* may get altered for custom version */
	if (larger == NULL) {	/* simulated memory */
		c->flags = D4F_MEM;
		c->assoc = 1;	/* not used, but helps avoid compiler warnings */
	}
	c->link = d4_allcaches;
	d4_allcaches = c;	/* d4customize depends on this LIFO order */
	return c;
}


/*
 * Check all caches, set up internal data structures.
 * Must be called exactly once, after all calls to d4new
 * and all necessary direct initialization of d4cache structures.
 * The call to d4setup must occur before any calls to d4ref.
 * The return value is zero for success.
 */
int
d4setup()
{
	int i, nnodes;
	int r = 0;
	d4cache *c, *cc;
	d4stacknode *nodes = NULL, *ptr;

	for (c = d4_allcaches;  c != NULL;  c = c->link) {

		/* Check some stuff the user shouldn't muck with */
		if (c->stack != NULL || c->pending != NULL ||
				c->cacheid < 1 ||
				(c->link == NULL && c->cacheid != 1) ||
				(c->flags != D4F_MEM && c->downstream == NULL) ||
				c->numsets != 0 ||
				c->ranges != NULL || c->nranges != 0 || c->maxranges != 0)
			goto fail1;

		/*
		 * If customization has been done,
		 * check that the same values have been set in the d4cache structure.
		 * NOTE: The order of the checks here
		 * must match the code in d4customize.
		 */
		if (d4custom) {
			int problem = 0;
			if (c->cacheid > d4_ncustom)
				problem |= 0x1;
			else {
				if (d4_cust_vals[c->cacheid][0] != c->flags)
					problem |= 0x2;
				if (d4_cust_vals[c->cacheid][1] != c->lg2blocksize)
					problem |= 0x4;
				if (d4_cust_vals[c->cacheid][2] != c->lg2subblocksize)
					problem |= 0x8;
				if (d4_cust_vals[c->cacheid][3] != c->lg2size)
					problem |= 0x10;
				if (d4_cust_vals[c->cacheid][4] != c->assoc)
					problem |= 0x20;
				if (d4_cust_vals[c->cacheid][5] != c->prefetch_abortpercent)
					problem |= 0x40;
				if (d4_cust_vals[c->cacheid][6] != ((c->replacementf==d4rep_lru)?'l':
									(c->replacementf==d4rep_fifo)?'f':
									(c->replacementf==d4rep_random)?'r':0))
					problem |= 0x80;
				if (d4_cust_vals[c->cacheid][7] != ((c->prefetchf==d4prefetch_none)?'n':
									(c->prefetchf==d4prefetch_always)?'a':
									(c->prefetchf==d4prefetch_loadforw)?'l':
									(c->prefetchf==d4prefetch_subblock)?'s':
									(c->prefetchf==d4prefetch_miss)?'m':
									(c->prefetchf==d4prefetch_tagged)?'t':0))
					problem |= 0x100;
				if (d4_cust_vals[c->cacheid][8] != ((c->wallocf==d4walloc_always)?'a':
									(c->wallocf==d4walloc_never)?'n':
									(c->wallocf==d4walloc_nofetch)?'f':0))
					problem |= 0x200;
				if (d4_cust_vals[c->cacheid][9] != ((c->wbackf==d4wback_always)?'a':
									(c->wbackf==d4wback_never)?'n':
									(c->wbackf==d4wback_nofetch)?'f':0))
					problem |= 0x400;
			}
			if (problem) {
				fprintf (stderr, "Dinero IV: custom values "
					 "are inconsistent, problem=0x%x\n",
					 problem);
				exit (9);
			}
		}

		if ((c->flags & D4F_MEM) != 0)
			c->numsets = 1;	/* not used, but helps avoid compiler warnings */
		else {
			/* check the things the user should have set */
			if (c->lg2blocksize < 0)
				goto fail2;
			if (c->lg2subblocksize < 0 || c->lg2subblocksize > c->lg2blocksize)
				goto fail3;
			if (c->lg2size < c->lg2blocksize)
				goto fail4;
			if (c->assoc <= 0)
				goto fail5;
			if (c->replacementf == NULL || c->name_replacement == NULL)
				goto fail6;
			if (c->prefetchf == NULL || c->name_prefetch == NULL)
				goto fail7;
			if (c->wallocf == NULL || c->name_walloc == NULL)
				goto fail8;
			if (c->wbackf == NULL || c->name_wback == NULL)
				goto fail9;

			c->vc = calloc(1, sizeof(d4stackhead));
			if(c->vc==NULL)
				goto fail10;
			nnodes=c->vc_size;   // TODO: Modify number of blocks in victim cache
			d4stacknode *vc_nodes = calloc(nnodes, sizeof(d4stacknode));
			vc_nodes->victim = 1;   // Set indicator for victim cache
			if(vc_nodes == NULL)
				goto fail11;
			d4stacknode *vc_ptr;
			vc_ptr=vc_nodes;
			c->vc->top = vc_ptr;
			c->vc->n = nnodes;

			for(i = 1; i < nnodes - 1; i++) {
				vc_ptr[i].onstack= -1;
				vc_ptr[i].down=&vc_ptr[i+1];
				vc_ptr[i].up=&vc_ptr[i-1];
			}
			vc_ptr[0].up=&vc_ptr[nnodes-1];
			vc_ptr[0].down=&vc_ptr[1];
			vc_ptr[0].onstack=-1;
			vc_ptr[nnodes-1].down=&vc_ptr[0];
			vc_ptr[nnodes-1].up=&vc_ptr[nnodes-2];
			vc_ptr[nnodes-1].onstack=-1;

			/* we don't try to check per-policy cache state */

			/* it looks ok, now initialize */
			c->numsets = (1<<c->lg2size) / ((1<<c->lg2blocksize) * c->assoc);

			c->stack = calloc (c->numsets+((c->flags&D4F_CCC)!=0),
						 sizeof(d4stackhead));
			if (c->stack == NULL)
				goto fail10;
			nnodes = c->numsets * (1 + c->assoc) +
				 (c->numsets * c->assoc + 1) * ((c->flags&D4F_CCC)!=0);
			nodes = calloc (nnodes, sizeof(d4stacknode));
			if (nodes == NULL)
				goto fail11;
			nodes->victim = 0;
			for (i = 0;  i < nnodes;  i++)
				nodes[i].cachep = c;
			ptr = nodes;
			/* set up circular list for each stack */
			for (i = 0;  i < c->numsets+((c->flags&D4F_CCC)!=0);  i++) {
				int j, n;
				n = 1 + c->assoc * ((i < c->numsets) ? 1 : c->numsets);
				c->stack[i].top = ptr;
				c->stack[i].n = n;
				for (j = 1;  j < n-1;  j++) {
					ptr[j].onstack = i;
					ptr[j].down = &ptr[j+1];
					ptr[j].up = &ptr[j-1];
				}
				ptr[0].onstack = i;
				ptr[0].down = &ptr[1];
				ptr[0].up = &ptr[n-1];
				ptr[n-1].onstack = i;
				ptr[n-1].down = &ptr[0];
				ptr[n-1].up = &ptr[n-2];
				ptr += n;
			}
			assert (ptr - nodes == nnodes);
#if D4_HASHSIZE == 0
			d4stackhash.size += c->numsets * c->assoc;
#endif
			d4nnodes += nnodes;
		}

		/* make a printable name if the user didn't pick one */
		if (c->name == NULL) {
			c->name = malloc (30);
			if (c->name == NULL)
				goto fail12;
			sprintf (c->name, "%s%d",
				 (c->flags&D4F_MEM)!=0 ? "memory" : "cache", c->cacheid);
		}
	}
#if D4_HASHSIZE > 0
	d4stackhash.size = D4_HASHSIZE;
#endif
	d4stackhash.table = calloc (d4stackhash.size, sizeof(d4stacknode*));
	if (d4stackhash.table == NULL)
		goto fail13;
	return 0;

	/* Try to undo stuff so (in principle) the user could try again */
fail13: r++;
	/* don't bother trying to deallocate c->name */
fail12:	r++;
	free (nodes);
fail11:	r++;
	free (c->stack);
fail10:	r++;
fail9:	r++;
fail8:	r++;
fail7:	r++;
fail6:	r++;
fail5:	r++;
fail4:	r++;
fail3:	r++;
fail2:	r++;
fail1:	r++;

	for (cc = d4_allcaches;  cc != c;  cc = cc->link) {
		/* don't bother trying to deallocate c->name */
		free (c->stack[0].top);
		free (c->stack);
		c->stack = NULL;
		c->numsets = 0;
	}
	d4nnodes = 0;
	return r;
}


/*
 * Initialization routines for built-in policies
 * These exist for convenience of use only.
 */
void
d4init_rep_lru (d4cache *c)
{
	c->replacementf = d4rep_lru;
	c->name_replacement = "LRU";
}

void
d4init_rep_fifo (d4cache *c)
{
	c->replacementf = d4rep_fifo;
	c->name_replacement = "FIFO";
}

void
d4init_rep_random (d4cache *c)
{
	c->replacementf = d4rep_random;
	c->name_replacement = "random";
}

void
d4init_prefetch_none (d4cache *c)
{
	c->prefetchf = d4prefetch_none;
	c->name_prefetch = "none";
}

void
d4init_prefetch_always (d4cache *c, int dist, int abortpct)
{
	c->prefetchf = d4prefetch_always;
	c->name_prefetch = "always";
	c->prefetch_distance = dist;
	c->prefetch_abortpercent = abortpct;
}

void
d4init_prefetch_loadforw (d4cache *c, int dist, int abortpct)
{
	c->prefetchf = d4prefetch_loadforw;
	c->name_prefetch = "load-forward";
	c->prefetch_distance = dist;
	c->prefetch_abortpercent = abortpct;
}

void
d4init_prefetch_subblock (d4cache *c, int dist, int abortpct)
{
	c->prefetchf = d4prefetch_subblock;
	c->name_prefetch = "subblock";
	c->prefetch_distance = dist;
	c->prefetch_abortpercent = abortpct;
}

void
d4init_prefetch_miss (d4cache *c, int dist, int abortpct)
{
	c->prefetchf = d4prefetch_miss;
	c->name_prefetch = "miss";
	c->prefetch_distance = dist;
	c->prefetch_abortpercent = abortpct;
}

void
d4init_prefetch_tagged (d4cache *c, int dist, int abortpct)
{
	c->prefetchf = d4prefetch_tagged;
	c->name_prefetch = "tagged";
	c->prefetch_distance = dist;
	c->prefetch_abortpercent = abortpct;
}

void
d4init_walloc_always (d4cache *c)
{
	c->wallocf = d4walloc_always;
	c->name_walloc = "always";
}

void
d4init_walloc_never (d4cache *c)
{
	c->wallocf = d4walloc_never;
	c->name_walloc = "never";
}

void
d4init_walloc_nofetch (d4cache *c)
{
	c->wallocf = d4walloc_nofetch;
	c->name_walloc = "nofetch";
}

void
d4init_wback_always (d4cache *c)
{
	c->wbackf = d4wback_always;
	c->name_wback = "always";
}

void
d4init_wback_never (d4cache *c)
{
	c->wbackf = d4wback_never;
	c->name_wback = "never";
}

void
d4init_wback_nofetch (d4cache *c)
{
	c->wbackf = d4wback_nofetch;
	c->name_wback = "nofetch";
}

/* this is for the walloc policy of an icache */
int
d4walloc_impossible (d4cache *c, d4memref m)
{
	fprintf (stderr, "Dinero IV: impossible walloc policy routine called for %s!!!\n",
		 c->name);
	exit (9);
	return 0;	/* can't really get here, but some compilers get upset if we don't have a return value */
}

/* this is for the wback policy of an icache */
int
d4wback_impossible (d4cache *c, d4memref m, int setnumber, d4stacknode *ptr, int walloc)
{
	fprintf (stderr, "Dinero IV: impossible wback policy routine called for %s!!!\n",
		 c->name);
	exit (9);
	return 0;	/* can't really get here, but some compilers get upset if we don't have a return value */
}


#if 0	/* not used normally, but can be useful for debugging */
/*
 * Perform a consistency check on a priority stack
 */
void d4checkstack (d4cache *, int, char *); /* prototype avoids warnings */
void
d4checkstack (d4cache *c, int stacknum, char *msg)
{
	d4stacknode *sp, *top;
	int i, ii;
	static int tentimes = 10;

	top = c->stack[stacknum].top;
	i = 0;
	sp = top;
	do {
		i++;
		sp = sp->down;
	} while (sp != top);
	if (i != c->stack[stacknum].n) {
		if (tentimes-- < 0)
			return;
		fprintf (stderr, "%s: cache %d stack %d actual forward count=%d, shouldbe=%d\n",
			 msg, c->cacheid, stacknum, i, c->stack[stacknum].n);
	}
	ii = 0;
	sp = top;
	do {
		ii++;
		sp = sp->up;
	} while (sp != top);
	if (ii != i) {
		if (tentimes-- < 0)
			return;
		fprintf (stderr, "%s: cache %d stack %d actual forward count=%d, actual reverse count=%d\n",
			 msg, c->cacheid, stacknum, i, ii);
	}
}
#endif


/*
 * Find address in stack.
 */
d4stacknode *
d4_find (d4cache *c, int stacknum, d4addr blockaddr)
{
	d4stacknode *ptr, *vc;

	if (c->stack[stacknum].n > D4HASH_THRESH) {
		int buck = D4HASH (blockaddr, stacknum, c->cacheid);
		for (ptr = d4stackhash.table[buck];
				 ptr!=NULL && (ptr->blockaddr!=blockaddr || ptr->cachep!=c || ptr->onstack != stacknum);
				 ptr = ptr->bucket)
			assert (ptr->valid != 0);
		return ptr;
	}

	/*
	 * Don't hash, search the stack linearly.
	 * The search will terminate,
	 * because the last node is guaranteed to have valid==0.
	 */
	for (ptr = c->stack[stacknum].top;
			 ptr->blockaddr != blockaddr && ptr->valid != 0;
			 ptr = ptr->down)
		continue;

	if (ptr->valid != 0) {
		/* printf("Found in L1 cache\n\n"); */
		return ptr;
	}
	vc=c->vc->top;
	d4stacknode *temp = vc;
	if(temp == NULL)
		return NULL;

	/* for (int i = 0; i < c->vc->n; ++i) { */
	/* 	printf("block: %ld\n", vc->blockaddr); */
	/* 	if(vc->blockaddr == blockaddr && vc->valid != 0) { */
	/* 		printf("Found you bucko!\n"); */
	/* 		return vc; */
	/* 	} */
	/* 	vc = vc->down; */
	/* } */

	/* for (vc = c->vc->top; */
	/* 		 vc->blockaddr != blockaddr && vc->valid != 0 && temp->down != vc; */
	/* 		 vc = vc->down) { */
	/* 	continue; */
	/* } */
	int count = 0;
	if(vc->blockaddr != 0) {
		while(temp->down != vc && count < c->vc_size) {
			if(temp->blockaddr == blockaddr && temp->valid != 0 && temp->blockaddr != 0) {
				break;
			}
			count++;
			temp = temp->down;
		}
		if(temp->valid != 0 && temp->blockaddr == blockaddr) {
			// Sanity check :)
#ifdef DEBUG
			printf("Searching for %ld and Found %ld in Victim Cache!!\n", blockaddr, temp->blockaddr);
#endif
			return temp;
		}
	}
	return NULL;	/* not found */
}


/* find the nth element from the top (1 origin) */
d4stacknode *
d4findnth (d4cache *c, int stacknum, int n)
{
	d4stacknode *p;
	int i, stacksize;

	stacksize = c->stack[stacknum].n;
	assert (n <= stacksize);

	/* go in the shortest direction to find node */
	p = c->stack[stacknum].top;
	if (n <= stacksize/2)		/* search from front */
		for (i = 1;  i < n;  i++)
			p = p->down;
	else				/* search from rear */
		for (i = stacksize+1;  i > n;  i--)
			p = p->up;
	return p;
}


/* Move node to top (most recently used position) of stack */
void
d4movetotop (d4cache *c, int stacknum, d4stacknode *ptr)
{
	d4stacknode *top = c->stack[stacknum].top;
	d4stacknode *bot;

	/* nothing to do if node is already at top */
	if (ptr != top) {
		bot = top->up;
		if (bot != ptr)	{	/* general case */

			if( ptr->victim == 1){
				bot->blockaddr = ptr->blockaddr;
				bot->valid = ptr->valid;
				bot->referenced = ptr->referenced;
				bot->dirty = ptr->dirty;
				c->vc->top = ptr->down;
				ptr = bot;
				bot->up->valid = 0;
			}
			else {
				ptr->down->up = ptr->up;	/* remove */
				ptr->up->down = ptr->down;
				ptr->up = bot;			/* insert between top & bot */
				ptr->down = top;
				bot->down = ptr;
				top->up = ptr;
			}
		}
		c->stack[stacknum].top = ptr;
	}
}


/* Move node to bottom (least recently used, actually spare) position */
void
d4movetobot (d4cache *c, int stacknum, d4stacknode *ptr)
{
	d4stacknode *top = c->stack[stacknum].top;
	d4stacknode *bot = top->up;

	/* nothing to do if node is already at bottom */
	if (ptr != bot) {
		if (top == ptr)		/* common and favorable: move from top to bot */
			c->stack[stacknum].top = top->down;
		else {
			ptr->down->up = ptr->up;	/* remove */
			ptr->up->down = ptr->down;
			ptr->up = bot;			/* insert between top & bot */
			ptr->down = top;
			bot->down = ptr;
			top->up = ptr;
		}
	}
}


/* Insert the indicated node into the hash table */
void
d4hash (d4cache *c, int stacknum, d4stacknode *s)
{
	int buck = D4HASH (s->blockaddr, stacknum, s->cachep->cacheid);

	assert (c->stack[stacknum].n > D4HASH_THRESH);
	s->bucket = d4stackhash.table[buck];
	d4stackhash.table[buck] = s;
}


/* Remove the indicated node from the hash table */
void
d4_unhash (d4cache *c, int stacknum, d4stacknode *s)
{
	int buck = D4HASH (s->blockaddr, stacknum, c->cacheid);
	d4stacknode *p = d4stackhash.table[buck];

	assert (c->stack[stacknum].n > D4HASH_THRESH);
	if (p == s)
		d4stackhash.table[buck] = s->bucket;
	else {
		while (p->bucket != s) {
			assert (p->bucket != NULL);
			p = p->bucket;
		}
		p->bucket = s->bucket;
	}
}


/* Allocate a structure describing a pending memory reference */
d4pendstack *
d4get_mref()
{
	d4pendstack *m;

	m = d4pendfree;
	if (m != NULL) {
		d4pendfree = m->next;
		return m;
	}
	m = malloc (sizeof(*m));	/* no need to get too fancy here */
	if (m != NULL)
		return m;
	fprintf (stderr, "DineroIV ***error: no memory for pending mref\n");
	exit (9);
	return NULL;	/* can't really get here, but some compilers get upset if we don't have a return value */
}


/* Deallocate the structure used to describe a pending memory reference */
void
d4put_mref (d4pendstack *m)
{
	m->next = d4pendfree;
	d4pendfree = m;
}


/*
 * Make recursive calls for pending references
 * to own cache or towards memory
 */
void
d4_dopending (d4cache *c, d4pendstack *newm)
{
	do {
		c->pending = newm->next;
		if ((newm->m.accesstype & D4PREFETCH) != 0)
			c->ref (c, newm->m);
		else if ((newm->m.accesstype & D4_MULTIBLOCK) != 0) {
			newm->m.accesstype &= ~D4_MULTIBLOCK;
			c->ref (c, newm->m);
		}
		else {
			switch (D4BASIC_ATYPE(newm->m.accesstype)) {
			default:	fprintf (stderr, "Dinero IV: missing case %d in d4_dopending\n",
						 D4BASIC_ATYPE(newm->m.accesstype));
					exit (9);
			case D4XMISC:
			case D4XREAD:
			case D4XINSTRN:	c->bytes_read += newm->m.size;
					break;
			case D4XWRITE:	c->bytes_written += newm->m.size;
					break;
			case D4XCOPYB:
			case D4XINVAL:	/* don't count these */
					break;
			}
			c->downstream->ref (c->downstream, newm->m);
		}
		d4put_mref(newm);
	} while ((newm = c->pending) != NULL);
}


/*
 * Initiate write back for the dirty parts of a block.
 * Each contiguous bunch of subblocks is written in one operation.
 */
void
d4_wbblock (d4cache *c, d4stacknode *ptr, const int lg2sbsize)
{
	d4addr a;
	unsigned int b, dbits;
	d4pendstack *newm;
	const int sbsize = 1 << lg2sbsize;

	b = 1;
	dbits = ptr->valid & ptr->dirty;
	a = ptr->blockaddr;
	do {
		newm = d4get_mref();
		newm->m.accesstype = D4XWRITE;
		for (;  (dbits&b) == 0;  b<<=1)
			a += sbsize;
		newm->m.address = a;
		for (;  (dbits&b) != 0;  b<<=1) {
			a += sbsize;
			dbits &= ~b;
		}
		newm->m.size = a - newm->m.address;
		newm->next = c->pending;
		c->pending = newm;
	} while (dbits != 0);
	ptr->dirty = 0;
}


/* invalidate and deallocate a block, as indicated by ptr */
void
d4_invblock (d4cache *c, int stacknum, d4stacknode *ptr)
{
	assert (ptr->valid != 0);
	ptr->valid = 0;
	d4movetobot (c, stacknum, ptr);
	if (c->stack[stacknum].n > D4HASH_THRESH)
		d4_unhash (c, stacknum, ptr);
}


/*
 * Copy any dirty stuff from the cache back towards memory.  The operation
 * affects the whole cache or just 1 block, depending on m:
 * if m == NULL or m->size == 0, it affects the whole cache.
 * If prop is true, the same copyback operation will be propagated
 * to other caches towards memory.
 * This function can be invoked directly by the subroutine-calling user,
 * or indirectly by passing a D4XCOPYB access type to d4ref
 * (in which case d4ref passes prop == 1).
 *
 * NOTE: this function does not invalidate!
 */
void
d4copyback (d4cache *c, const d4memref *m, int prop)
{
	int stacknum;
	d4stacknode *ptr;
	d4pendstack *newm;

	if (m != NULL)
		assert (m->accesstype == D4XCOPYB);
	if (prop) {
		newm = d4get_mref();
		if (m != NULL)
			newm->m = *m;
		else {
			newm->m.accesstype = D4XCOPYB;
			newm->m.address = 0;
			newm->m.size = 0;	/* affect the whole cache */
		}
		newm->next = c->pending;
		c->pending = newm;
	}
	if (m != NULL && m->size > 0) {		/* copy back just 1 block */
		ptr = d4_find (c, D4ADDR2SET (c, m->address), D4ADDR2BLOCK (c, m->address));
		if (ptr != NULL && (ptr->dirty & ptr->valid) != 0)
			d4_wbblock (c, ptr, c->lg2subblocksize);
	}
	else for (stacknum=0;  stacknum < c->numsets;  stacknum++) {
		d4stacknode *top = c->stack[stacknum].top;
		assert (top->up->valid == 0); /* this loop skips the bottom node */
		for (ptr = top;  ptr->down != top;  ptr = ptr->down)
			if ((ptr->dirty & ptr->valid) != 0)
				d4_wbblock (c, ptr, c->lg2subblocksize);
	}
	if ((newm = c->pending) != NULL)
		d4_dopending (c, newm);
}


/*
 * Invalidate cache contents.  The operation affects the whole cache
 * or just 1 block, depending on m:
 * if m == NULL or m->size == 0, it affects the whole cache.
 * If prop is true, the same invalidate operation will be propagated
 * to other caches towards memory.
 * This function can be invoked directly by the subroutine-calling user,
 * or indirectly by passing a D4XINVAL access type to d4ref
 * (in which case d4ref passes prop == 1).
 *
 * NOTE: this does not copy back dirty stuff!
 *	you have to call d4copyback first for that.
 */
void
d4invalidate (d4cache *c, const d4memref *m, int prop)
{
	int stacknum;
	d4stacknode *ptr;
	d4pendstack *newm;

	if (m != NULL)
		assert (m->accesstype == D4XINVAL);
	if (prop) {
		newm = d4get_mref();
		if (m != NULL)
			newm->m = *m;
		else {
			newm->m.accesstype = D4XINVAL;
			newm->m.address = 0;
			newm->m.size = 0;	/* affect the whole cache */
		}
		newm->next = c->pending;
		c->pending = newm;
	}
	if (m != NULL && m->size > 0) {		/* invalidate just one block */
		d4addr blockaddr = D4ADDR2BLOCK (c, m->address);
		stacknum = D4ADDR2SET (c, m->address);
		ptr = d4_find (c, stacknum, blockaddr);
		if (ptr != NULL)
			d4_invblock (c, stacknum, ptr);
		if ((c->flags & D4F_CCC) != 0 &&	/* fully assoc cache */
				(ptr = d4_find (c, c->numsets, blockaddr)) != NULL)
			d4_invblock (c, c->numsets, ptr);
	}
	else for (stacknum=0;  stacknum < c->numsets + ((c->flags & D4F_CCC) != 0);  stacknum++) {
		d4stacknode *top = c->stack[stacknum].top;
		assert (top->up->valid == 0); /* all invalid nodes are at bottom; at least 1 */
		for (ptr = top;  ptr->down != top;  ptr = ptr->down) {
			if (ptr->valid == 0)
				break;
			d4_invblock (c, stacknum, ptr);
		}
	}
	if ((c->flags & D4F_CCC) != 0)
		d4_invinfcache (c, m);
	if ((newm = c->pending) != NULL)
		d4_dopending (c, newm);
}


/*
 * Handle invalidation for infinite cache
 */
void
d4_invinfcache (d4cache *c, const d4memref *m)
{
	int i;

	if (m == NULL || m->size == 0) {	/* invalidate whole cache */
		for (i = 0;  i < c->nranges;  i++) {
			assert (c->ranges[i].bitmap != NULL);
			free (c->ranges[i].bitmap);
			c->ranges[i].bitmap = NULL;
		}
		c->nranges = 0;
		c->maxranges = 0;
	}
	else {					/* invalidate just one block */
		const unsigned int sbsize = 1 << D4VAL (c, lg2subblocksize);
		const unsigned int baddr = D4ADDR2BLOCK (c, m->address);
		unsigned int bitoff;	/* offset of bit in bitmap */
		int hi, lo, nsb;

		bitoff = (baddr & (D4_BITMAP_RSIZE-1)) / sbsize;

		/* binary search for range containing our address */
		hi = c->nranges-1;
		lo = 0;
		while (lo <= hi) {
			i = lo + (hi-lo)/2;
			if (c->ranges[i].addr + D4_BITMAP_RSIZE <= baddr)
				lo = i + 1;		/* need to look higher */
			else if (c->ranges[i].addr > baddr)
				hi = i - 1;		/* need to look lower */
			else {				/* found the right range */
				for (nsb = c->lg2blocksize - c->lg2subblocksize;
						 nsb-- > 0;
						 bitoff++)
					c->ranges[i].bitmap[bitoff/CHAR_BIT] &=
								~(1<<(bitoff%CHAR_BIT));
				break;
			}
		}
	}
}


/*
 * Create custom code for d4ref and some routines it calls.
 * For each cache, we output macro definitions to establish constant
 * alternatives for key fields within d4cache, rename customizable
 * functions, and output an #include "ref.c".
 * The expectation is that the user will compile this output file
 * and link it with the simulator.
 */
void
d4customize (FILE *f)
{
	d4cache *c;
	int i, n;

	fprintf (f, "#if !D4CUSTOM\n"
				"#error \"D4CUSTOM not set\"\n"
				"#endif\n"
				"#include \"ref.c\"\n\n");	/* get one-time stuff */

	/*
	 * define d4_custom[] and d4_ncustom,
	 * which can be used to find the proper customized d4ref function
	 * when the customized program is started up.
	 */
	if (d4_allcaches == NULL) {
		fprintf (stderr, "Dinero IV: d4customize called before d4new\n");
		exit (9);
	}
	n = d4_allcaches->cacheid;
	for (i = 1;  i <= n;  i++)
		fprintf (f, "extern void d4_%dref (d4cache *, d4memref);\n", i);
	fprintf (f, "void (*d4_custom[])(d4cache *, d4memref) = {\n\t");
	for (i = 1;  i <= n;  i++)
		fprintf (f, "d4_%dref%s", i, (i<n) ? ", " : "");
	fprintf (f, "\n};\n");
	fprintf (f, "int d4_ncustom = %d;\n", n);

	/*
	 * Now Generate the customized stuff for each cache.
	 * Only the policy functions provided with Dinero IV are
	 * customized; user-supplied policy functions are unaltered.
	 * If you add new policy functions to ref.c, you need to
	 * add code here too!
	 */
	for (c = d4_allcaches;  c != NULL;  c = c->link) {
		int cid = c->cacheid;
		fprintf (f, "\n");

		/* Define helper used by D4VAL macro */
		fprintf (f, "#undef D4_CACHEID\n"
					"#define D4_CACHEID %d\n", cid);

		/*
		 * Define a cache-specific macro
		 * for the value of each field to be constantized,
		 * and a "trigger" macro to allow its use in D4VAL.
		 * In a few cases, we may #undef the trigger later
		 * if we find we can't use it.
		 */
		fprintf (f, "#define D4_CACHE_%d_flags 0x%x\n"
					"#define D4_TRIGGER_%d_flags 1\n",
					cid, c->flags, cid);
		fprintf (f, "#define D4_CACHE_%d_lg2blocksize %d\n"
					"#define D4_TRIGGER_%d_lg2blocksize 1\n",
					cid, c->lg2blocksize, cid);
		fprintf (f, "#define D4_CACHE_%d_lg2subblocksize %d\n"
					"#define D4_TRIGGER_%d_lg2subblocksize 1\n",
					cid, c->lg2subblocksize, cid);
		fprintf (f, "#define D4_CACHE_%d_lg2size %d\n"
					"#define D4_TRIGGER_%d_lg2size 1\n",
					cid, c->lg2size, cid);
		fprintf (f, "#define D4_CACHE_%d_assoc %d\n"
					"#define D4_TRIGGER_%d_assoc 1\n",
					cid, c->assoc, cid);
		fprintf (f, "#define D4_CACHE_%d_numsets %d\n"
					"#define D4_TRIGGER_%d_numsets 1\n",
					cid, c->numsets, cid);
		fprintf (f, "#define D4_CACHE_%d_prefetch_abortpercent %d\n"
					"#define D4_TRIGGER_%d_prefetch_abortpercent 1\n",
					cid, c->prefetch_abortpercent, cid);
		fprintf (f, "#define D4_CACHE_%d_replacementf d4_%dreplacement\n"
					"#define D4_TRIGGER_%d_replacementf 1\n",
					cid, cid, cid);
		fprintf (f, "#define D4_CACHE_%d_prefetchf d4_%dprefetch\n"
					"#define D4_TRIGGER_%d_prefetchf 1\n",
					cid, cid, cid);
		fprintf (f, "#define D4_CACHE_%d_wallocf d4_%dwalloc\n"
					"#define D4_TRIGGER_%d_wallocf 1\n",
					cid, cid, cid);
		fprintf (f, "#define D4_CACHE_%d_wbackf d4_%dwback\n"
					"#define D4_TRIGGER_%d_wbackf 1\n",
					cid, cid, cid);

		/* define macro to activate CCC computations */
		fprintf (f, "#define D4_OPTS_%d_ccc %d\n", cid, (c->flags & D4F_CCC) != 0);

		/*
		 * For each policy function we recognize,
		 * define a macro to activate it and
		 * define the cache-specific policy name for it.
		 * For policy functions we don't recognize,
		 * turn off the trigger macro, so the call will
		 * be treated in a non-customized manner, using the pointer
		 * in the d4cache structure.
		 */
		if (c->replacementf == d4rep_lru)
			fprintf (f, "#define D4_OPTS_%d_rep_lru 1\n"
						"#define D4_POLICY_%d_rep 'l'\n"
						"#undef d4rep_lru\n"
						"#define d4rep_lru d4_%dreplacement\n",
						cid, cid, cid);
		else if (c->replacementf == d4rep_fifo)
			fprintf (f, "#define D4_OPTS_%d_rep_fifo 1\n"
						"#define D4_POLICY_%d_rep 'f'\n"
						"#undef d4rep_fifo\n"
						"#define d4rep_fifo d4_%dreplacement\n",
						cid, cid, cid);
		else if (c->replacementf == d4rep_random)
			fprintf (f, "#define D4_OPTS_%d_rep_random 1\n"
						"#define D4_POLICY_%d_rep 'r'\n"
						"#undef d4rep_random\n"
						"#define d4rep_random d4_%dreplacement\n",
						cid, cid, cid);
		else
			fprintf (f, "#undef D4_TRIGGER_%d_replacementf\n"
						"#define D4_TRIGGER_%d_replacementf 0\n"
						"#define D4_POLICY_%d_rep 0\n"
						"#define d4_%dreplacement D4_CACHE_bogus_replacementf\n",
						cid, cid, cid, cid);
		if (c->prefetchf != d4prefetch_none)
			fprintf (f, "#define D4_OPTS_%d_prefetch_none 0\n", cid);
		if (c->prefetchf == d4prefetch_none)
			fprintf (f, "#define D4_OPTS_%d_prefetch_none 1\n"
						"#define D4_POLICY_%d_pref 'n'\n"
						"#undef d4prefetch_none\n"
						"#define d4prefetch_none d4_%dprefetch\n",
						cid, cid, cid);
		else if (c->prefetchf == d4prefetch_always)
			fprintf (f, "#define D4_OPTS_%d_prefetch_always 1\n"
						"#define D4_POLICY_%d_pref 'a'\n"
						"#undef d4prefetch_always\n"
						"#define d4prefetch_always d4_%dprefetch\n",
						cid, cid, cid);
		else if (c->prefetchf == d4prefetch_loadforw)
			fprintf (f, "#define D4_OPTS_%d_prefetch_loadforw 1\n"
						"#define D4_POLICY_%d_pref 'l'\n"
						"#undef d4prefetch_loadforw\n"
						"#define d4prefetch_loadforw d4_%dprefetch\n",
						cid, cid, cid);
		else if (c->prefetchf == d4prefetch_subblock)
			fprintf (f, "#define D4_OPTS_%d_prefetch_subblock 1\n"
						"#define D4_POLICY_%d_pref 's'\n"
						"#undef d4prefetch_subblock\n"
						"#define d4prefetch_subblock d4_%dprefetch\n",
						cid, cid, cid);
		else if (c->prefetchf == d4prefetch_miss)
			fprintf (f, "#define D4_OPTS_%d_prefetch_miss 1\n"
						"#define D4_POLICY_%d_pref 'm'\n"
						"#undef d4prefetch_miss\n"
						"#define d4prefetch_miss d4_%dprefetch\n",
						cid, cid, cid);
		else if (c->prefetchf == d4prefetch_tagged)
			fprintf (f, "#define D4_OPTS_%d_prefetch_tagged 1\n"
						"#define D4_POLICY_%d_pref 't'\n"
						"#undef d4prefetch_tagged\n"
						"#define d4prefetch_tagged d4_%dprefetch\n",
						cid, cid, cid);
		else
			fprintf (f, "#undef D4_TRIGGER_%d_prefetchf\n"
						"#define D4_TRIGGER_%d_prefetchf 0\n"
						"#define D4_POLICY_%d_pref 0\n"
						"#define d4_%dprefetch D4_CACHE_bogus_prefetchf\n",
						cid, cid, cid, cid);
		if (c->wallocf == d4walloc_always)
			fprintf (f, "#define D4_OPTS_%d_walloc_always 1\n"
						"#define D4_POLICY_%d_walloc 'a'\n"
						"#undef d4walloc_always\n"
						"#define d4walloc_always d4_%dwalloc\n",
						cid, cid, cid);
		else if (c->wallocf == d4walloc_never)
			fprintf (f, "#define D4_OPTS_%d_walloc_never 1\n"
						"#define D4_POLICY_%d_walloc 'n'\n"
						"#undef d4walloc_never\n"
						"#define d4walloc_never d4_%dwalloc\n",
						cid, cid, cid);
		else if (c->wallocf == d4walloc_nofetch)
			fprintf (f, "#define D4_OPTS_%d_walloc_nofetch 1\n"
						"#define D4_POLICY_%d_walloc 'f'\n"
						"#undef d4walloc_nofetch\n"
						"#define d4walloc_nofetch d4_%dwalloc\n",
						cid, cid, cid);
		else
			fprintf (f, "#undef D4_TRIGGER_%d_wallocf\n"
						"#define D4_TRIGGER_%d_wallocf 0\n"
						"#define D4_POLICY_%d_walloc 0\n"
						"#define d4_%dwalloc D4_CACHE_bogus_wallocf\n",
						cid, cid, cid, cid);
		if (c->wbackf == d4wback_always)
			fprintf (f, "#define D4_OPTS_%d_wback_always 1\n"
						"#define D4_POLICY_%d_wback 'a'\n"
						"#undef d4wback_always\n"
						"#define d4wback_always d4_%dwback\n",
						cid, cid, cid);
		else if (c->wbackf == d4wback_never)
			fprintf (f, "#define D4_OPTS_%d_wback_never 1\n"
						"#define D4_POLICY_%d_wback 'n'\n"
						"#undef d4wback_never\n"
						"#define d4wback_never d4_%dwback\n",
						cid, cid, cid);
		else if (c->wbackf == d4wback_nofetch)
			fprintf (f, "#define D4_OPTS_%d_wback_nofetch 1\n"
						"#define D4_POLICY_%d_wback 'f'\n"
						"#undef d4wback_nofetch\n"
						"#define d4wback_nofetch d4_%dwback\n",
						cid, cid, cid);
		else
			fprintf (f, "#undef D4_TRIGGER_%d_wbackf\n"
						"#define D4_TRIGGER_%d_wbackf 0\n"
						"#define D4_POLICY_%d_wback 0\n"
						"#define d4_%dwback D4_CACHE_bogus_wbackf\n",
						cid, cid, cid, cid);


		/*
		 * Other customized functions require special renaming
		 */
		fprintf (f, "#undef d4infcache\n");
		if ((c->flags & D4F_CCC) != 0)
			fprintf (f, "#define d4infcache d4_%dinfcache\n", cid);
		else
			fprintf (f, "#define d4infcache(c,m) 0\n");

		fprintf (f, "#undef d4_splitm\n");
		fprintf (f, "#define d4_splitm d4_%dsplitm\n", cid);

		/*
		 * Record the various customized values
		 * for checking in d4setup.  The order here is significant,
		 * and must match the order in which things are checked
		 * in d4setup.
		 */
		fprintf (f, "long d4_cust_%d_vals[] = {\n", cid);
		fprintf (f, "	D4_CACHE_%d_flags,\n", cid);
		fprintf (f, "	D4_CACHE_%d_lg2blocksize,\n", cid);
		fprintf (f, "	D4_CACHE_%d_lg2subblocksize,\n", cid);
		fprintf (f, "	D4_CACHE_%d_lg2size,\n", cid);
		fprintf (f, "	D4_CACHE_%d_assoc,\n", cid);
		fprintf (f, "	D4_CACHE_%d_prefetch_abortpercent,\n", cid);
		fprintf (f, "	D4_POLICY_%d_rep,\n", cid);
		fprintf (f, "	D4_POLICY_%d_pref,\n", cid);
		fprintf (f, "	D4_POLICY_%d_walloc,\n", cid);
		fprintf (f, "	D4_POLICY_%d_wback\n", cid);
		fprintf (f, "};\n");

		/*
		 * Now define the cache-specific name for d4ref
		 * and include the real code
		 */
		fprintf (f, "#undef d4ref\n");
		fprintf (f, "#define d4ref d4_%dref\n", cid);
		fprintf (f, "#include \"ref.c\"\n");
	}

	/*
	 * Now tie all the customized values up for checking in d4setup
	 */
	n = d4_allcaches->cacheid;
	fprintf (f, "\nlong *d4_cust_vals[%d+1] = {\n\tNULL,\n", n);
	for (i = 1;  i <= n;  i++)
		fprintf (f, "	&d4_cust_%d_vals[0]%s\n", i, (i<n) ? "," : "");
	fprintf (f, "};\n");
}