-
Notifications
You must be signed in to change notification settings - Fork 6
/
parsyncfp2-manual.html
1812 lines (1720 loc) · 64.5 KB
/
parsyncfp2-manual.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="generator" content="AsciiDoc 10.1.2">
<title>parsyncfp2, a Single- or Multi-Host parallel rsync wrapper</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
/* Default font. */
body {
font-family: Georgia,serif;
}
/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
font-family: Arial,Helvetica,sans-serif;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
h5 {
font-size: 1.0em;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
.monospaced, code, pre {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
padding: 0;
margin: 0;
}
pre {
white-space: pre-wrap;
}
#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}
#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
#footer-text {
float: left;
padding-bottom: 0.5em;
}
#footer-badges {
float: right;
padding-bottom: 0.5em;
}
#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #888;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
#footer-badges { display: none; }
}
#toc {
margin-bottom: 2.5em;
}
#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
div.unbreakable { page-break-inside: avoid; }
/*
* xhtml11 specific
*
* */
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
/*
* html5 specific
*
* */
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
thead, p.tableblock.header {
font-weight: bold;
color: #527bbd;
}
p.tableblock {
margin-top: 0;
}
table.tableblock {
border-width: 3px;
border-spacing: 0px;
border-style: solid;
border-color: #527bbd;
border-collapse: collapse;
}
th.tableblock, td.tableblock {
border-width: 1px;
padding: 4px;
border-style: solid;
border-color: #527bbd;
}
table.tableblock.frame-topbot {
border-left-style: hidden;
border-right-style: hidden;
}
table.tableblock.frame-sides {
border-top-style: hidden;
border-bottom-style: hidden;
}
table.tableblock.frame-none {
border-style: hidden;
}
th.tableblock.halign-left, td.tableblock.halign-left {
text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
th.tableblock.valign-top, td.tableblock.valign-top {
vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
vertical-align: bottom;
}
/*
* manpage specific
*
* */
body.manpage h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
body.manpage h2 {
border-style: none;
}
body.manpage div.sectionbody {
margin-left: 3em;
}
@media print {
body.manpage div#toc { display: none; }
}
@media screen {
body {
max-width: 50em; /* approximately 80 characters wide */
margin-left: 16em;
}
#toc {
position: fixed;
top: 0;
left: 0;
bottom: 0;
width: 13em;
padding: 0.5em;
padding-bottom: 1.5em;
margin: 0;
overflow: auto;
border-right: 3px solid #f8f8f8;
background-color: white;
}
#toc .toclevel1 {
margin-top: 0.5em;
}
#toc .toclevel2 {
margin-top: 0.25em;
display: list-item;
color: #aaaaaa;
}
#toctitle {
margin-top: 0.5em;
}
}
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install(3);
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>parsyncfp2, a Single- or Multi-Host parallel rsync wrapper</h1>
<span id="author">Harry Mangalam</span><br>
<span id="email" class="monospaced"><<a href="mailto:harry.mangalam@uci.edu">harry.mangalam@uci.edu</a>></span><br>
<span id="revnumber">version 2.59,</span>
<span id="revdate">Mar 23, 2023</span>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_preamble">1. Preamble</h2>
<div class="sectionbody">
<div class="paragraph"><p><em>parsyncfp2</em> intially started as a one-off bash script and moved to Perl (as <em>parsync</em>) when
that became too cumbersome.
I incorporated <a href="https://www.fpart.org/">fpart</a> and it became <em>parsyncfp</em>, running on a single host, transmitting to a single rsync receiver host.
This MultiHost (MH) version allows it to run over multiple SEND hosts with shared storage to cooperatively
send data much faster. It still runs on a SingleHost and with a 64core AMD CPU, will happily saturate a 100Gbs pipe. In MultiHost mode, it can also send data to multiple storage endpoints simultaneously, as well as the same shared endpoint via multiple hosts.</p></div>
<div class="paragraph"><p>Rather than appending yet more acronymic characters to the name, I differentiated it with the major version number, so … <em>parsyncfp2</em> or <em>pfp2</em>. In the docs and
src code, you may still find references to <em>parsync</em>, <em>parsyncfp</em>, as well as various abbriev’s (why does <em>abbrieviation</em> need one?).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_introduction">2. Introduction</h2>
<div class="sectionbody">
<div class="paragraph"><p><em>parsyncfp2</em> (<em>pfp2</em>) is a Perl script that wraps Andrew Tridgell’s & Paul Mackerras' miraculous
<a href="https://en.wikipedia.org/wiki/Rsync">rsync</a> to provide load balancing and parallel operation across
network connections to substantially increase the amount of data it can send simultaneously.
<em>pfp2</em> exploits parallel operation to decrease the impact of the <a href="https://en.wikipedia.org/wiki/Round-trip_delay">TCP Round Trip Time(rtt)</a> to significantly increase the total bandwidth of data across networks. For more information about the variables surrounding data transfer over networks, see
<a href="https://tinyurl.com/yf33y6wg">How to Move Data</a>. Even on low-latency networks, it can speed large transfers by 4-10x. However it is not effective for small transfers, since the startup overhead will slow the effective throughput.</p></div>
<div class="sect2">
<h3 id="_general_features">2.1. General Features</h3>
<div class="paragraph"><p>Versions <2 allowed the SingleHost (SH) version to use 10s to 100s of rsyncs to increase
aggregate bandwidth. Versions >2 allow MultiHost (MH) send & receive to increase bandwidth
saturation to both regular rsync connections as well as rsyncd servers. This allows the
traffic to be split out to servers on different networks as well as sending to multiple
filesystems on the receiving end (tho the split dirs would then have to be re-combined).</p></div>
<div class="paragraph"><p><em>pfp2</em> uses Ganael Laplanche’s excellent <a href="http://goo.gl/K1WwtD">fpart</a> to dynamically create <em>chunkfiles</em> for rsync
to read, bypassing the need to wait for rsync’s complete recursive scan. ie, it
starts the transfer almost immediately, as soon as the first chunk is written.
For large, deep trees, this can be quite useful.
Also see the <a href="#filesfrom">filesfrom</a> options below. <em>pfp2</em> also allows huge transfers to take place without the memory overflow sometimes seen with using a single rsync, due to splitting the memory required over many smaller rsync instances.</p></div>
<div class="paragraph"><p>In both SH and MH, <em>pfp2</em> monitors the system <a href="https://www.howtogeek.com/194642/understanding-the-load-average-on-linux-and-other-unix-like-systems/">loadavg</a>. It will suspend spawned rsyncs until the 1m load decreases below the cutoff, then UNsuspend them as the load decreases below it.</p></div>
<div class="paragraph"><p>In the SH version, suspending the parent <em>pfp2</em> (with Ctrl+Z) will suspend all rsync children, regardless of current state. Similarly, if you kill the parent <em>pfp2</em> (Ctrl+C), all the children rsyncs will die with various cries of distress, depending on their states. In the MH version, the spawned rsyncs are running independently on separate hosts and can only be controlled by commands issued to that host. ie you have to <em>ssh</em> to the host and suspend or kill the processes separately. A version where the hosts communicate via sockets is in the works and a <em>killer</em> script <strong>pfp2stop</strong> is written out at each MH invocation, which will ssh to each of the SEND and REC hosts to kill off all the rsync and <em>pfp2</em> processes running.</p></div>
<div class="paragraph"><p><em>pfp2</em> can send files to any host with a standard rsync on the other end. In <em>normal</em>
client mode (the remote rsync starts up on demand via ssh) the target syntax
is either <em>host:/fully/qualified/path</em> or <em>host:path</em> (implying a dir off the
user’s HOME dir (specified in other apps as as <em>host:~/path</em>, but unacceptable to a native rsync).
<em>pfp2</em> can also send data to an <strong>rsyncd server</strong>. The rsyncd target syntax requires
a module name (<em>host::module</em>) and the user must be pre-registered
in the server’s <em>/etc/rsyncd.conf</em> and <em>/etc/rsyncd.secrets</em> file - see
<em>man rsyncd.conf</em>, unless the server is running without any kind of authentication.</p></div>
<div class="paragraph" id="introinterface"><p>Unless changed by <em>--interface</em>, <em>pfp2</em> assumes and monitors the routable interface.
The transfer will use whatever interface normal routing provides, normally
set by the name of the target. While rsync can be used for non-host-based
transfers (between mounted filesystems), it works less well than for strictly network-based
syncs. <em>pfp2</em> will honor requests to sync across local filesystems and shows low but significant speedup (2x-6x) on large transfers.</p></div>
<div class="paragraph"><p><em>pfp2</em> only works on dirs and files that originate from the current dir (or
specified via <em>--startdir</em>). You cannot include dirs and files from
discontinuous or higher-level dirs. <em>pfp2</em> also <em>does not</em> use rsync’s
sophisticated/idiosyncratic treatment of trailing ‘/s’ to direct where
files vs dirs are sent; dirs are treated as dirs regardless of the
trailing ‘/’.</p></div>
<div class="paragraph"><p><strong>The .pfp2 dir</strong> : (unless redirected to another dir via the <em>--altcache</em> option), this
contains the cache dir (<em>fpcache</em>, which is cleared
on each run), and the time-stamped rsync log files. These can accumulate
quickly since each rsync instance will leave a date-stamped log.
If you use the MH version, the .pfp2 dir is created in the common shared directory
(<em>--commondir</em>), and contains the (common) fpcache dir. The rsync logs are stored in the host-named subdirectories in the .pfp2 dir and are NOT deleted by the next <em>pfp2</em> run.</p></div>
<div class="paragraph"><p>If you use the MH version, the STDERR/STDOUT of the entire transfer
(the text that’s written to the screen) from each of the SEND hosts is captured in the
host-specific dir named <em>pfp2-log-(time)_(date)</em>.</p></div>
<div class="paragraph"><p>Due to the terminal text coloration, the pfp2-log files are
best viewed by cat’ing them to the terminal and then if necessary, copy-pasting them
from the terminal.</p></div>
<div class="paragraph"><p><strong>Odd characters in names</strong> : <em>pfp2</em> will refuse to transfer some
oddly named files (tho it should copy
filenames with spaces fine. Filenames with embedded newlines, DOS EOLs,
and some other odd chars will be recorded in the log files in the
<em>.pfp2</em> dir (see above).
You should be able to specify dirs and files in the <em>pfp2</em> command with either/both escaped spaces
or with quotes: "file\ with\ spaces" or ‘file with spaces’. Internal to pfp2, rsync rules prevail.</p></div>
</div>
<div class="sect2">
<h3 id="_release_license">2.2. Release License</h3>
<div class="paragraph"><p>parsyncfp2 is distributed under the Gnu Public License (GPL) v3.</p></div>
</div>
<div class="sect2">
<h3 id="installation">2.3. Installation</h3>
<div class="paragraph"><p>Installation of <em>parsyncfp2</em> is fairly simple. There’s not yet a deb or rpm package, but the bits to make it work that are not part of a fairly standard Linux distro are the Perl scripts <em>parsyncfp2</em>, <em>scut</em> (like <em>cut</em> but more flexible), and <em>stats</em> (spits out descriptive statistics of whatever semi-numeric stream is fed to it).
The rest of the dependents are listed here:</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>Debian/Ubuntu-like:</strong>
</p>
</li>
</ul></div>
<div class="literalblock">
<div class="content monospaced">
<pre>sudo apt install ethtool iproute2 fpart iw libstatistics-descriptive-perl infiniband-diags
git clone https://github.com/hjmangalam/parsyncfp2
cd parsyncfp2; cp parsyncfp2 scut stats ~/bin</pre>
</div></div>
<div class="ulist"><ul>
<li>
<p>
<strong>RHel/Centos/Rocky-like:</strong>
</p>
</li>
</ul></div>
<div class="literalblock">
<div class="content monospaced">
<pre> sudo yum install iw fpart ethtool iproute perl-Env.noarch \
perl-Statistics-Descriptive wireless-tools infiniband-diags
git clone https://github.com/hjmangalam/parsyncfp2
cd parsyncfp2; cp parsyncfp2 scut stats ~/bin</pre>
</div></div>
<div class="sect3">
<h4 id="requiredutils">2.3.1. Required utilities and packages</h4>
<div class="paragraph"><p>Should the above commands not fulfill the requirements or be missing from your set of repositories, the utilities are listed below.</p></div>
<div class="ulist"><ul>
<li>
<p>
ethtool - query or control network driver and hardware settings. Install via repository.
</p>
</li>
<li>
<p>
ip - show / manipulate routing, network devices, interfaces and tunnels. Install via repository.
</p>
</li>
<li>
<p>
fpart - Sort and pack files into partitions. Now in many distro repositories or install from: <a href="https://github.com/martymac/fpart">github</a>;
</p>
</li>
<li>
<p>
scut - a more intelligent cut. Included in the parsyncfp2 github
</p>
</li>
<li>
<p>
stats - calculate descriptive stats from STDIN. Included in the parsyncfp2 github
</p>
</li>
<li>
<p>
Perl::Descriptive-Statistics - basic descriptive statistical functions
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect2">
<h3 id="_recommended_utilities">2.4. Recommended Utilities</h3>
<div class="ulist"><ul>
<li>
<p>
iwconfig - configure a wireless network interface. Needed only for WiFi. Install via repository.
</p>
</li>
<li>
<p>
perfquery - query InfiniBand port counters. Needed only for InfiniBand. Install via repository.
</p>
</li>
</ul></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_options_in_detail">3. Options in detail</h2>
<div class="sectionbody">
<div class="paragraph"><p><em>pfp2</em> has a lot of options, but most are straightforward. The <a href="#multihostopts">MultiHost</a> and <a href="#filesfrom">FilesFrom</a> options require a little more description and are described in their own sections below.</p></div>
<div class="sect2">
<h3 id="_basic_options_for_both_sh_and_mh">3.1. Basic Options for both SH and MH</h3>
<div class="paragraph"><p>The only native rsync options that <em>pfp2</em> uses are <em>-a</em> (archive),
<em>-s</em> (protect-args), and <em>-l</em> (copy symlinks as symlinks).
If you need to pass more options to rsync, then it’s up to you to provide them ALL
via <em>--ro</em> and you must include the entire option string as rsync would see it
(--ro=<em>-slaz --times</em>)</p></div>
<div class="paragraph"><p>In the list <em>pfp2</em> options below, the brackets indicate:</p></div>
<div class="paragraph"><p><strong>[i]</strong> = integer number, <strong>[f]</strong> = floating point number, <strong>[s]</strong> = "quoted string", <strong>( )</strong> = the default if any</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>--NP|np</strong> [i] (sqrt(#CPUs))The number of rsync processes to start. The
optimal NP depends on many variables. Try the default and increase as needed. No point in using a high NP if your network won’t support it.
</p>
</li>
<li>
<p>
<strong>--altcache|ac</strong> [/path/to/dir] : The alternative cache dir for placing it on another FS
or for running multiple SH (not MH) <em>pfp2s</em> simultaneously
</p>
</li>
<li>
<p>
<strong>--startdir|sd</strong> [s] (<span class="monospaced">pwd</span>) : The top-level directory at which <em>pfp2</em> starts looking for files & dirs.
You can use globs/regexes with <em>--startdir</em>, but only if you’re at that
point in the dir tree. ie: if you’re not in the dir where the globs can be
expanded, then the glob will fail. However, explicit dirs can be set from
anywhere if given an existing dir with <em>--startdir</em>.
</p>
</li>
<li>
<p>
<strong>--maxbw</strong> [i] in KB/s (unlimited): <em>pfp2</em> appropriates rsync’s bandwidth throttle mechanism,
using <em>--maxbw</em> as a passthru to rsync’s <em>bwlimit</em> option, but divides it by the NP value so
as to keep the total bandwidth the same as the stated limit. It monitors and
shows <em>total</em> (not just pfp2’s) bandwidth thru the given interface.
</p>
</li>
<li>
<p>
<strong>--maxload|ml</strong> [f] (NP*2) : max system load - if 1m loadavg > maxload, 1 rsync
process will be suspended per <em>checkperiod</em> cycle until the loadavg decreases below the <em>maxload</em>.
At that point, the suspended rsyncs will be UNsuspended, one per <em>checkperiod</em>. rsync is very CPU-light;
running 6 rsyncs with compression (--ro=<em>-slaz</em>) causes an increase in loadavg of only about 1-2,
depending on the storage systems. This is handled independently on each of the SEND hosts.
</p>
</li>
<li>
<p>
<strong>--chunksize|cs</strong> [s] (10G) : aggregate size of files allocated to one rsync process.
Can specify in <em>human</em> terms [100M, 50K, 1T] as well as integer bytes. <em>pfp2</em> will warn once when/if
you exceed the WARN # of chunkfiles (2000) and abort if
you exceed the FATAL # of chunkfiles (5000). You CAN force
it to use very high numbers of chunkfiles by setting