Fix up doxygen.

--HG--
rename : docs/footer.html => src/doxygen/footer.html
rename : docs/stl.hh => src/doxygen/stl.hh
extra : convert_revision : 2b2e5637930843c1be07deaa708fd4126213cda2
This commit is contained in:
Steve Reinhardt
2006-08-14 19:25:07 -04:00
parent a04552ce86
commit 5bd07f98ed
37 changed files with 156 additions and 142 deletions

View File

@@ -30,7 +30,7 @@ PROJECT_NUMBER =
# If a relative path is entered, it will be relative to the location # If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used. # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = docs/doxygen OUTPUT_DIRECTORY = doxygen
# The OUTPUT_LANGUAGE tag is used to specify the language in which all # The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this # documentation generated by doxygen is written. Doxygen will use this
@@ -570,7 +570,7 @@ HTML_HEADER =
# each generated HTML page. If it is left blank doxygen will generate a # each generated HTML page. If it is left blank doxygen will generate a
# standard footer. # standard footer.
HTML_FOOTER = docs/footer.html HTML_FOOTER = doxygen/footer.html
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to # style sheet that is used by each HTML page. It can be used to

View File

@@ -37,7 +37,7 @@ SparcISA::MiscRegFile::setFSRegWithEffect(int miscReg, const MiscReg &val,
int64_t time; int64_t time;
SparcSystem *sys; SparcSystem *sys;
switch (miscReg) { switch (miscReg) {
/** Full system only ASRs */ /* Full system only ASRs */
case MISCREG_SOFTINT: case MISCREG_SOFTINT:
if (isNonPriv()) if (isNonPriv())
return new PrivilegedOpcode; return new PrivilegedOpcode;
@@ -94,7 +94,7 @@ SparcISA::MiscRegFile::setFSRegWithEffect(int miscReg, const MiscReg &val,
sTickCompare.schedule(time * Clock::Int::ns); sTickCompare.schedule(time * Clock::Int::ns);
return NoFault; return NoFault;
/** Fullsystem only Priv registers. */ /* Fullsystem only Priv registers. */
case MISCREG_PIL: case MISCREG_PIL:
if (FULL_SYSTEM) { if (FULL_SYSTEM) {
setReg(miscReg, val); setReg(miscReg, val);
@@ -104,7 +104,7 @@ SparcISA::MiscRegFile::setFSRegWithEffect(int miscReg, const MiscReg &val,
} else } else
panic("PIL not implemented for syscall emulation\n"); panic("PIL not implemented for syscall emulation\n");
/** Hyper privileged registers */ /* Hyper privileged registers */
case MISCREG_HPSTATE: case MISCREG_HPSTATE:
case MISCREG_HINTP: case MISCREG_HINTP:
setReg(miscReg, val); setReg(miscReg, val);
@@ -147,7 +147,7 @@ MiscRegFile::readFSRegWithEffect(int miscReg, Fault &fault, ThreadContext * tc)
{ {
switch (miscReg) { switch (miscReg) {
/** Privileged registers. */ /* Privileged registers. */
case MISCREG_SOFTINT: case MISCREG_SOFTINT:
if (isNonPriv()) { if (isNonPriv()) {
fault = new PrivilegedOpcode; fault = new PrivilegedOpcode;
@@ -177,7 +177,7 @@ MiscRegFile::readFSRegWithEffect(int miscReg, Fault &fault, ThreadContext * tc)
return readReg(miscReg); return readReg(miscReg);
/** Hyper privileged registers */ /* Hyper privileged registers */
case MISCREG_HPSTATE: case MISCREG_HPSTATE:
case MISCREG_HINTP: case MISCREG_HINTP:
return readReg(miscReg); return readReg(miscReg);

View File

@@ -72,7 +72,7 @@ class ChunkGenerator
public: public:
/** /**
* Constructor. * Constructor.
* @param startAddr The starting address of the region. * @param _startAddr The starting address of the region.
* @param totalSize The total size of the region. * @param totalSize The total size of the region.
* @param _chunkSize The size/alignment of chunks into which * @param _chunkSize The size/alignment of chunks into which
* the region should be decomposed. * the region should be decomposed.

View File

@@ -104,11 +104,11 @@ class SymbolTable
/// Find the nearest symbol equal to or less than the supplied /// Find the nearest symbol equal to or less than the supplied
/// address (e.g., the label for the enclosing function). /// address (e.g., the label for the enclosing function).
/// @param address The address to look up. /// @param addr The address to look up.
/// @param symbol Return reference for symbol string. /// @param symbol Return reference for symbol string.
/// @param sym_address Return reference for symbol address. /// @param symaddr Return reference for symbol address.
/// @param next_sym_address Address of following symbol (for /// @param nextaddr Address of following symbol (for
/// determining valid range of symbol). /// determining valid range of symbol).
/// @retval True if a symbol was found. /// @retval True if a symbol was found.
bool bool
findNearestSymbol(Addr addr, std::string &symbol, Addr &symaddr, findNearestSymbol(Addr addr, std::string &symbol, Addr &symaddr,
@@ -126,7 +126,7 @@ class SymbolTable
} }
/// Overload for findNearestSymbol() for callers who don't care /// Overload for findNearestSymbol() for callers who don't care
/// about next_sym_address. /// about nextaddr.
bool bool
findNearestSymbol(Addr addr, std::string &symbol, Addr &symaddr) const findNearestSymbol(Addr addr, std::string &symbol, Addr &symaddr) const
{ {

View File

@@ -259,7 +259,7 @@ class BasicPioDevice : public PioDevice
{} {}
/** return the address ranges that this device responds to. /** return the address ranges that this device responds to.
* @params range_list range list to populate with ranges * @param range_list range list to populate with ranges
*/ */
void addressRanges(AddrRangeList &range_list); void addressRanges(AddrRangeList &range_list);

View File

@@ -65,14 +65,14 @@ class IsaFake : public BasicPioDevice
/** /**
* This read always returns -1. * This read always returns -1.
* @param req The memory request. * @param pkt The memory request.
* @param data Where to put the data. * @param data Where to put the data.
*/ */
virtual Tick read(Packet *pkt); virtual Tick read(Packet *pkt);
/** /**
* All writes are simply ignored. * All writes are simply ignored.
* @param req The memory request. * @param pkt The memory request.
* @param data the data to not write. * @param data the data to not write.
*/ */
virtual Tick write(Packet *pkt); virtual Tick write(Packet *pkt);

View File

@@ -83,7 +83,8 @@ class Tsunami : public Platform
/** /**
* Constructor for the Tsunami Class. * Constructor for the Tsunami Class.
* @param name name of the object * @param name name of the object
* @param intrctrl pointer to the interrupt controller * @param s system the object belongs to
* @param intctrl pointer to the interrupt controller
*/ */
Tsunami(const std::string &name, System *s, IntrControl *intctrl); Tsunami(const std::string &name, System *s, IntrControl *intctrl);

View File

@@ -126,12 +126,14 @@ class TsunamiIO : public BasicPioDevice
/** /**
* Serialize this object to the given output stream. * Serialize this object to the given output stream.
* @param base The base name of the counter object.
* @param os The stream to serialize to. * @param os The stream to serialize to.
*/ */
void serialize(const std::string &base, std::ostream &os); void serialize(const std::string &base, std::ostream &os);
/** /**
* Reconstruct the state of this object from a checkpoint. * Reconstruct the state of this object from a checkpoint.
* @param base The base name of the counter object.
* @param cp The checkpoint use. * @param cp The checkpoint use.
* @param section The section name of this object * @param section The section name of this object
*/ */
@@ -221,12 +223,14 @@ class TsunamiIO : public BasicPioDevice
/** /**
* Serialize this object to the given output stream. * Serialize this object to the given output stream.
* @param os The stream to serialize to. * @param base The base name of the counter object.
* @param os The stream to serialize to.
*/ */
void serialize(const std::string &base, std::ostream &os); void serialize(const std::string &base, std::ostream &os);
/** /**
* Reconstruct the state of this object from a checkpoint. * Reconstruct the state of this object from a checkpoint.
* @param base The base name of the counter object.
* @param cp The checkpoint use. * @param cp The checkpoint use.
* @param section The section name of this object * @param section The section name of this object
*/ */
@@ -254,12 +258,14 @@ class TsunamiIO : public BasicPioDevice
/** /**
* Serialize this object to the given output stream. * Serialize this object to the given output stream.
* @param base The base name of the counter object.
* @param os The stream to serialize to. * @param os The stream to serialize to.
*/ */
void serialize(const std::string &base, std::ostream &os); void serialize(const std::string &base, std::ostream &os);
/** /**
* Reconstruct the state of this object from a checkpoint. * Reconstruct the state of this object from a checkpoint.
* @param base The base name of the counter object.
* @param cp The checkpoint use. * @param cp The checkpoint use.
* @param section The section name of this object * @param section The section name of this object
*/ */

View File

@@ -31,7 +31,8 @@
*/ */
/** /**
* @file Definition of a simple bus bridge without buffering. * @file
* Definition of a simple bus bridge without buffering.
*/ */
#include <algorithm> #include <algorithm>

View File

@@ -30,7 +30,8 @@
*/ */
/** /**
* @file Decleration of a simple bus bridge object with no buffering * @file
* Declaration of a simple bus bridge object with no buffering
*/ */
#ifndef __MEM_BRIDGE_HH__ #ifndef __MEM_BRIDGE_HH__
@@ -49,7 +50,7 @@
class Bridge : public MemObject class Bridge : public MemObject
{ {
protected: protected:
/** Decleration of the buses port type, one will be instantiated for each /** Declaration of the buses port type, one will be instantiated for each
of the interfaces connecting to the bus. */ of the interfaces connecting to the bus. */
class BridgePort : public Port class BridgePort : public Port
{ {

View File

@@ -29,7 +29,8 @@
*/ */
/** /**
* @file Definition of a bus object. * @file
* Definition of a bus object.
*/ */

View File

@@ -30,7 +30,8 @@
*/ */
/** /**
* @file Decleration of a bus object. * @file
* Declaration of a bus object.
*/ */
#ifndef __MEM_BUS_HH__ #ifndef __MEM_BUS_HH__
@@ -97,7 +98,7 @@ class Bus : public MemObject
void addressRanges(AddrRangeList &resp, AddrRangeList &snoop, int id); void addressRanges(AddrRangeList &resp, AddrRangeList &snoop, int id);
/** Decleration of the buses port type, one will be instantiated for each /** Declaration of the buses port type, one will be instantiated for each
of the interfaces connecting to the bus. */ of the interfaces connecting to the bus. */
class BusPort : public Port class BusPort : public Port
{ {

View File

@@ -488,7 +488,7 @@ class BaseCache : public MemObject
/** /**
* Send a response to the slave interface. * Send a response to the slave interface.
* @param req The request being responded to. * @param pkt The request being responded to.
* @param time The time the response is ready. * @param time The time the response is ready.
*/ */
void respond(Packet *pkt, Tick time) void respond(Packet *pkt, Tick time)
@@ -501,7 +501,7 @@ class BaseCache : public MemObject
/** /**
* Send a reponse to the slave interface and calculate miss latency. * Send a reponse to the slave interface and calculate miss latency.
* @param req The request to respond to. * @param pkt The request to respond to.
* @param time The time the response is ready. * @param time The time the response is ready.
*/ */
void respondToMiss(Packet *pkt, Tick time) void respondToMiss(Packet *pkt, Tick time)
@@ -517,7 +517,7 @@ class BaseCache : public MemObject
/** /**
* Suppliess the data if cache to cache transfers are enabled. * Suppliess the data if cache to cache transfers are enabled.
* @param req The bus transaction to fulfill. * @param pkt The bus transaction to fulfill.
*/ */
void respondToSnoop(Packet *pkt) void respondToSnoop(Packet *pkt)
{ {

View File

@@ -159,7 +159,7 @@ class Cache : public BaseCache
/** /**
* Performs the access specified by the request. * Performs the access specified by the request.
* @param req The request to perform. * @param pkt The request to perform.
* @return The result of the access. * @return The result of the access.
*/ */
bool access(Packet * &pkt); bool access(Packet * &pkt);
@@ -172,26 +172,26 @@ class Cache : public BaseCache
/** /**
* Was the request was sent successfully? * Was the request was sent successfully?
* @param req The request. * @param pkt The request.
* @param success True if the request was sent successfully. * @param success True if the request was sent successfully.
*/ */
virtual void sendResult(Packet * &pkt, bool success); virtual void sendResult(Packet * &pkt, bool success);
/** /**
* Handles a response (cache line fill/write ack) from the bus. * Handles a response (cache line fill/write ack) from the bus.
* @param req The request being responded to. * @param pkt The request being responded to.
*/ */
void handleResponse(Packet * &pkt); void handleResponse(Packet * &pkt);
/** /**
* Start handling a copy transaction. * Start handling a copy transaction.
* @param req The copy request to perform. * @param pkt The copy request to perform.
*/ */
void startCopy(Packet * &pkt); void startCopy(Packet * &pkt);
/** /**
* Handle a delayed copy transaction. * Handle a delayed copy transaction.
* @param req The delayed copy request to continue. * @param pkt The delayed copy request to continue.
* @param addr The address being responded to. * @param addr The address being responded to.
* @param blk The block of the current response. * @param blk The block of the current response.
* @param mshr The mshr being handled. * @param mshr The mshr being handled.
@@ -206,7 +206,7 @@ class Cache : public BaseCache
/** /**
* Snoops bus transactions to maintain coherence. * Snoops bus transactions to maintain coherence.
* @param req The current bus transaction. * @param pkt The current bus transaction.
*/ */
void snoop(Packet * &pkt); void snoop(Packet * &pkt);
@@ -221,9 +221,9 @@ class Cache : public BaseCache
void invalidateBlk(Addr addr, int asid); void invalidateBlk(Addr addr, int asid);
/** /**
* Aquash all requests associated with specified thread. * Squash all requests associated with specified thread.
* intended for use by I-cache. * intended for use by I-cache.
* @param req->getThreadNum()ber The thread to squash. * @param threadNum The thread to squash.
*/ */
void squash(int threadNum) void squash(int threadNum)
{ {
@@ -246,7 +246,7 @@ class Cache : public BaseCache
* time of completion. This function can either update the hierarchy state * time of completion. This function can either update the hierarchy state
* or just perform the access wherever the data is found depending on the * or just perform the access wherever the data is found depending on the
* state of the update flag. * state of the update flag.
* @param req The memory request to satisfy * @param pkt The memory request to satisfy
* @param update If true, update the hierarchy, otherwise just perform the * @param update If true, update the hierarchy, otherwise just perform the
* request. * request.
* @return The estimated completion time. * @return The estimated completion time.
@@ -257,7 +257,7 @@ class Cache : public BaseCache
* Snoop for the provided request in the cache and return the estimated * Snoop for the provided request in the cache and return the estimated
* time of completion. * time of completion.
* @todo Can a snoop probe not change state? * @todo Can a snoop probe not change state?
* @param req The memory request to satisfy * @param pkt The memory request to satisfy
* @param update If true, update the hierarchy, otherwise just perform the * @param update If true, update the hierarchy, otherwise just perform the
* request. * request.
* @return The estimated completion time. * @return The estimated completion time.

View File

@@ -85,7 +85,7 @@ class CoherenceProtocol : public SimObject
/** /**
* Return the proper state given the current state and the bus response. * Return the proper state given the current state and the bus response.
* @param req The bus response. * @param pkt The bus response.
* @param oldState The current block state. * @param oldState The current block state.
* @return The new state. * @return The new state.
*/ */
@@ -95,7 +95,7 @@ class CoherenceProtocol : public SimObject
/** /**
* Handle snooped bus requests. * Handle snooped bus requests.
* @param cache The cache that snooped the request. * @param cache The cache that snooped the request.
* @param req The snooped bus request. * @param pkt The snooped bus request.
* @param blk The cache block corresponding to the request, if any. * @param blk The cache block corresponding to the request, if any.
* @param mshr The MSHR corresponding to the request, if any. * @param mshr The MSHR corresponding to the request, if any.
* @param new_state The new coherence state of the block. * @param new_state The new coherence state of the block.

View File

@@ -96,7 +96,7 @@ class SimpleCoherence
/** /**
* Return the proper state given the current state and the bus response. * Return the proper state given the current state and the bus response.
* @param req The bus response. * @param pkt The bus response.
* @param current The current block state. * @param current The current block state.
* @return The new state. * @return The new state.
*/ */
@@ -107,7 +107,7 @@ class SimpleCoherence
/** /**
* Handle snooped bus requests. * Handle snooped bus requests.
* @param req The snooped bus request. * @param pkt The snooped bus request.
* @param blk The cache block corresponding to the request, if any. * @param blk The cache block corresponding to the request, if any.
* @param mshr The MSHR corresponding to the request, if any. * @param mshr The MSHR corresponding to the request, if any.
* @param new_state Return the new state for the block. * @param new_state Return the new state for the block.

View File

@@ -88,7 +88,7 @@ class UniCoherence
/** /**
* Just return readable and writeable. * Just return readable and writeable.
* @param req The bus response. * @param pkt The bus response.
* @param current The current block state. * @param current The current block state.
* @return The new state. * @return The new state.
*/ */
@@ -116,7 +116,7 @@ class UniCoherence
/** /**
* Handle snooped bus requests. * Handle snooped bus requests.
* @param req The snooped bus request. * @param pkt The snooped bus request.
* @param blk The cache block corresponding to the request, if any. * @param blk The cache block corresponding to the request, if any.
* @param mshr The MSHR corresponding to the request, if any. * @param mshr The MSHR corresponding to the request, if any.
* @param new_state The new coherence state of the block. * @param new_state The new coherence state of the block.

View File

@@ -107,7 +107,7 @@ public:
/** /**
* Handle a cache miss properly. Requests the bus and marks the cache as * Handle a cache miss properly. Requests the bus and marks the cache as
* blocked. * blocked.
* @param req The request that missed in the cache. * @param pkt The request that missed in the cache.
* @param blk_size The block size of the cache. * @param blk_size The block size of the cache.
* @param time The time the miss is detected. * @param time The time the miss is detected.
*/ */
@@ -128,43 +128,43 @@ public:
} }
/** /**
* Selects a outstanding request to service. * Selects a outstanding pktuest to service.
* @return The request to service, NULL if none found. * @return The pktuest to service, NULL if none found.
*/ */
Packet * getPacket(); Packet * getPacket();
/** /**
* Set the command to the given bus command. * Set the command to the given bus command.
* @param req The request to update. * @param pkt The request to update.
* @param cmd The bus command to use. * @param cmd The bus command to use.
*/ */
void setBusCmd(Packet * &pkt, Packet::Command cmd); void setBusCmd(Packet * &pkt, Packet::Command cmd);
/** /**
* Restore the original command in case of a bus transmission error. * Restore the original command in case of a bus transmission error.
* @param req The request to reset. * @param pkt The request to reset.
*/ */
void restoreOrigCmd(Packet * &pkt); void restoreOrigCmd(Packet * &pkt);
/** /**
* Marks a request as in service (sent on the bus). This can have side * Marks a pktuest as in service (sent on the bus). This can have side
* effect since storage for no response commands is deallocated once they * effect since storage for no response commands is deallocated once they
* are successfully sent. * are successfully sent.
* @param req The request that was sent on the bus. * @param pkt The request that was sent on the bus.
*/ */
void markInService(Packet * &pkt); void markInService(Packet * &pkt);
/** /**
* Frees the resources of the request and unblock the cache. * Frees the resources of the pktuest and unblock the cache.
* @param req The request that has been satisfied. * @param pkt The request that has been satisfied.
* @param time The time when the request is satisfied. * @param time The time when the pktuest is satisfied.
*/ */
void handleResponse(Packet * &pkt, Tick time); void handleResponse(Packet * &pkt, Tick time);
/** /**
* Removes all outstanding requests for a given thread number. If a request * Removes all outstanding pktuests for a given thread number. If a request
* has been sent to the bus, this function removes all of its targets. * has been sent to the bus, this function removes all of its targets.
* @param req->getThreadNum()ber The thread number of the requests to squash. * @param threadNum The thread number of the requests to squash.
*/ */
void squash(int threadNum); void squash(int threadNum);
@@ -220,14 +220,14 @@ public:
int size, uint8_t *data, bool compressed); int size, uint8_t *data, bool compressed);
/** /**
* Perform a writeback request. * Perform a writeback pktuest.
* @param req The writeback request. * @param pkt The writeback request.
*/ */
void doWriteback(Packet * &pkt); void doWriteback(Packet * &pkt);
/** /**
* Returns true if there are outstanding requests. * Returns true if there are outstanding pktuests.
* @return True if there are outstanding requests. * @return True if there are outstanding pktuests.
*/ */
bool havePending() bool havePending()
{ {
@@ -237,7 +237,7 @@ public:
/** /**
* Add a target to the given MSHR. This assumes it is in the miss queue. * Add a target to the given MSHR. This assumes it is in the miss queue.
* @param mshr The mshr to add a target to. * @param mshr The mshr to add a target to.
* @param req The target to add. * @param pkt The target to add.
*/ */
void addTarget(MSHR *mshr, Packet * &pkt) void addTarget(MSHR *mshr, Packet * &pkt)
{ {

View File

@@ -77,7 +77,7 @@ class MissQueue
/** The block size of the parent cache. */ /** The block size of the parent cache. */
int blkSize; int blkSize;
/** Increasing order number assigned to each incoming request. */ /** Increasing order number assigned to each incoming pktuest. */
uint64_t order; uint64_t order;
bool prefetchMiss; bool prefetchMiss;
@@ -164,7 +164,7 @@ class MissQueue
/** /**
* Allocate a new MSHR to handle the provided miss. * Allocate a new MSHR to handle the provided miss.
* @param req The miss to buffer. * @param pkt The miss to buffer.
* @param size The number of bytes to fetch. * @param size The number of bytes to fetch.
* @param time The time the miss occurs. * @param time The time the miss occurs.
* @return A pointer to the new MSHR. * @return A pointer to the new MSHR.
@@ -173,7 +173,7 @@ class MissQueue
/** /**
* Allocate a new WriteBuffer to handle the provided write. * Allocate a new WriteBuffer to handle the provided write.
* @param req The write to handle. * @param pkt The write to handle.
* @param size The number of bytes to write. * @param size The number of bytes to write.
* @param time The time the write occurs. * @param time The time the write occurs.
* @return A pointer to the new write buffer. * @return A pointer to the new write buffer.
@@ -212,9 +212,9 @@ class MissQueue
void setPrefetcher(BasePrefetcher *_prefetcher); void setPrefetcher(BasePrefetcher *_prefetcher);
/** /**
* Handle a cache miss properly. Either allocate an MSHR for the request, * Handle a cache miss properly. Either allocate an MSHR for the pktuest,
* or forward it through the write buffer. * or forward it through the write buffer.
* @param req The request that missed in the cache. * @param pkt The request that missed in the cache.
* @param blk_size The block size of the cache. * @param blk_size The block size of the cache.
* @param time The time the miss is detected. * @param time The time the miss is detected.
*/ */
@@ -232,43 +232,43 @@ class MissQueue
Packet * &target); Packet * &target);
/** /**
* Selects a outstanding request to service. * Selects a outstanding pktuest to service.
* @return The request to service, NULL if none found. * @return The pktuest to service, NULL if none found.
*/ */
Packet * getPacket(); Packet * getPacket();
/** /**
* Set the command to the given bus command. * Set the command to the given bus command.
* @param req The request to update. * @param pkt The request to update.
* @param cmd The bus command to use. * @param cmd The bus command to use.
*/ */
void setBusCmd(Packet * &pkt, Packet::Command cmd); void setBusCmd(Packet * &pkt, Packet::Command cmd);
/** /**
* Restore the original command in case of a bus transmission error. * Restore the original command in case of a bus transmission error.
* @param req The request to reset. * @param pkt The request to reset.
*/ */
void restoreOrigCmd(Packet * &pkt); void restoreOrigCmd(Packet * &pkt);
/** /**
* Marks a request as in service (sent on the bus). This can have side * Marks a pktuest as in service (sent on the bus). This can have side
* effect since storage for no response commands is deallocated once they * effect since storage for no response commands is deallocated once they
* are successfully sent. * are successfully sent.
* @param req The request that was sent on the bus. * @param pkt The request that was sent on the bus.
*/ */
void markInService(Packet * &pkt); void markInService(Packet * &pkt);
/** /**
* Collect statistics and free resources of a satisfied request. * Collect statistics and free resources of a satisfied pktuest.
* @param req The request that has been satisfied. * @param pkt The request that has been satisfied.
* @param time The time when the request is satisfied. * @param time The time when the pktuest is satisfied.
*/ */
void handleResponse(Packet * &pkt, Tick time); void handleResponse(Packet * &pkt, Tick time);
/** /**
* Removes all outstanding requests for a given thread number. If a request * Removes all outstanding pktuests for a given thread number. If a request
* has been sent to the bus, this function removes all of its targets. * has been sent to the bus, this function removes all of its targets.
* @param req->getThreadNum()ber The thread number of the requests to squash. * @param threadNum The thread number of the requests to squash.
*/ */
void squash(int threadNum); void squash(int threadNum);
@@ -313,21 +313,21 @@ class MissQueue
int size, uint8_t *data, bool compressed); int size, uint8_t *data, bool compressed);
/** /**
* Perform the given writeback request. * Perform the given writeback pktuest.
* @param req The writeback request. * @param pkt The writeback request.
*/ */
void doWriteback(Packet * &pkt); void doWriteback(Packet * &pkt);
/** /**
* Returns true if there are outstanding requests. * Returns true if there are outstanding pktuests.
* @return True if there are outstanding requests. * @return True if there are outstanding pktuests.
*/ */
bool havePending(); bool havePending();
/** /**
* Add a target to the given MSHR. This assumes it is in the miss queue. * Add a target to the given MSHR. This assumes it is in the miss queue.
* @param mshr The mshr to add a target to. * @param mshr The mshr to add a target to.
* @param req The target to add. * @param pkt The target to add.
*/ */
void addTarget(MSHR *mshr, Packet * &pkt) void addTarget(MSHR *mshr, Packet * &pkt)
{ {

View File

@@ -44,7 +44,7 @@ class MSHR;
/** /**
* Miss Status and handling Register. This class keeps all the information * Miss Status and handling Register. This class keeps all the information
* needed to handle a cache miss including a list of target requests. * needed to handle a cache miss including a list of target pktuests.
*/ */
class MSHR { class MSHR {
public: public:
@@ -63,15 +63,15 @@ class MSHR {
Addr addr; Addr addr;
/** Adress space id of the miss. */ /** Adress space id of the miss. */
short asid; short asid;
/** True if the request has been sent to the bus. */ /** True if the pktuest has been sent to the bus. */
bool inService; bool inService;
/** Thread number of the miss. */ /** Thread number of the miss. */
int threadNum; int threadNum;
/** The request that is forwarded to the next level of the hierarchy. */ /** The pktuest that is forwarded to the next level of the hierarchy. */
Packet * pkt; Packet * pkt;
/** The number of currently allocated targets. */ /** The number of currently allocated targets. */
short ntargets; short ntargets;
/** The original requesting command. */ /** The original pktuesting command. */
Packet::Command originalCmd; Packet::Command originalCmd;
/** Order number of assigned by the miss queue. */ /** Order number of assigned by the miss queue. */
uint64_t order; uint64_t order;
@@ -88,24 +88,24 @@ class MSHR {
Iterator allocIter; Iterator allocIter;
private: private:
/** List of all requests that match the address */ /** List of all pktuests that match the address */
TargetList targets; TargetList targets;
public: public:
/** /**
* Allocate a miss to this MSHR. * Allocate a miss to this MSHR.
* @param cmd The requesting command. * @param cmd The pktuesting command.
* @param addr The address of the miss. * @param addr The address of the miss.
* @param asid The address space id of the miss. * @param asid The address space id of the miss.
* @param size The number of bytes to request. * @param size The number of bytes to pktuest.
* @param req The original miss. * @param pkt The original miss.
*/ */
void allocate(Packet::Command cmd, Addr addr, int asid, int size, void allocate(Packet::Command cmd, Addr addr, int asid, int size,
Packet * &pkt); Packet * &pkt);
/** /**
* Allocate this MSHR as a buffer for the given request. * Allocate this MSHR as a buffer for the given pktuest.
* @param target The memory request to buffer. * @param target The memory pktuest to buffer.
*/ */
void allocateAsBuffer(Packet * &target); void allocateAsBuffer(Packet * &target);
@@ -115,7 +115,7 @@ public:
void deallocate(); void deallocate();
/** /**
* Add a request to the list of targets. * Add a pktuest to the list of targets.
* @param target The target. * @param target The target.
*/ */
void allocateTarget(Packet * &target); void allocateTarget(Packet * &target);

View File

@@ -39,7 +39,7 @@
#include "mem/cache/miss/mshr.hh" #include "mem/cache/miss/mshr.hh"
/** /**
* A Class for maintaining a list of pending and allocated memory requests. * A Class for maintaining a list of pending and allocated memory pktuests.
*/ */
class MSHRQueue { class MSHRQueue {
private: private:
@@ -55,7 +55,7 @@ class MSHRQueue {
// Parameters // Parameters
/** /**
* The total number of MSHRs in this queue. This number is set as the * The total number of MSHRs in this queue. This number is set as the
* number of MSHRs requested plus (numReserve - 1). This allows for * number of MSHRs pktuested plus (numReserve - 1). This allows for
* the same number of effective MSHRs while still maintaining the reserve. * the same number of effective MSHRs while still maintaining the reserve.
*/ */
const int numMSHRs; const int numMSHRs;
@@ -103,16 +103,16 @@ class MSHRQueue {
bool findMatches(Addr addr, int asid, std::vector<MSHR*>& matches) const; bool findMatches(Addr addr, int asid, std::vector<MSHR*>& matches) const;
/** /**
* Find any pending requests that overlap the given request. * Find any pending pktuests that overlap the given request.
* @param req The request to find. * @param pkt The request to find.
* @return A pointer to the earliest matching MSHR. * @return A pointer to the earliest matching MSHR.
*/ */
MSHR* findPending(Packet * &pkt) const; MSHR* findPending(Packet * &pkt) const;
/** /**
* Allocates a new MSHR for the request and size. This places the request * Allocates a new MSHR for the pktuest and size. This places the request
* as the first target in the MSHR. * as the first target in the MSHR.
* @param req The request to handle. * @param pkt The request to handle.
* @param size The number in bytes to fetch from memory. * @param size The number in bytes to fetch from memory.
* @return The a pointer to the MSHR allocated. * @return The a pointer to the MSHR allocated.
* *
@@ -121,12 +121,12 @@ class MSHRQueue {
MSHR* allocate(Packet * &pkt, int size = 0); MSHR* allocate(Packet * &pkt, int size = 0);
/** /**
* Allocate a read request for the given address, and places the given * Allocate a read pktuest for the given address, and places the given
* target on the target list. * target on the target list.
* @param addr The address to fetch. * @param addr The address to fetch.
* @param asid The address space for the fetch. * @param asid The address space for the fetch.
* @param size The number of bytes to request. * @param size The number of bytes to pktuest.
* @param target The first target for the request. * @param target The first target for the pktuest.
* @return Pointer to the new MSHR. * @return Pointer to the new MSHR.
*/ */
MSHR* allocateFetch(Addr addr, int asid, int size, Packet * &target); MSHR* allocateFetch(Addr addr, int asid, int size, Packet * &target);
@@ -135,7 +135,7 @@ class MSHRQueue {
* Allocate a target list for the given address. * Allocate a target list for the given address.
* @param addr The address to fetch. * @param addr The address to fetch.
* @param asid The address space for the fetch. * @param asid The address space for the fetch.
* @param size The number of bytes to request. * @param size The number of bytes to pktuest.
* @return Pointer to the new MSHR. * @return Pointer to the new MSHR.
*/ */
MSHR* allocateTargetList(Addr addr, int asid, int size); MSHR* allocateTargetList(Addr addr, int asid, int size);
@@ -151,7 +151,7 @@ class MSHRQueue {
* Allocates a target to the given MSHR. Used to keep track of the number * Allocates a target to the given MSHR. Used to keep track of the number
* of outstanding targets. * of outstanding targets.
* @param mshr The MSHR to allocate the target to. * @param mshr The MSHR to allocate the target to.
* @param req The target request. * @param pkt The target request.
*/ */
void allocateTarget(MSHR* mshr, Packet * &pkt) void allocateTarget(MSHR* mshr, Packet * &pkt)
{ {
@@ -181,22 +181,22 @@ class MSHRQueue {
void markInService(MSHR* mshr); void markInService(MSHR* mshr);
/** /**
* Mark an in service mshr as pending, used to resend a request. * Mark an in service mshr as pending, used to resend a pktuest.
* @param mshr The MSHR to resend. * @param mshr The MSHR to resend.
* @param cmd The command to resend. * @param cmd The command to resend.
*/ */
void markPending(MSHR* mshr, Packet::Command cmd); void markPending(MSHR* mshr, Packet::Command cmd);
/** /**
* Squash outstanding requests with the given thread number. If a request * Squash outstanding pktuests with the given thread number. If a request
* is in service, just squashes the targets. * is in service, just squashes the targets.
* @param req->getThreadNum()ber The thread to squash. * @param threadNum The thread to squash.
*/ */
void squash(int threadNum); void squash(int threadNum);
/** /**
* Returns true if the pending list is not empty. * Returns true if the pending list is not empty.
* @return True if there are outstanding requests. * @return True if there are outstanding pktuests.
*/ */
bool havePending() const bool havePending() const
{ {
@@ -213,8 +213,8 @@ class MSHRQueue {
} }
/** /**
* Returns the request at the head of the pendingList. * Returns the pktuest at the head of the pendingList.
* @return The next request to service. * @return The next pktuest to service.
*/ */
Packet * getReq() const Packet * getReq() const
{ {

View File

@@ -193,7 +193,7 @@ public:
/** /**
* Find the block in the cache and update the replacement data. Returns * Find the block in the cache and update the replacement data. Returns
* the access latency and the in cache flags as a side effect * the access latency and the in cache flags as a side effect
* @param req The req whose block to find * @param pkt The req whose block to find
* @param lat The latency of the access. * @param lat The latency of the access.
* @param inCache The FALRUBlk::inCache flags. * @param inCache The FALRUBlk::inCache flags.
* @return Pointer to the cache block. * @return Pointer to the cache block.
@@ -210,7 +210,7 @@ public:
/** /**
* Find a replacement block for the address provided. * Find a replacement block for the address provided.
* @param req The request to a find a replacement candidate for. * @param pkt The request to a find a replacement candidate for.
* @param writebacks List for any writebacks to be performed. * @param writebacks List for any writebacks to be performed.
* @param compress_blocks List of blocks to compress, for adaptive comp. * @param compress_blocks List of blocks to compress, for adaptive comp.
* @return The block to place the replacement in. * @return The block to place the replacement in.
@@ -328,7 +328,7 @@ public:
* @param source The block aligned source address. * @param source The block aligned source address.
* @param dest The block aligned destination adddress. * @param dest The block aligned destination adddress.
* @param asid The address space ID. * @param asid The address space ID.
* @param writebacks List for any generated writeback requests. * @param writebacks List for any generated writeback pktuests.
*/ */
void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks) void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks)
{ {

View File

@@ -454,7 +454,7 @@ class IIC : public BaseTags
/** /**
* Find the block and update the replacement data. This call also returns * Find the block and update the replacement data. This call also returns
* the access latency as a side effect. * the access latency as a side effect.
* @param req The req whose block to find * @param pkt The req whose block to find
* @param lat The access latency. * @param lat The access latency.
* @return A pointer to the block found, if any. * @return A pointer to the block found, if any.
*/ */
@@ -470,7 +470,7 @@ class IIC : public BaseTags
/** /**
* Find a replacement block for the address provided. * Find a replacement block for the address provided.
* @param req The request to a find a replacement candidate for. * @param pkt The request to a find a replacement candidate for.
* @param writebacks List for any writebacks to be performed. * @param writebacks List for any writebacks to be performed.
* @param compress_blocks List of blocks to compress, for adaptive comp. * @param compress_blocks List of blocks to compress, for adaptive comp.
* @return The block to place the replacement in. * @return The block to place the replacement in.
@@ -502,14 +502,14 @@ class IIC : public BaseTags
* @param source The block-aligned source address. * @param source The block-aligned source address.
* @param dest The block-aligned destination address. * @param dest The block-aligned destination address.
* @param asid The address space DI. * @param asid The address space DI.
* @param writebacks List for any generated writeback requests. * @param writebacks List for any generated writeback pktuests.
*/ */
void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks); void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);
/** /**
* If a block is currently marked copy on write, copy it before writing. * If a block is currently marked copy on write, copy it before writing.
* @param req The write request. * @param pkt The write request.
* @param writebacks List for any generated writeback requests. * @param writebacks List for any generated writeback pktuests.
*/ */
void fixCopy(Packet * &pkt, PacketList &writebacks); void fixCopy(Packet * &pkt, PacketList &writebacks);

View File

@@ -170,7 +170,7 @@ public:
/** /**
* Finds the given address in the cache and update replacement data. * Finds the given address in the cache and update replacement data.
* Returns the access latency as a side effect. * Returns the access latency as a side effect.
* @param req The request whose block to find. * @param pkt The request whose block to find.
* @param lat The access latency. * @param lat The access latency.
* @return Pointer to the cache block if found. * @return Pointer to the cache block if found.
*/ */
@@ -196,7 +196,7 @@ public:
/** /**
* Find a replacement block for the address provided. * Find a replacement block for the address provided.
* @param req The request to a find a replacement candidate for. * @param pkt The request to a find a replacement candidate for.
* @param writebacks List for any writebacks to be performed. * @param writebacks List for any writebacks to be performed.
* @param compress_blocks List of blocks to compress, for adaptive comp. * @param compress_blocks List of blocks to compress, for adaptive comp.
* @return The block to place the replacement in. * @return The block to place the replacement in.
@@ -307,7 +307,7 @@ public:
* @param source The block-aligned source address. * @param source The block-aligned source address.
* @param dest The block-aligned destination address. * @param dest The block-aligned destination address.
* @param asid The address space DI. * @param asid The address space DI.
* @param writebacks List for any generated writeback requests. * @param writebacks List for any generated writeback pktuests.
*/ */
void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks); void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);

View File

@@ -71,13 +71,13 @@ class Split : public BaseTags
Addr blkMask; Addr blkMask;
/** Number of NIC requests that hit in the NIC partition */ /** Number of NIC pktuests that hit in the NIC partition */
Stats::Scalar<> NR_NP_hits; Stats::Scalar<> NR_NP_hits;
/** Number of NIC requests that hit in the CPU partition */ /** Number of NIC pktuests that hit in the CPU partition */
Stats::Scalar<> NR_CP_hits; Stats::Scalar<> NR_CP_hits;
/** Number of CPU requests that hit in the NIC partition */ /** Number of CPU pktuests that hit in the NIC partition */
Stats::Scalar<> CR_NP_hits; Stats::Scalar<> CR_NP_hits;
/** Number of CPU requests that hit in the CPU partition */ /** Number of CPU pktuests that hit in the CPU partition */
Stats::Scalar<> CR_CP_hits; Stats::Scalar<> CR_CP_hits;
/** The number of nic replacements (i.e. misses) */ /** The number of nic replacements (i.e. misses) */
Stats::Scalar<> nic_repl; Stats::Scalar<> nic_repl;
@@ -203,7 +203,7 @@ class Split : public BaseTags
/** /**
* Finds the given address in the cache and update replacement data. * Finds the given address in the cache and update replacement data.
* Returns the access latency as a side effect. * Returns the access latency as a side effect.
* @param req The memory request whose block to find * @param pkt The memory request whose block to find
* @param lat The access latency. * @param lat The access latency.
* @return Pointer to the cache block if found. * @return Pointer to the cache block if found.
*/ */
@@ -219,7 +219,7 @@ class Split : public BaseTags
/** /**
* Find a replacement block for the address provided. * Find a replacement block for the address provided.
* @param req The request to a find a replacement candidate for. * @param pkt The request to a find a replacement candidate for.
* @param writebacks List for any writebacks to be performed. * @param writebacks List for any writebacks to be performed.
* @param compress_blocks List of blocks to compress, for adaptive comp. * @param compress_blocks List of blocks to compress, for adaptive comp.
* @return The block to place the replacement in. * @return The block to place the replacement in.
@@ -315,7 +315,7 @@ class Split : public BaseTags
* @param source The block-aligned source address. * @param source The block-aligned source address.
* @param dest The block-aligned destination address. * @param dest The block-aligned destination address.
* @param asid The address space DI. * @param asid The address space DI.
* @param writebacks List for any generated writeback requests. * @param writebacks List for any generated writeback pktuests.
*/ */
void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks); void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);

View File

@@ -47,7 +47,7 @@ class SplitBlk : public CacheBlk {
bool isTouched; bool isTouched;
/** Has this block been used after being brought in? (for LIFO partition) */ /** Has this block been used after being brought in? (for LIFO partition) */
bool isUsed; bool isUsed;
/** is this blk a NIC block? (i.e. requested by the NIC) */ /** is this blk a NIC block? (i.e. pktuested by the NIC) */
bool isNIC; bool isNIC;
/** timestamp of the arrival of this block into the cache */ /** timestamp of the arrival of this block into the cache */
Tick ts; Tick ts;

View File

@@ -203,7 +203,7 @@ public:
/** /**
* Finds the given address in the cache and update replacement data. * Finds the given address in the cache and update replacement data.
* Returns the access latency as a side effect. * Returns the access latency as a side effect.
* @param req The req whose block to find * @param pkt The req whose block to find
* @param lat The access latency. * @param lat The access latency.
* @return Pointer to the cache block if found. * @return Pointer to the cache block if found.
*/ */
@@ -219,7 +219,7 @@ public:
/** /**
* Find a replacement block for the address provided. * Find a replacement block for the address provided.
* @param req The request to a find a replacement candidate for. * @param pkt The request to a find a replacement candidate for.
* @param writebacks List for any writebacks to be performed. * @param writebacks List for any writebacks to be performed.
* @param compress_blocks List of blocks to compress, for adaptive comp. * @param compress_blocks List of blocks to compress, for adaptive comp.
* @return The block to place the replacement in. * @return The block to place the replacement in.
@@ -330,7 +330,7 @@ public:
* @param source The block-aligned source address. * @param source The block-aligned source address.
* @param dest The block-aligned destination address. * @param dest The block-aligned destination address.
* @param asid The address space DI. * @param asid The address space DI.
* @param writebacks List for any generated writeback requests. * @param writebacks List for any generated writeback pktuests.
*/ */
void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks); void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);

View File

@@ -186,7 +186,7 @@ public:
/** /**
* Finds the given address in the cache and update replacement data. * Finds the given address in the cache and update replacement data.
* Returns the access latency as a side effect. * Returns the access latency as a side effect.
* @param req The req whose block to find. * @param pkt The req whose block to find.
* @param lat The access latency. * @param lat The access latency.
* @return Pointer to the cache block if found. * @return Pointer to the cache block if found.
*/ */
@@ -202,7 +202,7 @@ public:
/** /**
* Find a replacement block for the address provided. * Find a replacement block for the address provided.
* @param req The request to a find a replacement candidate for. * @param pkt The request to a find a replacement candidate for.
* @param writebacks List for any writebacks to be performed. * @param writebacks List for any writebacks to be performed.
* @param compress_blocks List of blocks to compress, for adaptive comp. * @param compress_blocks List of blocks to compress, for adaptive comp.
* @return The block to place the replacement in. * @return The block to place the replacement in.
@@ -313,7 +313,7 @@ public:
* @param source The block-aligned source address. * @param source The block-aligned source address.
* @param dest The block-aligned destination address. * @param dest The block-aligned destination address.
* @param asid The address space DI. * @param asid The address space DI.
* @param writebacks List for any generated writeback requests. * @param writebacks List for any generated writeback pktuests.
*/ */
void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks); void doCopy(Addr source, Addr dest, int asid, PacketList &writebacks);

View File

@@ -30,7 +30,7 @@
/** /**
* @file * @file
* Base Memory Object decleration. * Base Memory Object declaration.
*/ */
#ifndef __MEM_MEM_OBJECT_HH__ #ifndef __MEM_MEM_OBJECT_HH__

View File

@@ -49,7 +49,7 @@
class System; class System;
/** /**
* Page Table Decleration. * Page Table Declaration.
*/ */
class PageTable class PageTable
{ {

View File

@@ -29,7 +29,8 @@
*/ */
/** /**
* @file Port object definitions. * @file
* Port object definitions.
*/ */
#include "base/chunk_generator.hh" #include "base/chunk_generator.hh"

View File

@@ -30,7 +30,7 @@
/** /**
* @file * @file
* Port Object Decleration. Ports are used to interface memory objects to * Port Object Declaration. Ports are used to interface memory objects to
* each other. They will always come in pairs, and we refer to the other * each other. They will always come in pairs, and we refer to the other
* port object as the peer. These are used to make the design more * port object as the peer. These are used to make the design more
* modular so that a specific interface between every type of objcet doesn't * modular so that a specific interface between every type of objcet doesn't

View File

@@ -31,7 +31,8 @@
*/ */
/** /**
* @file Decleration of a request, the overall memory request consisting of * @file
* Declaration of a request, the overall memory request consisting of
the parts of the request that are persistent throughout the transaction. the parts of the request that are persistent throughout the transaction.
*/ */

View File

@@ -29,7 +29,8 @@
*/ */
/** /**
* @file Port object definitions. * @file
* Port object definitions.
*/ */
#include "base/chunk_generator.hh" #include "base/chunk_generator.hh"

View File

@@ -30,7 +30,7 @@
/** /**
* @file * @file
* Virtual Port Object Decleration. These ports incorporate some translation * Virtual Port Object Declaration. These ports incorporate some translation
* into their access methods. Thus you can use one to read and write data * into their access methods. Thus you can use one to read and write data
* to/from virtual addresses. * to/from virtual addresses.
*/ */