This file is indexed.

/usr/share/perl5/MCE/Relay.pm is in libmce-perl 1.810-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
###############################################################################
## ----------------------------------------------------------------------------
## Extends Many-Core Engine with relay capabilities.
##
###############################################################################

package MCE::Relay;

use strict;
use warnings;

no warnings qw( threads recursion uninitialized );

our $VERSION = '1.810';

## no critic (Subroutines::ProhibitSubroutinePrototypes)

use bytes;

use constant {
   OUTPUT_W_RLA => 'W~RLA',  # Worker has relayed
};

###############################################################################
## ----------------------------------------------------------------------------
## Import routine.
##
###############################################################################

my $LF = "\012";  Internals::SvREADONLY($LF, 1);
my $_imported;

sub import {

   my $_class = shift; return if ($_imported++);

   if (defined $MCE::VERSION) {
      _mce_m_init();
   }
   else {
      $\ = undef; require Carp;
      Carp::croak(
         "MCE::Relay cannot be used directly. Please consult the MCE::Relay\n".
         "documentation for more information.\n\n"
      );
   }

   return;
}

###############################################################################
## ----------------------------------------------------------------------------
## Output routines for the manager process.
##
###############################################################################

{
   my ($_MCE, $_DAU_R_SOCK_REF, $_DAU_R_SOCK, $_rla_nextid, $_max_workers);

   my %_output_function = (

      OUTPUT_W_RLA.$LF => sub {                   # Worker has relayed

       # $_DAU_R_SOCK = ${ $_DAU_R_SOCK_REF };

         $_rla_nextid = 0 if ( ++$_rla_nextid == $_max_workers );

         return;
      },

   );

   sub _mce_m_loop_begin {

      ($_MCE, $_DAU_R_SOCK_REF) = @_;

      my $_caller = $_MCE->{_caller};

      $_max_workers = (exists $_MCE->{user_tasks})
         ? $_MCE->{user_tasks}[0]{max_workers}
         : $_MCE->{max_workers};

      ## Write initial relay data.
      if (defined $_MCE->{init_relay}) {
         my $_ref = ref $_MCE->{init_relay};

         MCE::_croak("MCE::Relay: (init_relay) is not valid")
            if ($_ref ne '' && $_ref ne 'HASH' && $_ref ne 'ARRAY');

         my $_RLA_W_SOCK = $_MCE->{_rla_w_sock}->[0];
         my $_init_relay;

         if (ref $_MCE->{init_relay} eq '') {
            $_init_relay = $_MCE->{init_relay} . '0';
         }
         elsif (ref $_MCE->{init_relay} eq 'HASH') {
            $_init_relay = $_MCE->{freeze}($_MCE->{init_relay}) . '1';
         }
         elsif (ref $_MCE->{init_relay} eq 'ARRAY') {
            $_init_relay = $_MCE->{freeze}($_MCE->{init_relay}) . '2';
         }

         print {$_RLA_W_SOCK} length($_init_relay) . $LF . $_init_relay;

         $_rla_nextid = 0;
      }

      delete $MCE::RLA->{$_caller};

      return;
   }

   sub _mce_m_loop_end {

      ## Obtain final relay data.
      if (defined $_MCE->{init_relay}) {
         my $_RLA_R_SOCK = $_MCE->{_rla_r_sock}->[$_rla_nextid];
         my ($_caller, $_len, $_ret) = ($_MCE->{_caller});

         chomp($_len = <$_RLA_R_SOCK>);
         read $_RLA_R_SOCK, $_ret, $_len;

         if (chop $_ret) {
            $MCE::RLA->{$_caller} = $_MCE->{thaw}($_ret);
         } else {
            $MCE::RLA->{$_caller} = $_ret;
         }
      }

      ## Clear variables.
      $_MCE = $_DAU_R_SOCK_REF = $_DAU_R_SOCK = undef;
      $_rla_nextid = $_max_workers = undef;

      return;
   }

   sub _mce_m_init {

      MCE::_attach_plugin(
         \%_output_function, \&_mce_m_loop_begin, \&_mce_m_loop_end
      );

      return;
   }
}

