compile_all.py 6.92 KB
Newer Older
Enrico Pozzobon committed
1 2 3 4
#!/usr/bin/env python3

import os
import sys
Enrico Pozzobon committed
5
import stat
6
import argparse
Enrico Pozzobon committed
7 8 9
import shutil
import subprocess

Enrico Pozzobon committed
10

Enrico Pozzobon committed
11
def build(algo_dir, template_dir, build_dir):
12
    if os.path.isdir(build_dir):
Enrico Pozzobon committed
13
        raise Exception("Directory %s doesn't exist" % build_dir)
14

15
    print("Building in %s" % build_dir)
16

Enrico Pozzobon committed
17
    # copy all the files from the submitted algorithm into the build directory
Enrico Pozzobon committed
18 19
    shutil.copytree(algo_dir, build_dir)

Enrico Pozzobon committed
20
    # remove the test vectors generator if it is there
21 22 23 24 25 26
    for r, d, f in os.walk(build_dir):
        for file in f:
            with open(os.path.join(r, file), 'r') as o:
                is_generator = 'generate_test_vectors' in o.read()
            if is_generator:
                os.remove(os.path.join(r, file))
Enrico Pozzobon committed
27

Enrico Pozzobon committed
28
    # find all c and h files, since they will be added to the makefile
29 30
    hfiles = []
    cfiles = []
31
    sfiles = []
32 33
    for r, d, f in os.walk(build_dir):
        for file in f:
34
            if file.lower().endswith(".c"):
35
                cfiles.append(file)
36 37 38
            elif file.lower().endswith(".s"):
                sfiles.append(file)
            elif file.lower().endswith(".h"):
39 40
                hfiles.append(file)

Enrico Pozzobon committed
41
    # copy all the files from the template directory into the build directory
42 43 44 45 46 47 48 49 50 51
    for f in os.listdir(template_dir):
        dst = os.path.join(build_dir, f)
        src = os.path.join(template_dir, f)
        if os.path.isfile(src) or os.path.islink(src):
            shutil.copy2(src, dst)
        elif os.path.isdir(src):
            shutil.copytree(src, dst)
        else:
            raise Exception("I don't know what %s is" % src)

Enrico Pozzobon committed
52
    # prepare the environmental variables for the makefile
Enrico Pozzobon committed
53 54
    env = os.environ
    env['SRC_FILES'] = ' '.join(cfiles)
55
    env['ASM_FILES'] = ' '.join(sfiles)
Enrico Pozzobon committed
56 57
    env['HDR_FILES'] = ' '.join(hfiles)

Enrico Pozzobon committed
58
    # enter the directory and execute the makefile
Enrico Pozzobon committed
59
    wd = os.getcwd()
Enrico Pozzobon committed
60
    os.chdir(build_dir)
Enrico Pozzobon committed
61
    try:
62
        if os.path.isfile('./configure'):
63
            subprocess.check_call(["./configure"])
64

65 66 67 68 69
        stdout_path = 'make.stdout.log'
        stderr_path = 'make.stderr.log'
        with open(stdout_path, 'w') as outfile, \
             open(stderr_path, 'w') as errfile:
            subprocess.check_call(['make'], stdout=outfile, stderr=errfile)
Enrico Pozzobon committed
70

71
        if os.path.isfile('./cleanup'):
72
            subprocess.check_call(["./cleanup"])
73

Enrico Pozzobon committed
74
    finally:
75 76
        sys.stdout.flush()
        sys.stderr.flush()
Enrico Pozzobon committed
77 78
        os.chdir(wd)

Enrico Pozzobon committed
79
    # if execution arrives here, the build was successful
Enrico Pozzobon committed
80
    return True
Enrico Pozzobon committed
81

Enrico Pozzobon committed
82 83

# Find test vectors in directory or one of the parent directories
Enrico Pozzobon committed
84 85
def find_test_vectors(d):
    kat = None
Enrico Pozzobon committed
86
    while True:
Enrico Pozzobon committed
87 88 89 90 91 92 93
        if d == '':
            raise Exception("Test vector not found")
        for f in os.listdir(d):
            if f.startswith("LWC_AEAD_KAT_") and f.endswith(".txt"):
                if kat is not None:
                    raise Exception("Multiple test vectors?")
                kat = f
Enrico Pozzobon committed
94 95 96 97
        if kat is None:
            d = os.path.split(d)[0]
        else:
            break
Enrico Pozzobon committed
98 99
    kat = os.path.join(d, kat)
    return kat
Enrico Pozzobon committed
100

Enrico Pozzobon committed
101

102
def main(argv):
103
    include_list = None
