caminos-lib 0.2.0

A modular interconnection network simulator.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162

use std::cell::RefCell;
use std::rc::{Rc,Weak};
use std::ops::Deref;
use std::mem::{size_of};
use ::rand::{Rng,StdRng};
use super::{Router,TransmissionMechanism,StatusAtEmissor,SpaceAtReceptor,TransmissionToServer,TransmissionFromServer,SimpleVirtualChannels,AugmentedBuffer,AcknowledgeMessage};
use crate::config_parser::ConfigurationValue;
use crate::topology::{Topology,Location};
use crate::routing::CandidateEgress;
use crate::policies::{RequestInfo,VirtualChannelPolicy,new_virtual_channel_policy,VCPolicyBuilderArgument};
use crate::event::{Event,Eventful,EventGeneration,CyclePosition};
use crate::{Phit,Packet,Simulation};
use crate::quantify::Quantifiable;
use crate::Plugs;


///Strategy for the arbitration of the output port.
enum OutputArbiter
{
	#[allow(dead_code)]
	Random,
	Token{
		port_token: Vec<usize>,
	},
}

///The basic Router struct. Very similar to FSIN's router.
pub struct Basic<TM:TransmissionMechanism>
{
	///Weak pointer to itself, see https://users.rust-lang.org/t/making-a-rc-refcell-trait2-from-rc-refcell-trait1/16086/3
	self_rc: Weak<RefCell<Basic<TM>>>,
	///If there is an event pending
	event_pending: bool,
	///The cycle number of the last time Basic::process was called. Only for debugging/assertion purposes.
	last_process_at_cycle: Option<usize>,
	///Its index in the topology
	router_index: usize,
	///The mechanism to select virtual channels
	virtual_channel_policies: Vec<Box<dyn VirtualChannelPolicy>>,
	///If the bubble mechanism is active
	bubble: bool,
	///Credits required in the next router's virtual port to begin the transmission
	flit_size: usize,
	///Size of each input buffer.
	buffer_size: usize,
	///Give priority to in-transit packets over packets in injection queues.
	intransit_priority: bool,
	///To allow to request a port even if some other packet is being transmitted throught it to a different virtual channel (as FSIN does).
	///It may appear that should obviously be put to `true`, but in practice that just reduces performance.
	allow_request_busy_port: bool,
	///Use the labels provided by the routing to sort the petitions in the output arbiter.
	output_priorize_lowest_label: bool,
	///transmission_port_status[port] = status
	transmission_port_status: Vec<Box<dyn StatusAtEmissor>>,
	///reception_port_space[port] = space
	reception_port_space: Vec<Box<dyn SpaceAtReceptor>>,
	///If 0 then there are no output buffer, if greater than 0 then the size of each of them.
	output_buffer_size: usize,
	///The outut buffers indexed as [output_port][output_vc].
	///Phits are stored with their (entry_port,entry_vc).
	output_buffers: Vec<Vec<AugmentedBuffer<(usize,usize)>>>,
	///If not None then the input port+virtual_channel which is either sending by this port+virtual_channel or writing to this output buffer.
	///We keep the packet for debugging/check considerations.
	selected_input: Vec<Vec<Option<(Rc<Packet>,usize,usize)>>>,
	///If not None then all the phits should go through this port+virtual_channel or stored in this output buffer, since they are part of the same packet
	///We keep the packet for debugging/check considerations.
	selected_output: Vec<Vec<Option<(Rc<Packet>,usize,usize)>>>,
	///Number of cycles that the current phit, if any, in the head of a given (port,virtual channel) input buffer the phit has been waiting.
	time_at_input_head: Vec<Vec<usize>>,
	///And arbiter of the physical output port.
	output_arbiter: OutputArbiter,
	///The maximum packet size that is allowed. Only for bubble consideration, that reserves space for a given packet plus maximum packet size.
	maximum_packet_size: usize,

	//statistics:
	///The first cycle included in the statistics.
	statistics_begin_cycle: usize,
	///Accumulated over time, averaged per port.
	statistics_output_buffer_occupation_per_vc: Vec<f64>,
	///Accumulated over time, averaged per port.
	statistics_reception_space_occupation_per_vc: Vec<f64>,
}

