-
Notifications
You must be signed in to change notification settings - Fork 887
/
MediaDriver.java
4408 lines (4010 loc) · 164 KB
/
MediaDriver.java
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
/*
* Copyright 2014-2024 Real Logic Limited.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.aeron.driver;
import io.aeron.Aeron;
import io.aeron.CncFileDescriptor;
import io.aeron.CommonContext;
import io.aeron.config.Config;
import io.aeron.driver.buffer.FileStoreLogFactory;
import io.aeron.driver.buffer.LogFactory;
import io.aeron.driver.exceptions.ActiveDriverException;
import io.aeron.driver.media.*;
import io.aeron.driver.reports.LossReport;
import io.aeron.driver.status.DutyCycleStallTracker;
import io.aeron.driver.status.SystemCounters;
import io.aeron.exceptions.AeronException;
import io.aeron.exceptions.ConcurrentConcludeException;
import io.aeron.exceptions.ConfigurationException;
import io.aeron.logbuffer.BufferClaim;
import io.aeron.logbuffer.LogBufferDescriptor;
import io.aeron.version.Versioned;
import org.agrona.*;
import org.agrona.concurrent.*;
import org.agrona.concurrent.broadcast.BroadcastTransmitter;
import org.agrona.concurrent.errors.DistinctErrorLog;
import org.agrona.concurrent.ringbuffer.ManyToOneRingBuffer;
import org.agrona.concurrent.ringbuffer.RingBuffer;
import org.agrona.concurrent.status.*;
import java.io.ByteArrayOutputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.VarHandle;
import java.net.StandardSocketOptions;
import java.nio.ByteOrder;
import java.nio.MappedByteBuffer;
import java.nio.channels.DatagramChannel;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Date;
import java.util.concurrent.*;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;
import static io.aeron.CncFileDescriptor.*;
import static io.aeron.driver.Configuration.*;
import static io.aeron.driver.reports.LossReportUtil.mapLossReport;
import static io.aeron.driver.status.SystemCounterDescriptor.CONTROLLABLE_IDLE_STRATEGY;
import static io.aeron.driver.status.SystemCounterDescriptor.*;
import static io.aeron.logbuffer.LogBufferDescriptor.TERM_MAX_LENGTH;
import static java.nio.charset.StandardCharsets.US_ASCII;
import static org.agrona.BitUtil.SIZE_OF_LONG;
import static org.agrona.IoUtil.mapNewFile;
import static org.agrona.SystemUtil.loadPropertiesFiles;
import static org.agrona.concurrent.status.CountersReader.METADATA_LENGTH;
/**
* Main class for JVM-based media driver
* <p>
* Usage:
* <code>
* $ java -jar aeron-driver.jar
* $ java -Doption=value -jar aeron-driver.jar
* </code>
*
* @see Configuration
*/
@Versioned
public final class MediaDriver implements AutoCloseable
{
private boolean wasHighResTimerEnabled;
private final AgentRunner sharedRunner;
private final AgentRunner sharedNetworkRunner;
private final AgentRunner conductorRunner;
private final AgentRunner receiverRunner;
private final AgentRunner senderRunner;
private final AgentInvoker sharedInvoker;
private final Context ctx;
/**
* Main method for launching the process.
*
* @param args passed to the process.
*/
@SuppressWarnings("try")
public static void main(final String[] args)
{
loadPropertiesFiles(args);
final ShutdownSignalBarrier barrier = new ShutdownSignalBarrier();
final MediaDriver.Context ctx = new MediaDriver.Context().terminationHook(barrier::signal);
try (MediaDriver ignore = MediaDriver.launch(ctx))
{
barrier.await();
System.out.println("Shutdown Driver...");
}
}
/**
* Construct a media driver with the given ctx.
*
* @param ctx for the media driver parameters
*/
private MediaDriver(final Context ctx)
{
ctx.concludeAeronDirectory();
ensureDirectoryIsRecreated(ctx);
validateSocketBufferLengths(ctx);
try
{
ctx.conclude();
this.ctx = ctx;
final DriverConductor conductor = new DriverConductor(ctx);
final Receiver receiver = new Receiver(ctx);
final Sender sender = new Sender(ctx);
ctx.receiverProxy().receiver(receiver);
ctx.senderProxy().sender(sender);
ctx.driverConductorProxy().driverConductor(conductor);
final AtomicCounter errorCounter = ctx.systemCounters().get(ERRORS);
final ErrorHandler errorHandler = ctx.errorHandler();
switch (ctx.threadingMode())
{
case INVOKER:
sharedInvoker = new AgentInvoker(
errorHandler,
errorCounter,
new NamedCompositeAgent(ctx.aeronDirectoryName(), sender, receiver, conductor));
sharedRunner = null;
sharedNetworkRunner = null;
conductorRunner = null;
receiverRunner = null;
senderRunner = null;
break;
case SHARED:
sharedRunner = new AgentRunner(
ctx.sharedIdleStrategy(),
errorHandler,
errorCounter,
new NamedCompositeAgent(ctx.aeronDirectoryName(), sender, receiver, conductor));
sharedNetworkRunner = null;
conductorRunner = null;
receiverRunner = null;
senderRunner = null;
sharedInvoker = null;
break;
case SHARED_NETWORK:
sharedNetworkRunner = new AgentRunner(
ctx.sharedNetworkIdleStrategy(),
errorHandler,
errorCounter,
new NamedCompositeAgent(ctx.aeronDirectoryName(), sender, receiver));
conductorRunner = new AgentRunner(
ctx.conductorIdleStrategy(), errorHandler, errorCounter, conductor);
sharedRunner = null;
receiverRunner = null;
senderRunner = null;
sharedInvoker = null;
break;
case DEDICATED:
default:
senderRunner = new AgentRunner(ctx.senderIdleStrategy(), errorHandler, errorCounter, sender);
receiverRunner = new AgentRunner(ctx.receiverIdleStrategy(), errorHandler, errorCounter, receiver);
conductorRunner = new AgentRunner(
ctx.conductorIdleStrategy(), errorHandler, errorCounter, conductor);
sharedNetworkRunner = null;
sharedRunner = null;
sharedInvoker = null;
break;
}
}
catch (final ConcurrentConcludeException ex)
{
throw ex;
}
catch (final Exception ex)
{
CloseHelper.quietClose(ctx::close);
throw ex;
}
}
/**
* Launch an isolated MediaDriver embedded in the current process with a generated aeronDirectoryName that can be
* retrieved by calling aeronDirectoryName.
* <p>
* If the aeronDirectoryName is set as a system property to something different from
* {@link CommonContext#AERON_DIR_PROP_DEFAULT} then this set value will be used.
*
* @return the newly started MediaDriver.
*/
public static MediaDriver launchEmbedded()
{
return launchEmbedded(new Context());
}
/**
* Launch an isolated MediaDriver embedded in the current process with a provided configuration ctx and a generated
* aeronDirectoryName (overwrites configured {@link Context#aeronDirectoryName()}) that can be retrieved by calling
* aeronDirectoryName.
* <p>
* If the aeronDirectoryName is set as a system property, or via context, to something different from
* {@link CommonContext#AERON_DIR_PROP_DEFAULT} then this set value will be used.
*
* @param ctx containing the configuration options.
* @return the newly started MediaDriver.
*/
public static MediaDriver launchEmbedded(final Context ctx)
{
if (CommonContext.AERON_DIR_PROP_DEFAULT.equals(ctx.aeronDirectoryName()))
{
ctx.aeronDirectoryName(CommonContext.generateRandomDirName());
}
return launch(ctx);
}
/**
* Launch a MediaDriver embedded in the current process with default configuration.
*
* @return the newly started MediaDriver.
*/
public static MediaDriver launch()
{
return launch(new Context());
}
/**
* Launch a MediaDriver embedded in the current process and provided a configuration ctx.
*
* @param ctx containing the configuration options.
* @return the newly created MediaDriver.
*/
public static MediaDriver launch(final Context ctx)
{
final MediaDriver mediaDriver = new MediaDriver(ctx);
if (ctx.useWindowsHighResTimer() && SystemUtil.isWindows())
{
mediaDriver.wasHighResTimerEnabled = HighResolutionTimer.isEnabled();
if (!mediaDriver.wasHighResTimerEnabled)
{
HighResolutionTimer.enable();
}
}
if (null != mediaDriver.conductorRunner)
{
AgentRunner.startOnThread(mediaDriver.conductorRunner, ctx.conductorThreadFactory());
}
if (null != mediaDriver.senderRunner)
{
AgentRunner.startOnThread(mediaDriver.senderRunner, ctx.senderThreadFactory());
}
if (null != mediaDriver.receiverRunner)
{
AgentRunner.startOnThread(mediaDriver.receiverRunner, ctx.receiverThreadFactory());
}
if (null != mediaDriver.sharedNetworkRunner)
{
AgentRunner.startOnThread(mediaDriver.sharedNetworkRunner, ctx.sharedNetworkThreadFactory());
}
if (null != mediaDriver.sharedRunner)
{
AgentRunner.startOnThread(mediaDriver.sharedRunner, ctx.sharedThreadFactory());
}
if (null != mediaDriver.sharedInvoker)
{
mediaDriver.sharedInvoker.start();
}
return mediaDriver;
}
/**
* Get the {@link MediaDriver.Context} that is used by this {@link MediaDriver}.
*
* @return the {@link MediaDriver.Context} that is used by this {@link MediaDriver}.
*/
public Context context()
{
return ctx;
}
/**
* Get the {@link AgentInvoker} for the shared agents when running without threads.
*
* @return the {@link AgentInvoker} for the shared agents when running without threads.
*/
public AgentInvoker sharedAgentInvoker()
{
return sharedInvoker;
}
/**
* Shutdown the media driver by stopping all threads and freeing resources.
*/
public void close()
{
try
{
CloseHelper.closeAll(
sharedRunner, sharedNetworkRunner, receiverRunner, senderRunner, conductorRunner, sharedInvoker);
}
finally
{
if (ctx.useWindowsHighResTimer() && SystemUtil.isWindows() && !wasHighResTimerEnabled)
{
HighResolutionTimer.disable();
}
}
}
/**
* Used to access the configured aeronDirectoryName for this MediaDriver, typically used after the
* {@link #launchEmbedded()} method is used.
*
* @return the context aeronDirectoryName
*/
public String aeronDirectoryName()
{
return ctx.aeronDirectoryName();
}
private static void ensureDirectoryIsRecreated(final Context ctx)
{
if (ctx.aeronDirectory().isDirectory())
{
if (ctx.warnIfDirectoryExists())
{
System.err.println("WARNING: " + ctx.aeronDirectory() + " exists");
}
if (!ctx.dirDeleteOnStart())
{
final Consumer<String> logger = ctx.warnIfDirectoryExists() ? System.err::println : (s) -> {};
final MappedByteBuffer cncByteBuffer = ctx.mapExistingCncFile(logger);
try
{
if (CommonContext.isDriverActive(ctx.driverTimeoutMs(), logger, cncByteBuffer))
{
throw new ActiveDriverException("active driver detected");
}
reportExistingErrors(ctx, cncByteBuffer);
}
finally
{
BufferUtil.free(cncByteBuffer);
}
}
ctx.deleteDirectory();
}
IoUtil.ensureDirectoryExists(ctx.aeronDirectory(), "aeron");
}
private static void reportExistingErrors(final Context ctx, final MappedByteBuffer cncByteBuffer)
{
try
{
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final int observations = ctx.saveErrorLog(new PrintStream(baos, false, "US-ASCII"), cncByteBuffer);
if (observations > 0)
{
final StringBuilder builder = new StringBuilder(ctx.aeronDirectoryName());
IoUtil.removeTrailingSlashes(builder);
final SimpleDateFormat dateFormat = new SimpleDateFormat("-yyyy-MM-dd-HH-mm-ss-SSSZ");
builder.append(dateFormat.format(new Date())).append("-error.log");
final String errorLogFilename = builder.toString();
System.err.println("WARNING: Existing errors saved to: " + errorLogFilename);
try (FileOutputStream out = new FileOutputStream(errorLogFilename))
{
baos.writeTo(out);
}
}
}
catch (final Exception ex)
{
LangUtil.rethrowUnchecked(ex);
}
}
/**
* Context for the {@link MediaDriver} that can be used to provide overrides for {@link Configuration}.
* <p>
* <b>Note:</b> Do not reuse instances of this {@link Context} across different {@link MediaDriver}s.
* <p>
* The context will be owned by {@link DriverConductor} after a successful
* {@link MediaDriver#launch(Context)} and closed via {@link MediaDriver#close()}.
*/
public static final class Context extends CommonContext
{
private static final VarHandle IS_CLOSED_VH;
static
{
try
{
IS_CLOSED_VH = MethodHandles.lookup().findVarHandle(Context.class, "isClosed", boolean.class);
}
catch (final ReflectiveOperationException ex)
{
throw new ExceptionInInitializerError(ex);
}
}
private volatile boolean isClosed;
private boolean printConfigurationOnStart = Configuration.printConfigurationOnStart();
private boolean useWindowsHighResTimer = Configuration.useWindowsHighResTimer();
private boolean warnIfDirectoryExists = Configuration.warnIfDirExists();
private boolean dirDeleteOnStart = Configuration.dirDeleteOnStart();
private boolean dirDeleteOnShutdown = Configuration.dirDeleteOnShutdown();
private boolean termBufferSparseFile = Configuration.termBufferSparseFile();
private boolean performStorageChecks = Configuration.performStorageChecks();
private boolean spiesSimulateConnection = Configuration.spiesSimulateConnection();
private boolean reliableStream = Configuration.reliableStream();
private boolean tetherSubscriptions = Configuration.tetherSubscriptions();
private boolean rejoinStream = Configuration.rejoinStream();
private long lowStorageWarningThreshold = Configuration.lowStorageWarningThreshold();
private long timerIntervalNs = Configuration.timerIntervalNs();
private long clientLivenessTimeoutNs = Configuration.clientLivenessTimeoutNs();
private long imageLivenessTimeoutNs = Configuration.imageLivenessTimeoutNs();
private long publicationUnblockTimeoutNs = Configuration.publicationUnblockTimeoutNs();
private long publicationConnectionTimeoutNs = Configuration.publicationConnectionTimeoutNs();
private long publicationLingerTimeoutNs = Configuration.publicationLingerTimeoutNs();
private long untetheredWindowLimitTimeoutNs = Configuration.untetheredWindowLimitTimeoutNs();
private long untetheredRestingTimeoutNs = Configuration.untetheredRestingTimeoutNs();
private long statusMessageTimeoutNs = Configuration.statusMessageTimeoutNs();
private long counterFreeToReuseTimeoutNs = Configuration.counterFreeToReuseTimeoutNs();
private long retransmitUnicastDelayNs = Configuration.retransmitUnicastDelayNs();
private long retransmitUnicastLingerNs = Configuration.retransmitUnicastLingerNs();
private long nakUnicastDelayNs = Configuration.nakUnicastDelayNs();
private long nakUnicastRetryDelayRatio = Configuration.nakUnicastRetryDelayRatio();
private long nakMulticastMaxBackoffNs = Configuration.nakMulticastMaxBackoffNs();
private long flowControlReceiverTimeoutNs = Configuration.flowControlReceiverTimeoutNs();
private long reResolutionCheckIntervalNs = Configuration.reResolutionCheckIntervalNs();
private long conductorCycleThresholdNs = Configuration.conductorCycleThresholdNs();
private long senderCycleThresholdNs = Configuration.senderCycleThresholdNs();
private long receiverCycleThresholdNs = Configuration.receiverCycleThresholdNs();
private long nameResolverThresholdNs = Configuration.nameResolverThresholdNs();
private int conductorBufferLength = Configuration.conductorBufferLength();
private int toClientsBufferLength = Configuration.toClientsBufferLength();
private int counterValuesBufferLength = Configuration.counterValuesBufferLength();
private int errorBufferLength = Configuration.errorBufferLength();
private int nakMulticastGroupSize = Configuration.nakMulticastGroupSize();
private int publicationTermBufferLength = Configuration.termBufferLength();
private int ipcTermBufferLength = Configuration.ipcTermBufferLength();
private int publicationTermWindowLength = Configuration.publicationTermWindowLength();
private int ipcPublicationTermWindowLength = Configuration.ipcPublicationTermWindowLength();
private int initialWindowLength = Configuration.initialWindowLength();
private int socketSndbufLength = Configuration.socketSndbufLength();
private int socketRcvbufLength = Configuration.socketRcvbufLength();
private int socketMulticastTtl = Configuration.socketMulticastTtl();
private int mtuLength = Configuration.mtuLength();
private int ipcMtuLength = Configuration.ipcMtuLength();
private int filePageSize = Configuration.filePageSize();
private int publicationReservedSessionIdLow = Configuration.publicationReservedSessionIdLow();
private int publicationReservedSessionIdHigh = Configuration.publicationReservedSessionIdHigh();
private int lossReportBufferLength = Configuration.lossReportBufferLength();
private int sendToStatusMessagePollRatio = Configuration.sendToStatusMessagePollRatio();
private int resourceFreeLimit = Configuration.resourceFreeLimit();
private int asyncTaskExecutorThreads = Configuration.asyncTaskExecutorThreads();
private int maxResend = Configuration.maxResend();
private Long receiverGroupTag = Configuration.groupTag();
private long flowControlGroupTag = Configuration.flowControlGroupTag();
private int flowControlGroupMinSize = Configuration.flowControlGroupMinSize();
private InferableBoolean receiverGroupConsideration = Configuration.receiverGroupConsideration();
private String resolverName = Configuration.resolverName();
private String resolverInterface = Configuration.resolverInterface();
private String resolverBootstrapNeighbor = Configuration.resolverBootstrapNeighbor();
private String senderWildcardPortRange = Configuration.senderWildcardPortRange();
private String receiverWildcardPortRange = Configuration.receiverWildcardPortRange();
private EpochClock epochClock;
private NanoClock nanoClock;
private CachedEpochClock cachedEpochClock;
private CachedNanoClock cachedNanoClock;
private CachedNanoClock senderCachedNanoClock;
private CachedNanoClock receiverCachedNanoClock;
private ThreadingMode threadingMode;
private ThreadFactory conductorThreadFactory;
private ThreadFactory senderThreadFactory;
private ThreadFactory receiverThreadFactory;
private ThreadFactory sharedThreadFactory;
private ThreadFactory sharedNetworkThreadFactory;
private Executor asyncTaskExecutor;
private IdleStrategy conductorIdleStrategy;
private IdleStrategy senderIdleStrategy;
private IdleStrategy receiverIdleStrategy;
private IdleStrategy sharedNetworkIdleStrategy;
private IdleStrategy sharedIdleStrategy;
private SendChannelEndpointSupplier sendChannelEndpointSupplier;
private ReceiveChannelEndpointSupplier receiveChannelEndpointSupplier;
private ReceiveChannelEndpointThreadLocals receiveChannelEndpointThreadLocals;
private MutableDirectBuffer tempBuffer;
private FlowControlSupplier unicastFlowControlSupplier;
private FlowControlSupplier multicastFlowControlSupplier;
private byte[] applicationSpecificFeedback;
private CongestionControlSupplier congestionControlSupplier;
private FeedbackDelayGenerator unicastFeedbackDelayGenerator;
private FeedbackDelayGenerator multicastFeedbackDelayGenerator;
private FeedbackDelayGenerator retransmitUnicastDelayGenerator;
private FeedbackDelayGenerator retransmitUnicastLingerGenerator;
private TerminationValidator terminationValidator;
private Runnable terminationHook;
private NameResolver nameResolver;
private DistinctErrorLog errorLog;
private ErrorHandler errorHandler;
private boolean useConcurrentCountersManager;
private CountersManager countersManager;
private SystemCounters systemCounters;
private LossReport lossReport;
private LogFactory logFactory;
private DataTransportPoller dataTransportPoller;
private ControlTransportPoller controlTransportPoller;
private ManyToOneConcurrentLinkedQueue<Runnable> driverCommandQueue;
private OneToOneConcurrentArrayQueue<Runnable> receiverCommandQueue;
private OneToOneConcurrentArrayQueue<Runnable> senderCommandQueue;
private ReceiverProxy receiverProxy;
private SenderProxy senderProxy;
private DriverConductorProxy driverConductorProxy;
private ClientProxy clientProxy;
private RingBuffer toDriverCommands;
private MappedByteBuffer lossReportBuffer;
private MappedByteBuffer cncByteBuffer;
private UnsafeBuffer cncMetaDataBuffer;
private int osDefaultSocketRcvbufLength = Aeron.NULL_VALUE;
private int osMaxSocketRcvbufLength = Aeron.NULL_VALUE;
private int osDefaultSocketSndbufLength = Aeron.NULL_VALUE;
private int osMaxSocketSndbufLength = Aeron.NULL_VALUE;
private EpochNanoClock channelReceiveTimestampClock;
private EpochNanoClock channelSendTimestampClock;
private DutyCycleTracker conductorDutyCycleTracker;
private DutyCycleTracker senderDutyCycleTracker;
private DutyCycleTracker receiverDutyCycleTracker;
private DutyCycleTracker nameResolverTimeTracker;
private PortManager senderPortManager;
private PortManager receiverPortManager;
private int streamSessionLimit = Configuration.streamSessionLimit();
/**
* Perform a shallow copy of the object.
*
* @return a shallow copy of the object.
*/
public Context clone()
{
return (Context)super.clone();
}
/**
* Free up resources but don't delete files in case they are required for debugging unless
* {@link #dirDeleteOnShutdown()} is set.
*/
public void close()
{
if (IS_CLOSED_VH.compareAndSet(this, false, true))
{
CloseHelper.close(errorHandler, logFactory);
if (null != systemCounters)
{
final AtomicCounter errorCounter = systemCounters.get(ERRORS);
errorCounter.disconnectCountersManager();
errorCounter.close();
}
if (errorHandler instanceof AutoCloseable)
{
CloseHelper.quietClose((AutoCloseable)errorHandler);
}
BufferUtil.free(lossReportBuffer);
this.lossReportBuffer = null;
BufferUtil.free(cncByteBuffer);
this.cncByteBuffer = null;
if (dirDeleteOnShutdown)
{
this.deleteDirectory();
}
super.close();
}
}
/**
* {@inheritDoc}
*/
public Context conclude()
{
super.conclude();
try
{
concludeNullProperties();
resolveOsSocketBufLengths();
validateMtuLength(mtuLength);
validateMtuLength(ipcMtuLength);
validatePageSize(filePageSize);
validateValueRange(
conductorBufferLength, CONDUCTOR_BUFFER_LENGTH_DEFAULT, Integer.MAX_VALUE, "conductorBufferLength");
validateValueRange(
toClientsBufferLength,
TO_CLIENTS_BUFFER_LENGTH_DEFAULT,
Integer.MAX_VALUE,
"toClientsBufferLength");
validateValueRange(
counterValuesBufferLength,
COUNTERS_VALUES_BUFFER_LENGTH_DEFAULT,
COUNTERS_VALUES_BUFFER_LENGTH_MAX,
"counterValuesBufferLength");
validateValueRange(
errorBufferLength, ERROR_BUFFER_LENGTH_DEFAULT, Integer.MAX_VALUE, "errorBufferLength");
validateValueRange(
publicationTermWindowLength, 0, TERM_MAX_LENGTH, "publicationTermWindowLength");
validateValueRange(
ipcPublicationTermWindowLength, 0, TERM_MAX_LENGTH, "ipcPublicationTermWindowLength");
validateSessionIdRange(publicationReservedSessionIdLow, publicationReservedSessionIdHigh);
LogBufferDescriptor.checkTermLength(publicationTermBufferLength);
LogBufferDescriptor.checkTermLength(ipcTermBufferLength);
validateInitialWindowLength(initialWindowLength, mtuLength);
validateUnblockTimeout(publicationUnblockTimeoutNs(), clientLivenessTimeoutNs(), timerIntervalNs);
validateUntetheredTimeouts(untetheredWindowLimitTimeoutNs, untetheredRestingTimeoutNs, timerIntervalNs);
final long cncFileLength = BitUtil.align(
(long)END_OF_METADATA_OFFSET +
conductorBufferLength +
toClientsBufferLength +
countersMetadataBufferLength(counterValuesBufferLength) +
counterValuesBufferLength +
errorBufferLength,
filePageSize);
validateValueRange(cncFileLength, 0, Integer.MAX_VALUE, "CnC file length");
cncByteBuffer = mapNewFile(cncFile(), cncFileLength);
cncMetaDataBuffer = CncFileDescriptor.createMetaDataBuffer(cncByteBuffer);
CncFileDescriptor.fillMetaData(
cncMetaDataBuffer,
conductorBufferLength,
toClientsBufferLength,
Configuration.countersMetadataBufferLength(counterValuesBufferLength),
counterValuesBufferLength,
clientLivenessTimeoutNs,
errorBufferLength,
epochClock.time(),
SystemUtil.getPid());
concludeCounters();
concludeDependantProperties();
concludeIdleStrategies();
systemCounters.get(BYTES_CURRENTLY_MAPPED).setOrdered(cncFileLength + lossReportBufferLength);
toDriverCommands.nextCorrelationId();
toDriverCommands.consumerHeartbeatTime(epochClock.time());
CncFileDescriptor.signalCncReady(cncMetaDataBuffer);
cncByteBuffer.force();
}
catch (final Exception ex)
{
LangUtil.rethrowUnchecked(ex);
}
if (printConfigurationOnStart)
{
System.out.println(this);
}
return this;
}
/**
* Delete the directory used by the {@link MediaDriver} which delegates to
* {@link CommonContext#deleteAeronDirectory()}.
*/
public void deleteDirectory()
{
if (null != aeronDirectory())
{
super.deleteAeronDirectory();
}
}
/**
* {@inheritDoc}
*/
public Context aeronDirectoryName(final String dirName)
{
super.aeronDirectoryName(dirName);
return this;
}
/**
* {@inheritDoc}
*/
public Context driverTimeoutMs(final long value)
{
super.driverTimeoutMs(value);
return this;
}
/**
* {@inheritDoc}
*/
public Context countersMetaDataBuffer(final UnsafeBuffer countersMetaDataBuffer)
{
super.countersMetaDataBuffer(countersMetaDataBuffer);
return this;
}
/**
* {@inheritDoc}
*/
public Context countersValuesBuffer(final UnsafeBuffer countersValuesBuffer)
{
super.countersValuesBuffer(countersValuesBuffer);
return this;
}
/**
* Should the driver print its configuration on start to {@link System#out} at the end of {@link #conclude()}.
*
* @return true if the configuration should be printed on start.
* @see Configuration#PRINT_CONFIGURATION_ON_START_PROP_NAME
*/
@Config
public boolean printConfigurationOnStart()
{
return printConfigurationOnStart;
}
/**
* Should the driver print its configuration on start to {@link System#out} at the end of {@link #conclude()}.
*
* @param printConfigurationOnStart if the configuration should be printed on start.
* @return this for a fluent API.
* @see Configuration#PRINT_CONFIGURATION_ON_START_PROP_NAME
*/
public Context printConfigurationOnStart(final boolean printConfigurationOnStart)
{
this.printConfigurationOnStart = printConfigurationOnStart;
return this;
}
/**
* Should an attempt be made to use the high resolution timers for waiting on Windows.
*
* @param useWindowsHighResTimers Should an attempt be made to use the high-res timers for waiting on Windows.
* @return this for a fluent API.
* @see Configuration#USE_WINDOWS_HIGH_RES_TIMER_PROP_NAME
*/
public Context useWindowsHighResTimer(final boolean useWindowsHighResTimers)
{
this.useWindowsHighResTimer = useWindowsHighResTimers;
return this;
}
/**
* Should an attempt be made to use the high resolution timers for waiting on Windows.
*
* @return true if an attempt be made to use the high resolution timers for waiting on Windows.
* @see Configuration#USE_WINDOWS_HIGH_RES_TIMER_PROP_NAME
*/
@Config
public boolean useWindowsHighResTimer()
{
return useWindowsHighResTimer;
}
/**
* Should a warning be issued if the {@link #aeronDirectoryName()} exists?
*
* @return should a warning be issued if the {@link #aeronDirectoryName()} exists?
* @see Configuration#DIR_WARN_IF_EXISTS_PROP_NAME
*/
@Config(id = "DIR_WARN_IF_EXISTS")
public boolean warnIfDirectoryExists()
{
return warnIfDirectoryExists;
}
/**
* Should a warning be issued if the {@link #aeronDirectoryName()} exists?
*
* @param warnIfDirectoryExists warn if the {@link #aeronDirectoryName()} exists?
* @return this for a fluent API.
* @see Configuration#DIR_WARN_IF_EXISTS_PROP_NAME
*/
public Context warnIfDirectoryExists(final boolean warnIfDirectoryExists)
{
this.warnIfDirectoryExists = warnIfDirectoryExists;
return this;
}
/**
* Will the driver attempt to immediately delete {@link #aeronDirectoryName()} on startup.
* WARNING: {@link #aeronDirectoryName()} will be recreated regardless, unless set to false
* and an active Media Driver is detected.
*
* @return true when directory will be recreated without checks, otherwise false.
* @see Configuration#DIR_DELETE_ON_START_PROP_NAME
*/
@Config
public boolean dirDeleteOnStart()
{
return dirDeleteOnStart;
}
/**
* Should the driver attempt to immediately delete {@link #aeronDirectoryName()} on startup.
* WARNING: {@link #aeronDirectoryName()} will be recreated regardless, unless set to false
* and an active Media Driver is detected.
*
* @param dirDeleteOnStart Attempt deletion without checks.
* @return this for a fluent API.
* @see Configuration#DIR_DELETE_ON_START_PROP_NAME
*/
public Context dirDeleteOnStart(final boolean dirDeleteOnStart)
{
this.dirDeleteOnStart = dirDeleteOnStart;
return this;
}
/**
* Will the driver attempt to delete {@link #aeronDirectoryName()} on shutdown.
*
* @return true when directory will be deleted, otherwise false.
* @see Configuration#DIR_DELETE_ON_SHUTDOWN_PROP_NAME
*/
@Config
public boolean dirDeleteOnShutdown()
{
return dirDeleteOnShutdown;
}
/**
* Should the driver attempt to delete {@link #aeronDirectoryName()} on shutdown.
*
* @param dirDeleteOnShutdown Attempt deletion.
* @return this for a fluent API.
* @see Configuration#DIR_DELETE_ON_SHUTDOWN_PROP_NAME
*/
public Context dirDeleteOnShutdown(final boolean dirDeleteOnShutdown)
{
this.dirDeleteOnShutdown = dirDeleteOnShutdown;
return this;
}
/**
* Should the term buffers be created with sparse files?
*
* @return should the term buffers be created with sparse files?
* @see Configuration#TERM_BUFFER_SPARSE_FILE_PROP_NAME
*/
@Config
public boolean termBufferSparseFile()
{
return termBufferSparseFile;
}
/**
* Should the term buffer be created with sparse files?
*
* @param termBufferSparseFile should the term buffers be created with sparse files?
* @return this for a fluent API.
* @see Configuration#TERM_BUFFER_SPARSE_FILE_PROP_NAME
*/
public Context termBufferSparseFile(final boolean termBufferSparseFile)
{
this.termBufferSparseFile = termBufferSparseFile;
return this;
}
/**
* Length of the {@link RingBuffer} for sending commands to the driver conductor from clients.
*
* @return length of the {@link RingBuffer} for sending commands to the driver conductor from clients.
* @see Configuration#CONDUCTOR_BUFFER_LENGTH_PROP_NAME
*/
@Config
public int conductorBufferLength()
{
return conductorBufferLength;
}
/**
* Length of the {@link RingBuffer} for sending commands to the driver conductor from clients.
*
* @param length of the {@link RingBuffer} for sending commands to the driver conductor from clients.
* @return this for a fluent API.
* @see Configuration#CONDUCTOR_BUFFER_LENGTH_PROP_NAME
*/
public Context conductorBufferLength(final int length)
{
conductorBufferLength = length;
return this;
}
/**
* Length of the {@link BroadcastTransmitter} buffer for sending events to the clients.
*
* @return length of the {@link BroadcastTransmitter} buffer for sending events to the clients.
* @see Configuration#TO_CLIENTS_BUFFER_LENGTH_PROP_NAME
*/
@Config
public int toClientsBufferLength()
{
return toClientsBufferLength;
}
/**
* Length of the {@link BroadcastTransmitter} buffer for sending events to the clients.
*
* @param length of the {@link BroadcastTransmitter} buffer for sending events to the clients.
* @return this for a fluent API.
* @see Configuration#TO_CLIENTS_BUFFER_LENGTH_PROP_NAME
*/
public Context toClientsBufferLength(final int length)
{
toClientsBufferLength = length;
return this;
}
/**
* Length of the buffer for storing values by the {@link CountersManager}.
*
* @return length of the buffer for storing values by the {@link CountersManager}.
* @see Configuration#COUNTERS_VALUES_BUFFER_LENGTH_PROP_NAME
*/
@Config(id = "COUNTERS_VALUES_BUFFER_LENGTH")
public int counterValuesBufferLength()
{
return counterValuesBufferLength;
}
/**
* Length of the buffer for storing values by the {@link CountersManager}.
*
* @param length of the buffer for storing values by the {@link CountersManager}.
* @return this for a fluent API.
* @see Configuration#COUNTERS_VALUES_BUFFER_LENGTH_PROP_NAME
*/
public Context counterValuesBufferLength(final int length)
{
counterValuesBufferLength = length;
return this;
}
/**
* Length of the {@link DistinctErrorLog} buffer for recording exceptions.
*
* @return length of the {@link DistinctErrorLog} buffer for recording exceptions.
* @see Configuration#ERROR_BUFFER_LENGTH_PROP_NAME
*/
@Config
public int errorBufferLength()