Skip to content

Commit

Permalink
milestone
Browse files Browse the repository at this point in the history
  • Loading branch information
@YuanhuanO
YuanhuanO committed Oct 3, 2024
1 parent 69d4612 commit 15b8025
Show file tree
Hide file tree
Showing 3 changed files with 178 additions and 24 deletions.
7 changes: 3 additions & 4 deletions timing/rob/builder.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ package rob

import (
"container/list"

"github.com/sarchlab/akita/v3/sim"
"github.com/sarchlab/akita/v3/sim"
)

// A Builder can build ReorderBuffers.
Expand All @@ -12,6 +11,7 @@ type Builder struct {
freq sim.Freq
numReqPerCycle int
bufferSize int
bottomUnit sim.Port
}

// MakeBuilder creates a builder with default parameters.
Expand Down Expand Up @@ -51,7 +51,6 @@ func (b Builder) WithBufferSize(n int) Builder {
// Build creates a ReorderBuffer with the given parameters.
func (b Builder) Build(name string) *ReorderBuffer {
rb := &ReorderBuffer{}

rb.TickingComponent = sim.NewTickingComponent(name, b.engine, b.freq, rb)

rb.transactions = list.New()
Expand All @@ -62,7 +61,7 @@ func (b Builder) Build(name string) *ReorderBuffer {
rb.numReqPerCycle = b.numReqPerCycle

b.createPorts(name, rb)

rb.isFlushing = false
return rb
}

Expand Down
191 changes: 171 additions & 20 deletions timing/rob/rob.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ package rob

import (
"container/list"

"github.com/sarchlab/akita/v3/mem/mem"
"github.com/sarchlab/akita/v3/sim"
"github.com/sarchlab/akita/v3/tracing"
"fmt"
"encoding/csv"
"sync"
"os"
)

type transaction struct {
Expand All @@ -33,14 +36,79 @@ type ReorderBuffer struct {
isFlushing bool
}

type Milestone struct {
ID string
TaskID string
BlockingCategory string
BlockingReason string
BlockingLocation string
Timestamp sim.VTimeInSec
}

func (m *MilestoneManager) AddMilestone(
taskID string,
blockingCategory string,
blockingReason string,
blockingLocation string,
timestamp sim.VTimeInSec,
) {
m.mutex.Lock()
defer m.mutex.Unlock()
milestone := Milestone {
ID: fmt.Sprintf("milestone_%d", len(m.milestones)+1),
TaskID: taskID,
BlockingCategory: blockingCategory,
BlockingReason: blockingReason,
BlockingLocation: blockingLocation,
Timestamp: timestamp,
}
m.milestones = append(m.milestones, milestone)
fmt.Printf("Added milestone: %+v\n", milestone)
}

type MilestoneManager struct {
milestones []Milestone
mutex sync.Mutex
}

var GlobalMilestoneManager = &MilestoneManager{
milestones: make([]Milestone, 0),
}

func (m *MilestoneManager) GetMilestones() []Milestone {
m.mutex.Lock()
defer m.mutex.Unlock()

return m.milestones
}

func (b *ReorderBuffer) getTaskID() string {
if b.transactions.Len() == 0 {
return ""
}

trans := b.transactions.Front().Value.(*transaction)

if trans.reqFromTop != nil {
return trans.reqFromTop.Meta().ID
}

if trans.reqToBottom != nil {
return trans.reqFromTop.Meta().ID
}

return ""
}


// Tick updates the status of the ReorderBuffer.
func (b *ReorderBuffer) Tick(now sim.VTimeInSec) (madeProgress bool) {
madeProgress = b.processControlMsg(now) || madeProgress

if !b.isFlushing {
madeProgress = b.runPipeline(now) || madeProgress
}

// b.ExportMilestonesToCSV("../samples/fir/milestones.csv")
return madeProgress
}

Expand Down Expand Up @@ -138,9 +206,16 @@ func (b *ReorderBuffer) runPipeline(now sim.VTimeInSec) (madeProgress bool) {
}

func (b *ReorderBuffer) topDown(now sim.VTimeInSec) bool {
if b.isFull() {
return false
}
if b.isFull() {
GlobalMilestoneManager.AddMilestone(
b.getTaskID(),
"Hardware Occupancy",
"buffer full",
"topDown",
now,
)
return false
}

item := b.topPort.Peek()
if item == nil {
Expand All @@ -152,11 +227,18 @@ func (b *ReorderBuffer) topDown(now sim.VTimeInSec) bool {

trans.reqToBottom.Meta().Src = b.bottomPort
trans.reqToBottom.Meta().SendTime = now
err := b.bottomPort.Send(trans.reqToBottom)
if err != nil {
return false
}

sendErr := b.bottomPort.Send(trans.reqToBottom)
if sendErr != nil {
GlobalMilestoneManager.AddMilestone(
b.getTaskID(),
"Network Error",
"Unable to send request to bottom port",
"topDown",
now,
)
return false
}

b.addTransaction(trans)
b.topPort.Retrieve(now)

Expand All @@ -169,9 +251,17 @@ func (b *ReorderBuffer) topDown(now sim.VTimeInSec) bool {

func (b *ReorderBuffer) parseBottom(now sim.VTimeInSec) bool {
item := b.bottomPort.Peek()
if item == nil {
return false
}
if item == nil {
GlobalMilestoneManager.AddMilestone(
b.getTaskID(),
"dependency",
"waiting for bottom response",
"parseBottom",
now,
)
return false
}


rsp := item.(mem.AccessRsp)
rspTo := rsp.GetRspTo()
Expand All @@ -191,12 +281,26 @@ func (b *ReorderBuffer) parseBottom(now sim.VTimeInSec) bool {

func (b *ReorderBuffer) bottomUp(now sim.VTimeInSec) bool {
elem := b.transactions.Front()
if elem == nil {
return false
}
if elem == nil {
GlobalMilestoneManager.AddMilestone(
b.getTaskID(),
"dependency",
"no transactions to process",
"bottomUp",
now,
)
return false
}

trans := elem.Value.(*transaction)
if trans.rspFromBottom == nil {
GlobalMilestoneManager.AddMilestone(
b.getTaskID(),
"dependency",
"waiting for bottom response",
"bottomUp",
now,
)
return false
}

Expand All @@ -205,10 +309,17 @@ func (b *ReorderBuffer) bottomUp(now sim.VTimeInSec) bool {
rsp.Meta().Src = b.topPort
rsp.Meta().SendTime = now

err := b.topPort.Send(rsp)
if err != nil {
return false
}
sendErr := b.bottomPort.Send(trans.reqToBottom)
if sendErr != nil {
GlobalMilestoneManager.AddMilestone(
b.getTaskID(),
"Network Error",
"Unable to send request to bottom port",
"bottomUp",
now,
)
return false
}

b.deleteTransaction(elem)

Expand Down Expand Up @@ -301,3 +412,43 @@ func (b *ReorderBuffer) duplicateWriteDoneRsp(
WithRspTo(rspTo).
Build()
}

func (m *MilestoneManager) ExportMilestonesToCSV(filename string) error {
m.mutex.Lock()
defer m.mutex.Unlock()

for _, milestone := range m.milestones {
fmt.Printf("ID: %s, TaskID: %s, BlockingCategory: %s, BlockingReason: %s, BlockingLocation: %s, Timestamp: %v\n",
milestone.ID, milestone.TaskID, milestone.BlockingCategory, milestone.BlockingReason, milestone.BlockingLocation, milestone.Timestamp)
}

file, err := os.Create(filename)
if err != nil {
return err
}
defer file.Close()

writer := csv.NewWriter(file)
defer writer.Flush()

headers := []string{"ID", "TaskID", "BlockingCategory", "BlockingReason", "BlockingLocation", "Timestamp"}
if err := writer.Write(headers); err != nil {
return err
}

for _, m := range m.milestones {
record := []string{
m.ID,
m.TaskID,
m.BlockingCategory,
m.BlockingReason,
m.BlockingLocation,
fmt.Sprintf("%v", m.Timestamp),
}
if err := writer.Write(record); err != nil {
return err
}
}

return nil
}
4 changes: 4 additions & 0 deletions timing/rob/rob_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ var _ = Describe("Reorder Buffer", func() {

AfterEach(func() {
mockCtrl.Finish()
err := rob.ExportMilestonesToCSV("milestones.csv")

Check failure on line 38 in timing/rob/rob_test.go

View workflow job for this annotation

GitHub Actions / Lint 

rob.ExportMilestonesToCSV undefined (type *ReorderBuffer has no field or method ExportMilestonesToCSV)
Expect(err).ToNot(HaveOccurred(), "Failed to export milestones")
})

Context("top-down", func() {
Expand All @@ -56,6 +58,8 @@ var _ = Describe("Reorder Buffer", func() {
madeProgress := rob.topDown(10)

Expect(madeProgress).To(BeFalse())
err := rob.ExportMilestonesToCSV("milestones.csv")

Check failure on line 61 in timing/rob/rob_test.go

View workflow job for this annotation

GitHub Actions / Lint 

rob.ExportMilestonesToCSV undefined (type *ReorderBuffer has no field or method ExportMilestonesToCSV) (typecheck)
Expect(err).ToNot(HaveOccurred(), "Failed to export milestones")
})

It("should do nothing if no message arriving", func() {
Expand Down

0 comments on commit 15b8025

Please sign in to comment.