impl<TM:'static+TransmissionMechanism> Router for Basic<TM>
{
	fn insert(&mut self, phit:Rc<Phit>, port:usize, rng: &RefCell<StdRng>)
	{
		self.reception_port_space[port].insert(phit,rng).expect("there was some problem on the insertion");
	}
	fn acknowledge(&mut self, port:usize, ack_message:AcknowledgeMessage)
	{
		self.transmission_port_status[port].acknowledge(ack_message);
	}
	fn num_virtual_channels(&self) -> usize
	{
		//self.virtual_ports[0].len()
		self.transmission_port_status[0].num_virtual_channels()
	}
	fn virtual_port_size(&self, _port:usize, _virtual_channel:usize) -> usize
	{
		self.buffer_size
	}
	fn iter_phits(&self) -> Box<dyn Iterator<Item=Rc<Phit>>>
	{
		//unimplemented!();
		//Box::new(self.virtual_ports.iter().flat_map(|port|port.iter().flat_map(|vp|vp.iter_phits())).collect::<Vec<_>>().into_iter())
		Box::new(self.reception_port_space.iter().flat_map(|space|space.iter_phits()).collect::<Vec<_>>().into_iter())
	}
	//fn get_virtual_port(&self, port:usize, virtual_channel:usize) -> Option<&VirtualPort>
	//{
	//	Some(&self.virtual_ports[port][virtual_channel])
	//}
	fn get_status_at_emisor(&self, port:usize) -> Option<&dyn StatusAtEmissor>
	{
		Some(&*self.transmission_port_status[port])
	}
	fn get_maximum_credits_towards(&self, _port:usize, _virtual_channel:usize) -> Option<usize>
	{
		Some(self.buffer_size)
	}
	fn get_index(&self)->Option<usize>
	{
		Some(self.router_index)
	}
	fn aggregate_statistics(&self, statistics:Option<ConfigurationValue>, router_index:usize, total_routers:usize, cycle:usize) -> Option<ConfigurationValue>
	{
		//let n_ports = self.selected_input.len();
		//let n_vcs = self.selected_input[0].len();
		//let mut output_buffer_occupation_per_vc:Option<Vec<f64>>= if self.output_buffer_size==0 {None} else
		//{
		//	Some((0..n_vcs).map(|vc|self.output_buffers.iter().map(|port|port[vc].len()).sum::<usize>() as f64).collect())
		//};
		let cycle_span = cycle - self.statistics_begin_cycle;
		let mut reception_space_occupation_per_vc:Option<Vec<f64>> = Some(self.statistics_reception_space_occupation_per_vc.iter().map(|x|x/cycle_span as f64).collect());
		let mut output_buffer_occupation_per_vc:Option<Vec<f64>> = Some(self.statistics_output_buffer_occupation_per_vc.iter().map(|x|x/cycle_span as f64).collect());
		if let Some(previous)=statistics
		{
			if let ConfigurationValue::Object(cv_name,previous_pairs) = previous
			{
				if cv_name!="Basic"
				{
					panic!("incompatible statistics, should be `Basic` object not `{}`",cv_name);
				}
				for (ref name,ref value) in previous_pairs
				{
					match name.as_ref()
					{
						"average_output_buffer_occupation_per_vc" => match value
						{
							&ConfigurationValue::Array(ref prev_a) =>
							{
								if let Some(ref mut curr_a) = output_buffer_occupation_per_vc
								{
									for (c,p) in curr_a.iter_mut().zip(prev_a.iter())
									{
										if let ConfigurationValue::Number(x)=p
										{
											*c += x;
										}
										else
										{
											panic!("The non-number {:?} cannot be added",p);
										}
									}
								}
								else
								{
									println!("Ignoring average_output_buffer_occupation_per_vc.");
								}
							}
							_ => panic!("bad value for average_output_buffer_occupation_per_vc"),
						},
						"average_reception_space_occupation_per_vc" => match value
						{
							&ConfigurationValue::Array(ref prev_a) =>
							{
								if let Some(ref mut curr_a) = reception_space_occupation_per_vc
								{
									for (c,p) in curr_a.iter_mut().zip(prev_a.iter())
									{
										if let ConfigurationValue::Number(x)=p
										{
											*c += x;
										}
										else
										{
											panic!("The non-number {:?} cannot be added",p);
										}
									}
								}
								else
								{
									println!("Ignoring average_output_buffer_occupation_per_vc.");
								}
							}
							_ => panic!("bad value for average_output_buffer_occupation_per_vc"),
						},
						_ => panic!("Nothing to do with field {} in Basic statistics",name),
					}
				}
			}
			else
			{
				panic!("received incompatible statistics");
			}
		}
		let mut result_content : Vec<(String,ConfigurationValue)> = vec![
			//(String::from("injected_load"),ConfigurationValue::Number(injected_load)),
			//(String::from("accepted_load"),ConfigurationValue::Number(accepted_load)),
			//(String::from("average_message_delay"),ConfigurationValue::Number(average_message_delay)),
			//(String::from("server_generation_jain_index"),ConfigurationValue::Number(jsgp)),
			//(String::from("server_consumption_jain_index"),ConfigurationValue::Number(jscp)),
			//(String::from("average_packet_hops"),ConfigurationValue::Number(average_packet_hops)),
			//(String::from("total_packet_per_hop_count"),ConfigurationValue::Array(total_packet_per_hop_count)),
			//(String::from("average_link_utilization"),ConfigurationValue::Number(average_link_utilization)),
			//(String::from("maximum_link_utilization"),ConfigurationValue::Number(maximum_link_utilization)),
			//(String::from("git_id"),ConfigurationValue::Literal(format!("\"{}\"",git_id))),
		];
		let is_last = router_index+1==total_routers;
		if let Some(ref mut content)=output_buffer_occupation_per_vc
		{
			if is_last
			{
				let factor=1f64 / total_routers as f64;
				for x in content.iter_mut()
				{
					*x *= factor;
				}
			}
			result_content.push((String::from("average_output_buffer_occupation_per_vc"),ConfigurationValue::Array(content.iter().map(|x|ConfigurationValue::Number(*x)).collect())));
		}
		if let Some(ref mut content)=reception_space_occupation_per_vc
		{
			if is_last
			{
				let factor=1f64 / total_routers as f64;
				for x in content.iter_mut()
				{
					*x *= factor;
				}
			}
			result_content.push((String::from("average_reception_space_occupation_per_vc"),ConfigurationValue::Array(content.iter().map(|x|ConfigurationValue::Number(*x)).collect())));
		}
		Some(ConfigurationValue::Object(String::from("Basic"),result_content))
	}
	fn reset_statistics(&mut self, next_cycle:usize)
	{
		self.statistics_begin_cycle=next_cycle;
		for x in self.statistics_output_buffer_occupation_per_vc.iter_mut()
		{
			*x=0f64;
		}
		for x in self.statistics_reception_space_occupation_per_vc.iter_mut()
		{
			*x=0f64;
		}
	}
}