###############################################################################
## ----------------------------------------------------------------------------
## Relay methods.
##
###############################################################################

## Items below are folded into MCE.

package # hide from rpm
   MCE;

no warnings 'threads';
no warnings 'recursion';
no warnings 'uninitialized';

use Scalar::Util qw( weaken );
use bytes;

no warnings 'redefine';

sub relay_final {

   my $x = shift; my $self = ref($x) ? $x : $MCE::MCE;

   _croak('MCE::relay_final: method is not allowed by the worker process')
      if ($self->{_wid});

   my $_caller = caller;

   if (exists $MCE::RLA->{$_caller}) {
      if (ref $MCE::RLA->{$_caller} eq '') {
         return delete $MCE::RLA->{$_caller};
      }
      elsif (ref $MCE::RLA->{$_caller} eq 'HASH') {
         return %{ delete $MCE::RLA->{$_caller} };
      }
      elsif (ref $MCE::RLA->{$_caller} eq 'ARRAY') {
         return @{ delete $MCE::RLA->{$_caller} };
      }

      # should not reach the following line
      delete $MCE::RLA->{$_caller};
   }

   return;
}

sub relay_recv {

   my $x = shift; my $self = ref($x) ? $x : $MCE::MCE;

   _croak('MCE::relay_recv: (init_relay) is not specified')
      unless (defined $self->{init_relay});
   _croak('MCE::relay_recv: method is not allowed by the manager process')
      unless ($self->{_wid});
   _croak('MCE::relay_recv: method is not allowed by task_id > 0')
      if ($self->{_task_id} > 0);

   my ($_chn, $_nxt, $_rdr, $_len, $_ref); local $_;

   $_chn = $self->{_chunk_id} || $self->{_wid};
   $_chn = ($_chn - 1) % $self->{max_workers};
   $_nxt = $_chn + 1;
   $_nxt = 0 if ($_nxt == $self->{max_workers});
   $_rdr = $self->{_rla_r_sock}->[$_chn];

   print {$self->{_dat_w_sock}->[0]} OUTPUT_W_RLA.$LF . '0'.$LF;

   chomp($_len = <$_rdr>);
   read $_rdr, $_, $_len;
   $_ref = chop $_;

   if ($_ref == 0) {                                 ## scalar value
      $self->{_rla_data} = $_;
      return unless defined wantarray;
      return $self->{_rla_data};
   }
   elsif ($_ref == 1) {                              ## hash reference
      $self->{_rla_data} = $self->{thaw}($_);
      return unless defined wantarray;
      return %{ $self->{_rla_data} };
   }
   elsif ($_ref == 2) {                              ## array reference
      $self->{_rla_data} = $self->{thaw}($_);
      return unless defined wantarray;
      return @{ $self->{_rla_data} };
   }

   return;
}