104 105 106

    # Parse the arguments
    argparser = argparse.ArgumentParser(
107
        description='Compiles all LWC submissions for a given template')
108 109 110

    argparser.add_argument('-v', '--verbose', action='count')
    argparser.add_argument('-i', '--include', action='append')
111 112 113 114
    argparser.add_argument('-t', '--template', default='templates/linux')
    argparser.add_argument('-b', '--build-dir', default='build')
    argparser.add_argument('-s', '--submissions-dir',
                           default='all-lwc-submission-files')
115 116 117 118 119 120

    args = argparser.parse_args(argv[1:])
    template_dir = args.template
    build_root_dir = args.build_dir

    include_list = args.include
121
    submissions_dir = args.submissions_dir
122

123
    print("Using template %s" % template_dir)
Enrico Pozzobon committed
124 125
    subs = os.listdir(submissions_dir)

Enrico Pozzobon committed
126
    # get all the submissions by looking for files named "api.h"
127
    implementations = []
Enrico Pozzobon committed
128
    for submission in subs:
129
        variants_dir = os.path.join(
130
            submissions_dir, submission, "Implementations", "crypto_aead")
Enrico Pozzobon committed
131

132
        if not os.path.isdir(variants_dir):
Enrico Pozzobon committed
133 134
            continue

135
        if "NOT ACCEPTED" in variants_dir:
Enrico Pozzobon committed
136 137 138 139 140 141
            continue

        print()
        print("###  %s  ###" % submission)

        c = 0
142 143 144
        for variant in os.listdir(variants_dir):
            implementations_dir = os.path.join(
                variants_dir, variant)
145 146
            if not os.path.isdir(implementations_dir):
                continue
147 148 149 150 151 152
            for implementation in os.listdir(implementations_dir):
                implementation_dir = os.path.join(
                    implementations_dir, implementation)
                if os.path.isfile(os.path.join(implementation_dir, "api.h")):
                    implementations.append(
                        (submission, variant, implementation))
153 154 155 156
                    c += 1

        if c == 0:
            raise Exception("No implementations found")
Enrico Pozzobon committed
157

158 159
    if include_list is not None:
        print("Include list has %d entries" % len(include_list))
Enrico Pozzobon committed
160

161
    files = []
162 163 164 165 166
    for submission, variant, implementation in implementations:

        # base name n (a.k.a. cipher slug)
        n = '.'.join([submission, variant, implementation])
        print(n)
Enrico Pozzobon committed
167

168
        # Source directory d
169 170 171
        d = os.path.join(
            submissions_dir, submission, "Implementations", "crypto_aead",
            variant, implementation)
172 173
        assert os.path.isdir(d)
        print(d)
Enrico Pozzobon committed
174

175 176 177
        # Test vectors file t
        t = find_test_vectors(d)
        print(t)
Enrico Pozzobon committed
178

179 180
        # if include_list was provided, skip elements not in the list
        if include_list is not None:
181
            if n not in include_list:
182 183
                continue

184 185 186 187 188 189 190
        # Find date of last modification in directory
        st_mtime = 0
        for root, dirs, filess in os.walk(d):
            for name in filess:
                path = os.path.join(root, name)
                st_mtime = max(st_mtime, os.stat(path).st_mtime)

191
        # Put all in a tuple and count
192
        files.append((t, d, n, st_mtime))
Enrico Pozzobon committed
193

194
    # Uncomment next line for testing, if we only want to do 1
195
    # files = files[:1]
196
    print("%d algorithms will be compiled" % len(files))
Enrico Pozzobon committed
197

198 199
    if not os.path.isdir(build_root_dir):
        os.mkdir(build_root_dir)
Enrico Pozzobon committed
200 201 202

    print()

203
    # Build all found algorithms
Enrico Pozzobon committed
204
    for t, d, name, st_mtime in files:
205 206 207 208 209
        print()
        print(d)
        try:
            build_dir = os.path.join(build_root_dir, name)

Enrico Pozzobon committed
210
            build(d, template_dir, build_dir)
211

Enrico Pozzobon committed
212
            shutil.copyfile(t, os.path.join(build_dir, 'LWC_AEAD_KAT.txt'))
213 214 215 216 217 218 219 220 221

            mdate_path = os.path.join(build_dir, 'cipher_mtime.txt')
            with open(mdate_path, 'wt') as mdate_file:
                print(int(st_mtime), file=mdate_file)

            print("COMPILATION SUCCESS FOR %s" % d)
        except Exception as ex:
            print("COMPILATION FAILED FOR %s" % d)
            print(ex)
Enrico Pozzobon committed
222

223 224
    print()

Enrico Pozzobon committed
225 226 227

if __name__ == "__main__":
    sys.exit(main(sys.argv))