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 Digest::MD5 'md5_hex';
15
16my $vsx_dir = "visualc/VS2017";
17my $vsx_ext = "vcxproj";
18my $vsx_app_tpl_file = "scripts/data_files/vs2017-app-template.$vsx_ext";
19my $vsx_main_tpl_file = "scripts/data_files/vs2017-main-template.$vsx_ext";
20my $vsx_main_file = "$vsx_dir/mbedTLS.$vsx_ext";
21my $vsx_sln_tpl_file = "scripts/data_files/vs2017-sln-template.sln";
22my $vsx_sln_file = "$vsx_dir/mbedTLS.sln";
23
24my $programs_dir = 'programs';
25my $mbedtls_header_dir = 'include/mbedtls';
26my $psa_header_dir = 'include/psa';
27my $source_dir = 'library';
28my $test_source_dir = 'tests/src';
29my $test_header_dir = 'tests/include/test';
30my $test_drivers_header_dir = 'tests/include/test/drivers';
31my $test_drivers_source_dir = 'tests/src/drivers';
32
33my @thirdparty_header_dirs = qw(
34    3rdparty/everest/include/everest
35);
36my @thirdparty_source_dirs = qw(
37    3rdparty/everest/library
38    3rdparty/everest/library/kremlib
39    3rdparty/everest/library/legacy
40);
41
42# Directories to add to the include path.
43# Order matters in case there are files with the same name in more than
44# one directory: the compiler will use the first match.
45my @include_directories = qw(
46    include
47    3rdparty/everest/include/
48    3rdparty/everest/include/everest
49    3rdparty/everest/include/everest/vs2013
50    3rdparty/everest/include/everest/kremlib
51    tests/include
52);
53my $include_directories = join(';', map {"../../$_"} @include_directories);
54
55# Directories to add to the include path when building the library, but not
56# when building tests or applications.
57my @library_include_directories = qw(
58    library
59);
60my $library_include_directories =
61  join(';', map {"../../$_"} (@library_include_directories,
62                              @include_directories));
63
64my @excluded_files = qw(
65    3rdparty/everest/library/Hacl_Curve25519.c
66);
67my %excluded_files = ();
68foreach (@excluded_files) { $excluded_files{$_} = 1 }
69
70my $vsx_hdr_tpl = <<EOT;
71    <ClInclude Include="..\\..\\{NAME}" />
72EOT
73my $vsx_src_tpl = <<EOT;
74    <ClCompile Include="..\\..\\{NAME}" />
75EOT
76
77my $vsx_sln_app_entry_tpl = <<EOT;
78Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "{APPNAME}", "{APPNAME}.vcxproj", "{GUID}"
79	ProjectSection(ProjectDependencies) = postProject
80		{46CF2D25-6A36-4189-B59C-E4815388E554} = {46CF2D25-6A36-4189-B59C-E4815388E554}
81	EndProjectSection
82EndProject
83EOT
84
85my $vsx_sln_conf_entry_tpl = <<EOT;
86		{GUID}.Debug|Win32.ActiveCfg = Debug|Win32
87		{GUID}.Debug|Win32.Build.0 = Debug|Win32
88		{GUID}.Debug|x64.ActiveCfg = Debug|x64
89		{GUID}.Debug|x64.Build.0 = Debug|x64
90		{GUID}.Release|Win32.ActiveCfg = Release|Win32
91		{GUID}.Release|Win32.Build.0 = Release|Win32
92		{GUID}.Release|x64.ActiveCfg = Release|x64
93		{GUID}.Release|x64.Build.0 = Release|x64
94EOT
95
96exit( main() );
97
98sub check_dirs {
99    foreach my $d (@thirdparty_header_dirs, @thirdparty_source_dirs) {
100        if (not (-d $d)) { return 0; }
101    }
102    return -d $vsx_dir
103        && -d $mbedtls_header_dir
104        && -d $psa_header_dir
105        && -d $source_dir
106        && -d $test_source_dir
107        && -d $test_drivers_source_dir
108        && -d $test_header_dir
109        && -d $test_drivers_header_dir
110        && -d $programs_dir;
111}
112
113sub slurp_file {
114    my ($filename) = @_;
115
116    local $/ = undef;
117    open my $fh, '<:crlf', $filename or die "Could not read $filename\n";
118    my $content = <$fh>;
119    close $fh;
120
121    return $content;
122}
123
124sub content_to_file {
125    my ($content, $filename) = @_;
126
127    open my $fh, '>:crlf', $filename or die "Could not write to $filename\n";
128    print $fh $content;
129    close $fh;
130}
131
132sub gen_app_guid {
133    my ($path) = @_;
134
135    my $guid = md5_hex( "mbedTLS:$path" );
136    $guid =~ s/(.{8})(.{4})(.{4})(.{4})(.{12})/\U{$1-$2-$3-$4-$5}/;
137
138    return $guid;
139}
140
141sub gen_app {
142    my ($path, $template, $dir, $ext) = @_;
143
144    my $guid = gen_app_guid( $path );
145    $path =~ s!/!\\!g;
146    (my $appname = $path) =~ s/.*\\//;
147    my $is_test_app = ($path =~ m/^test\\/);
148
149    my $srcs = "<ClCompile Include=\"..\\..\\programs\\$path.c\" \/>";
150    if( $appname eq "ssl_client2" or $appname eq "ssl_server2" or
151        $appname eq "query_compile_time_config" ) {
152        $srcs .= "\n    <ClCompile Include=\"..\\..\\programs\\test\\query_config.c\" \/>";
153    }
154    if( $appname eq "ssl_client2" or $appname eq "ssl_server2" ) {
155        $srcs .= "\n    <ClCompile Include=\"..\\..\\programs\\ssl\\ssl_test_lib.c\" \/>";
156    }
157
158    my $content = $template;
159    $content =~ s/<SOURCES>/$srcs/g;
160    $content =~ s/<APPNAME>/$appname/g;
161    $content =~ s/<GUID>/$guid/g;
162    $content =~ s/INCLUDE_DIRECTORIES\n/($is_test_app ?
163                                         $library_include_directories :
164                                         $include_directories)/ge;
165
166    content_to_file( $content, "$dir/$appname.$ext" );
167}
168
169sub get_app_list {
170    my $makefile_contents = slurp_file('programs/Makefile');
171    $makefile_contents =~ /\n\s*APPS\s*=[\\\s]*(.*?)(?<!\\)[\#\n]/s
172      or die "Cannot find APPS = ... in programs/Makefile\n";
173    return split /(?:\s|\\)+/, $1;
174}
175
176sub gen_app_files {
177    my @app_list = @_;
178
179    my $vsx_tpl = slurp_file( $vsx_app_tpl_file );
180
181    for my $app ( @app_list ) {
182        gen_app( $app, $vsx_tpl, $vsx_dir, $vsx_ext );
183    }
184}
185
186sub gen_entry_list {
187    my ($tpl, @names) = @_;
188
189    my $entries;
190    for my $name (@names) {
191        (my $entry = $tpl) =~ s/{NAME}/$name/g;
192        $entries .= $entry;
193    }
194
195    return $entries;
196}
197
198sub gen_main_file {
199    my ($headers, $sources,
200        $hdr_tpl, $src_tpl,
201        $main_tpl, $main_out) = @_;
202
203    my $header_entries = gen_entry_list( $hdr_tpl, @$headers );
204    my $source_entries = gen_entry_list( $src_tpl, @$sources );
205
206    my $out = slurp_file( $main_tpl );
207    $out =~ s/SOURCE_ENTRIES\n/$source_entries/m;
208    $out =~ s/HEADER_ENTRIES\n/$header_entries/m;
209    $out =~ s/INCLUDE_DIRECTORIES\n/$library_include_directories/g;
210
211    content_to_file( $out, $main_out );
212}
213
214sub gen_vsx_solution {
215    my (@app_names) = @_;
216
217    my ($app_entries, $conf_entries);
218    for my $path (@app_names) {
219        my $guid = gen_app_guid( $path );
220        (my $appname = $path) =~ s!.*/!!;
221
222        my $app_entry = $vsx_sln_app_entry_tpl;
223        $app_entry =~ s/{APPNAME}/$appname/g;
224        $app_entry =~ s/{GUID}/$guid/g;
225
226        $app_entries .= $app_entry;
227
228        my $conf_entry = $vsx_sln_conf_entry_tpl;
229        $conf_entry =~ s/{GUID}/$guid/g;
230
231        $conf_entries .= $conf_entry;
232    }
233
234    my $out = slurp_file( $vsx_sln_tpl_file );
235    $out =~ s/APP_ENTRIES\n/$app_entries/m;
236    $out =~ s/CONF_ENTRIES\n/$conf_entries/m;
237
238    content_to_file( $out, $vsx_sln_file );
239}
240
241sub del_vsx_files {
242    unlink glob "'$vsx_dir/*.$vsx_ext'";
243    unlink $vsx_main_file;
244    unlink $vsx_sln_file;
245}
246
247sub main {
248    if( ! check_dirs() ) {
249        chdir '..' or die;
250        check_dirs or die "Must be run from Mbed TLS root or scripts dir\n";
251    }
252
253    # Remove old files to ensure that, for example, project files from deleted
254    # apps are not kept
255    del_vsx_files();
256
257    my @app_list = get_app_list();
258    my @header_dirs = (
259                       $mbedtls_header_dir,
260                       $psa_header_dir,
261                       $test_header_dir,
262                       $test_drivers_header_dir,
263                       $source_dir,
264                       @thirdparty_header_dirs,
265                      );
266    my @headers = (map { <$_/*.h> } @header_dirs);
267    my @source_dirs = (
268                       $source_dir,
269                       $test_source_dir,
270                       $test_drivers_source_dir,
271                       @thirdparty_source_dirs,
272                      );
273    my @sources = (map { <$_/*.c> } @source_dirs);
274
275    @headers = grep { ! $excluded_files{$_} } @headers;
276    @sources = grep { ! $excluded_files{$_} } @sources;
277    map { s!/!\\!g } @headers;
278    map { s!/!\\!g } @sources;
279
280    gen_app_files( @app_list );
281
282    gen_main_file( \@headers, \@sources,
283                   $vsx_hdr_tpl, $vsx_src_tpl,
284                   $vsx_main_tpl_file, $vsx_main_file );
285
286    gen_vsx_solution( @app_list );
287
288    return 0;
289}
290