sub relay (;&) {

   my ($self, $_code);

   if (ref $_[0] eq 'CODE') {
      ($self, $_code) = ($MCE::MCE, shift);
   } else {
      my $x = shift; $self = ref($x) ? $x : $MCE::MCE;
      $_code = shift;
   }

   _croak('MCE::relay: (init_relay) is not specified')
      unless (defined $self->{init_relay});
   _croak('MCE::relay: method is not allowed by the manager process')
      unless ($self->{_wid});
   _croak('MCE::relay: method is not allowed by task_id > 0')
      if ($self->{_task_id} > 0);

   if (ref $_code ne 'CODE') {
      _croak('MCE::relay: argument is not a code block') if (defined $_code);
   } else {
      weaken $_code;
   }

   my ($_chn, $_nxt, $_rdr, $_wtr);

   $_chn = $self->{_chunk_id} || $self->{_wid};
   $_chn = ($_chn - 1) % $self->{max_workers};
   $_nxt = $_chn + 1;
   $_nxt = 0 if ($_nxt == $self->{max_workers});
   $_rdr = $self->{_rla_r_sock}->[$_chn];
   $_wtr = $self->{_rla_w_sock}->[$_nxt];

   if (exists $self->{_rla_data}) {
      local $_ = delete $self->{_rla_data};
      $_code->() if (ref $_code eq 'CODE');

      if (ref $_ eq '') {                         ## scalar value
         my $_tmp = $_ . '0';
         print {$_wtr} length($_tmp) . $LF . $_tmp;
      }
      elsif (ref $_ eq 'HASH') {                  ## hash reference
         my $_tmp = $self->{freeze}($_) . '1';
         print {$_wtr} length($_tmp) . $LF . $_tmp;
      }
      elsif (ref $_ eq 'ARRAY') {                 ## array reference
         my $_tmp = $self->{freeze}($_) . '2';
         print {$_wtr} length($_tmp) . $LF . $_tmp;
      }
   }
   else {
      my ($_len, $_ref); local $_;

      print {$self->{_dat_w_sock}->[0]} OUTPUT_W_RLA.$LF . '0'.$LF;

      chomp($_len = <$_rdr>);
      read $_rdr, $_, $_len;
      $_ref = chop $_;

      if ($_ref == 0) {                              ## scalar value
         my $_ret = $_;         $_code->() if (ref $_code eq 'CODE');
         my $_tmp = $_ . '0';
         print {$_wtr} length($_tmp) . $LF . $_tmp;
         return unless defined wantarray;
         return $_ret;
      }
      elsif ($_ref == 1) {                           ## hash reference
         my %_ret = %{ $self->{thaw}($_) };
         local $_ = { %_ret };  $_code->() if (ref $_code eq 'CODE');
         my $_tmp = $self->{freeze}($_) . '1';
         print {$_wtr} length($_tmp) . $LF . $_tmp;
         return unless defined wantarray;
         return %_ret;
      }
      elsif ($_ref == 2) {                           ## array reference
         my @_ret = @{ $self->{thaw}($_) };
         local $_ = [ @_ret ];  $_code->() if (ref $_code eq 'CODE');
         my $_tmp = $self->{freeze}($_) . '2';
         print {$_wtr} length($_tmp) . $LF . $_tmp;
         return unless defined wantarray;
         return @_ret;
      }
   }

   return;
}

## Aliases.

*relay_lock   = \&relay_recv;
*relay_unlock = \&relay;

1;

__END__

###############################################################################
## ----------------------------------------------------------------------------
## Module usage.
##
###############################################################################

=head1 NAME

MCE::Relay - Extends Many-Core Engine with relay capabilities

=head1 VERSION

This document describes MCE::Relay version 1.810

