initpattern.pl

#!/usr/bin/perl -w

print "WARNING: This tool writes a pattern to a disk/card and thereby OVERWRITES the whole disk/card. Only use it on donors. Do not use it if you are not sure what you are doing!\n";

if(!scalar(@ARGV))
{
  print "$0 generates a pattern and writes it directly to a device or to a dumpfile with a given size.\n";
  print "Usage: $0 <device>\n";
  print "Usage: $0 <dumpfile> <size in MB> <data area size>\n";
  exit;
}

my $mydev=($ARGV[0] || "/dev/sdx");
my $xmlfn=$mydev.".xml"; $xmlfn=~s/\//_/g;


if(!-w $mydev)
{
  die "Cannot open device/file $mydev for writing!\n";
}

open $OUT,">:raw",$mydev;
if(!defined($OUT))
{
  die "Could not open device/file $mydev for writing: $!\n";
}

my $DATAsize=$ARGV[2] || 8192;
my $eccreal=($DATAsize/512)+1;
my $majority=7;

my $border0=512*1024*2; # 512MB pattern
my $border7=1024*1024*2; # 512MB 00
my $borderf=1280*1024*2; # 256 MB 77
my $borderphi=1536*1024*2; # 256 MB FF
my $borderecc=$borderphi+$eccreal*$eccreal*$majority*$DATAsize*8+1; # lots of ECC (for 512B DA we dont need much, for 4KB we need 11 GB)
# And at the end we have the pattern again

my $overwritten=1;
my $size=undef;

sub idema_gb2lba($) # ($GB)
{
  my $AdvertisedCapacity=$_[0];
  my $LBAcounts = (97696368) + (1953504 * ($AdvertisedCapacity - 50));
  return($LBAcounts);
}

if($ARGV[1])
{
  $size=idema_gb2lba($1)*512 if($ARGV[1]=~m/^(\d+)GB$/i);
  $size=$1*1024*1024 if($ARGV[1]=~m/^(\d+)$/i);
  if($size<$borderecc*512)
  {
    print "WARNING: Not all of the pattern will be in the dump! Enlarge the image size to at least ".int($borderecc/2/1024)." or change the image configuration\n";
    while($size<$borderecc*512)
    {
      $DATAsize>>=1;
      $borderecc=$borderphi+$eccreal*$eccreal*$majority*$DATAsize*8+1; # lots of ECC (for 512B DA we dont need much, for 4KB we need 11 GB)
    }
    print "Automatically changing the data area size to $DATAsize to fit into the device/image file.\n";
  }
  if(($DATAsize%512)>0)
  {
    print "ERROR: The datasize is not a multiple of 512 Bytes, please check the parameters!\n";
    exit(-1);
  }
  print "Size of the image file to be written: $size\n";
  $overwritten=0;
}
else
{
  seek($OUT,0,2);
  $size=tell($OUT);
  print "Size of the physical device to be written to: $size\n";
  seek($OUT,0,0);
  $overwritten=1;
}

if($size<$borderecc*512)
{
  print "WARNING: The pattern required for a data size of $DATAsize is too large to fit into this device/image and would be cut off! Enlarge the image size to at least ".int($borderecc/2/1024)." MB or change the pattern configuration\n";
  while($size<($borderecc<<9) && $DATAsize>512 && (($DATAsize%1024)==0))
  {
    $DATAsize/=2;
    $eccreal=($DATAsize/512)+1;
    $borderecc=$borderphi+$eccreal*$eccreal*$majority*$DATAsize*8+1;
    #print "Trying Datasize:$DATAsize borderecc:".(($borderecc<<9)/1000/1000) MB targetsize:".(($size/1000/1000))." MB\n";
  }
  print "We have automatically adjusted the DATA size to $DATAsize to fit into the device/image.\n";


  while($size<$borderecc*512)
  {
    $DATAsize>>=1;
    $borderecc=$borderphi+$eccreal*$eccreal*$majority*$DATAsize*8+1; # lots of ECC (for 512B DA we dont need much, for 4KB we need 11 GB)
  }
  print "Automatically changing the data area size to $DATAsize to fit into the device/image file.\n";
}




