aboutsummaryrefslogtreecommitdiff
path: root/lib/compilers/zig.ts
blob: e01808e576ddc67de8aa980e70fb0e20a23efeb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
// Copyright (c) 2018, Marc Tiehuis
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

import path from 'path';

import Semver from 'semver';
import _ from 'underscore';

import type {PreliminaryCompilerInfo} from '../../types/compiler.interfaces.js';
import type {ParseFiltersAndOutputOptions} from '../../types/features/filters.interfaces.js';
import type {SelectedLibraryVersion} from '../../types/libraries/libraries.interfaces.js';
import {BaseCompiler} from '../base-compiler.js';
import {asSafeVer} from '../utils.js';

export class ZigCompiler extends BaseCompiler {
    private readonly self_hosted_cli: boolean;

    static get key() {
        return 'zig';
    }

    constructor(info: PreliminaryCompilerInfo, env) {
        super(info, env);
        this.compiler.supportsIntel = true;
        this.compiler.supportsIrView = true;

        this.self_hosted_cli =
            this.compiler.semver === 'trunk' ||
            !!(this.compiler.semver && Semver.gt(asSafeVer(this.compiler.semver), '0.6.0', true));

        if (this.self_hosted_cli) {
            this.compiler.irArg = ['-femit-llvm-ir'];
        } else {
            this.compiler.irArg = ['--emit', 'llvm-ir'];
        }
        this.compiler.minIrArgs = ['--emit llvm-ir', '-femit-llvm-ir'];
    }

    override getSharedLibraryPathsAsArguments(): string[] {
        return [];
    }

    override preProcess(source: string): string {
        if (Semver.eq(asSafeVer(this.compiler.semver), '0.2.0', true)) {
            source += '\n';
            source += 'extern fn zig_panic() noreturn;\n';
            source += 'pub fn panic(msg: []const u8, error_return_trace: ?&@import("builtin").StackTrace) noreturn {\n';
            source += '    zig_panic();\n';
            source += '}\n';
        } else if (
            Semver.gte(asSafeVer(this.compiler.semver), '0.3.0', true) &&
            Semver.lte(asSafeVer(this.compiler.semver), '0.7.1', true)
        ) {
            source += '\n';
            source += 'extern fn zig_panic() noreturn;\n';
            source += 'pub fn panic(msg: []const u8, error_return_trace: ?*@import("builtin").StackTrace) noreturn {\n';
            source += '    zig_panic();\n';
            source += '}\n';
        } else if (
            Semver.gte(asSafeVer(this.compiler.semver), '0.8.0', true) &&
            Semver.lte(asSafeVer(this.compiler.semver), '0.9.0', true)
        ) {
            source += '\n';
            source += 'extern fn zig_panic() noreturn;\n';
            source +=
                'pub fn panic(msg: []const u8, error_return_trace: ' +
                '?*@import("std").builtin.StackTrace) noreturn {\n';
            source += '    _ = msg;\n';
            source += '    _ = error_return_trace;\n';
            source += '    zig_panic();\n';
            source += '}\n';
        } else {
            source += '\n';
            source += 'extern fn zig_panic() noreturn;\n';
            source +=
                'pub fn panic(msg: []const u8, error_return_trace: ' +
                '?*@import("std").builtin.StackTrace, ret_addr: ?usize) noreturn {\n';
            source += '    _ = msg;\n';
            source += '    _ = error_return_trace;\n';
            source += '    _ = ret_addr;\n';
            source += '    zig_panic();\n';
            source += '}\n';
        }

        return source;
    }

    override optionsForFilter(
        filters: ParseFiltersAndOutputOptions,
        outputFilename: string,
        userOptions: string[],
    ): string[] {
        let options = [filters.execute ? 'build-exe' : 'build-obj'];

        const desiredName = path.basename(outputFilename);
        // strip '.s' if we aren't executing
        const name = filters.execute ? desiredName : desiredName.slice(0, -2);

        if (this.self_hosted_cli) {
            // Versions after 0.6.0 use a different command line interface.
            const outputDir = path.dirname(outputFilename);
            options.push('--cache-dir', outputDir, '--name', name);

            if (filters.binary) {
                options.push('-femit-bin=' + desiredName);
            } else {
                options.push('-fno-emit-bin', '-femit-asm=' + desiredName);
            }
            return options;
        }

        if (this.compiler.semver && Semver.gt(asSafeVer(this.compiler.semver), '0.3.0', true)) {
            const outputDir = path.dirname(outputFilename);
            options.push('--cache-dir', outputDir, '--output-dir', outputDir, '--name', name);
        } else {
            // Older versions use a different command line interface (#1304)
            options.push(
                '--cache-dir',
                path.dirname(outputFilename),
                '--output',
                this.filename(outputFilename),
                '--output-h',
                '/dev/null',
            );
        }

        if (!filters.binary) {
            const userRequestedEmit = _.any(userOptions, opt => opt.includes('--emit'));
            if (!userRequestedEmit) {
                options = options.concat('--emit', 'asm');
            }
            if (filters.intel) options = options.concat('-mllvm', '--x86-asm-syntax=intel');
        }
        return options;
    }

    override getIncludeArguments(libraries: SelectedLibraryVersion[]) {
        return libraries.flatMap(selectedLib => {
            const foundVersion = this.findLibVersion(selectedLib);
            if (!foundVersion) return [];
            // Zig should not have more than 1 path, but it's still an array so spread it
            return [
                '--pkg-begin',
                ...(foundVersion.name ? [foundVersion.name] : []),
                ...foundVersion.path,
                '--pkg-end',
            ];
        });
    }

    override getIrOutputFilename(inputFilename: string): string {
        return this.getOutputFilename(path.dirname(inputFilename), this.outputFilebase).replace('.s', '.ll');
    }

    override filterUserOptions(userOptions: string[]): string[] {
        const forbiddenOptions = /^(((--(cache-dir|name|output|verbose))|(-(mllvm|f(no-)?emit-))).*)$/;
        return userOptions.filter(option => !forbiddenOptions.test(option));
    }

    override isCfgCompiler(/*compilerVersion*/): boolean {
        return true;
    }
}