Skip to content

Conversation

@TBird2001
Copy link

This allows OpenVAF to compile and run on macOS. The following changes were made:

  • Use clang as linker on macOS instead of ld
  • Change -dylib to -dynamiclib for clang compatibility
  • Add build.rs to dynamically detect LLVM library path via llvm-config
  • Add rpath to find libLLVM.dylib at runtime

Tested on macOS with MacPorts LLVM 18 on Apple Silicon.

This allows OpenVAF to compile and run on macOS. The following changes
were made:
- Use clang as linker on macOS instead of ld
- Change -dylib to -dynamiclib for clang compatibility
- Add build.rs to dynamically detect LLVM library path via llvm-config
- Add rpath to find libLLVM.dylib at runtime

Tested on macOS with MacPorts LLVM 18 on Apple Silicon.
@gemini-code-assist
Copy link

Summary of Changes

Hello @TBird2001, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces essential modifications to enable OpenVAF to successfully compile and execute on macOS. The changes primarily focus on adapting the linking process to the macOS environment, including switching to the clang linker, adjusting specific linker flags for dynamic library creation, and implementing a dynamic mechanism to resolve LLVM library paths at build time, ensuring proper runtime library discovery.

Highlights

  • Linker Change for macOS: The default linker for macOS has been updated from ld to clang to ensure compatibility with the macOS build environment.
  • Linker Flag Adjustment: The linker flag for building dynamic libraries on macOS has been changed from -dylib to -dynamiclib to align with clang's requirements.
  • Dynamic LLVM Library Path Resolution: A new build.rs script has been introduced to dynamically detect the LLVM library path on macOS using llvm-config.
  • Runtime Library Discovery: An rpath linker argument is now added during the build process on macOS to help the system locate libLLVM.dylib at runtime.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • openvaf/linker/src/lib.rs
    • Modified the get_linker function to use clang as the default linker when compiling on target_os = "macos".
    • Updated the build_dylib method to use the -dynamiclib linker argument instead of -dylib for macOS targets, ensuring compatibility with clang.
  • openvaf/openvaf-driver/build.rs
    • Added a new build script (build.rs) that is executed during compilation.
    • For macOS targets, this script runs llvm-config --libdir to obtain the LLVM library directory.
    • The script then adds a cargo:rustc-link-arg=-Wl,-rpath,<libdir> instruction, embedding the LLVM library path into the binary to facilitate runtime library loading.
Activity
  • No human activity (comments, reviews, etc.) has been recorded on this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request successfully introduces macOS support for OpenVAF. The changes correctly configure the linker to use clang on macOS and adjust the dynamic library flag to -dynamiclib for compatibility. Additionally, the new build.rs script effectively handles the dynamic detection and setup of LLVM library rpaths, which is essential for proper linking and execution on macOS. The overall approach is sound and addresses the stated goal.

Comment on lines +7 to +15
if let Ok(output) = std::process::Command::new("llvm-config")
.arg("--libdir")
.output()
{
if output.status.success() {
let libdir = String::from_utf8_lossy(&output.stdout).trim().to_string();
println!("cargo:rustc-link-arg=-Wl,-rpath,{}", libdir);
}
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider adding a warning or error message if llvm-config fails to execute or returns a non-successful status. Currently, if llvm-config is not found or fails, the rpath is silently skipped, which might lead to confusing runtime errors later. Explicit feedback here would improve debuggability for users, especially during initial setup or when LLVM is not correctly configured on their system.

@Kreijstal
Copy link
Contributor

hmm I must update the mob branch to the arpad master one since that one is more up to date.. however i beleive they have done mac os support there already https://github.com/arpadbuermen/OpenVAF

@TBird2001
Copy link
Author

Ah, interesting. I didn't appreciate that the arpad repo was the most active one. Their macOS support isn't quite right (as best I can tell). I'll put in a similar pull request for that repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants