write_queue.hh revision 12727
111375Sandreas.hansson@arm.com/* 211375Sandreas.hansson@arm.com * Copyright (c) 2015-2016 ARM Limited 311375Sandreas.hansson@arm.com * All rights reserved. 411375Sandreas.hansson@arm.com * 511375Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 611375Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 711375Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 811375Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 911375Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 1011375Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 1111375Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 1211375Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 1311375Sandreas.hansson@arm.com * 1411375Sandreas.hansson@arm.com * Redistribution and use in source and binary forms, with or without 1511375Sandreas.hansson@arm.com * modification, are permitted provided that the following conditions are 1611375Sandreas.hansson@arm.com * met: redistributions of source code must retain the above copyright 1711375Sandreas.hansson@arm.com * notice, this list of conditions and the following disclaimer; 1811375Sandreas.hansson@arm.com * redistributions in binary form must reproduce the above copyright 1911375Sandreas.hansson@arm.com * notice, this list of conditions and the following disclaimer in the 2011375Sandreas.hansson@arm.com * documentation and/or other materials provided with the distribution; 2111375Sandreas.hansson@arm.com * neither the name of the copyright holders nor the names of its 2211375Sandreas.hansson@arm.com * contributors may be used to endorse or promote products derived from 2311375Sandreas.hansson@arm.com * this software without specific prior written permission. 2411375Sandreas.hansson@arm.com * 2511375Sandreas.hansson@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2611375Sandreas.hansson@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2711375Sandreas.hansson@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2811375Sandreas.hansson@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2911375Sandreas.hansson@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3011375Sandreas.hansson@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3111375Sandreas.hansson@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3211375Sandreas.hansson@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3311375Sandreas.hansson@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3411375Sandreas.hansson@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3511375Sandreas.hansson@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3611375Sandreas.hansson@arm.com * 3711375Sandreas.hansson@arm.com * Authors: Andreas Hansson 3811375Sandreas.hansson@arm.com */ 3911375Sandreas.hansson@arm.com 4011375Sandreas.hansson@arm.com/** 4111375Sandreas.hansson@arm.com * @file Declaration of a queue structure to manage uncacheable write 4211375Sandreas.hansson@arm.com * and writebacks. 4311375Sandreas.hansson@arm.com */ 4411375Sandreas.hansson@arm.com 4511375Sandreas.hansson@arm.com#ifndef __MEM_CACHE_WRITE_QUEUE_HH__ 4611375Sandreas.hansson@arm.com#define __MEM_CACHE_WRITE_QUEUE_HH__ 4711375Sandreas.hansson@arm.com 4812727Snikos.nikoleris@arm.com#include <string> 4911375Sandreas.hansson@arm.com 5012727Snikos.nikoleris@arm.com#include "base/types.hh" 5111375Sandreas.hansson@arm.com#include "mem/cache/queue.hh" 5211375Sandreas.hansson@arm.com#include "mem/cache/write_queue_entry.hh" 5312727Snikos.nikoleris@arm.com#include "mem/packet.hh" 5411375Sandreas.hansson@arm.com 5511375Sandreas.hansson@arm.com/** 5611375Sandreas.hansson@arm.com * A write queue for all eviction packets, i.e. writebacks and clean 5711375Sandreas.hansson@arm.com * evictions, as well as uncacheable writes. 5811375Sandreas.hansson@arm.com */ 5911375Sandreas.hansson@arm.comclass WriteQueue : public Queue<WriteQueueEntry> 6011375Sandreas.hansson@arm.com{ 6111375Sandreas.hansson@arm.com 6211375Sandreas.hansson@arm.com public: 6311375Sandreas.hansson@arm.com 6411375Sandreas.hansson@arm.com /** 6511375Sandreas.hansson@arm.com * Create a write queue with a given number of entries. 6611375Sandreas.hansson@arm.com * @param num_entries The number of entries in this queue. 6711375Sandreas.hansson@arm.com * @param reserve The maximum number of entries needed to satisfy 6811375Sandreas.hansson@arm.com * any access. 6911375Sandreas.hansson@arm.com */ 7011375Sandreas.hansson@arm.com WriteQueue(const std::string &_label, int num_entries, int reserve); 7111375Sandreas.hansson@arm.com 7211375Sandreas.hansson@arm.com /** 7311375Sandreas.hansson@arm.com * Allocates a new WriteQueueEntry for the request and size. This 7411375Sandreas.hansson@arm.com * places the request as the first target in the WriteQueueEntry. 7511375Sandreas.hansson@arm.com * 7611375Sandreas.hansson@arm.com * @param blk_addr The address of the block. 7711375Sandreas.hansson@arm.com * @param blk_size The number of bytes to request. 7811375Sandreas.hansson@arm.com * @param pkt The original write. 7911375Sandreas.hansson@arm.com * @param when_ready When is the WriteQueueEntry be ready to act upon. 8011375Sandreas.hansson@arm.com * @param order The logical order of this WriteQueueEntry 8111375Sandreas.hansson@arm.com * 8211375Sandreas.hansson@arm.com * @return The a pointer to the WriteQueueEntry allocated. 8311375Sandreas.hansson@arm.com * 8411375Sandreas.hansson@arm.com * @pre There are free entries. 8511375Sandreas.hansson@arm.com */ 8611375Sandreas.hansson@arm.com WriteQueueEntry *allocate(Addr blk_addr, unsigned blk_size, 8711375Sandreas.hansson@arm.com PacketPtr pkt, Tick when_ready, Counter order); 8811375Sandreas.hansson@arm.com 8911375Sandreas.hansson@arm.com /** 9011375Sandreas.hansson@arm.com * Mark the given entry as in service. This removes the entry from 9111375Sandreas.hansson@arm.com * the readyList or deallocates the entry if it does not expect a 9211375Sandreas.hansson@arm.com * response (writeback/eviction rather than an uncacheable write). 9311375Sandreas.hansson@arm.com * 9411375Sandreas.hansson@arm.com * @param entry The entry to mark in service. 9511375Sandreas.hansson@arm.com */ 9611375Sandreas.hansson@arm.com void markInService(WriteQueueEntry *entry); 9711375Sandreas.hansson@arm.com}; 9811375Sandreas.hansson@arm.com 9911375Sandreas.hansson@arm.com#endif //__MEM_CACHE_WRITE_QUEUE_HH__ 100