2 machine(Directory, "Directory protocol")
3 : DirectoryMemory * directory,
4 MemoryControl * memBuffer,
5 int directory_latency = 12
8 MessageBuffer forwardFromDir, network="To", virtual_network="3", ordered="false", vnet_type="forward";
9 MessageBuffer responseFromDir, network="To", virtual_network="4", ordered="false", vnet_type="response";
10 MessageBuffer dmaResponseFromDir, network="To", virtual_network="1", ordered="true", vnet_type="response";
12 MessageBuffer requestToDir, network="From", virtual_network="2", ordered="true", vnet_type="request";
13 MessageBuffer dmaRequestToDir, network="From", virtual_network="0", ordered="true", vnet_type="request";
16 state_declaration(State, desc="Directory states", default="Directory_State_I") {
18 I, AccessPermission:Read_Write, desc="Invalid";
19 M, AccessPermission:Invalid, desc="Modified";
21 M_DRD, AccessPermission:Busy, desc="Blocked on an invalidation for a DMA read";
22 M_DWR, AccessPermission:Busy, desc="Blocked on an invalidation for a DMA write";
24 M_DWRI, AccessPermission:Busy, desc="Intermediate state M_DWR-->I";
25 M_DRDI, AccessPermission:Busy, desc="Intermediate state M_DRD-->I";
27 IM, AccessPermission:Busy, desc="Intermediate state I-->M";
28 MI, AccessPermission:Busy, desc="Intermediate state M-->I";
29 ID, AccessPermission:Busy, desc="Intermediate state for DMA_READ when in I";
30 ID_W, AccessPermission:Busy, desc="Intermediate state for DMA_WRITE when in I";
34 enumeration(Event, desc="Directory events") {
36 GETX, desc="A GETX arrives";
37 GETS, desc="A GETS arrives";
38 PUTX, desc="A PUTX arrives";
39 PUTX_NotOwner, desc="A PUTX arrives";
42 DMA_READ, desc="A DMA Read memory request";
43 DMA_WRITE, desc="A DMA Write memory request";
46 Memory_Data, desc="Fetched data from memory arrives";
47 Memory_Ack, desc="Writeback Ack from memory arrives";
53 structure(Entry, desc="...", interface="AbstractEntry") {
54 State DirectoryState, desc="Directory state";
55 DataBlock DataBlk, desc="data for the block";
56 NetDest Sharers, desc="Sharers for this block";
57 NetDest Owner, desc="Owner of this block";
60 // TBE entries for DMA requests
61 structure(TBE, desc="TBE entries for outstanding DMA requests") {
62 Address PhysicalAddress, desc="physical address";
63 State TBEState, desc="Transient State";
64 DataBlock DataBlk, desc="Data to be written (DMA write only)";
66 MachineID DmaRequestor, desc="DMA requestor";
69 structure(TBETable, external="yes") {
71 void allocate(Address);
72 void deallocate(Address);
73 bool isPresent(Address);
77 TBETable TBEs, template_hack="<Directory_TBE>";
82 Entry getDirectoryEntry(Address addr), return_by_ref="yes" {
83 return static_cast(Entry, directory[addr]);
86 State getState(TBE tbe, Address addr) {
89 } else if (directory.isPresent(addr)) {
90 return getDirectoryEntry(addr).DirectoryState;
96 void setState(TBE tbe, Address addr, State state) {
99 tbe.TBEState := state;
102 if (directory.isPresent(addr)) {
104 if (state == State:M) {
105 assert(getDirectoryEntry(addr).Owner.count() == 1);
106 assert(getDirectoryEntry(addr).Sharers.count() == 0);
109 getDirectoryEntry(addr).DirectoryState := state;
111 if (state == State:I) {
112 assert(getDirectoryEntry(addr).Owner.count() == 0);
113 assert(getDirectoryEntry(addr).Sharers.count() == 0);
114 directory.invalidateBlock(addr);
119 AccessPermission getAccessPermission(Address addr) {
120 TBE tbe := TBEs[addr];
122 return Directory_State_to_permission(tbe.TBEState);
125 return Directory_State_to_permission(getDirectoryEntry(addr).DirectoryState);
128 void setAccessPermission(Address addr, State state) {
129 if (directory.isPresent(addr)) {
130 getDirectoryEntry(addr).changePermission(Directory_State_to_permission(state));
135 out_port(forwardNetwork_out, RequestMsg, forwardFromDir);
136 out_port(responseNetwork_out, ResponseMsg, responseFromDir);
137 out_port(requestQueue_out, ResponseMsg, requestToDir); // For recycling requests
138 out_port(dmaResponseNetwork_out, DMAResponseMsg, dmaResponseFromDir);
141 out_port(memQueue_out, MemoryMsg, memBuffer);
144 in_port(dmaRequestQueue_in, DMARequestMsg, dmaRequestToDir) {
145 if (dmaRequestQueue_in.isReady()) {
146 peek(dmaRequestQueue_in, DMARequestMsg) {
147 TBE tbe := TBEs[in_msg.LineAddress];
148 if (in_msg.Type == DMARequestType:READ) {
149 trigger(Event:DMA_READ, in_msg.LineAddress, tbe);
150 } else if (in_msg.Type == DMARequestType:WRITE) {
151 trigger(Event:DMA_WRITE, in_msg.LineAddress, tbe);
153 error("Invalid message");
159 in_port(requestQueue_in, RequestMsg, requestToDir) {
160 if (requestQueue_in.isReady()) {
161 peek(requestQueue_in, RequestMsg) {
162 TBE tbe := TBEs[in_msg.Address];
163 if (in_msg.Type == CoherenceRequestType:GETS) {
164 trigger(Event:GETS, in_msg.Address, tbe);
165 } else if (in_msg.Type == CoherenceRequestType:GETX) {
166 trigger(Event:GETX, in_msg.Address, tbe);
167 } else if (in_msg.Type == CoherenceRequestType:PUTX) {
168 if (getDirectoryEntry(in_msg.Address).Owner.isElement(in_msg.Requestor)) {
169 trigger(Event:PUTX, in_msg.Address, tbe);
171 trigger(Event:PUTX_NotOwner, in_msg.Address, tbe);
174 error("Invalid message");
181 // off-chip memory request/response is done
182 in_port(memQueue_in, MemoryMsg, memBuffer) {
183 if (memQueue_in.isReady()) {
184 peek(memQueue_in, MemoryMsg) {
185 TBE tbe := TBEs[in_msg.Address];
186 if (in_msg.Type == MemoryRequestType:MEMORY_READ) {
187 trigger(Event:Memory_Data, in_msg.Address, tbe);
188 } else if (in_msg.Type == MemoryRequestType:MEMORY_WB) {
189 trigger(Event:Memory_Ack, in_msg.Address, tbe);
191 DPRINTF(RubySlicc,"%s\n", in_msg.Type);
192 error("Invalid message");
200 action(a_sendWriteBackAck, "a", desc="Send writeback ack to requestor") {
201 peek(requestQueue_in, RequestMsg) {
202 enqueue(forwardNetwork_out, RequestMsg, latency=directory_latency) {
203 out_msg.Address := address;
204 out_msg.Type := CoherenceRequestType:WB_ACK;
205 out_msg.Requestor := in_msg.Requestor;
206 out_msg.Destination.add(in_msg.Requestor);
207 out_msg.MessageSize := MessageSizeType:Writeback_Control;
212 action(l_sendWriteBackAck, "la", desc="Send writeback ack to requestor") {
213 peek(memQueue_in, MemoryMsg) {
214 enqueue(forwardNetwork_out, RequestMsg, latency="1") {
215 out_msg.Address := address;
216 out_msg.Type := CoherenceRequestType:WB_ACK;
217 out_msg.Requestor := in_msg.OriginalRequestorMachId;
218 out_msg.Destination.add(in_msg.OriginalRequestorMachId);
219 out_msg.MessageSize := MessageSizeType:Writeback_Control;
224 action(b_sendWriteBackNack, "b", desc="Send writeback nack to requestor") {
225 peek(requestQueue_in, RequestMsg) {
226 enqueue(forwardNetwork_out, RequestMsg, latency=directory_latency) {
227 out_msg.Address := address;
228 out_msg.Type := CoherenceRequestType:WB_NACK;
229 out_msg.Requestor := in_msg.Requestor;
230 out_msg.Destination.add(in_msg.Requestor);
231 out_msg.MessageSize := MessageSizeType:Writeback_Control;
236 action(c_clearOwner, "c", desc="Clear the owner field") {
237 getDirectoryEntry(address).Owner.clear();
240 action(d_sendData, "d", desc="Send data to requestor") {
241 peek(memQueue_in, MemoryMsg) {
242 enqueue(responseNetwork_out, ResponseMsg, latency="1") {
243 out_msg.Address := address;
244 out_msg.Type := CoherenceResponseType:DATA;
245 out_msg.Sender := machineID;
246 out_msg.Destination.add(in_msg.OriginalRequestorMachId);
247 out_msg.DataBlk := in_msg.DataBlk;
248 out_msg.MessageSize := MessageSizeType:Response_Data;
253 action(dr_sendDMAData, "dr", desc="Send Data to DMA controller from directory") {
254 peek(memQueue_in, MemoryMsg) {
255 enqueue(dmaResponseNetwork_out, DMAResponseMsg, latency="1") {
256 assert(is_valid(tbe));
257 out_msg.PhysicalAddress := address;
258 out_msg.LineAddress := address;
259 out_msg.Type := DMAResponseType:DATA;
260 out_msg.DataBlk := in_msg.DataBlk; // we send the entire data block and rely on the dma controller to split it up if need be
261 out_msg.Destination.add(tbe.DmaRequestor);
262 out_msg.MessageSize := MessageSizeType:Response_Data;
269 action(drp_sendDMAData, "drp", desc="Send Data to DMA controller from incoming PUTX") {
270 peek(requestQueue_in, RequestMsg) {
271 enqueue(dmaResponseNetwork_out, DMAResponseMsg, latency="1") {
272 assert(is_valid(tbe));
273 out_msg.PhysicalAddress := address;
274 out_msg.LineAddress := address;
275 out_msg.Type := DMAResponseType:DATA;
276 out_msg.DataBlk := in_msg.DataBlk; // we send the entire data block and rely on the dma controller to split it up if need be
277 out_msg.Destination.add(tbe.DmaRequestor);
278 out_msg.MessageSize := MessageSizeType:Response_Data;
283 action(da_sendDMAAck, "da", desc="Send Ack to DMA controller") {
284 enqueue(dmaResponseNetwork_out, DMAResponseMsg, latency="1") {
285 assert(is_valid(tbe));
286 out_msg.PhysicalAddress := address;
287 out_msg.LineAddress := address;
288 out_msg.Type := DMAResponseType:ACK;
289 out_msg.Destination.add(tbe.DmaRequestor);
290 out_msg.MessageSize := MessageSizeType:Writeback_Control;
294 action(e_ownerIsRequestor, "e", desc="The owner is now the requestor") {
295 peek(requestQueue_in, RequestMsg) {
296 getDirectoryEntry(address).Owner.clear();
297 getDirectoryEntry(address).Owner.add(in_msg.Requestor);
301 action(f_forwardRequest, "f", desc="Forward request to owner") {
302 peek(requestQueue_in, RequestMsg) {
303 APPEND_TRANSITION_COMMENT("Own: ");
304 APPEND_TRANSITION_COMMENT(getDirectoryEntry(in_msg.Address).Owner);
305 APPEND_TRANSITION_COMMENT("Req: ");
306 APPEND_TRANSITION_COMMENT(in_msg.Requestor);
307 enqueue(forwardNetwork_out, RequestMsg, latency=directory_latency) {
308 out_msg.Address := address;
309 out_msg.Type := in_msg.Type;
310 out_msg.Requestor := in_msg.Requestor;
311 out_msg.Destination := getDirectoryEntry(in_msg.Address).Owner;
312 out_msg.MessageSize := MessageSizeType:Writeback_Control;
317 action(inv_sendCacheInvalidate, "inv", desc="Invalidate a cache block") {
318 peek(dmaRequestQueue_in, DMARequestMsg) {
319 enqueue(forwardNetwork_out, RequestMsg, latency=directory_latency) {
320 out_msg.Address := address;
321 out_msg.Type := CoherenceRequestType:INV;
322 out_msg.Requestor := machineID;
323 out_msg.Destination := getDirectoryEntry(in_msg.PhysicalAddress).Owner;
324 out_msg.MessageSize := MessageSizeType:Writeback_Control;
329 action(i_popIncomingRequestQueue, "i", desc="Pop incoming request queue") {
330 requestQueue_in.dequeue();
333 action(p_popIncomingDMARequestQueue, "p", desc="Pop incoming DMA queue") {
334 dmaRequestQueue_in.dequeue();
337 action(l_writeDataToMemory, "pl", desc="Write PUTX data to memory") {
338 peek(requestQueue_in, RequestMsg) {
339 // assert(in_msg.Dirty);
340 // assert(in_msg.MessageSize == MessageSizeType:Writeback_Data);
341 getDirectoryEntry(in_msg.Address).DataBlk := in_msg.DataBlk;
342 //getDirectoryEntry(in_msg.Address).DataBlk.copyPartial(in_msg.DataBlk, addressOffset(in_msg.Address), in_msg.Len);
346 action(dwt_writeDMADataFromTBE, "dwt", desc="DMA Write data to memory from TBE") {
347 assert(is_valid(tbe));
348 getDirectoryEntry(address).DataBlk.copyPartial(tbe.DataBlk, addressOffset(tbe.PhysicalAddress), tbe.Len);
351 action(v_allocateTBE, "v", desc="Allocate TBE") {
352 peek(dmaRequestQueue_in, DMARequestMsg) {
353 TBEs.allocate(address);
354 set_tbe(TBEs[address]);
355 tbe.DataBlk := in_msg.DataBlk;
356 tbe.PhysicalAddress := in_msg.PhysicalAddress;
357 tbe.Len := in_msg.Len;
358 tbe.DmaRequestor := in_msg.Requestor;
362 action(r_allocateTbeForDmaRead, "\r", desc="Allocate TBE for DMA Read") {
363 peek(dmaRequestQueue_in, DMARequestMsg) {
364 TBEs.allocate(address);
365 set_tbe(TBEs[address]);
366 tbe.DmaRequestor := in_msg.Requestor;
370 action(v_allocateTBEFromRequestNet, "\v", desc="Allocate TBE") {
371 peek(requestQueue_in, RequestMsg) {
372 TBEs.allocate(address);
373 set_tbe(TBEs[address]);
374 tbe.DataBlk := in_msg.DataBlk;
378 action(w_deallocateTBE, "w", desc="Deallocate TBE") {
379 TBEs.deallocate(address);
383 action(z_recycleRequestQueue, "z", desc="recycle request queue") {
384 requestQueue_in.recycle();
387 action(y_recycleDMARequestQueue, "y", desc="recycle dma request queue") {
388 dmaRequestQueue_in.recycle();
392 action(qf_queueMemoryFetchRequest, "qf", desc="Queue off-chip fetch request") {
393 peek(requestQueue_in, RequestMsg) {
394 enqueue(memQueue_out, MemoryMsg, latency="1") {
395 out_msg.Address := address;
396 out_msg.Type := MemoryRequestType:MEMORY_READ;
397 out_msg.Sender := machineID;
398 out_msg.OriginalRequestorMachId := in_msg.Requestor;
399 out_msg.MessageSize := in_msg.MessageSize;
400 out_msg.DataBlk := getDirectoryEntry(in_msg.Address).DataBlk;
401 DPRINTF(RubySlicc,"%s\n", out_msg);
406 action(qf_queueMemoryFetchRequestDMA, "qfd", desc="Queue off-chip fetch request") {
407 peek(dmaRequestQueue_in, DMARequestMsg) {
408 enqueue(memQueue_out, MemoryMsg, latency="1") {
409 out_msg.Address := address;
410 out_msg.Type := MemoryRequestType:MEMORY_READ;
411 out_msg.Sender := machineID;
412 //out_msg.OriginalRequestorMachId := machineID;
413 out_msg.MessageSize := in_msg.MessageSize;
414 out_msg.DataBlk := getDirectoryEntry(address).DataBlk;
415 DPRINTF(RubySlicc,"%s\n", out_msg);
420 action(qw_queueMemoryWBRequest_partial, "qwp", desc="Queue off-chip writeback request") {
421 peek(dmaRequestQueue_in, DMARequestMsg) {
422 enqueue(memQueue_out, MemoryMsg, latency="1") {
423 out_msg.Address := address;
424 out_msg.Type := MemoryRequestType:MEMORY_WB;
425 //out_msg.OriginalRequestorMachId := machineID;
426 //out_msg.DataBlk := in_msg.DataBlk;
427 out_msg.DataBlk.copyPartial(in_msg.DataBlk, addressOffset(in_msg.PhysicalAddress), in_msg.Len);
428 out_msg.MessageSize := in_msg.MessageSize;
429 //out_msg.Prefetch := in_msg.Prefetch;
431 DPRINTF(RubySlicc,"%s\n", out_msg);
436 action(qw_queueMemoryWBRequest_partialTBE, "qwt", desc="Queue off-chip writeback request") {
437 peek(requestQueue_in, RequestMsg) {
438 enqueue(memQueue_out, MemoryMsg, latency="1") {
439 assert(is_valid(tbe));
440 out_msg.Address := address;
441 out_msg.Type := MemoryRequestType:MEMORY_WB;
442 out_msg.OriginalRequestorMachId := in_msg.Requestor;
444 // out_msg.DataBlk := in_msg.DataBlk;
445 out_msg.DataBlk.copyPartial(tbe.DataBlk, addressOffset(tbe.PhysicalAddress), tbe.Len);
446 out_msg.MessageSize := in_msg.MessageSize;
447 //out_msg.Prefetch := in_msg.Prefetch;
449 DPRINTF(RubySlicc,"%s\n", out_msg);
456 action(l_queueMemoryWBRequest, "lq", desc="Write PUTX data to memory") {
457 peek(requestQueue_in, RequestMsg) {
458 enqueue(memQueue_out, MemoryMsg, latency="1") {
459 out_msg.Address := address;
460 out_msg.Type := MemoryRequestType:MEMORY_WB;
461 out_msg.Sender := machineID;
462 out_msg.OriginalRequestorMachId := in_msg.Requestor;
463 out_msg.DataBlk := in_msg.DataBlk;
464 out_msg.MessageSize := in_msg.MessageSize;
465 //out_msg.Prefetch := in_msg.Prefetch;
467 DPRINTF(RubySlicc,"%s\n", out_msg);
472 action(l_popMemQueue, "q", desc="Pop off-chip request queue") {
473 memQueue_in.dequeue();
476 action(w_writeDataToMemoryFromTBE, "\w", desc="Write date to directory memory from TBE") {
477 //getDirectoryEntry(address).DataBlk := TBEs[address].DataBlk;
478 assert(is_valid(tbe));
479 getDirectoryEntry(address).DataBlk.copyPartial(tbe.DataBlk,
480 addressOffset(tbe.PhysicalAddress),
487 transition({M_DRD, M_DWR, M_DWRI, M_DRDI}, GETX) {
488 z_recycleRequestQueue;
491 transition({IM, MI, ID, ID_W}, {GETX, GETS, PUTX, PUTX_NotOwner} ) {
492 z_recycleRequestQueue;
495 transition({IM, MI, ID, ID_W}, {DMA_READ, DMA_WRITE} ) {
496 y_recycleDMARequestQueue;
500 transition(I, GETX, IM) {
502 qf_queueMemoryFetchRequest;
504 i_popIncomingRequestQueue;
507 transition(IM, Memory_Data, M) {
509 //e_ownerIsRequestor;
514 transition(I, DMA_READ, ID) {
516 r_allocateTbeForDmaRead;
517 qf_queueMemoryFetchRequestDMA;
518 p_popIncomingDMARequestQueue;
521 transition(ID, Memory_Data, I) {
523 //p_popIncomingDMARequestQueue;
530 transition(I, DMA_WRITE, ID_W) {
532 qw_queueMemoryWBRequest_partial;
533 p_popIncomingDMARequestQueue;
536 transition(ID_W, Memory_Ack, I) {
537 dwt_writeDMADataFromTBE;
543 transition(M, DMA_READ, M_DRD) {
545 inv_sendCacheInvalidate;
546 p_popIncomingDMARequestQueue;
549 transition(M_DRD, PUTX, M_DRDI) {
553 l_queueMemoryWBRequest;
554 i_popIncomingRequestQueue;
557 transition(M_DRDI, Memory_Ack, I) {
564 transition(M, DMA_WRITE, M_DWR) {
566 inv_sendCacheInvalidate;
567 p_popIncomingDMARequestQueue;
570 transition(M_DWR, PUTX, M_DWRI) {
572 qw_queueMemoryWBRequest_partialTBE;
574 i_popIncomingRequestQueue;
577 transition(M_DWRI, Memory_Ack, I) {
578 w_writeDataToMemoryFromTBE;
585 transition(M, GETX, M) {
588 i_popIncomingRequestQueue;
591 transition(M, PUTX, MI) {
594 v_allocateTBEFromRequestNet;
595 l_queueMemoryWBRequest;
596 i_popIncomingRequestQueue;
599 transition(MI, Memory_Ack, I) {
600 w_writeDataToMemoryFromTBE;
606 transition(M, PUTX_NotOwner, M) {
608 i_popIncomingRequestQueue;
611 transition(I, PUTX_NotOwner, I) {
613 i_popIncomingRequestQueue;