core

type CHIMessageType string

type CHIResponseType string

type CHITransactionType string

type CacheState string

type CacheStateTransition struct {
	Cycle     int
	FromState CacheState
	ToState   CacheState
	Reason    string
}

type DependencyType string

type DirectoryOperation struct {
	Cycle     int
	Operation string
	Address   uint64
}

type DirectoryState string

type EdgeKey struct {
	FromID int `json:"fromID"`
	ToID   int `json:"toID"`
}

type MESIState string

type NodeInfo struct {
	ID    int      `json:"id"`
	Label string   `json:"label"`
	Type  NodeType `json:"type"`
}

type NodeType string

type OrderingDecision struct {
	Cycle       int
	Decision    string
	RelatedTxns []int64
}

type Packet struct {
	ID    int64  // unique packet id
	Type  string // legacy: "request" or "response" - use MessageType instead (kept for compatibility)
	SrcID int    // source node id
	DstID int    // destination node id

	GeneratedAt int // cycle when generated (for requests)
	SentAt      int // cycle when sent to channel
	ReceivedAt  int // cycle when received by next hop
	CompletedAt int // cycle when processed (for requests)

	// Legacy fields (deprecated, kept for backward compatibility)
	// These fields are maintained for compatibility with older code but should not be used in new code.
	// Migration: Use CHI protocol fields (MessageType, TransactionType) instead of Type.
	// MasterID is equivalent to the original Request Node ID in CHI terminology.
	MasterID  int   // legacy: original master/request node id - use CHI MessageType + DstID instead
	RequestID int64 // legacy: request id - same as ID for request packets, preserved for compatibility

	// CHI protocol fields (preferred)
	// These are the primary fields for packet identification and routing in CHI protocol.
	TransactionType CHITransactionType // CHI transaction type (ReadNoSnp, WriteNoSnp, etc.)
	MessageType     CHIMessageType     // CHI message type (Req, Resp, Data, Comp) - primary field for message type
	ResponseType    CHIResponseType    // CHI response type (CompData, CompAck, etc.)
	Address         uint64             // memory address for the transaction
	DataSize        int                // data size in bytes (default: DefaultCacheLineSize)

	// Transaction tracking
	TransactionID int64 // ID of the transaction this packet belongs to (0 if not associated)

	// Snoop-related fields
	OriginalTxnID int64 // For Snoop responses: the original transaction ID that triggered this snoop
	SnoopTargetID int   // For Snoop requests: the target Request Node ID to snoop

	// Packet generation tracking
	ParentPacketID int64 // ID of the parent packet that generated this packet (0 if no parent)

	// Extension metadata, used by plugins to attach custom fields.
	Metadata map[string]string
}

type PacketEvent struct {
	Sequence       int64             `json:"sequence"`
	TransactionID  int64             `json:"transactionID"`
	PacketID       int64             `json:"packetID"`
	ParentPacketID int64             `json:"parentPacketID"` // 0 means no parent packet
	NodeID         int               `json:"nodeID"`
	NodeLabel      string            `json:"nodeLabel"` // "RN 0", "SN 1", etc.
	EventType      PacketEventType   `json:"eventType"`
	Cycle          int               `json:"cycle"`
	EdgeKey        *EdgeKey          `json:"edgeKey,omitempty"` // nil for in-node events
	Metadata       map[string]string `json:"metadata,omitempty"`
}

type PacketEventType string

type PacketInfo struct {
	ID              int64              `json:"id"`
	Type            string             `json:"type"`
	SrcID           int                `json:"srcID"`
	DstID           int                `json:"dstID"`
	GeneratedAt     int                `json:"generatedAt"`
	SentAt          int                `json:"sentAt"`
	ReceivedAt      int                `json:"receivedAt"`
	CompletedAt     int                `json:"completedAt"`
	MasterID        int                `json:"masterID"`
	RequestID       int64              `json:"requestID"`
	TransactionType CHITransactionType `json:"transactionType"`
	MessageType     CHIMessageType     `json:"messageType"`
	ResponseType    CHIResponseType    `json:"responseType"`
	Address         uint64             `json:"address"`
	DataSize        int                `json:"dataSize"`
	TransactionID   int64              `json:"transactionID"` // Transaction ID this packet belongs to
	Metadata        map[string]string  `json:"metadata,omitempty"`
}

type Position struct {
	X, Y float64
}

type QueueInfo struct {
	Name     string       `json:"name"`
	Length   int          `json:"length"`
	Capacity int          `json:"capacity"` // -1 means unlimited capacity
	Packets  []PacketInfo `json:"packets,omitempty"`
}

type StateTransition struct {
	Cycle        int              // Cycle when transition occurred
	FromState    TransactionState // Previous state
	ToState      TransactionState // New state
	Reason       string           // Reason for transition (brief description)
	RelatedTxnID *int64           // Related transaction ID (if any)
}

type TimeRange struct {
	Start int `json:"start"`
	End   int `json:"end"`
}

type Transaction struct {
	Context *TransactionContext
}

type TransactionContext struct {
	// Basic information (must store)
	TransactionID   int64
	TransactionType CHITransactionType
	Address         uint64

	// State information (simplified)
	State        TransactionState
	StateHistory []StateTransition // Only record key state transition points
	InitiatedAt  int
	CompletedAt  int

	// Dependency relationships (must store, for graph construction)
	SameAddrOrdering      []int64 // Transaction IDs with same-address ordering dependency
	GlobalOrdering        []int64 // Transaction IDs with global ordering dependency
	GeneratedTransactions []int64 // Child transaction IDs generated by this transaction

	// Metadata (lightweight extension fields)
	Metadata map[string]string // Use string instead of interface{} to reduce storage
}

type TransactionDependency struct {
	FromTransactionID int64          // Source transaction ID
	ToTransactionID   int64          // Target transaction ID
	DependencyType    DependencyType // Type of dependency
	Reason            string         // Reason for dependency (CacheMiss, SameAddrOrdering, etc.)
	Cycle             int            // Cycle when dependency was created
}

type TransactionState string

type TransactionTimeline struct {
	TransactionID int64          `json:"transactionID"`
	Events        []*PacketEvent `json:"events"`
	Nodes         []NodeInfo     `json:"nodes"`
	TimeRange     TimeRange      `json:"timeRange"`
	Packets       []PacketInfo   `json:"packets"`
}