lamina_platform/

shared.rs

//! Types the IR and the MIR both name, defined once so the two layers agree.
//!
//! Each of these was once declared in `lamina-ir` and again in `lamina-mir`, which made
//! `lamina::TlsModel` and `lamina::mir::TlsModel` distinct types with one name, bridged
//! by hand at the lowering boundary.

use std::{fmt, num::NonZeroU32};

/// How a thread-local symbol's address is computed.
///
/// Only the two models that need no runtime support are here. General-dynamic and
/// local-dynamic both call `__tls_get_addr`, which a freestanding target does not have,
/// so the parser names them and refuses.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum TlsModel {
    /// The offset from the thread pointer is a link-time constant. Only valid in an
    /// executable that defines the symbol itself.
    LocalExec,
    /// The offset from the thread pointer is loaded from the GOT, so the symbol may be
    /// defined by a shared object present at program start.
    InitialExec,
}

impl TlsModel {
    pub const fn as_str(&self) -> &'static str {
        match self {
            TlsModel::LocalExec => "local_exec",
            TlsModel::InitialExec => "initial_exec",
        }
    }
}

impl fmt::Display for TlsModel {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

/// Ordering guarantees an atomic operation carries, relative to other memory
/// operations in the same thread and across threads.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum MemoryOrdering {
    /// No synchronization or ordering constraints.
    Relaxed,
    /// Prevents reordering of subsequent loads.
    Acquire,
    /// Prevents reordering of previous stores.
    Release,
    /// Both acquire and release semantics.
    AcqRel,
    /// Sequentially consistent: the strongest guarantee.
    SeqCst,
}

impl MemoryOrdering {
    /// Where this ordering sits in the total order the C and LLVM memory models put
    /// their orderings in, so that one can be compared against another.
    pub fn strength(self) -> u8 {
        match self {
            Self::Relaxed => 0,
            Self::Acquire => 1,
            Self::Release => 2,
            Self::AcqRel => 3,
            Self::SeqCst => 4,
        }
    }

    /// Why `failure` cannot be the failure ordering of a compare-exchange whose
    /// success ordering is `success`, or `None` when it can.
    ///
    /// A compare-exchange that fails still performs the load and nothing else, so its
    /// ordering carries no release, and it may not order more than the success
    /// ordering does. C and LLVM both impose these two rules.
    pub fn cmpxchg_failure_rejection(success: Self, failure: Self) -> Option<&'static str> {
        match failure {
            Self::Release | Self::AcqRel => {
                Some("the failure ordering is a load: use relaxed, acquire or seqcst")
            }
            Self::Relaxed | Self::Acquire | Self::SeqCst => {
                if failure.strength() > success.strength() {
                    Some("the failure ordering may not be stronger than the success ordering")
                } else {
                    None
                }
            }
        }
    }
}

impl fmt::Display for MemoryOrdering {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let s = match self {
            MemoryOrdering::Relaxed => "relaxed",
            MemoryOrdering::Acquire => "acquire",
            MemoryOrdering::Release => "release",
            MemoryOrdering::AcqRel => "acqrel",
            MemoryOrdering::SeqCst => "seqcst",
        };
        write!(f, "{s}")
    }
}

pub const DEFAULT_SOURCE_FILE: NonZeroU32 = NonZeroU32::MIN;

/// A position in the `.lamina` source an instruction was parsed from.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct SourceLoc {
    pub line: NonZeroU32,
    pub column: u32,
    pub file: NonZeroU32,
}

impl SourceLoc {
    /// A position, or `None` when `line` is zero: lines are numbered from one.
    pub fn new(line: u32, column: u32) -> Option<Self> {
        Self::in_file(DEFAULT_SOURCE_FILE.get(), line, column)
    }

    pub fn in_file(file: u32, line: u32, column: u32) -> Option<Self> {
        Some(Self {
            line: NonZeroU32::new(line)?,
            column,
            file: NonZeroU32::new(file)?,
        })
    }

    pub fn line(self) -> u32 {
        self.line.get()
    }
}

impl fmt::Display for SourceLoc {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.file == DEFAULT_SOURCE_FILE {
            write!(f, "{}:{}", self.line, self.column)
        } else {
            write!(f, "{}:{}:{}", self.file, self.line, self.column)
        }
    }
}

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

    #[test]
    fn source_loc_rejects_line_zero() {
        assert!(SourceLoc::new(0, 4).is_none());
        let loc = SourceLoc::new(7, 4).expect("line 7 is a line");
        assert_eq!(loc.line(), 7);
        assert_eq!(loc.file, DEFAULT_SOURCE_FILE);
        assert_eq!(loc.to_string(), "7:4");
    }

    #[test]
    fn source_loc_in_a_file_names_that_file() {
        assert!(SourceLoc::in_file(0, 3, 1).is_none());
        assert!(SourceLoc::in_file(2, 0, 1).is_none());
        let loc = SourceLoc::in_file(2, 3, 1).expect("file 2, line 3");
        assert_eq!(loc.file.get(), 2);
        assert_eq!(loc.to_string(), "2:3:1");
        assert_ne!(loc, SourceLoc::new(3, 1).expect("line 3"));
    }

    #[test]
    fn a_compare_exchange_failure_ordering_is_a_load_no_stronger_than_the_success() {
        use MemoryOrdering::{AcqRel, Acquire, Relaxed, Release, SeqCst};
        for (success, failure) in [
            (SeqCst, SeqCst),
            (SeqCst, Acquire),
            (SeqCst, Relaxed),
            (AcqRel, Acquire),
            (Release, Acquire),
            (Acquire, Acquire),
            (Acquire, Relaxed),
            (Relaxed, Relaxed),
        ] {
            assert_eq!(
                MemoryOrdering::cmpxchg_failure_rejection(success, failure),
                None,
                "{success} / {failure}"
            );
        }
        for (success, failure) in [
            (SeqCst, Release),
            (SeqCst, AcqRel),
            (Relaxed, Release),
            (Acquire, SeqCst),
            (AcqRel, SeqCst),
            (Relaxed, Acquire),
        ] {
            assert!(
                MemoryOrdering::cmpxchg_failure_rejection(success, failure).is_some(),
                "{success} / {failure}"
            );
        }
    }

    #[test]
    fn tls_and_ordering_names_round_trip_to_text() {
        assert_eq!(TlsModel::LocalExec.as_str(), "local_exec");
        assert_eq!(TlsModel::InitialExec.to_string(), "initial_exec");
        assert_eq!(MemoryOrdering::AcqRel.to_string(), "acqrel");
        assert_eq!(MemoryOrdering::SeqCst.to_string(), "seqcst");
    }
}