lamina 0.0.10

High-performance compiler backend for Lamina Intermediate Representation
Documentation
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
//! Assembly/compilation backends for converting intermediate formats to binaries.
//!
//! Supports multiple assemblers:
//! - **Ras**: Drop-in replacement for as/gas; x86_64 and AArch64, ELF (library or `ras` binary).
//! - gas (GNU Assembler), clang's as
//! - WASM: wat2wasm

use crate::error::LaminaError;
use lamina_platform::{TargetArchitecture, TargetOperatingSystem};
use std::path::{Path, PathBuf};
use std::process::Command;

/// Assembler backend type
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum AssemblerBackend {
    /// Ras (drop-in replacement for as/gas); x86_64 and AArch64, ELF object output
    Ras,
    /// GNU Assembler (gas/as)
    Gas,
    /// Clang's integrated assembler
    Lld,
    /// wat2wasm for WebAssembly
    Wat2Wasm,
    /// Custom assembler (specified by name)
    Custom(&'static str),
}

/// Result of assembly operation
pub struct AssembleResult {
    /// Path to the output file (object file or WASM binary)
    pub output_path: PathBuf,
    /// Whether linking is needed after assembly
    pub needs_linking: bool,
}

/// Assemble intermediate format to binary
pub fn assemble(
    input_path: &Path,
    output_path: &Path,
    target_arch: TargetArchitecture,
    target_os: TargetOperatingSystem,
    backend: Option<AssemblerBackend>,
    additional_flags: &[String],
    verbose: bool,
) -> Result<AssembleResult, LaminaError> {
    assemble_with_ras_object_options(
        input_path,
        output_path,
        target_arch,
        target_os,
        backend,
        additional_flags,
        verbose,
        ras::ObjectWriteOptions::default(),
    )
}

/// Like [`assemble`], but passes [`ras::ObjectWriteOptions`] when the backend is Ras (ignored for gas/lld/wat2wasm).
#[allow(clippy::too_many_arguments)]
pub fn assemble_with_ras_object_options(
    input_path: &Path,
    output_path: &Path,
    target_arch: TargetArchitecture,
    target_os: TargetOperatingSystem,
    backend: Option<AssemblerBackend>,
    additional_flags: &[String],
    verbose: bool,
    ras_object_write_options: ras::ObjectWriteOptions,
) -> Result<AssembleResult, LaminaError> {
    if !input_path.exists() {
        return Err(LaminaError::ValidationError(format!(
            "Input file does not exist: {}",
            input_path.display()
        )));
    }

    match target_arch {
        TargetArchitecture::Wasm32 | TargetArchitecture::Wasm64 => {
            assemble_wasm(input_path, output_path, backend, additional_flags, verbose)
        }
        _ => assemble_native(
            input_path,
            output_path,
            target_arch,
            target_os,
            backend,
            additional_flags,
            verbose,
            ras_object_write_options,
        ),
    }
}

/// Assemble WASM (WAT -> WASM binary)
fn assemble_wasm(
    input_path: &Path,
    output_path: &Path,
    backend: Option<AssemblerBackend>,
    additional_flags: &[String],
    verbose: bool,
) -> Result<AssembleResult, LaminaError> {
    let backend = backend.unwrap_or(AssemblerBackend::Wat2Wasm);

    match backend {
        AssemblerBackend::Wat2Wasm => {
            let mut cmd = Command::new("wat2wasm");
            cmd.arg(input_path);
            cmd.arg("-o");
            cmd.arg(output_path);
            cmd.args(additional_flags);
            let output = cmd.output().map_err(|e| {
                LaminaError::ValidationError(format!(
                    "Failed to spawn wat2wasm: {}. Make sure wat2wasm is installed and in PATH.",
                    e
                ))
            })?;

            if !output.status.success() {
                let stderr = String::from_utf8_lossy(&output.stderr);
                return Err(LaminaError::ValidationError(format!(
                    "wat2wasm failed: {}",
                    stderr
                )));
            }

            if verbose {
                println!(
                    "[VERBOSE] wat2wasm: {} -> {}",
                    input_path.display(),
                    output_path.display()
                );
            }

            Ok(AssembleResult {
                output_path: output_path.to_path_buf(),
                needs_linking: false, // WASM doesn't need linking
            })
        }
        _ => Err(LaminaError::ValidationError(format!(
            "Unsupported assembler backend for WASM: {:?}",
            backend
        ))),
    }
}

/// Assemble native assembly to object file
#[allow(clippy::too_many_arguments)]
fn assemble_native(
    input_path: &Path,
    output_path: &Path,
    target_arch: TargetArchitecture,
    target_os: TargetOperatingSystem,
    backend: Option<AssemblerBackend>,
    additional_flags: &[String],
    verbose: bool,
    ras_object_write_options: ras::ObjectWriteOptions,
) -> Result<AssembleResult, LaminaError> {
    let backend = backend.unwrap_or_else(|| detect_assembler_backend(target_arch, target_os));
    let backend = validate_assembler_backend_for_target(backend, target_arch, target_os)?;

    if backend == AssemblerBackend::Ras {
        if verbose {
            println!(
                "[VERBOSE] Assembling with ras (as/GAS alternative): {} -> {}",
                input_path.display(),
                output_path.display()
            );
        }
        let mut ras =
            ras::Ras::with_object_write_options(target_arch, target_os, ras_object_write_options)
                .map_err(|e| {
                LaminaError::ValidationError(format!("Failed to create ras assembler: {}", e))
            })?;
        ras.assemble_file(input_path, output_path)
            .map_err(|e| LaminaError::ValidationError(format!("ras assembly failed: {}", e)))?;
        return Ok(AssembleResult {
            output_path: output_path.to_path_buf(),
            needs_linking: true,
        });
    }

    let (cmd, args) = match backend {
        AssemblerBackend::Gas => {
            let mut args = vec![];
            // Set architecture-specific flags for gas/as
            match target_arch {
                TargetArchitecture::X86_64 => {
                    if target_os != TargetOperatingSystem::MacOS {
                        args.push("--64".to_string());
                    }
                }
                TargetArchitecture::Aarch64 => {
                    // macOS as doesn't support -march, it auto-detects from -arch
                    if target_os == TargetOperatingSystem::MacOS {
                        args.push("-arch".to_string());
                        args.push("arm64".to_string());
                    } else {
                        args.push("-march=aarch64".to_string());
                    }
                }
                TargetArchitecture::Riscv32 | TargetArchitecture::Riscv64 => {
                    args.push(format!(
                        "-march=rv{}",
                        if matches!(target_arch, TargetArchitecture::Riscv64) {
                            "64"
                        } else {
                            "32"
                        }
                    ));
                }
                _ => {}
            }
            args.push(input_path.to_string_lossy().to_string());
            args.push("-o".to_string());
            args.push(output_path.to_string_lossy().to_string());
            args.extend(additional_flags.iter().cloned());
            ("as", args)
        }
        AssemblerBackend::Lld => {
            let mut args = vec!["-c".to_string()];

            let target_triple = match (target_arch, target_os) {
                (TargetArchitecture::X86_64, TargetOperatingSystem::Linux) => {
                    "x86_64-unknown-linux-gnu"
                }
                (TargetArchitecture::X86_64, TargetOperatingSystem::MacOS) => "x86_64-apple-darwin",
                (TargetArchitecture::X86_64, TargetOperatingSystem::Windows) => {
                    "x86_64-pc-windows-msvc"
                }
                (TargetArchitecture::Aarch64, TargetOperatingSystem::Linux) => {
                    "aarch64-unknown-linux-gnu"
                }
                (TargetArchitecture::Aarch64, TargetOperatingSystem::MacOS) => {
                    "aarch64-apple-darwin"
                }
                (TargetArchitecture::Riscv32, TargetOperatingSystem::Linux) => {
                    "riscv32-unknown-linux-gnu"
                }
                (TargetArchitecture::Riscv64, TargetOperatingSystem::Linux) => {
                    "riscv64-unknown-linux-gnu"
                }
                _ => {
                    return Err(LaminaError::ValidationError(format!(
                        "Unsupported target combination for clang assembler: {:?} {:?}",
                        target_arch, target_os
                    )));
                }
            };

            args.push("-target".to_string());
            args.push(target_triple.to_string());
            args.extend(additional_flags.iter().cloned());
            args.push(input_path.to_string_lossy().to_string());
            args.push("-o".to_string());
            args.push(output_path.to_string_lossy().to_string());
            ("clang", args)
        }
        AssemblerBackend::Custom(name) => {
            let args = vec![
                input_path.to_string_lossy().to_string(),
                "-o".to_string(),
                output_path.to_string_lossy().to_string(),
            ];
            (name, args)
        }
        AssemblerBackend::Ras => unreachable!("Ras handled above"),
        AssemblerBackend::Wat2Wasm => {
            return Err(LaminaError::ValidationError(
                "Wat2Wasm is for WASM targets only".to_string(),
            ));
        }
    };

    if verbose {
        println!("[VERBOSE] Assembling with {}: {:?}", cmd, args);
    }

    let output = Command::new(cmd).args(&args).output().map_err(|e| {
        LaminaError::ValidationError(format!("Failed to spawn assembler '{}': {}", cmd, e))
    })?;

    if !output.status.success() {
        let stderr = String::from_utf8_lossy(&output.stderr);
        let stdout = String::from_utf8_lossy(&output.stdout);
        return Err(LaminaError::ValidationError(format!(
            "Assembler '{}' failed:\nstdout: {}\nstderr: {}",
            cmd, stdout, stderr
        )));
    }

    Ok(AssembleResult {
        output_path: output_path.to_path_buf(),
        needs_linking: true, // Native object files need linking
    })
}

/// Detect available assembler backend for the given target.
///
/// Prefers a system assembler (gas/clang) when one is installed, because ras
/// cannot yet assemble programs that reference data symbols or external calls
/// (e.g. `print`/printf). ras is used only as a fallback when no system
/// assembler is present; select it explicitly with `--assembler ras` or
/// `-c lamina` for the standalone, no-toolchain path.
pub fn detect_assembler_backend(
    target_arch: TargetArchitecture,
    target_os: TargetOperatingSystem,
) -> AssemblerBackend {
    if target_os == TargetOperatingSystem::Windows
        && Command::new("clang").arg("--version").output().is_ok()
    {
        return AssemblerBackend::Lld;
    }

    if Command::new("as").arg("--version").output().is_ok() {
        return AssemblerBackend::Gas;
    }

    if Command::new("clang").arg("--version").output().is_ok() {
        return AssemblerBackend::Lld;
    }

    if matches!(
        target_arch,
        TargetArchitecture::X86_64 | TargetArchitecture::Aarch64 | TargetArchitecture::Arx64
    ) && ras::is_object_file_supported(target_arch, target_os)
    {
        return AssemblerBackend::Ras;
    }

    AssemblerBackend::Gas
}

/// Get the appropriate file extension for assembly output
pub fn get_assembly_output_extension(target_arch: TargetArchitecture) -> &'static str {
    match target_arch {
        TargetArchitecture::Wasm32 | TargetArchitecture::Wasm64 => "wasm",
        _ => "o", // Object file for native targets
    }
}

