Commit ae4c7450 authored by Richard Levitte's avatar Richard Levitte
Browse files

Unified - Add the build.info command GENERATE, to generate source files 



In some cases, one might want to generate some source files from
others, that's done as follows:

    GENERATE[foo.s]=asm/something.pl $(CFLAGS)
    GENERATE[bar.s]=asm/bar.S

The value of each GENERATE line is a command line or part of it.
Configure places no rules on the command line, except the the first
item muct be the generator file.  It is, however, entirely up to the
build file template to define exactly how those command lines should
be handled, how the output is captured and so on.

Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
parent 667867cc

Configurations/README

+36 −2
Original line number Diff line number Diff line
@@ -363,8 +363,22 @@ include paths the build of their source files should use: 


    INCLUDE[foo]=include



It's possible to have raw build file lines, between BEGINRAW and

ENDRAW lines as follows:

In some cases, one might want to generate some source files from

others, that's done as follows:



    GENERATE[foo.s]=asm/something.pl $(CFLAGS)

    GENERATE[bar.s]=asm/bar.S



The value of each GENERATE line is a command line or part of it.

Configure places no rules on the command line, except the the first

item muct be the generator file.  It is, however, entirely up to the

build file template to define exactly how those command lines should

be handled, how the output is captured and so on.



NOTE: GENERATE lines are limited to one command only per GENERATE.



As a last resort, it's possible to have raw build file lines, between

BEGINRAW and ENDRAW lines as follows:



    BEGINRAW[Makefile(unix)]

    haha.h: {- $builddir -}/Makefile
@@ -461,6 +475,26 @@ The build-file template is expected to define at least the following 
perl functions in a perl code fragment enclosed with "{-" and "-}".

They are all expected to return a string with the lines they produce.



    generatesrc - function that produces build file lines to generate

                  a source file from some input.



                  It's called like this:



                        generatesrc(src => "PATH/TO/tobegenerated",

                                    generator => [ "generatingfile", ... ]

                                    deps => [ "dep1", ... ],

                                    intent => one of "libs", "dso", "bin" );



                  'src' has the name of the file to be generated.

                  'generator' is the command or part of command to

                  generate the file, of which the first item is

                  expected to be the file to generate from.

                  generatesrc() is expected to analyse and figure out

                  exactly how to apply that file and how to capture

                  the result.  'deps' is a list of explicit

                  dependencies.  'intent' indicates what the generated

                  file is going to be used for.



    src2obj     - function that produces build file lines to build an

                  object file from source files and associated data.

Configurations/README.design

+5 −11
Original line number Diff line number Diff line
@@ -89,11 +89,8 @@ depends on the library 'libssl' to function properly. 
    SOURCE[../libcrypto]=aes.c evp.c cversion.c

    DEPEND[cversion.o]=buildinf.h

    

    BEGINRAW[Makefile(unix)]

    crypto/buildinf.h : Makefile

    	perl util/mkbuildinf.h "$(CC) $(CFLAGS)" "$(PLATFORM)" \

    	    > crypto/buildinf.h

    ENDRAW[Makefile(unix)]

    GENERATE[buildinf.h]=../util/mkbuildinf.pl "$(CC) $(CFLAGS)" "$(PLATFORM)"

    DEPEND[buildinf.h]=../Makefile



This is the build.info file in 'crypto', and it tells us a little more

about what's needed to produce 'libcrypto'.  LIBS is used again to
@@ -161,11 +158,8 @@ information comes down to this: 
    DEPEND[engines/libossltest]=libcrypto

    INCLUDE[engines/libossltest]=include

    

    BEGINRAW[Makefile(unix)]

    crypto/buildinf.h : Makefile

    	perl util/mkbuildinf.h "$(CC) $(CFLAGS)" "$(PLATFORM)" \

    	    > crypto/buildinf.h

    ENDRAW[Makefile(unix)]

    GENERATE[crypto/buildinf.h]=util/mkbuildinf.pl "$(CC) $(CFLAGS)" "$(PLATFORM)"

    DEPEND[crypto/buildinf.h]=Makefile





