diff options
author | Steve Reinhardt <stever@eecs.umich.edu> | 2006-08-14 19:25:07 -0400 |
---|---|---|
committer | Steve Reinhardt <stever@eecs.umich.edu> | 2006-08-14 19:25:07 -0400 |
commit | 5bd07f98ed8b69e93345df4a7e626376fab57d8a (patch) | |
tree | 676422af140c7e446eb7c96808698965a55683cf /src/mem/cache/miss | |
parent | a04552ce86d0c4311d70abe78035bd8a52f1a14b (diff) | |
download | gem5-5bd07f98ed8b69e93345df4a7e626376fab57d8a.tar.xz |
Fix up doxygen.
--HG--
rename : docs/footer.html => src/doxygen/footer.html
rename : docs/stl.hh => src/doxygen/stl.hh
extra : convert_revision : 2b2e5637930843c1be07deaa708fd4126213cda2
Diffstat (limited to 'src/mem/cache/miss')
-rw-r--r-- | src/mem/cache/miss/blocking_buffer.hh | 34 | ||||
-rw-r--r-- | src/mem/cache/miss/miss_queue.hh | 42 | ||||
-rw-r--r-- | src/mem/cache/miss/mshr.hh | 22 | ||||
-rw-r--r-- | src/mem/cache/miss/mshr_queue.hh | 34 |
4 files changed, 66 insertions, 66 deletions
diff --git a/src/mem/cache/miss/blocking_buffer.hh b/src/mem/cache/miss/blocking_buffer.hh index 39a06a377..a6261f62c 100644 --- a/src/mem/cache/miss/blocking_buffer.hh +++ b/src/mem/cache/miss/blocking_buffer.hh @@ -107,7 +107,7 @@ public: /** * Handle a cache miss properly. Requests the bus and marks the cache as * 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 time The time the miss is detected. */ @@ -128,43 +128,43 @@ public: } /** - * Selects a outstanding request to service. - * @return The request to service, NULL if none found. + * Selects a outstanding pktuest to service. + * @return The pktuest to service, NULL if none found. */ Packet * getPacket(); /** * 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. */ void setBusCmd(Packet * &pkt, Packet::Command cmd); /** * 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); /** - * 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 * 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); /** - * Frees the resources of the request and unblock the cache. - * @param req The request that has been satisfied. - * @param time The time when the request is satisfied. + * Frees the resources of the pktuest and unblock the cache. + * @param pkt The request that has been satisfied. + * @param time The time when the pktuest is satisfied. */ 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. - * @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); @@ -220,14 +220,14 @@ public: int size, uint8_t *data, bool compressed); /** - * Perform a writeback request. - * @param req The writeback request. + * Perform a writeback pktuest. + * @param pkt The writeback request. */ void doWriteback(Packet * &pkt); /** - * Returns true if there are outstanding requests. - * @return True if there are outstanding requests. + * Returns true if there are outstanding pktuests. + * @return True if there are outstanding pktuests. */ bool havePending() { @@ -237,7 +237,7 @@ public: /** * 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 req The target to add. + * @param pkt The target to add. */ void addTarget(MSHR *mshr, Packet * &pkt) { diff --git a/src/mem/cache/miss/miss_queue.hh b/src/mem/cache/miss/miss_queue.hh index b88b7038c..c558df956 100644 --- a/src/mem/cache/miss/miss_queue.hh +++ b/src/mem/cache/miss/miss_queue.hh @@ -77,7 +77,7 @@ class MissQueue /** The block size of the parent cache. */ int blkSize; - /** Increasing order number assigned to each incoming request. */ + /** Increasing order number assigned to each incoming pktuest. */ uint64_t order; bool prefetchMiss; @@ -164,7 +164,7 @@ class MissQueue /** * 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 time The time the miss occurs. * @return A pointer to the new MSHR. @@ -173,7 +173,7 @@ class MissQueue /** * 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 time The time the write occurs. * @return A pointer to the new write buffer. @@ -212,9 +212,9 @@ class MissQueue 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. - * @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 time The time the miss is detected. */ @@ -232,43 +232,43 @@ class MissQueue Packet * &target); /** - * Selects a outstanding request to service. - * @return The request to service, NULL if none found. + * Selects a outstanding pktuest to service. + * @return The pktuest to service, NULL if none found. */ Packet * getPacket(); /** * 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. */ void setBusCmd(Packet * &pkt, Packet::Command cmd); /** * 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); /** - * 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 * 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); /** - * Collect statistics and free resources of a satisfied request. - * @param req The request that has been satisfied. - * @param time The time when the request is satisfied. + * Collect statistics and free resources of a satisfied pktuest. + * @param pkt The request that has been satisfied. + * @param time The time when the pktuest is satisfied. */ 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. - * @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); @@ -313,21 +313,21 @@ class MissQueue int size, uint8_t *data, bool compressed); /** - * Perform the given writeback request. - * @param req The writeback request. + * Perform the given writeback pktuest. + * @param pkt The writeback request. */ void doWriteback(Packet * &pkt); /** - * Returns true if there are outstanding requests. - * @return True if there are outstanding requests. + * Returns true if there are outstanding pktuests. + * @return True if there are outstanding pktuests. */ bool havePending(); /** * 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 req The target to add. + * @param pkt The target to add. */ void addTarget(MSHR *mshr, Packet * &pkt) { diff --git a/src/mem/cache/miss/mshr.hh b/src/mem/cache/miss/mshr.hh index 167aa26cd..ad2865973 100644 --- a/src/mem/cache/miss/mshr.hh +++ b/src/mem/cache/miss/mshr.hh @@ -44,7 +44,7 @@ class MSHR; /** * 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 { public: @@ -63,15 +63,15 @@ class MSHR { Addr addr; /** Adress space id of the miss. */ short asid; - /** True if the request has been sent to the bus. */ + /** True if the pktuest has been sent to the bus. */ bool inService; /** Thread number of the miss. */ 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; /** The number of currently allocated targets. */ short ntargets; - /** The original requesting command. */ + /** The original pktuesting command. */ Packet::Command originalCmd; /** Order number of assigned by the miss queue. */ uint64_t order; @@ -88,24 +88,24 @@ class MSHR { Iterator allocIter; private: - /** List of all requests that match the address */ + /** List of all pktuests that match the address */ TargetList targets; public: /** * Allocate a miss to this MSHR. - * @param cmd The requesting command. + * @param cmd The pktuesting command. * @param addr The address of the miss. * @param asid The address space id of the miss. - * @param size The number of bytes to request. - * @param req The original miss. + * @param size The number of bytes to pktuest. + * @param pkt The original miss. */ void allocate(Packet::Command cmd, Addr addr, int asid, int size, Packet * &pkt); /** - * Allocate this MSHR as a buffer for the given request. - * @param target The memory request to buffer. + * Allocate this MSHR as a buffer for the given pktuest. + * @param target The memory pktuest to buffer. */ void allocateAsBuffer(Packet * &target); @@ -115,7 +115,7 @@ public: void deallocate(); /** - * Add a request to the list of targets. + * Add a pktuest to the list of targets. * @param target The target. */ void allocateTarget(Packet * &target); diff --git a/src/mem/cache/miss/mshr_queue.hh b/src/mem/cache/miss/mshr_queue.hh index a67f1b9a6..02b6a026d 100644 --- a/src/mem/cache/miss/mshr_queue.hh +++ b/src/mem/cache/miss/mshr_queue.hh @@ -39,7 +39,7 @@ #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 { private: @@ -55,7 +55,7 @@ class MSHRQueue { // Parameters /** * 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. */ const int numMSHRs; @@ -103,16 +103,16 @@ class MSHRQueue { bool findMatches(Addr addr, int asid, std::vector<MSHR*>& matches) const; /** - * Find any pending requests that overlap the given request. - * @param req The request to find. + * Find any pending pktuests that overlap the given request. + * @param pkt The request to find. * @return A pointer to the earliest matching MSHR. */ 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. - * @param req The request to handle. + * @param pkt The request to handle. * @param size The number in bytes to fetch from memory. * @return The a pointer to the MSHR allocated. * @@ -121,12 +121,12 @@ class MSHRQueue { 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. * @param addr The address to fetch. * @param asid The address space for the fetch. - * @param size The number of bytes to request. - * @param target The first target for the request. + * @param size The number of bytes to pktuest. + * @param target The first target for the pktuest. * @return Pointer to the new MSHR. */ MSHR* allocateFetch(Addr addr, int asid, int size, Packet * &target); @@ -135,7 +135,7 @@ class MSHRQueue { * Allocate a target list for the given address. * @param addr The address to 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. */ 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 * of outstanding targets. * @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) { @@ -181,22 +181,22 @@ class MSHRQueue { 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 cmd The command to resend. */ 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. - * @param req->getThreadNum()ber The thread to squash. + * @param threadNum The thread to squash. */ void squash(int threadNum); /** * 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 { @@ -213,8 +213,8 @@ class MSHRQueue { } /** - * Returns the request at the head of the pendingList. - * @return The next request to service. + * Returns the pktuest at the head of the pendingList. + * @return The next pktuest to service. */ Packet * getReq() const { |