ghc/driver/split/ghc-split.lprl

   1 %************************************************************************
   2 %*                                                                      *
   3 \section[Driver-obj-splitting]{Splitting into many \tr{.o} files (for libraries)}
   4 %*                                                                      *
   5 %************************************************************************
   6
   7 \begin{code}
   8 $TargetPlatform = $TARGETPLATFORM;
   9
  10 ($Pgm = $0) =~ s|.*/||;
  11 $ifile      = $ARGV[0];
  12 $Tmp_prefix = $ARGV[1];
  13 $Output     = $ARGV[2];
  14
  15 &split_asm_file($ifile);
  16
  17 open(OUTPUT, "> $Output") ||  &tidy_up_and_die(1,"$Pgm: failed to open `$Output' (to write)\n");
  18 print OUTPUT "$NoOfSplitFiles\n";
  19 close(OUTPUT);
  20
  21 exit(0);
  22 \end{code}
  23
  24
  25 \begin{code}
  26 sub split_asm_file {
  27     local($asm_file) = @_;
  28
  29     open(TMPI, "< $asm_file") || &tidy_up_and_die(1,"$Pgm: failed to open `$asm_file' (to read)\n");
  30
  31     &collectExports_hppa() if $TargetPlatform =~ /^hppa/;
  32     &collectExports_mips() if $TargetPlatform =~ /^mips/;
  33     &collectDyldStuff_powerpc() if $TargetPlatform =~ /^powerpc-apple/;
  34
  35     $octr = 0;  # output file counter
  36     $* = 1;     # multi-line matches are OK
  37
  38     %LocalConstant = (); # we have to subvert C compiler's commoning-up of constants...
  39
  40     $s_stuff = &ReadTMPIUpToAMarker( '', $octr );
  41     # that first stuff is a prologue for all .s outputs
  42     $prologue_stuff = &process_asm_block ( $s_stuff );
  43     # $_ already has some of the next stuff in it...
  44
  45 #   &tidy_up_and_die(1,"$Pgm: no split markers in .s file!\n")
  46 #       if $prologue_stuff eq $s_stuff;
  47
  48     # lie about where this stuff came from
  49     $prologue_stuff =~ s|"${Tmp_prefix}\.c"|"$ifile_root\.hc"|g;
  50
  51     while ( $_ ne '' ) { # not EOF
  52         $octr++;
  53
  54         # grab and de-mangle a section of the .s file...
  55         $s_stuff = &ReadTMPIUpToAMarker ( $_, $octr );
  56         $this_piece = &process_asm_block ( $s_stuff );
  57
  58         # output to a file of its own
  59         # open a new output file...
  60         $ofname = "${Tmp_prefix}__${octr}.s";
  61         open(OUTF, "> $ofname") || die "$Pgm: can't open output file: $ofname\n";
  62
  63         print OUTF $prologue_stuff;
  64         print OUTF $this_piece;
  65
  66         close(OUTF)
  67           || &tidy_up_and_die(1,"$Pgm:Failed writing ${Tmp_prefix}__${octr}.s\n");
  68     }
  69
  70     $NoOfSplitFiles = $octr;
  71
  72     close(TMPI) || &tidy_up_and_die(1,"Failed reading $asm_file\n");
  73 }
  74
  75 sub collectExports_hppa { # Note: HP-PA only
  76
  77     %LocalExport = (); # NB: global table
  78
  79     while(<TMPI>) {
  80         if (/^\s+\.EXPORT\s+([^,]+),.*\n/) {
  81             local($label) = $1;
  82             local($body)  = "\t.IMPORT $label";
  83             if (/,DATA/) {
  84                 $body .= ",DATA\n";
  85             } else {
  86                 $body .= ",CODE\n";
  87             }
  88             $label =~ s/\$/\\\$/g;
  89             $LocalExport{$label} = $body;
  90         }
  91     }
  92
  93     seek(TMPI, 0, 0);
  94 }
  95
  96 sub collectExports_mips { # Note: MIPS only
  97     # (not really sure this is necessary [WDP 95/05])
  98
  99     $UNDEFINED_FUNS = ''; # NB: global table
 100
 101     while(<TMPI>) {
 102         $UNDEFINED_FUNS .= $_ if /^\t\.globl\s+\S+ \.\S+\n/;
 103         # just save 'em all
 104     }
 105
 106     seek(TMPI, 0, 0);
 107 }
 108
 109 sub collectDyldStuff_powerpc { # Note: Darwin/PowerPC only
 110     local($chunk_label,$label,$cur_section,$section,$chunk,$alignment,$cur_alignment);
 111
 112     %DyldChunks = (); # NB: global table
 113     %DyldChunksDefined = (); # NB: global table
 114
 115     $cur_section = '';
 116     $section = '';
 117     $label = '';
 118     $chunk = '';
 119     $alignment = '';
 120     $cur_alignment = '';
 121
 122     while ( 1 ) {
 123         $_ = <TMPI>;
 124         if ( $_ eq '' || /^L(_.+)\$.+:/ ) {
 125             if ( $label ne '' ) {
 126                 $DyldChunksDefined{$label} .= $section . $chunk_label . $alignment . $ chunk;
 127                 if( $section =~ s/\.data/\.non_lazy_symbol_pointer/ ) {
 128                     $chunk = "\t.indirect_symbol $label\n\t.long 0\n";
 129                 }
 130                 $DyldChunks{$label} .= $section . $chunk_label . $chunk;
 131                 # don't use $alignment, it's only needed for .data, which we change into .non_lazy_symbol_pointer
 132                 print STDERR "### dyld chunk: $label\n$section$alignment$chunk\n###\n" if $Dump_asm_splitting_info;
 133             }
 134             last if ($_ eq '');
 135
 136             $chunk = '';
 137             $chunk_label = $_;
 138             $label = $1;
 139             $section = $cur_section;
 140             $alignment = $cur_alignment;
 141             print STDERR "label: $label\n" if $Dump_asm_splitting_info;
 142         } elsif ( /^\s*\.(symbol_stub|picsymbol_stub|lazy_symbol_pointer|non_lazy_symbol_pointer|data)/ ) {
 143             $cur_section = $_;
 144             printf STDERR "section: $cur_section\n" if $Dump_asm_splitting_info;
 145             $cur_alignment = ''
 146         } elsif ( /^\s*\.align.*/ ) {
 147             $cur_alignment = $_;
 148             printf STDERR "alignment: $cur_alignment\n" if $Dump_asm_splitting_info;
 149         } else {
 150             $chunk .= $_;
 151         }
 152     }
 153
 154     seek(TMPI, 0, 0);
 155 }
 156
 157 sub ReadTMPIUpToAMarker {
 158     local($str, $count) = @_; # already read bits
 159
 160
 161     for ( $_ = <TMPI>; $_ ne '' && ! /_?__stg_split_marker/; $_ = <TMPI> ) {
 162         $str .= $_;
 163     }
 164     # if not EOF, then creep forward until next "real" line
 165     # (throwing everything away).
 166     # that first "real" line will stay in $_.
 167
 168     # This loop is intended to pick up the body of the split_marker function
 169     # Note that the assembler mangler will already have eliminated this code
 170     # if it's been invoked (which it probably has).
 171
 172     while ($_ ne '' && (/_?__stg_split_marker/
 173                      || /^L[^C].*:$/
 174                      || /^\.stab/
 175                      || /\t\.proc/
 176                      || /\t\.stabd/
 177                      || /\t\.even/
 178                      || /\tunlk a6/
 179                      || /^\t!#PROLOGUE/
 180                      || /\t\.prologue/
 181                      || /\t\.frame/
 182                      # || /\t\.end/ NOT!  Let the split_marker regexp catch it
 183                      # || /\t\.ent/ NOT!  Let the split_marker regexp catch it
 184                      || /^\s+(save|retl?|restore|nop)/)) {
 185         $_ = <TMPI>;
 186     }
 187
 188     print STDERR "### BLOCK:$count:\n$str" if $Dump_asm_splitting_info;
 189
 190     # return str
 191     $str =~ tr/\r//d if $TargetPlatform =~ /-mingw32$/; # in case Perl doesn't convert line endings
 192     $str;
 193 }
 194 \end{code}
 195
 196 We must (a)~strip the marker off the block, (b)~record any literal C
 197 constants that are defined here, and (c)~inject copies of any C constants
 198 that are used-but-not-defined here.
 199
 200 \begin{code}
 201 sub process_asm_block {
 202     local($str) = @_;
 203
 204     return(&process_asm_block_m68k($str))  if $TargetPlatform =~ /^m68k-/;
 205     return(&process_asm_block_sparc($str)) if $TargetPlatform =~ /^sparc-/;
 206     return(&process_asm_block_iX86($str))  if $TargetPlatform =~ /^i[34]86-/;
 207     return(&process_asm_block_alpha($str)) if $TargetPlatform =~ /^alpha-/;
 208     return(&process_asm_block_hppa($str))  if $TargetPlatform =~ /^hppa/;
 209     return(&process_asm_block_mips($str))   if $TargetPlatform =~ /^mips-/;
 210     return(&process_asm_block_powerpc($str))   if $TargetPlatform =~ /^powerpc-apple-/;
 211
 212     # otherwise...
 213     &tidy_up_and_die(1,"$Pgm: no process_asm_block for $TargetPlatform\n");
 214 }
 215
 216 sub process_asm_block_sparc {
 217     local($str) = @_;
 218
 219     # strip the marker
 220     if ( $OptimiseC ) {
 221         $str =~ s/_?__stg_split_marker.*:\n//;
 222     } else {
 223         $str =~ s/(\.text\n\t\.align .\n)\t\.global\s+.*_?__stg_split_marker.*\n\t\.proc.*\n/$1/;
 224         $str =~ s/(\t\.align .\n)\t\.global\s+.*_?__stg_split_marker.*\n\t\.proc.*\n/$1/;
 225     }
 226
 227     # make sure the *.hc filename gets saved; not just ghc*.c (temp name)
 228     $str =~ s/^\.stabs "(ghc\d+\.c)"/.stabs "$ifile_root.hc"/g; # HACK HACK
 229
 230     # remove/record any literal constants defined here
 231     while ( $str =~ /(\t\.align .\n\.?(L?LC\d+):\n(\t\.asci[iz].*\n)+)/ ) {
 232         local($label) = $2;
 233         local($body)  = $1;
 234
 235         &tidy_up_and_die(1,"Local constant label $label already defined!\n")
 236             if $LocalConstant{$label};
 237
 238         $LocalConstant{$label} = $body;
 239
 240         $str =~ s/\t\.align .\n\.?LL?C\d+:\n(\t\.asci[iz].*\n)+//;
 241     }
 242
 243     # inject definitions for any local constants now used herein
 244     foreach $k (keys %LocalConstant) {
 245         if ( $str =~ /\b$k\b/ ) {
 246             $str = $LocalConstant{$k} . $str;
 247         }
 248     }
 249
 250    print STDERR "### STRIPPED BLOCK (sparc):\n$str" if $Dump_asm_splitting_info;
 251
 252    $str;
 253 }
 254
 255 sub process_asm_block_m68k {
 256     local($str) = @_;
 257
 258     # strip the marker
 259
 260     $str =~ s/(\.text\n\t\.even\n)\t\.globl\s+.*_?__stg_split_marker.*\n/$1/;
 261     $str =~ s/(\t\.even\n)\t\.globl\s+.*_?__stg_split_marker.*\n/$1/;
 262
 263     # it seems prudent to stick on one of these:
 264     $str = "\.text\n\t.even\n" . $str;
 265
 266     # remove/record any literal constants defined here
 267     while ( $str =~ /((LC\d+):\n\t\.ascii.*\n)/ ) {
 268         local($label) = $2;
 269         local($body)  = $1;
 270
 271         &tidy_up_and_die(1,"Local constant label $label already defined!\n")
 272             if $LocalConstant{$label};
 273
 274         $LocalConstant{$label} = $body;
 275
 276         $str =~ s/LC\d+:\n\t\.ascii.*\n//;
 277     }
 278
 279     # inject definitions for any local constants now used herein
 280     foreach $k (keys %LocalConstant) {
 281         if ( $str =~ /\b$k\b/ ) {
 282             $str = $LocalConstant{$k} . $str;
 283         }
 284     }
 285
 286    print STDERR "### STRIPPED BLOCK (m68k):\n$str" if $Dump_asm_splitting_info;
 287
 288    $str;
 289 }
 290
 291 sub process_asm_block_alpha {
 292     local($str) = @_;
 293
 294     # strip the marker
 295     if ( $OptimiseC ) {
 296         $str =~ s/_?__stg_split_marker.*:\n//;
 297     } else {
 298         $str =~ s/(\t\.align .\n)\t\.globl\s+.*_?__stg_split_marker.*\n\t\.ent.*\n/$1/;
 299     }
 300
 301     # remove/record any literal constants defined here
 302     while ( $str =~ /(\.rdata\n\t\.align \d\n)?(\$(C\d+):\n\t\..*\n)/ ) {
 303         local($label) = $3;
 304         local($body)  = $2;
 305
 306         &tidy_up_and_die(1,"Local constant label $label already defined!\n")
 307             if $LocalConstant{$label};
 308
 309         $LocalConstant{$label} = ".rdata\n\t.align 3\n" . $body . "\t.text\n";
 310
 311         $str =~ s/(\.rdata\n\t\.align \d\n)?\$C\d+:\n\t\..*\n//;
 312     }
 313
 314     # inject definitions for any local constants now used herein
 315     foreach $k (keys %LocalConstant) {
 316         if ( $str =~ /\$\b$k\b/ ) {
 317             $str = $LocalConstant{$k} . $str;
 318         }
 319     }
 320
 321     # Slide the dummy direct return code into the vtbl .ent/.end block,
 322     # to keep the label fixed if it's the last thing in a module, and
 323     # to avoid having any anonymous text that the linker will complain about
 324     $str =~ s/(\t\.end [A-Za-z0-9_]+)\n\t# nop/\tnop\n$1/g;
 325
 326     print STDERR "### STRIPPED BLOCK (alpha):\n$str" if $Dump_asm_splitting_info;
 327
 328     $str;
 329 }
 330
 331 sub process_asm_block_iX86 {
 332     local($str) = @_;
 333
 334     # strip the marker
 335
 336     $str =~ s/(\.text\n\t\.align .(,0x90)?\n)\.globl\s+.*_?__stg_split_marker.*\n/$1/;
 337     $str =~ s/(\t\.align .(,0x90)?\n)\.globl\s+.*_?__stg_split_marker.*\n/$1/;
 338
 339     # it seems prudent to stick on one of these:
 340     $str = "\.text\n\t.align 4\n" . $str;
 341
 342     # remove/record any literal constants defined here
 343     # [perl made uglier to work around the perl 5.7/5.8 bug documented at
 344     # http://bugs6.perl.org/rt2/Ticket/Display.html?id=1760 and illustrated
 345     # by the seg fault of perl -e '("x\n" x 5000) =~ /(.*\n)+/'
 346     # -- ccshan 2002-09-05]
 347     while ( ($str =~ /(\.?(LC\d+):\n(\t\.(ascii|string).*\n|\s*\.byte.*\n){1,100})/ )) {
 348         local($label) = $2;
 349         local($body)  = $1;
 350         local($prefix, $suffix, $*) = ($`, $', 0);
 351
 352         &tidy_up_and_die(1,"Local constant label $label already defined!\n")
 353             if $LocalConstant{$label};
 354
 355         while ( $suffix =~ /^((\t\.(ascii|string).*\n|\s*\.byte.*\n){1,100})/ ) {
 356             $body .= $1;
 357             $suffix = $';
 358         }
 359         $LocalConstant{$label} = $body;
 360         $str = $prefix . $suffix;
 361     }
 362
 363     # inject definitions for any local constants now used herein
 364     foreach $k (keys %LocalConstant) {
 365         if ( $str =~ /\b$k\b/ ) {
 366             $str = $LocalConstant{$k} . $str;
 367         }
 368     }
 369
 370    print STDERR "### STRIPPED BLOCK (iX86):\n$str" if $Dump_asm_splitting_info;
 371
 372    $str;
 373 }
 374 \end{code}
 375
 376 \begin{code}
 377 sub process_asm_block_hppa {
 378     local($str) = @_;
 379
 380     # strip the marker
 381     $str =~ s/___stg_split_marker.*\n//;
 382
 383     # remove/record any imports defined here
 384     while ( $str =~ /^(\s+\.IMPORT\s.*\n)/ ) {
 385         $Imports .= $1;
 386
 387         $str =~ s/^\s+\.IMPORT.*\n//;
 388     }
 389
 390     # remove/record any literal constants defined here
 391     while ( $str =~ /^(\s+\.align.*\n(L\$C\d+)\n(\s.*\n)+); end literal\n/ ) {
 392         local($label) = $2;
 393         local($body)  = $1;
 394         local($prefix) = $`;
 395         local($suffix) = $';
 396         $label =~ s/\$/\\\$/g;
 397
 398         &tidy_up_and_die(1,"Local constant label $label already defined!\n")
 399             if $LocalConstant{$label};
 400
 401         $LocalConstant{$label} = "\t.SPACE \$TEXT\$\n\t.SUBSPA \$LIT\$\n\n" . $body;
 402
 403         $str = $prefix . $suffix;
 404     }
 405
 406     # inject definitions for any local constants now used herein
 407     foreach $k (keys %LocalConstant) {
 408         if ( $str =~ /\b$k\b/ ) {
 409             $str = $LocalConstant{$k} . $str;
 410         }
 411     }
 412
 413     # inject required imports for local exports in other chunks
 414     foreach $k (keys %LocalExport) {
 415         if ( $str =~ /\b$k\b/ && ! /EXPORT\s+$k\b/ ) {
 416             $str = $LocalExport{$k} . $str;
 417         }
 418     }
 419
 420     # inject collected imports
 421
 422     $str = $Imports . $str;
 423
 424     print STDERR "### STRIPPED BLOCK (hppa):\n$str" if $Dump_asm_splitting_info;
 425
 426     $str;
 427 }
 428 \end{code}
 429
 430 \begin{code}
 431 sub process_asm_block_mips {
 432     local($str) = @_;
 433
 434     # strip the marker
 435     if ( $OptimiseC ) {
 436         $str =~ s/_?__stg_split_marker.*:\n//;
 437     } else {
 438         $str =~ s/(\t\.align .\n)\t\.globl\s+.*_?__stg_split_marker.*\n\t\.ent.*\n/$1/;
 439     }
 440
 441     # remove/record any literal constants defined here
 442     while ( $str =~ /(\t\.rdata\n\t\.align \d\n)?(\$(LC\d+):\n(\t\.byte\t.*\n)+)/ ) {
 443         local($label) = $3;
 444         local($body)  = $2;
 445
 446         &tidy_up_and_die(1,"Local constant label $label already defined!\n")
 447             if $LocalConstant{$label};
 448
 449         $LocalConstant{$label} = "\t.rdata\n\t.align 2\n" . $body . "\t.text\n";
 450
 451         $str =~ s/(\t\.rdata\n\t\.align \d\n)?\$LC\d+:\n(\t\.byte\t.*\n)+//;
 452     }
 453
 454     # inject definitions for any local constants now used herein
 455     foreach $k (keys %LocalConstant) {
 456         if ( $str =~ /\$\b$k\b/ ) {
 457             $str = $LocalConstant{$k} . $str;
 458         }
 459     }
 460
 461     # Slide the dummy direct return code into the vtbl .ent/.end block,
 462     # to keep the label fixed if it's the last thing in a module, and
 463     # to avoid having any anonymous text that the linker will complain about
 464     $str =~ s/(\t\.end [A-Za-z0-9_]+)\n\t# nop/\tnop\n$1/g;
 465
 466     $str .= $UNDEFINED_FUNS; # pin on gratuitiously-large amount of info
 467
 468     print STDERR "### STRIPPED BLOCK (mips):\n$str" if $Dump_asm_splitting_info;
 469
 470     $str;
 471 }
 472 \end{code}
 473
 474 \begin{code}
 475 sub process_asm_block_powerpc {
 476     local($str) = @_;
 477     local($dyld_stuff) = '';
 478
 479     # strip the marker
 480     $str =~ s/___stg_split_marker.*\n//;
 481
 482     $str =~ s/L_.*\$.*:\n(.|\n)*//;
 483
 484     # remove/record any literal constants defined here
 485     while ( $str =~ s/^(\s+.const_data\n\s+\.align.*\n(LC\d+):\n(\s\.(byte|short|long|fill|space|ascii).*\n)+)// ) {
 486         local($label) = $2;
 487         local($body)  = $1;
 488
 489         &tidy_up_and_die(1,"Local constant label $label already defined!\n")
 490             if $LocalConstant{$label};
 491
 492         $LocalConstant{$label} = $body;
 493     }
 494
 495     # inject definitions for any local constants now used herein
 496     foreach $k (keys %LocalConstant) {
 497         if ( $str =~ /\b$k(\b|\[)/ ) {
 498             $str = $LocalConstant{$k} . $str;
 499         }
 500     }
 501
 502     foreach $k (keys %DyldChunks) {
 503         if ( $str =~ /\bL$k\$/ ) {
 504             if ( $str =~ /^$k:$/ ) {
 505                 $dyld_stuff .= $DyldChunksDefined{$k};
 506             } else {
 507                 $dyld_stuff .= $DyldChunks{$k};
 508             }
 509         }
 510     }
 511
 512     $str .= "\n" . $dyld_stuff;
 513
 514     print STDERR "### STRIPPED BLOCK (powerpc):\n$str" if $Dump_asm_splitting_info;
 515
 516     $str;
 517 }
 518 \end{code}
 519
 520 \begin{code}
 521 sub tidy_up_and_die {
 522     local($return_val, $msg) = @_;
 523     print STDERR $msg;
 524     exit (($return_val == 0) ? 0 : 1);
 525 }
 526 \end{code}