impl Basic<SimpleVirtualChannels>
{
	pub fn new(router_index: usize, cv:&ConfigurationValue, plugs:&Plugs, topology:&dyn Topology, maximum_packet_size:usize) -> Rc<RefCell<Basic<SimpleVirtualChannels>>>
	{
		//let mut servers=None;
		//let mut load=None;
		let mut virtual_channels=None;
		//let mut routing=None;
		let mut buffer_size=None;
		let mut virtual_channel_policies=None;
		let mut bubble=None;
		let mut flit_size=None;
		let mut intransit_priority=None;
		let mut allow_request_busy_port=None;
		let mut output_priorize_lowest_label=None;
		let mut output_buffer_size=None;
		if let &ConfigurationValue::Object(ref cv_name, ref cv_pairs)=cv
		{
			if cv_name!="Basic"
			{
				panic!("A Basic must be created from a `Basic` object not `{}`",cv_name);
			}
			for &(ref name,ref value) in cv_pairs
			{
				match name.as_ref()
				{
					"virtual_channels" => match value
					{
						&ConfigurationValue::Number(f) => virtual_channels=Some(f as usize),
						_ => panic!("bad value for virtual_channels"),
					},
					//"routing" => routing=Some(new_routing(value)),
					//"virtual_channel_policy" => virtual_channel_policy=Some(new_virtual_channel_policy(value)),
					"virtual_channel_policies" => match value
					{
						//&ConfigurationValue::Array(ref a) => virtual_channel_policies=Some(a.iter().map(|cv|new_virtual_channel_policy(cv,plugs)).collect()),
						&ConfigurationValue::Array(ref a) => virtual_channel_policies=Some(a.iter().map(
							|cv|new_virtual_channel_policy(VCPolicyBuilderArgument{
							cv,
							plugs
						})).collect()),
						_ => panic!("bad value for permute"),
					}
					"delay" => (),//FIXME: yet undecided if/how to implemente this.
					"buffer_size" => match value
					{
						&ConfigurationValue::Number(f) => buffer_size=Some(f as usize),
						_ => panic!("bad value for buffer_size"),
					},
					"output_buffer_size" => match value
					{
						&ConfigurationValue::Number(f) => output_buffer_size=Some(f as usize),
						_ => panic!("bad value for buffer_size"),
					},
					"bubble" => match value
					{
						&ConfigurationValue::True => bubble=Some(true),
						&ConfigurationValue::False => bubble=Some(false),
						_ => panic!("bad value for bubble"),
					},
					"flit_size" => match value
					{
						&ConfigurationValue::Number(f) => flit_size=Some(f as usize),
						_ => panic!("bad value for flit_size"),
					},
					"intransit_priority" => match value
					{
						&ConfigurationValue::True => intransit_priority=Some(true),
						&ConfigurationValue::False => intransit_priority=Some(false),
						_ => panic!("bad value for intransit_priority"),
					},
					"allow_request_busy_port" => match value
					{
						&ConfigurationValue::True => allow_request_busy_port=Some(true),
						&ConfigurationValue::False => allow_request_busy_port=Some(false),
						_ => panic!("bad value for allow_request_busy_port"),
					},
					"output_priorize_lowest_label" => match value
					{
						&ConfigurationValue::True => output_priorize_lowest_label=Some(true),
						&ConfigurationValue::False => output_priorize_lowest_label=Some(false),
						_ => panic!("bad value for output_priorize_lowest_label"),
					},
					_ => panic!("Nothing to do with field {} in Basic",name),
				}
			}
		}
		else
		{
			panic!("Trying to create a Basic from a non-Object");
		}
		//let sides=sides.expect("There were no sides");
		let virtual_channels=virtual_channels.expect("There were no virtual_channels");
		let virtual_channel_policies=virtual_channel_policies.expect("There were no virtual_channel_policies");
		//let routing=routing.expect("There were no routing");
		let buffer_size=buffer_size.expect("There were no buffer_size");
		let output_buffer_size=output_buffer_size.expect("There were no output_buffer_size");
		let bubble=bubble.expect("There were no bubble");
		let flit_size=flit_size.expect("There were no flit_size");
		let intransit_priority=intransit_priority.expect("There were no intransit_priority");
		let allow_request_busy_port=allow_request_busy_port.expect("There were no allow_request_busy_port");
		let output_priorize_lowest_label=output_priorize_lowest_label.expect("There were no output_priorize_lowest_label");
		let input_ports=topology.ports(router_index);
		let selected_input=(0..input_ports).map(|_|
			(0..virtual_channels).map(|_|None).collect()
		).collect();
		let selected_output=(0..input_ports).map(|_|
			(0..virtual_channels).map(|_|None).collect()
		).collect();
		let time_at_input_head=(0..input_ports).map(|_|
			(0..virtual_channels).map(|_|0).collect()
		).collect();
		let transmission_mechanism = SimpleVirtualChannels::new(virtual_channels,buffer_size,flit_size);
		let to_server_mechanism = TransmissionToServer();
		let from_server_mechanism = TransmissionFromServer::new(virtual_channels,buffer_size,flit_size);
		let transmission_port_status:Vec<Box<dyn StatusAtEmissor>> = (0..input_ports).map(|p|
			if let (Location::ServerPort(_server),_link_class)=topology.neighbour(router_index,p)
			{
				let b:Box<dyn StatusAtEmissor> = Box::new(to_server_mechanism.new_status_at_emissor());
				b
			}
			else
			{
				Box::new(transmission_mechanism.new_status_at_emissor())
			}
		).collect();
		let reception_port_space = (0..input_ports).map(|p|
			if let (Location::ServerPort(_server),_link_class)=topology.neighbour(router_index,p)
			{
				let b:Box<dyn SpaceAtReceptor> = Box::new(from_server_mechanism.new_space_at_receptor());
				b
			}
			else
			{
				Box::new(transmission_mechanism.new_space_at_receptor())
			}
		).collect();
		let output_buffers= if output_buffer_size==0 {vec![]} else{
			(0..input_ports).map(|_|
				(0..virtual_channels).map(|_|AugmentedBuffer::new()).collect()
			).collect()
		};
		let r=Rc::new(RefCell::new(Basic{
			self_rc: Weak::new(),
			event_pending: false,
			last_process_at_cycle: None,
			router_index,
			//routing,
			virtual_channel_policies,
			bubble,
			flit_size,
			intransit_priority,
			allow_request_busy_port,
			output_priorize_lowest_label,
			buffer_size,
			transmission_port_status,
			reception_port_space,
			output_buffer_size,
			output_buffers,
			selected_input,
			selected_output,
			time_at_input_head,
			output_arbiter: OutputArbiter::Token{port_token: vec![0;input_ports]},
			maximum_packet_size,
			statistics_begin_cycle: 0,
			statistics_output_buffer_occupation_per_vc: vec![0f64;virtual_channels],
			statistics_reception_space_occupation_per_vc: vec![0f64;virtual_channels],
		}));
		//r.borrow_mut().self_rc=r.downgrade();
		r.borrow_mut().self_rc=Rc::<_>::downgrade(&r);
		r
	}
}