=head1 SYNOPSIS

   use MCE::Flow;

   my $file = shift || \*STDIN;

   ## Line Count #######################################

   mce_flow_f {
      max_workers => 4,
      use_slurpio => 1,
      init_relay  => 0,
   },
   sub {
      my ($mce, $slurp_ref, $chunk_id) = @_;
      my $line_count = ($$slurp_ref =~ tr/\n//);

      ## Receive and pass on updated information.
      my $lines_read = MCE::relay { $_ += $line_count };

   }, $file;

   my $total_lines = MCE->relay_final;

   print {*STDERR} "$total_lines\n";

   ## Orderly Action ###################################

   $| = 1; # Important, must flush output immediately.

   mce_flow_f {
      max_workers => 2,
      use_slurpio => 1,
      init_relay  => 0,
   },
   sub {
      my ($mce, $slurp_ref, $chunk_id) = @_;

      ## The relay value is relayed and remains 0.
      ## Writes to STDOUT orderly.

      MCE->relay_lock;
      print $$slurp_ref;
      MCE->relay_unlock;

   }, $file;

=head1 DESCRIPTION

This module enables workers to receive and pass on information orderly with
zero involvement by the manager process while running. The module is loaded
automatically when MCE option C<init_relay> is specified.

All workers (belonging to task_id 0) must participate when relaying data.

Relaying is not meant for passing big data. The last worker will stall if
exceeding the buffer size for the socket. Not exceeding 16 KiB - 7 is safe
across all platforms.

=head1 API DOCUMENTATION

=over 3

=item MCE->relay ( sub { code } )

=item MCE::relay { code }

Relay is enabled by specifying the init_relay option which takes a hash or array
reference, or a scalar value. Relaying is orderly and driven by chunk_id when
processing data, otherwise task_wid. Omitting the code block (e.g. MCE::relay)
relays forward.

Below, relaying multiple values via a HASH reference.

   use MCE::Flow max_workers => 4;

   mce_flow {
      init_relay => { p => 0, e => 0 },
   },
   sub {
      my $wid = MCE->wid;

      ## do work
      my $pass = $wid % 3;
      my $errs = $wid % 2;

      ## relay
      my %last_rpt = MCE::relay { $_->{p} += $pass; $_->{e} += $errs };

      MCE->print("$wid: passed $pass, errors $errs\n");

      return;
   };

   my %results = MCE->relay_final;

   print "   passed $results{p}, errors $results{e} final\n\n";

   -- Output

   1: passed 1, errors 1
   2: passed 2, errors 0
   3: passed 0, errors 1
   4: passed 1, errors 0
      passed 4, errors 2 final

Or multiple values via an ARRAY reference.

   use MCE::Flow max_workers => 4;

   mce_flow {
      init_relay => [ 0, 0 ],
   },
   sub {
      my $wid = MCE->wid;

      ## do work
      my $pass = $wid % 3;
      my $errs = $wid % 2;

      ## relay
      my @last_rpt = MCE::relay { $_->[0] += $pass; $_->[1] += $errs };

      MCE->print("$wid: passed $pass, errors $errs\n");

      return;
   };

   my ($pass, $errs) = MCE->relay_final;

   print "   passed $pass, errors $errs final\n\n";

   -- Output

   1: passed 1, errors 1
   2: passed 2, errors 0
   3: passed 0, errors 1
   4: passed 1, errors 0
      passed 4, errors 2 final

Or simply a scalar value.

   use MCE::Flow max_workers => 4;

   mce_flow {
      init_relay => 0,
   },
   sub {
      my $wid = MCE->wid;

      ## do work
      my $bytes_read = 1000 + ((MCE->wid % 3) * 3);

      ## relay
      my $last_offset = MCE::relay { $_ += $bytes_read };

      ## output
      MCE->print("$wid: $bytes_read\n");

      return;
   };

   my $total = MCE->relay_final;

   print "   $total size\n\n";

   -- Output

   1: 1003
   2: 1006
   3: 1000
   4: 1003
      4012 size

=item MCE->relay_final ( void )

Call this method to obtain the final relay value(s) after running. See included
example findnull.pl for another use case.

   use MCE max_workers => 4;

   my $mce = MCE->new(
      init_relay => [ 0, 100 ],       ## initial values (two counters)

      user_func => sub {
         my ($mce) = @_;

         ## do work
         my ($acc1, $acc2) = (10, 20);

         ## relay to next worker
         MCE::relay { $_->[0] += $acc1; $_->[1] += $acc2 };

         return;
      }
   )->run;

   my ($cnt1, $cnt2) = $mce->relay_final;

   print "$cnt1 : $cnt2\n";

   -- Output

   40 : 180

=item MCE->relay_recv ( void )

Call this method to obtain the next relay value before relaying. This allows
serial-code to be processed orderly between workers. The following is a parallel
demonstration for the fasta-benchmark on the web.

   # perl fasta.pl 25000000

   # The Computer Language Benchmarks game
   # http://benchmarksgame.alioth.debian.org/
   #
   # contributed by Barry Walsh
   # port of fasta.rb #6
   #
   # MCE::Flow version by Mario Roy
   # requires MCE 1.807+
   # requires MCE::Shared 1.806+

   use strict;
   use warnings;
   use feature 'say';

   use MCE::Flow;
   use MCE::Shared;
   use MCE::Candy;

   use constant IM => 139968;
   use constant IA => 3877;
   use constant IC => 29573;

   my $LAST = MCE::Shared->scalar( 42 );

   my $alu =
      'GGCCGGGCGCGGTGGCTCACGCCTGTAATCCCAGCACTTTGG' .
      'GAGGCCGAGGCGGGCGGATCACCTGAGGTCAGGAGTTCGAGA' .
      'CCAGCCTGGCCAACATGGTGAAACCCCGTCTCTACTAAAAAT' .
      'ACAAAAATTAGCCGGGCGTGGTGGCGCGCGCCTGTAATCCCA' .
      'GCTACTCGGGAGGCTGAGGCAGGAGAATCGCTTGAACCCGGG' .
      'AGGCGGAGGTTGCAGTGAGCCGAGATCGCGCCACTGCACTCC' .
      'AGCCTGGGCGACAGAGCGAGACTCCGTCTCAAAAA';

   my $iub = [
      [ 'a', 0.27 ], [ 'c', 0.12 ], [ 'g', 0.12 ],
      [ 't', 0.27 ], [ 'B', 0.02 ], [ 'D', 0.02 ],
      [ 'H', 0.02 ], [ 'K', 0.02 ], [ 'M', 0.02 ],
      [ 'N', 0.02 ], [ 'R', 0.02 ], [ 'S', 0.02 ],
      [ 'V', 0.02 ], [ 'W', 0.02 ], [ 'Y', 0.02 ]
   ];

   my $homosapiens = [
      [ 'a', 0.3029549426680 ],
      [ 'c', 0.1979883004921 ],
      [ 'g', 0.1975473066391 ],
      [ 't', 0.3015094502008 ]
   ];

   sub make_repeat_fasta {
      my ( $src, $n ) = @_;
      my $width = qr/(.{1,60})/;
      my $l     = length $src;
      my $s     = $src x ( ($n / $l) + 1 );
      substr( $s, $n, $l ) = '';

      while ( $s =~ m/$width/g ) { say $1 }
   }

   sub make_random_fasta {
      my ( $table, $n ) = @_;
      my $rand   = undef;
      my $width  = 60;
      my $prob   = 0.0;
      my $output = '';
      my ( $c1, $c2, $last );

      $_->[1] = ( $prob += $_->[1] ) for @$table;

      $c1  = '$rand = ( $last = ( $last * IA + IC ) % IM ) / IM;';
      $c1 .= "\$output .= '$_->[0]', next if $_->[1] > \$rand;\n" for @$table;

      my $seq = MCE::Shared->sequence(
         { chunk_size => 2000, bounds_only => 1 },
         1, $n / $width
      );

      my $code1 = q{
         while ( 1 ) {
            # --------------------------------------------
            # Process code orderly between workers.
            # --------------------------------------------

            my $chunk_id = MCE->relay_recv;
            my ( $begin, $end ) = $seq->next;

            MCE->relay, last if ( !defined $begin );

            my $last = $LAST->get;
            my $temp = $last;

            # Pre-compute $LAST value for the next worker
            for ( 1 .. ( $end - $begin + 1 ) * $width ) {
               $temp = ( $temp * IA + IC ) % IM;
            }

            $LAST->set( $temp );

            # Increment chunk_id value
            MCE->relay( sub { $_ += 1 } );

            # --------------------------------------------
            # Also run code in parallel between workers.
            # --------------------------------------------

            for ( $begin .. $end ) {
               for ( 1 .. $width ) { !C! }
               $output .= "\n";
            }

            # --------------------------------------------
            # Display orderly.
            # --------------------------------------------

            MCE->gather( $chunk_id, $output );

            $output = '';
         }
      };

      $code1 =~ s/!C!/$c1/g;

      MCE::Flow->init(
         max_workers => 4, ## MCE::Util->get_ncpu || 4,
         gather      => MCE::Candy::out_iter_fh( \*STDOUT ),
         init_relay  => 1,
         use_threads => 0,
      );

      MCE::Flow->run( sub { eval $code1 } );
      MCE::Flow->finish;

      $last = $LAST->get;

      $c2  = '$rand = ( $last = ( $last * IA + IC ) % IM ) / IM;';
      $c2 .= "print('$_->[0]'), next if $_->[1] > \$rand;\n" for @$table;

      my $code2 = q{
         if ( $n % $width != 0 ) {
            for ( 1 .. $n % $width ) { !C! }
            print "\n";
         }
      };

      $code2 =~ s/!C!/$c2/g;
      eval $code2;

      $LAST->set( $last );
   }

   my $n = $ARGV[0] || 27;

   say ">ONE Homo sapiens alu";
   make_repeat_fasta( $alu, $n * 2 );

   say ">TWO IUB ambiguity codes";
   make_random_fasta( $iub, $n * 3 );

   say ">THREE Homo sapiens frequency";
   make_random_fasta( $homosapiens, $n * 5 );

=item MCE->relay_lock ( void )

=item MCE->relay_unlock ( void )

The C<relay_lock> and C<relay_unlock> methods, added to MCE 1.807, are
aliases for C<relay_recv> and C<relay> respectively. They allow one to
perform an exclusive action prior to actual relaying of data.

Below, C<user_func> is taken from the C<cat.pl> MCE example. Relaying is
driven by C<chunk_id> or C<task_wid> when not processing input, thus
occurs orderly.

   user_func => sub {
      my ($mce, $chunk_ref, $chunk_id) = @_;

      if ($n_flag) {
         ## Relays the total lines read.

         my $output = ''; my $line_count = ($$chunk_ref =~ tr/\n//);
         my $lines_read = MCE::relay { $_ += $line_count };

         open my $fh, '<', $chunk_ref;
         $output .= sprintf "%6d\t%s", ++$lines_read, $_ while (<$fh>);
         close $fh;

         $output .= ":$chunk_id";
         MCE->do('display_chunk', $output);
      }
      else {
         ## The following is another way to have ordered output. Workers
         ## write directly to STDOUT exclusively without any involvement
         ## from the manager process. The statement(s) between relay_lock
         ## and relay_unlock run serially and most important orderly.

         MCE->relay_lock;      # alias for MCE->relay_recv

         print $$chunk_ref;    # ensure $| = 1 in script

         MCE->relay_unlock;    # alias for MCE->relay
      }

      return;
   }

The following is a variant of the fasta-benchmark demonstration shown above.
Here, workers write exclusively and orderly to C<STDOUT>.

   # perl fasta.pl 25000000

   # The Computer Language Benchmarks game
   # http://benchmarksgame.alioth.debian.org/
   #
   # contributed by Barry Walsh
   # port of fasta.rb #6
   #
   # MCE::Flow version by Mario Roy
   # requires MCE 1.807+
   # requires MCE::Shared 1.806+

   use strict;
   use warnings;
   use feature 'say';

   use MCE::Flow;
   use MCE::Shared;

   use constant IM => 139968;
   use constant IA => 3877;
   use constant IC => 29573;

   my $LAST = MCE::Shared->scalar( 42 );

   my $alu =
      'GGCCGGGCGCGGTGGCTCACGCCTGTAATCCCAGCACTTTGG' .
      'GAGGCCGAGGCGGGCGGATCACCTGAGGTCAGGAGTTCGAGA' .
      'CCAGCCTGGCCAACATGGTGAAACCCCGTCTCTACTAAAAAT' .
      'ACAAAAATTAGCCGGGCGTGGTGGCGCGCGCCTGTAATCCCA' .
      'GCTACTCGGGAGGCTGAGGCAGGAGAATCGCTTGAACCCGGG' .
      'AGGCGGAGGTTGCAGTGAGCCGAGATCGCGCCACTGCACTCC' .
      'AGCCTGGGCGACAGAGCGAGACTCCGTCTCAAAAA';

   my $iub = [
      [ 'a', 0.27 ], [ 'c', 0.12 ], [ 'g', 0.12 ],
      [ 't', 0.27 ], [ 'B', 0.02 ], [ 'D', 0.02 ],
      [ 'H', 0.02 ], [ 'K', 0.02 ], [ 'M', 0.02 ],
      [ 'N', 0.02 ], [ 'R', 0.02 ], [ 'S', 0.02 ],
      [ 'V', 0.02 ], [ 'W', 0.02 ], [ 'Y', 0.02 ]
   ];

   my $homosapiens = [
      [ 'a', 0.3029549426680 ],
      [ 'c', 0.1979883004921 ],
      [ 'g', 0.1975473066391 ],
      [ 't', 0.3015094502008 ]
   ];

   sub make_repeat_fasta {
      my ( $src, $n ) = @_;
      my $width = qr/(.{1,60})/;
      my $l     = length $src;
      my $s     = $src x ( ($n / $l) + 1 );
      substr( $s, $n, $l ) = '';

      while ( $s =~ m/$width/g ) { say $1 }
   }

   sub make_random_fasta {
      my ( $table, $n ) = @_;
      my $rand   = undef;
      my $width  = 60;
      my $prob   = 0.0;
      my $output = '';
      my ( $c1, $c2, $last );

      $_->[1] = ( $prob += $_->[1] ) for @$table;

      $c1  = '$rand = ( $last = ( $last * IA + IC ) % IM ) / IM;';
      $c1 .= "\$output .= '$_->[0]', next if $_->[1] > \$rand;\n" for @$table;

      my $seq = MCE::Shared->sequence(
         { chunk_size => 2000, bounds_only => 1 },
         1, $n / $width
      );

      my $code1 = q{
         $| = 1; # Important, must flush output immediately.

         while ( 1 ) {
            # --------------------------------------------
            # Process code orderly between workers.
            # --------------------------------------------

            MCE->relay_lock;

            my ( $begin, $end ) = $seq->next;
            print( $output ), $output = '' if ( length $output );

            MCE->relay_unlock, last if ( !defined $begin );

            my $last = $LAST->get;
            my $temp = $last;

            # Pre-compute $LAST value for the next worker
            for ( 1 .. ( $end - $begin + 1 ) * $width ) {
               $temp = ( $temp * IA + IC ) % IM;
            }

            $LAST->set( $temp );

            MCE->relay_unlock;

            # --------------------------------------------
            # Also run code in parallel.
            # --------------------------------------------

            for ( $begin .. $end ) {
               for ( 1 .. $width ) { !C! }
               $output .= "\n";
            }
         }
      };

      $code1 =~ s/!C!/$c1/g;

      MCE::Flow->init(
         max_workers => 4, ## MCE::Util->get_ncpu || 4,
         init_relay  => 0,
         use_threads => 0,
      );

      MCE::Flow->run( sub { eval $code1 } );
      MCE::Flow->finish;

      $last = $LAST->get;

      $c2  = '$rand = ( $last = ( $last * IA + IC ) % IM ) / IM;';
      $c2 .= "print('$_->[0]'), next if $_->[1] > \$rand;\n" for @$table;

      my $code2 = q{
         if ( $n % $width != 0 ) {
            for ( 1 .. $n % $width ) { !C! }
            print "\n";
         }
      };

      $code2 =~ s/!C!/$c2/g;
      eval $code2;

      $LAST->set( $last );
   }

   my $n = $ARGV[0] || 27;

   say ">ONE Homo sapiens alu";
   make_repeat_fasta( $alu, $n * 2 );

   say ">TWO IUB ambiguity codes";
   make_random_fasta( $iub, $n * 3 );

   say ">THREE Homo sapiens frequency";
   make_random_fasta( $homosapiens, $n * 5 );

=back

=head1 INDEX

L<MCE|MCE>, L<MCE::Core>

=head1 AUTHOR

Mario E. Roy, S<E<lt>marioeroy AT gmail DOT comE<gt>>

=cut