if(open XML,">$xmlfn")
{
  print XML "<root overwritten='$overwritten'>\n<device>$ARGV[0]</device>\n<pattern type='sectornumber' begin='0' end='".($border0-1)."' size='".($border0)."'/>\n<pattern type='XOR-00' begin='$border0' end='".($border7-1)."' size='".($border7-$border0)."'/>\n<pattern type='XOR-77' begin='$border7' end='".($borderf-1)."' size='".($borderf-$border7)."'/>\n<pattern type='XOR-FF' begin='$borderf' end='".($borderphi-1)."' size='".($borderphi-$borderf)."'/>\n<pattern type='ECC' begin='$borderphi' end='".($borderecc-1)."' size='".($borderecc-$borderphi)."' coverage='$DATAsize' majority='$majority'/>\n<pattern type='sectornumber' begin='$borderecc' end='".(int($size/512)-1)."' size='".(int($size/512)-$borderecc)."'/>\n</root>\n";
  close XML;
}
else
{
  print STDERR "Could not open $xmlfn for writing the XML configuration of the pattern: $!\n";
}

print "Size: $size Bytes ".($size/1000/1000/1000)." GB\n";
print "Creating a pattern for page size of $DATAsize Bytes.\n";
my $nblocks=$size/512;

system "date";

if($overwritten)
{
  print "First stage pattern for FTL recovery\n";
  foreach my $block (0 .. $size/512)
  {
    my $data=sprintf("|Block#%012d (0x%08X) Byte: %020d Pos: %10d MB\n***OVERWRITTEN",$block,$block,$block*512,$block>>11);
    $data.= "x"x(510-length($data))."\n\x00";
    if(length($data)!=512)
    {
      print STDERR "WARNING: sector size is wrong in overwritten\n";
    }
    print $OUT $data;
    if(!($block %1000000))
    {
      my $percent=int(100*$block/$nblocks);
      print STDERR "$block $percent\%\n";
    }
  }
  print "Second stage pattern for LDPC and XOR recovery\n";
  system "date";
}

print "Pos: ".tell($OUT)."\n";
print "Seeking: ".seek($OUT,0,0)."\n";
print "Pos: ".tell($OUT)."\n";

foreach my $block (0 .. $size/512)
{
  my $data="";
  
  if($block>=$border0 && $block<$border7)
  {
    $data="\x00" x 512;
  }
  elsif($block>=$border7 && $block<$borderf)
  {
    $data="\x77" x 512;
  }
  elsif($block>=$borderf && $block<$borderphi)
  {
    $data="\xFF" x 512;
  }
  else
  {
    $data=sprintf("|Block#%012d (0x%08X) Byte: %020d Pos: %10d MB\n***",$block,$block,$block*512,$block>>11);
    $data.= "x"x(510-length($data))."\n\x00";
  }

  if($block>=$borderphi && $block <$borderecc) # overrides $data where needed, but reuses $data in some cases
  {
    my $patternsize=$eccreal*$eccreal*$majority;
    my $offset=$block-$borderphi;
    my $pattern=int($offset/$patternsize); # 0 .. DATAsize*8
    my $patternpos=$offset % $eccreal;
    my $patternmod=int(($offset % ($eccreal*$eccreal))/$eccreal);
    my $bittargetsector=($pattern>>3) >>9;
    #print "\npatternsize: $patternsize\noffset: $offset\npattern: $pattern\npatternpos: $patternpos\nbittargetsector: $bittargetsector\n";
    if($patternpos>0)
    {
      $data=sprintf("P%011X%04X",$pattern,$patternpos) x (512/16); # "\x00" x 512; #"0123456789abcdef"x(512/16);
      if(length($data)!=512)
      {
        print STDERR "WARNING: sector size is wrong in new LDPC pattern at block $block\n";
      }
      if($bittargetsector==($patternpos-1) && ($patternmod&1))
      {
        my $bittargetbyte=($pattern>>3) & 0x1FF;
        my $bittargetbit=$pattern&7;
	#print "bittargetbyte: $bittargetbyte\nbittargetbit: $bittargetbit\n";
        substr($data,$bittargetbyte,1)=substr($data,$bittargetbyte,1)^pack("C",(1<<$bittargetbit));
      }
      if(length($data)!=512)
      {
        print STDERR "WARNING: sector size is wrong in new LDPC pattern after bit change at block $block\n";
      }

    }
  }

  if(length($data)!=512)
  {
    print STDERR "WARNING: sector size is wrong in new pattern at block $block\n";
  }
  print $OUT $data;
  if(!($block %1000000))
  {
    my $percent=int(100*$block/$nblocks);
    print STDERR "$block $percent\%\n";
  }
}

close $OUT;
system "sync";
print STDERR "Pattern has been written to device/file $mydev\n";
print STDERR "Pattern configuration has been written to the file $xmlfn in XML format.\n";
print STDERR "You can now write the pattern image to the disk/pendrive/car with dd, balenaEtcher or PC3K, or use it in the controllersim.\n";
print STDERR "Done.\n";
system "date";