impl<TM:TransmissionMechanism> Basic<TM>
{
	///Whether a phit in an input buffer can advance.
	///bubble_in_use should be true only for leading phits that require the additional space.
	fn can_phit_advance(&self, phit:&Rc<Phit>, exit_port:usize, exit_vc:usize, bubble_in_use:bool)->bool
	{
		//if not internal output space
		if self.output_buffer_size==0
		{
			let status=&self.transmission_port_status[exit_port];
			if bubble_in_use
			{
				//status.can_transmit_whole_packet(&phit,exit_vc)
				if let Some(space)=status.known_available_space_for_virtual_channel(exit_vc)
				{
					status.can_transmit(&phit,exit_vc) && space>= phit.packet.size + self.maximum_packet_size
				}
				else
				{
					panic!("Basic router requires knowledge of available space to apply bubble.");
				}
			}
			else
			{
				self.transmission_port_status[exit_port].can_transmit(&phit,exit_vc)
			}
		}
		else
		{
			let available_internal_space = self.output_buffer_size-self.output_buffers[exit_port][exit_vc].len();
			let mut necessary_credits=1;
			if phit.is_begin()
			{
				//necessary_credits=self.counter.flit_size;
				//necessary_credits=match transmit_auxiliar_info
				necessary_credits=if bubble_in_use
				{
					phit.packet.size + self.maximum_packet_size
				}
				else
				{
					self.flit_size
				}
			}
			available_internal_space >= necessary_credits
		}
	}
}


///A phit in the virtual channel `virtual_channel` of the port `entry_port` is requesting to go to the virtual channel `requested_vc` of the port `requested_port`.
///The label is the one returned by the routing algorithm or 0 if it comes from a selection in a previous cycle.
#[derive(Clone)]
struct PortRequest
{
	packet: Rc<Packet>,
	entry_port: usize,
	entry_vc: usize,
	requested_port: usize,
	requested_vc: usize,
	label: i32,
}

