1#!/usr/bin/env perl
2
3# Generate main file, individual apps and solution files for
4# MS Visual Studio 2017
5#
6# Must be run from Mbed TLS root or scripts directory.
7# Takes no argument.
8#
9# Copyright The Mbed TLS Contributors
10# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
11
12use warnings;
13use strict;
14use Getopt::Long;
15use Digest::MD5 'md5_hex';
16
17# Declare variables for options
18my $vsx_dir = "visualc/VS2017";
19my $list = 0; # Default off
20
21GetOptions(
22    "directory=s" => \$vsx_dir, # Target directory
23    "list"        => \$list     # Only list generated files
24) or die "Invalid options\n";
25
26my $vsx_ext = "vcxproj";
27my $vsx_app_tpl_file = "scripts/data_files/vs2017-app-template.$vsx_ext";
28my $vsx_main_tpl_file = "scripts/data_files/vs2017-main-template.$vsx_ext";
29my $vsx_main_file = "$vsx_dir/mbedTLS.$vsx_ext";
30my $vsx_sln_tpl_file = "scripts/data_files/vs2017-sln-template.sln";
31my $vsx_sln_file = "$vsx_dir/mbedTLS.sln";
32
33my $mbedtls_programs_dir = "programs";
34my $framework_programs_dir = "framework/tests/programs";
35my $tfpsacrypto_programs_dir = "tf-psa-crypto/programs";
36
37my $mbedtls_header_dir = 'include/mbedtls';
38my $drivers_builtin_header_dir = 'tf-psa-crypto/drivers/builtin/include/mbedtls';
39my $psa_header_dir = 'tf-psa-crypto/include/psa';
40my $tls_source_dir = 'library';
41my $crypto_core_source_dir = 'tf-psa-crypto/core';
42my $crypto_source_dir = 'tf-psa-crypto/drivers/builtin/src';
43my $tls_test_source_dir = 'tests/src';
44my $tls_test_header_dir = 'tests/include/test';
45my $crypto_test_source_dir = 'tf-psa-crypto/tests/src';
46my $crypto_test_header_dir = 'tf-psa-crypto/tests/include/test';
47my $test_source_dir = 'framework/tests/src';
48my $test_header_dir = 'framework/tests/include/test';
49my $test_drivers_header_dir = 'framework/tests/include/test/drivers';
50my $test_drivers_source_dir = 'framework/tests/src/drivers';
51
52my @thirdparty_header_dirs = qw(
53    tf-psa-crypto/drivers/everest/include/tf-psa-crypto/private/everest
54);
55my @thirdparty_source_dirs = qw(
56    tf-psa-crypto/drivers/everest/library
57    tf-psa-crypto/drivers/everest/library/kremlib
58    tf-psa-crypto/drivers/everest/library/legacy
59);
60
61# Directories to add to the include path.
62# Order matters in case there are files with the same name in more than
63# one directory: the compiler will use the first match.
64my @include_directories = qw(
65    include
66    tf-psa-crypto/include
67    tf-psa-crypto/drivers/builtin/include
68    tf-psa-crypto/drivers/everest/include/
69    tf-psa-crypto/drivers/everest/include/tf-psa-crypto/private/everest
70    tf-psa-crypto/drivers/everest/include/tf-psa-crypto/private/everest/vs2013
71    tf-psa-crypto/drivers/everest/include/tf-psa-crypto/private/everest/kremlib
72    tests/include
73    tf-psa-crypto/tests/include
74    framework/tests/include
75    framework/tests/programs
76);
77my $include_directories = join(';', map {"../../$_"} @include_directories);
78
79# Directories to add to the include path when building the libraries, but not
80# when building tests or applications.
81my @library_include_directories = qw(
82    library
83    tf-psa-crypto/core
84    tf-psa-crypto/drivers/builtin/src
85);
86my $library_include_directories =
87  join(';', map {"../../$_"} (@library_include_directories,
88                              @include_directories));
89
90my @excluded_files = qw(
91    tf-psa-crypto/drivers/everest/library/Hacl_Curve25519.c
92);
93my %excluded_files = ();
94foreach (@excluded_files) { $excluded_files{$_} = 1 }
95
96my $vsx_hdr_tpl = <<EOT;
97    <ClInclude Include="..\\..\\{NAME}" />
98EOT
99my $vsx_src_tpl = <<EOT;
100    <ClCompile Include="..\\..\\{NAME}" />
101EOT
102
103my $vsx_sln_app_entry_tpl = <<EOT;
104Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "{APPNAME}", "{APPNAME}.vcxproj", "{GUID}"
105	ProjectSection(ProjectDependencies) = postProject
106		{46CF2D25-6A36-4189-B59C-E4815388E554} = {46CF2D25-6A36-4189-B59C-E4815388E554}
107	EndProjectSection
108EndProject
109EOT
110
111my $vsx_sln_conf_entry_tpl = <<EOT;
112		{GUID}.Debug|Win32.ActiveCfg = Debug|Win32
113		{GUID}.Debug|Win32.Build.0 = Debug|Win32
114		{GUID}.Debug|x64.ActiveCfg = Debug|x64
115		{GUID}.Debug|x64.Build.0 = Debug|x64
116		{GUID}.Release|Win32.ActiveCfg = Release|Win32
117		{GUID}.Release|Win32.Build.0 = Release|Win32
118		{GUID}.Release|x64.ActiveCfg = Release|x64
119		{GUID}.Release|x64.Build.0 = Release|x64
120EOT
121
122exit( main() );
123
124sub check_dirs {
125    foreach my $d (@thirdparty_header_dirs, @thirdparty_source_dirs) {
126        if (not (-d $d)) { return 0; }
127    }
128    return -d $vsx_dir
129        && -d $mbedtls_header_dir
130        && -d $drivers_builtin_header_dir
131        && -d $psa_header_dir
132        && -d $tls_source_dir
133        && -d $crypto_core_source_dir
134        && -d $crypto_source_dir
135        && -d $test_source_dir
136        && -d $tls_test_source_dir
137        && -d $crypto_test_source_dir
138        && -d $test_drivers_source_dir
139        && -d $test_header_dir
140        && -d $tls_test_header_dir
141        && -d $crypto_test_header_dir
142        && -d $test_drivers_header_dir
143        && -d $mbedtls_programs_dir
144        && -d $framework_programs_dir
145        && -d $tfpsacrypto_programs_dir;
146}
147
148sub slurp_file {
149    my ($filename) = @_;
150
151    local $/ = undef;
152    open my $fh, '<:crlf', $filename or die "Could not read $filename\n";
153    my $content = <$fh>;
154    close $fh;
155
156    return $content;
157}
158
159sub content_to_file {
160    my ($content, $filename) = @_;
161
162    open my $fh, '>:crlf', $filename or die "Could not write to $filename\n";
163    print $fh $content;
164    close $fh;
165}
166
167sub gen_app_guid {
168    my ($path) = @_;
169
170    my $guid = md5_hex( "mbedTLS:$path" );
171    $guid =~ s/(.{8})(.{4})(.{4})(.{4})(.{12})/\U{$1-$2-$3-$4-$5}/;
172
173    return $guid;
174}
175
176sub gen_app {
177    my ($path, $template, $dir, $ext) = @_;
178
179    my $guid = gen_app_guid( $path );
180    $path =~ s!/!\\!g;
181    (my $appname = $path) =~ s/.*\\//;
182    my $is_test_app = ($path =~ m/^test\\/);
183
184    my $srcs;
185    if( $appname eq "metatest" or $appname eq "query_compile_time_config" or
186        $appname eq "query_included_headers" or $appname eq "zeroize" ) {
187        $srcs = "<ClCompile Include=\"..\\..\\framework\\tests\\programs\\$appname.c\" \/>";
188    } else {
189        $srcs = "<ClCompile Include=\"..\\..\\programs\\$path.c\" \/>";
190    }
191
192    if( $appname eq "ssl_client2" or $appname eq "ssl_server2" or
193        $appname eq "query_compile_time_config" ) {
194        $srcs .= "\n    <ClCompile Include=\"..\\..\\programs\\test\\query_config.c\" \/>";
195    }
196    if( $appname eq "ssl_client2" or $appname eq "ssl_server2" ) {
197        $srcs .= "\n    <ClCompile Include=\"..\\..\\programs\\ssl\\ssl_test_lib.c\" \/>";
198    }
199
200    my $content = $template;
201    $content =~ s/<SOURCES>/$srcs/g;
202    $content =~ s/<APPNAME>/$appname/g;
203    $content =~ s/<GUID>/$guid/g;
204    $content =~ s/INCLUDE_DIRECTORIES\n/($is_test_app ?
205                                         $library_include_directories :
206                                         $include_directories)/ge;
207
208    content_to_file( $content, "$dir/$appname.$ext" );
209}
210
211sub get_app_list {
212    my $makefile_contents = slurp_file('programs/Makefile');
213    $makefile_contents =~ /\n\s*APPS\s*=[\\\s]*(.*?)(?<!\\)[\#\n]/s
214      or die "Cannot find APPS = ... in programs/Makefile\n";
215    return split /(?:\s|\\)+/, $1;
216}
217
218sub gen_app_files {
219    my @app_list = @_;
220
221    my $vsx_tpl = slurp_file( $vsx_app_tpl_file );
222
223    for my $app ( @app_list ) {
224        gen_app( $app, $vsx_tpl, $vsx_dir, $vsx_ext );
225    }
226}
227
228sub gen_entry_list {
229    my ($tpl, @names) = @_;
230
231    my $entries;
232    for my $name (@names) {
233        (my $entry = $tpl) =~ s/{NAME}/$name/g;
234        $entries .= $entry;
235    }
236
237    return $entries;
238}
239
240sub gen_main_file {
241    my ($headers, $sources,
242        $hdr_tpl, $src_tpl,
243        $main_tpl, $main_out) = @_;
244
245    my $header_entries = gen_entry_list( $hdr_tpl, @$headers );
246    my $source_entries = gen_entry_list( $src_tpl, @$sources );
247
248    my $out = slurp_file( $main_tpl );
249    $out =~ s/SOURCE_ENTRIES\n/$source_entries/m;
250    $out =~ s/HEADER_ENTRIES\n/$header_entries/m;
251    $out =~ s/INCLUDE_DIRECTORIES\n/$library_include_directories/g;
252
253    content_to_file( $out, $main_out );
254}
255
256sub gen_vsx_solution {
257    my (@app_names) = @_;
258
259    my ($app_entries, $conf_entries);
260    for my $path (@app_names) {
261        my $guid = gen_app_guid( $path );
262        (my $appname = $path) =~ s!.*/!!;
263
264        my $app_entry = $vsx_sln_app_entry_tpl;
265        $app_entry =~ s/{APPNAME}/$appname/g;
266        $app_entry =~ s/{GUID}/$guid/g;
267
268        $app_entries .= $app_entry;
269
270        my $conf_entry = $vsx_sln_conf_entry_tpl;
271        $conf_entry =~ s/{GUID}/$guid/g;
272
273        $conf_entries .= $conf_entry;
274    }
275
276    my $out = slurp_file( $vsx_sln_tpl_file );
277    $out =~ s/APP_ENTRIES\n/$app_entries/m;
278    $out =~ s/CONF_ENTRIES\n/$conf_entries/m;
279
280    content_to_file( $out, $vsx_sln_file );
281}
282
283sub del_vsx_files {
284    unlink glob "'$vsx_dir/*.$vsx_ext'";
285    unlink $vsx_main_file;
286    unlink $vsx_sln_file;
287}
288
289sub main {
290    if( ! check_dirs() ) {
291        chdir '..' or die;
292        check_dirs or die "Must be run from Mbed TLS root or scripts dir\n";
293    }
294
295    # Remove old files to ensure that, for example, project files from deleted
296    # apps are not kept
297    if (not $list) {
298        del_vsx_files();
299    }
300
301    my @app_list = get_app_list();
302    my @header_dirs = (
303                       $mbedtls_header_dir,
304                       $drivers_builtin_header_dir,
305                       $psa_header_dir,
306                       $test_header_dir,
307                       $tls_test_header_dir,
308                       $crypto_test_header_dir,
309                       $test_drivers_header_dir,
310                       $tls_source_dir,
311                       $crypto_core_source_dir,
312                       $crypto_source_dir,
313                       $framework_programs_dir,
314                       @thirdparty_header_dirs,
315                      );
316    my @headers = (map { <$_/*.h> } @header_dirs);
317    my @source_dirs = (
318                       $tls_source_dir,
319                       $crypto_core_source_dir,
320                       $crypto_source_dir,
321                       $test_source_dir,
322                       $tls_test_source_dir,
323                       $crypto_test_source_dir,
324                       $test_drivers_source_dir,
325                       @thirdparty_source_dirs,
326                      );
327    my @sources = (map { <$_/*.c> } @source_dirs);
328
329    @headers = grep { ! $excluded_files{$_} } @headers;
330    @sources = grep { ! $excluded_files{$_} } @sources;
331    map { s!/!\\!g } @headers;
332    map { s!/!\\!g } @sources;
333
334    if ($list) {
335        foreach my $app (@app_list) {
336            $app =~ s/.*\///;
337            print "$vsx_dir/$app.$vsx_ext\n";
338        }
339        print "$vsx_main_file\n";
340        print "$vsx_sln_file\n";
341    } else {
342        gen_app_files( @app_list );
343
344        gen_main_file( \@headers, \@sources,
345                       $vsx_hdr_tpl, $vsx_src_tpl,
346                       $vsx_main_tpl_file, $vsx_main_file );
347
348        gen_vsx_solution( @app_list );
349    }
350
351    return 0;
352}
353