/// Intermediate assembly/WAT file extension for the given target.
pub fn get_intermediate_extension(
    target_arch: TargetArchitecture,
    target_os: TargetOperatingSystem,
) -> &'static str {
    match target_arch {
        TargetArchitecture::Wasm32 | TargetArchitecture::Wasm64 => "wat",
        _ => {
            if target_os == TargetOperatingSystem::Windows {
                "asm"
            } else {
                "s"
            }
        }
    }
}

fn validate_assembler_backend_for_target(
    backend: AssemblerBackend,
    target_arch: TargetArchitecture,
    target_os: TargetOperatingSystem,
) -> Result<AssemblerBackend, LaminaError> {
    match backend {
        AssemblerBackend::Wat2Wasm => {
            if matches!(
                target_arch,
                TargetArchitecture::Wasm32 | TargetArchitecture::Wasm64
            ) {
                Ok(backend)
            } else {
                Err(LaminaError::ValidationError(
                    "wat2wasm assembler is only valid for WASM targets".to_string(),
                ))
            }
        }
        AssemblerBackend::Ras => {
            if !matches!(
                target_arch,
                TargetArchitecture::X86_64 | TargetArchitecture::Aarch64 | TargetArchitecture::Arx64
            ) {
                return Err(LaminaError::ValidationError(format!(
                    "Ras assembler supports x86_64, AArch64, and ARX64 only, not {:?}",
                    target_arch
                )));
            }
            if !ras::is_object_file_supported(target_arch, target_os) {
                return Err(LaminaError::ValidationError(format!(
                    "Ras assembler does not support object output for {:?} {:?}",
                    target_arch, target_os
                )));
            }
            Ok(backend)
        }
        AssemblerBackend::Gas => {
            if target_os == TargetOperatingSystem::Windows {
                return Err(LaminaError::ValidationError(
                    "GNU as/gas is not supported for Windows targets; use --assembler clang"
                        .to_string(),
                ));
            }
            Ok(backend)
        }
        AssemblerBackend::Lld | AssemblerBackend::Custom(_) => Ok(backend),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn intermediate_extension_windows_uses_asm() {
        assert_eq!(
            get_intermediate_extension(
                TargetArchitecture::X86_64,
                TargetOperatingSystem::Windows
            ),
            "asm"
        );
    }

    #[test]
    fn intermediate_extension_linux_uses_s() {
        assert_eq!(
            get_intermediate_extension(
                TargetArchitecture::X86_64,
                TargetOperatingSystem::Linux
            ),
            "s"
        );
    }

    #[test]
    fn intermediate_extension_macos_uses_s() {
        assert_eq!(
            get_intermediate_extension(
                TargetArchitecture::Aarch64,
                TargetOperatingSystem::MacOS
            ),
            "s"
        );
    }

    #[test]
    fn intermediate_extension_wasm_uses_wat() {
        assert_eq!(
            get_intermediate_extension(
                TargetArchitecture::Wasm32,
                TargetOperatingSystem::Linux
            ),
            "wat"
        );
    }

    #[test]
    fn gas_rejected_for_windows_target() {
        let error = validate_assembler_backend_for_target(
            AssemblerBackend::Gas,
            TargetArchitecture::X86_64,
            TargetOperatingSystem::Windows,
        )
        .expect_err("gas should be rejected on Windows targets");
        assert!(error.to_string().contains("GNU as/gas"));
    }
}