impl<TM:'static+TransmissionMechanism> Eventful for Basic<TM>
{
	///main routine of the router. Do all things that must be done in a cycle, if any.
	fn process(&mut self, simulation:&Simulation) -> Vec<EventGeneration>
	{
		let mut cycles_span = 1;//cycles since last checked
		if let Some(ref last)=self.last_process_at_cycle
		{
			cycles_span = simulation.cycle - *last;
			if *last >= simulation.cycle
			{
				panic!("Trying to process at cycle {} a router::Basic already processed at {}",simulation.cycle,last);
			}
			//if *last +1 < simulation.cycle
			//{
			//	println!("INFO: {} cycles since last processing router {}, cycle={}",simulation.cycle-*last,self.router_index,simulation.cycle);
			//}
		}
		self.last_process_at_cycle = Some(simulation.cycle);
		let mut request:Vec<PortRequest>=vec![];
		let topology = simulation.network.topology.as_ref();
		
		let amount_virtual_channels=self.num_virtual_channels();
		//-- gather cycle statistics
		for port_space in self.reception_port_space.iter()
		{
			for vc in 0..amount_virtual_channels
			{
				self.statistics_reception_space_occupation_per_vc[vc]+=(port_space.occupied_dedicated_space(vc).unwrap_or(0)*cycles_span) as f64 / self.reception_port_space.len() as f64;
			}
		}
		for output_port in self.output_buffers.iter()
		{
			for (vc,buffer) in output_port.iter().enumerate()
			{
				self.statistics_output_buffer_occupation_per_vc[vc]+=(buffer.len()*cycles_span) as f64 / self.output_buffers.len() as f64;
			}
		}

		//-- Precompute whatever polcies ask for.
		let server_ports : Option<Vec<usize>> = if self.virtual_channel_policies.iter().any(|policy|policy.need_server_ports())
		{
			Some((0..topology.ports(self.router_index)).filter(|&p|
				if let (Location::ServerPort(_server),_link_class)=topology.neighbour(self.router_index,p)
				{
					true
				}
				else
				{
					false
				}
			).collect())
		}
		else
		{
			None
		};
		let busy_ports:Vec<bool> = self.transmission_port_status.iter().enumerate().map(|(port,ref _status)|{
			let mut is_busy = false;
			for vc in 0..amount_virtual_channels
			{
				if let Some((ref _packet,selected_port,selected_virtual_channel))=self.selected_input[port][vc]
				{
					if let Some(phit)=self.reception_port_space[selected_port].front_virtual_channel(selected_virtual_channel)
					{
						//if status.can_transmit(&phit,vc,None)
						if self.can_phit_advance(&phit,port,vc,false)
						{
							is_busy=true;
							break;
						}
					}
				}
			}
			is_busy
		}).collect();
		let port_last_transmission:Option<Vec<usize>> = if self.virtual_channel_policies.iter().any(|policy|policy.need_port_last_transmission())
		{
			Some(self.transmission_port_status.iter().map(|ref p|
				//p.iter().map(|ref vp|vp.last_transmission).max().unwrap()
				p.get_last_transmission()
			).collect())
		}
		else
		{
			None
		};
		let port_average_neighbour_queue_length:Option<Vec<f32>> = if self.virtual_channel_policies.iter().any(|policy|policy.need_port_average_queue_length())
		{
			Some(self.transmission_port_status.iter().map(|ref p|{
				//let total=p.iter().map(|ref vp|self.buffer_size - vp.neighbour_credits).sum::<usize>();
				//(total as f32) / (p.len() as f32)
				let total=(0..amount_virtual_channels).map(|vc|self.buffer_size-p.known_available_space_for_virtual_channel(vc).expect("needs to know available space")).sum::<usize>();
				(total as f32) / (amount_virtual_channels as f32)
			}).collect())
		}
		else
		{
			None
		};
		//let average_neighbour_queue_length:Option<f32> = if let Some(ref v)=port_average_neighbour_queue_length
		//{
		//	Some(v.iter().sum::<f32>() / (v.len() as f32))
		//}
		//else
		//{
		//	None
		//};
		let port_occupied_output_space:Option<Vec<usize>> = if self.output_buffer_size==0
		{
			None
		}
		else
		{
			Some(self.output_buffers.iter().map(|p|
				p.iter().map(|b|b.len()).sum()
			).collect())
		};
		let port_available_output_space:Option<Vec<usize>> = if self.output_buffer_size==0
		{
			None
		}
		else
		{
			Some(self.output_buffers.iter().map(|p|
				p.iter().map(|b|self.output_buffer_size - b.len()).sum()
			).collect())
		};
		let virtual_channel_occupied_output_space:Option<Vec<Vec<usize>>> = if self.output_buffer_size==0
		{
			None
		}
		else
		{
			Some(self.output_buffers.iter().map(|p|
				p.iter().map(|b|b.len()).collect()
			).collect())
		};
		let virtual_channel_available_output_space:Option<Vec<Vec<usize>>> = if self.output_buffer_size==0
		{
			None
		}
		else
		{
			Some(self.output_buffers.iter().map(|p|
				p.iter().map(|b|self.output_buffer_size-b.len()).collect()
			).collect())
		};

		//-- Routing and requests.
		let mut undecided_channels=0;//just as indicator if the router has pending work.
		let mut moved_phits=0;//another indicator of pending work.
		//Iterate over the reception space to find phits that request to advance.
		for entry_port in 0..self.reception_port_space.len()
		{
			for phit in self.reception_port_space[entry_port].front_iter()
			{
				let entry_vc={
					phit.virtual_channel.borrow().expect("it should have an associated virtual channel")
				};
				let (requested_port,requested_vc,label)=match self.selected_output[entry_port][entry_vc]
				{
					None =>
					{
						undecided_channels+=1;
						let target_server=phit.packet.message.destination;
						let (target_location,_link_class)=topology.server_neighbour(target_server);
						let target_router=match target_location
						{
							Location::RouterPort{router_index,router_port:_} =>router_index,
							_ => panic!("The server is not attached to a router"),
						};
						let mut good_ports=simulation.routing.next(phit.packet.routing_info.borrow().deref(),simulation.network.topology.as_ref(),self.router_index,target_server,amount_virtual_channels,&simulation.rng).into_iter().filter_map(|candidate|{
							let CandidateEgress{port:f_port,virtual_channel:f_virtual_channel,..} = candidate;
							//We analyze each candidate output port, considering whether they are in use (port or virtual channel).
							match self.selected_input[f_port][f_virtual_channel]
							{
								//Some((s_port,s_virtual_channel))=> s_port==entry_port && s_virtual_channel==entry_vc,
								Some(_) => None,
								None =>
								{
									let bubble_in_use= self.bubble && phit.is_begin() && simulation.network.topology.is_direction_change(self.router_index,entry_port,f_port);
									//if self.transmission_port_status[f_port].can_transmit(&phit,f_virtual_channel,transmit_auxiliar_info)
									let allowed = if self.can_phit_advance(&phit,f_port,f_virtual_channel,bubble_in_use)
									{
										if self.allow_request_busy_port
										{
											true
										}
										else
										{
											!busy_ports[f_port]
										}
									}
									else
									{
										false
									};
									Some(CandidateEgress{router_allows:Some(allowed), ..candidate})
								}
							}
						}).collect::<Vec<_>>();
						if good_ports.len()==0
						{
							//There are currently no good port choices, but there may be in the future.
							continue;
						}
						let performed_hops=phit.packet.routing_info.borrow().hops;
						//Apply all the declared virtual channel policies in order.
						let request_info=RequestInfo{
							target_router_index: target_router,
							entry_port,
							entry_virtual_channel: entry_vc,
							performed_hops,
							server_ports: server_ports.as_ref(),
							port_average_neighbour_queue_length: port_average_neighbour_queue_length.as_ref(),
							port_last_transmission: port_last_transmission.as_ref(),
							port_occupied_output_space: port_occupied_output_space.as_ref(),
							port_available_output_space: port_available_output_space.as_ref(),
							virtual_channel_occupied_output_space: virtual_channel_occupied_output_space.as_ref(),
							virtual_channel_available_output_space: virtual_channel_available_output_space.as_ref(),
							time_at_front: Some(self.time_at_input_head[entry_port][entry_vc]),
							current_cycle: simulation.cycle,
						};
						for vcp in self.virtual_channel_policies.iter()
						{
							//good_ports=vcp.filter(good_ports,self,target_router,entry_port,entry_vc,performed_hops,&server_ports,&port_average_neighbour_queue_length,&port_last_transmission,&port_occupied_output_space,&port_available_output_space,simulation.cycle,topology,&simulation.rng);
							good_ports=vcp.filter(good_ports,self,&request_info,topology,&simulation.rng);
							if good_ports.len()==0
							{
								break;//No need to check other policies.
							}
						}
						if good_ports.len()==0
						{
							continue;//There is no available port satisfying the policies. Hopefully there will in the future.
						}
						else if good_ports.len()>=2
						{
							panic!("You need a VirtualChannelPolicy able to select a single (port,vc).");
						}
						simulation.routing.performed_request(&good_ports[0],&phit.packet.routing_info,simulation.network.topology.as_ref(),self.router_index,target_server,amount_virtual_channels,&simulation.rng);
						match good_ports[0]
						{
							CandidateEgress{port,virtual_channel,label,estimated_remaining_hops:_,..}=>(port,virtual_channel,label),
						}
					},
					Some((ref _packet,port,vc)) => (port,vc,0),//FIXME: perhaps 0 changes into None?
				};
				//FIXME: this should not call known_available_space_for_virtual_channel
				//In wormhole we may have a selected output but be unable to advance, but it is not clear whether makes any difference.
				let credits=self.transmission_port_status[requested_port].known_available_space_for_virtual_channel(requested_vc).expect("no available space known");
				//println!("entry_port={} virtual_channel={} credits={}",entry_port,entry_vc,credits);
				if credits>0
				{
					match self.selected_input[requested_port][requested_vc]
					{
						Some(_) => (),
						None => request.push( PortRequest{packet:phit.packet.clone(),entry_port,entry_vc,requested_port,requested_vc,label} ),
					};
				}
				self.time_at_input_head[entry_port][entry_vc]+=1;
			}
		}

		//-- Arbitrate the requests.
		let request_len = request.len();
		//FIXME: allocator policies
		let min_label=match request.iter().map(|r|r.label).min()
		{
			Some(x)=>x,
			None=>0,
		};
		let max_label=match request.iter().map(|r|r.label).max()
		{
			Some(x)=>x,
			None=>0,
		};
		//Split que sequence in subsequences, where any items in a subsequence has more priority than any element in a later subsequence.
		let request_sequence:Vec<Vec<PortRequest>>=if self.output_priorize_lowest_label
		{
			//(min_label..max_label+1).map(|label|request.iter().filter(|r|r.label==label).map(|&t|t).collect()).collect()
			//(min_label..max_label+1).map(move |label|request.into_iter().filter(|r|r.label==label).collect()).collect()
			let mut sequence : Vec<Vec<PortRequest>> = vec![ Vec::with_capacity(request.len()) ; (max_label+1-min_label) as usize];
			for req in request.into_iter()
			{
				let index :usize = (req.label - min_label) as usize;
				sequence[index].push(req);
			}
			sequence
		}
		else
		{
			vec![request]
		};
		//Shuffle the subsequences. XXX Perhaps the separation transit/injection should be done in a similar as to the separation by labels.
		//for ref mut rx in request_sequence.iter_mut()
		let captured_intransit_priority=self.intransit_priority;//to move into closure
		let captured_router_index=self.router_index;//to move into closure
		let request_it = request_sequence.into_iter().flat_map(|mut rx|{
			if captured_intransit_priority
			{
				//let (mut request_transit, mut request_injection) : (Vec<PortRequest>,Vec<PortRequest>) = rx.into_iter().map(|&mut t|t).partition(|&req|{
				//	match simulation.network.topology.neighbour(self.router_index,req.entry_port)
				//	{
				//		( Location::RouterPort{..} ,_) => true,
				//		_ => false,
				//	}
				//});
				let (mut request_transit, mut request_injection) : (Vec<PortRequest>,Vec<PortRequest>) = rx.into_iter().partition(|req|{
					match simulation.network.topology.neighbour(captured_router_index,req.entry_port)
					{
						( Location::RouterPort{..} ,_) => true,
						_ => false,
					}
				});
				simulation.rng.borrow_mut().shuffle(&mut request_transit);
				simulation.rng.borrow_mut().shuffle(&mut request_injection);
				//**rx=request_transit;
				rx=request_transit;
				rx.append(&mut request_injection);
			}
			else
			{
				//simulation.rng.borrow_mut().shuffle(rx);
				simulation.rng.borrow_mut().shuffle(&mut rx);
			}
			rx
		});
		//Complete the arbitration of the requests by writing the selected_input of the output virtual ports.
		//let request=request_sequence.concat();
		for PortRequest{packet,entry_port,entry_vc,requested_port,requested_vc,..} in request_it
		{
			//println!("processing request {},{},{},{}",entry_port,entry_vc,requested_port,requested_vc);
			match self.selected_input[requested_port][requested_vc]
			{
				Some(_) => (),
				None =>
				{
					self.selected_input[requested_port][requested_vc]=Some((packet,entry_port,entry_vc));
				},
			};
		}

		//-- For each output port decide with input actually use it this cycle.
		let mut events=vec![];
		for exit_port in 0..self.transmission_port_status.len()
		{
			let nvc=amount_virtual_channels;
			//Gather the list of all vc that can advance
			let mut cand=Vec::with_capacity(nvc);
			let mut cand_in_transit=false;
			let mut undo_selected_input=Vec::with_capacity(nvc);
			for exit_vc in 0..nvc
			{
				if let Some((ref entry_packet,entry_port,entry_vc))=self.selected_input[exit_port][exit_vc]
				{
					if self.output_buffer_size>0
					{
						//-- Move phits into the internal output space
						//Note that it is possible when flit_size<packet_size for the packet to not be in that buffer. The output arbiter can decide to advance other virtual channel.
						if let Ok((phit,ack_message)) = self.reception_port_space[entry_port].extract(entry_vc)
						{
							if self.output_buffers[exit_port][exit_vc].len()>=self.output_buffer_size
							{
								panic!("Trying to move into a full output buffer.");
							}
							moved_phits+=1;
							self.time_at_input_head[entry_port][entry_vc]=0;
							*phit.virtual_channel.borrow_mut()=Some(exit_vc);
							if let Some(message)=ack_message
							{
								let (previous_location,previous_link_class)=simulation.network.topology.neighbour(self.router_index,entry_port);
								events.push(EventGeneration{
									delay: simulation.link_classes[previous_link_class].delay,
									position:CyclePosition::Begin,
									//event:Event::Acknowledge{location:previous_location,message:AcknowledgeMessage::ack_phit_clear_from_virtual_channel(entry_vc)},
									event:Event::Acknowledge{location:previous_location,message},
								});
							}
							if let Some((ref s_exit_packet,s_exit_port,s_exit_vc))=self.selected_output[entry_port][entry_vc]
							{
								let entry_packet_ptr = entry_packet.as_ref() as *const Packet;
								let s_exit_packet_ptr = s_exit_packet.as_ref() as *const Packet;
								if s_exit_packet_ptr!=entry_packet_ptr || s_exit_port!=exit_port || s_exit_vc!=exit_vc
								{
									panic!("Mismatch between selected input and selected output: selected_input[{}][{}]=({:?},{},{}) selected_output[{}][{}]=({:?},{},{}).",exit_port,exit_vc,entry_packet_ptr,entry_port,entry_vc,  entry_port,entry_vc,s_exit_packet_ptr,s_exit_port,s_exit_vc);
								}
							}
							if phit.is_end()
							{
								self.selected_input[exit_port][exit_vc]=None;
								self.selected_output[entry_port][entry_vc]=None;
							}
							else
							{
								self.selected_output[entry_port][entry_vc]=Some((entry_packet.clone(),exit_port,exit_vc));
							}
							self.output_buffers[exit_port][exit_vc].push(phit,(entry_port,entry_vc));
						}
						else
						{
							if self.flit_size>1
							{
								//We would like to panic if phit.packet.size<=flit_size, but we do not have the phit accesible.
								println!("WARNING: There were no phit at the selected_input[{}][{}]=({},{}) of the router {}.",exit_port,exit_vc,entry_port,entry_vc,self.router_index);
							}
						}
					}
					else if let Some(phit)=self.reception_port_space[entry_port].front_virtual_channel(entry_vc)
					{
						if phit.is_begin()
						{
							undo_selected_input.push(exit_vc);
						}
						let bubble_in_use= self.bubble && phit.is_begin() && simulation.network.topology.is_direction_change(self.router_index,entry_port,exit_port);
						//if self.transmission_port_status[exit_port].can_transmit(&phit,exit_vc,transmit_auxiliar_info)
						if self.can_phit_advance(&phit,exit_port,exit_vc,bubble_in_use)
						{
							//cand.push(exit_vc);
							if cand_in_transit
							{
								if !phit.is_begin()
								{
									cand.push(exit_vc);
								}
							}
							else
							{
								if phit.is_begin()
								{
									cand.push(exit_vc);
								}
								else
								{
									cand=vec![exit_vc];
									cand_in_transit=true;
								}
							}
						}
					}
				}
				if self.output_buffer_size>0
				{
					//Candidates when using output ports.
					if let Some( (phit,(entry_port,_entry_vc))) = self.output_buffers[exit_port][exit_vc].front()
					{
						let bubble_in_use= self.bubble && phit.is_begin() && simulation.network.topology.is_direction_change(self.router_index,entry_port,exit_port);
						let status=&self.transmission_port_status[exit_port];
						let can_transmit = if bubble_in_use
						{
							//self.transmission_port_status[exit_port].can_transmit_whole_packet(&phit,exit_vc)
							if let Some(space)=status.known_available_space_for_virtual_channel(exit_vc)
							{
								status.can_transmit(&phit,exit_vc) && space>= phit.packet.size + self.maximum_packet_size
							}
							else
							{
								panic!("Basic router requires knowledge of available space to apply bubble.");
							}
						}
						else
						{
							status.can_transmit(&phit,exit_vc)
						};
						if can_transmit
						{
							if cand_in_transit
							{
								if !phit.is_begin()
								{
									cand.push(exit_vc);
								}
							}
							else
							{
								if phit.is_begin()
								{
									cand.push(exit_vc);
								}
								else
								{
									cand=vec![exit_vc];
									cand_in_transit=true;
								}
							}
						}
						else
						{
							if 0<phit.index && phit.index<self.flit_size
							{
								panic!("cannot transmit phit (index={}) but it should (flit_size={})",phit.index,self.flit_size);
							}
						}
					}
				}
			}
			//for selected_virtual_channel in 0..nvc
			let selected_virtual_channel = if cand.len()>0
			{
				//Then select one of the vc candidates (either in input or output buffer) to actually use the physical port.
				let selected_virtual_channel = match self.output_arbiter
				{
					OutputArbiter::Random=> cand[simulation.rng.borrow_mut().gen_range(0,cand.len())],
					OutputArbiter::Token{ref mut port_token}=>
					{
						//Or by tokens as in fsin
						//let nvc=self.virtual_ports[exit_port].len() as i64;
						let nvc= amount_virtual_channels as i64;
						let token= port_token[exit_port] as i64;
						let mut best=0;
						let mut bestd=nvc;
						for vc in cand
						{
							let mut d:i64 = vc as i64 - token;
							if d<0
							{
								d+=nvc;
							}
							if d<bestd
							{
								best=vc;
								bestd=d;
							}
						}
						port_token[exit_port]=best;
						best
					},
				};
				//move phits around.
				let (phit,original_port) = if self.output_buffer_size>0
				{
					//If we get the phit from an output buffer there is little to do.
					let (phit,(entry_port,_entry_vc))=self.output_buffers[exit_port][selected_virtual_channel].pop().expect("incorrect selected_input");
					(phit,entry_port)
				}
				else
				{
					//If we get the phit from an input buffer we have to send acks to the previous router and take care of sending the packet in one piece.
					if let Some((ref packet,iport,entry_vc))=self.selected_input[exit_port][selected_virtual_channel]
					{
						if let Ok((phit,ack_message)) = self.reception_port_space[iport].extract(entry_vc)
						{
							moved_phits+=1;
							self.time_at_input_head[iport][entry_vc]=0;
							//phit.virtual_channel.replace(Some(selected_virtual_channel));
							*phit.virtual_channel.borrow_mut()=Some(selected_virtual_channel);
							if let Some(message)=ack_message
							{
								let (previous_location,previous_link_class)=simulation.network.topology.neighbour(self.router_index,iport);
								events.push(EventGeneration{
									delay: simulation.link_classes[previous_link_class].delay,
									position:CyclePosition::Begin,
									//event:Event::PhitClearAcknowledge{location:previous_location,virtual_channel:entry_vc},
									event:Event::Acknowledge{location:previous_location,message},
								});
							}
							if phit.is_end()
							{
								self.selected_input[exit_port][selected_virtual_channel]=None;
								self.selected_output[iport][entry_vc]=None;
							}
							else
							{
								self.selected_output[iport][entry_vc]=Some((packet.clone(),exit_port,selected_virtual_channel));
							}
							(phit,iport)
						}
						else
						{
							panic!("There were no phit at the selected_input[{}][{}]=({},{}), and somehow it is selected",exit_port,selected_virtual_channel,iport,entry_vc);
						}
					}
					else
					{
						panic!("incorrect selected_input")
					}
				};
				let (new_location,link_class)=simulation.network.topology.neighbour(self.router_index,exit_port);
				//Send the phit to the other link endpoint.
				events.push(EventGeneration{
					delay: simulation.link_classes[link_class].delay,
					position:CyclePosition::Begin,
					event:Event::PhitToLocation{
						phit: phit.clone(),
						previous: Location::RouterPort{
							router_index: self.router_index,
							router_port: original_port,
						},
						new: new_location,
					},
				});
				self.transmission_port_status[exit_port].notify_outcoming_phit(selected_virtual_channel,simulation.cycle);
				if phit.is_end()
				{
					if let OutputArbiter::Token{ref mut port_token}=self.output_arbiter
					{
						port_token[exit_port]=(port_token[exit_port]+1)%amount_virtual_channels;
					}
				}
				Some(selected_virtual_channel)
			} else {None};
			for other_virtual_channel in undo_selected_input
			{
				if Some(other_virtual_channel) != selected_virtual_channel
				{
					//Packets that have not started to move can change their decision at the next cycle
					self.selected_input[exit_port][other_virtual_channel]=None;
				}
			}
		}
		//TODO: what to do with probabilistic requests???
		if undecided_channels>0 || moved_phits>0 || events.len()>0 || request_len>0
		//if undecided_channels>0 || moved_phits>0 || events.len()>0
		//if true
		{
			//Repeat at next cycle
			events.push(EventGeneration{
				delay:1,
				position:CyclePosition::End,
				event:Event::Generic(self.as_eventful().upgrade().expect("missing router")),
			});
		}
		else
		{
			self.clear_pending_events();
		}
		events
	}
	fn pending_events(&self)->usize
	{
		if self.event_pending { 1 } else { 0 }
	}
	fn add_pending_event(&mut self)
	{
		self.event_pending=true;
	}
	fn clear_pending_events(&mut self)
	{
		self.event_pending=false;
	}
	fn as_eventful(&self)->Weak<RefCell<dyn Eventful>>
	{
		self.self_rc.clone()
	}
}

impl<TM:TransmissionMechanism> Quantifiable for Basic<TM>
{
	fn total_memory(&self) -> usize
	{
		//FIXME: redo
		//return size_of::<Basic<TM>>() + self.virtual_ports.total_memory() + self.port_token.total_memory();
		return size_of::<Basic<TM>>();
	}
	fn print_memory_breakdown(&self)
	{
		unimplemented!();
	}
	fn forecast_total_memory(&self) -> usize
	{
		unimplemented!();
	}
}