A few notes worth mentioning:
@@ -180,7 +174,7 @@ The indexes for SOURCE, INCLUDE and ORDINALS must only be end product 
files, such as libraries, programs or engines.  The values of SOURCE

variables must only be source files (possibly generated)



DEPEND shows a relationship between different end product files, such

DEPEND shows a relationship between different produced files, such

as a program depending on a library, or between an object file and

some extra source file.

Configurations/common.tmpl

+21 −1
Original line number Diff line number Diff line
@@ -32,6 +32,22 @@ 
     @newlist;

 }



 sub dogenerate {

     my $src = shift;

     return "" if $cache{$src};

     my %opts = @_;

     if ($unified_info{generate}->{$src}) {

         $OUT .= generatesrc(src => $src,

                             generator => $unified_info{generate}->{$src},

                             deps => $unified_info{depends}->{$src},

                             %opts);

         foreach (@{$unified_info{depends}->{$src}}) {

             dogenerate($_, %opts);

         }

     }

     $cache{$src} = 1;

 }



 # doobj is responsible for producing all the recipes that build

 # object files as well as dependency files.

 sub doobj {
@@ -43,10 +59,14 @@ 
     if (@{$unified_info{sources}->{$obj}}) {

         $OUT .= src2obj(obj => $obj_no_o,

                         srcs => $unified_info{sources}->{$obj},

                         deps => [ reducedepends(resolvedepends($obj)) ],

                         deps => $unified_info{depends}->{$obj},

                         incs => [ @{$unified_info{includes}->{$bin}},

                                   @{$unified_info{includes}->{$obj}} ],

                         %opts);

         foreach ((@{$unified_info{sources}->{$obj}},

                   @{$unified_info{depends}->{$obj}})) {

             dogenerate($_, %opts);

         }

     }

     $cache{$obj} = 1;

 }

Configure

+18 −0
Original line number Diff line number Diff line
@@ -1283,6 +1283,7 @@ if ($builder eq "unified") { 
        my %depends = ();

        my %renames = ();

        my %sharednames = ();

        my %generate = ();



        push @{$config{build_infos}}, catfile(abs2rel($sourced, $blddir), $f);

        my $template = Text::Template->new(TYPE => 'FILE',
@@ -1354,6 +1355,9 @@ if ($builder eq "unified") { 
            qr/^\s*DEPEND\[((?:\\.|[^\\\]])+)\]\s*=\s*(.*)\s*$/

            => sub { push @{$depends{$1}}, split(/\s+/, $2)

                         if !@skip || $skip[$#skip] > 0 },

            qr/^\s*GENERATE\[((?:\\.|[^\\\]])+)\]\s*=\s*(.*)\s*$/

            => sub { push @{$generate{$1}}, $2

                         if !@skip || $skip[$#skip] > 0 },

            qr/^\s*RENAME\[((?:\\.|[^\\\]])+)\]\s*=\s*(.*)\s*$/

            => sub { push @{$renames{$1}}, split(/\s+/, $2)

                         if !@skip || $skip[$#skip] > 0 },
@@ -1514,6 +1518,20 @@ EOF 
            }

        }



        foreach (keys %generate) {

            my $dest = $_;

            my $ddest = cleanfile($buildd, $_, $blddir);

            if ($unified_info{rename}->{$ddest}) {

                $ddest = $unified_info{rename}->{$ddest};

            }

            die "more than one generator for $dest: "

                    ,join(" ", @{$generate{$_}}),"\n"

                    if scalar @{$generate{$_}} > 1;

            my @generator = split /\s+/, $generate{$dest}->[0];

            $generator[0] = cleanfile($sourced, $generator[0], $blddir),

            $unified_info{generate}->{$ddest} = [ @generator ];

        }



        foreach (keys %depends) {

            my $dest = $_;

            my $ddest = cleanfile($buildd, $_, $blddir);