pvxs-sys 0.1.1

Low-level FFI bindings for EPICS PVXS library
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

// Copyright 2026 Tine Zata
// SPDX-License-Identifier: MPL-2.0
use std::env;
use std::path::PathBuf;

fn main() {
    // Skip C++ compilation when building docs on docs.rs
    if cfg!(doc) || env::var("DOCS_RS").is_ok() {
        println!("cargo:warning=Skipping C++ compilation for documentation build");
        return;
    }

    // Get EPICS_BASE from environment
    let epics_base = env::var("EPICS_BASE")
        .expect("EPICS_BASE environment variable not set. Please set it to your EPICS base installation path.");

    let epics_base_path = PathBuf::from(&epics_base);

    // Determine EPICS host architecture
    let epics_host_arch = env::var("EPICS_HOST_ARCH").unwrap_or_else(|_| {
        // Try to determine from common patterns
        if cfg!(target_os = "windows") {
            if cfg!(target_pointer_width = "64") {
                "windows-x64".to_string()
            } else {
                "win32-x86".to_string()
            }
        } else if cfg!(target_os = "linux") {
            if cfg!(target_pointer_width = "64") {
                "linux-x86_64".to_string()
            } else {
                "linux-x86".to_string()
            }
        } else if cfg!(target_os = "macos") {
            "darwin-x86".to_string()
        } else {
            panic!("Unable to determine EPICS_HOST_ARCH. Please set it manually.")
        }
    });

    println!("cargo:warning=INFO: Using EPICS_BASE: {}", epics_base);
    println!(
        "cargo:warning=INFO: Using EPICS_HOST_ARCH: {}",
        epics_host_arch
    );

    // EPICS Base paths
    let epics_include = epics_base_path.join("include");
    let epics_lib = epics_base_path.join("lib").join(&epics_host_arch);

    // Get PVXS location (could be within EPICS base or separate)
    let pvxs_base = env::var("EPICS_PVXS")
        .or_else(|_| env::var("PVXS_DIR"))
        .or_else(|_| env::var("PVXS_BASE"))
        .unwrap_or_else(|_| {
            // Assume PVXS is built as an EPICS module within base
            epics_base.clone()
        });

    let pvxs_base_path = PathBuf::from(&pvxs_base);
    let pvxs_include = pvxs_base_path.join("include");
    let pvxs_lib = pvxs_base_path.join("lib").join(&epics_host_arch);

    // Get libevent location (bundled with PVXS)
    let libevent_base = env::var("EPICS_PVXS_LIBEVENT").unwrap_or_else(|_| {
        // Default to bundled libevent within PVXS
        pvxs_base_path
            .join("bundle")
            .join("usr")
            .join(&epics_host_arch)
            .to_string_lossy()
            .to_string()
    });

    let libevent_base_path = PathBuf::from(&libevent_base);
    let libevent_include = libevent_base_path.join("include");
    let libevent_lib = libevent_base_path.join("lib");

    println!("cargo:warning=INFO: Using PVXS location: {}", pvxs_base);
    println!(
        "cargo:warning=INFO: Using libevent location: {}",
        libevent_base
    );

    // Tell cargo to rerun this build script if files change
    println!("cargo:rerun-if-changed=src/lib.rs");
    println!("cargo:rerun-if-changed=src/bridge.rs");
    println!("cargo:rerun-if-changed=include/wrapper.h");
    println!("cargo:rerun-if-changed=src/client_wrapper.cpp");
    println!("cargo:rerun-if-changed=src/client_wrapper_async.cpp");
    println!("cargo:rerun-if-changed=src/client_wrapper_monitor.cpp");
    println!("cargo:rerun-if-changed=src/client_wrapper_rpc.cpp");
    println!("cargo:rerun-if-changed=src/server_wrapper.cpp");
    println!("cargo:rerun-if-env-changed=EPICS_BASE");
    println!("cargo:rerun-if-env-changed=EPICS_HOST_ARCH");
    println!("cargo:rerun-if-env-changed=EPICS_PVXS");
    println!("cargo:rerun-if-env-changed=PVXS_DIR");
    println!("cargo:rerun-if-env-changed=EPICS_PVXS_LIBEVENT");

    // Copy wrapper.h to cxxbridge include directory so it can be found
    let out_dir = PathBuf::from(env::var("OUT_DIR").unwrap());
    let cxxbridge_dir = out_dir.join("cxxbridge");
    let cxxbridge_include_dir = cxxbridge_dir.join("include");
    std::fs::create_dir_all(&cxxbridge_include_dir).ok();
    std::fs::copy("include/wrapper.h", cxxbridge_include_dir.join("wrapper.h")).ok();

    // Build the C++ bridge using cxx
    let mut build = cxx_build::bridge("src/bridge.rs");

    // Check if async feature is enabled
    if cfg!(feature = "async") {
        build.define("PVXS_ASYNC_ENABLED", "1");
    }

    // Platform-specific compiler and OS includes
    let (compiler_dir, os_dir) = if cfg!(target_os = "windows") {
        ("msvc", "WIN32")
    } else if cfg!(target_os = "linux") {
        ("gcc", "Linux")
    } else if cfg!(target_os = "macos") {
        ("clang", "Darwin")
    } else {
        ("gcc", "default")
    };

    // Get current directory for wrapper.h
    let include_dir = std::env::current_dir().unwrap().join("include");

    build
        .file("src/client_wrapper_async.cpp")
        .file("src/client_wrapper_monitor.cpp")
        .file("src/client_wrapper_rpc.cpp")
        .file("src/client_wrapper.cpp")
        .file("src/server_wrapper.cpp")
        .include(&include_dir) // Add include directory first so wrapper.h is found
        .include(&epics_include)
        .include(epics_include.join("compiler").join(compiler_dir))
        .include(epics_include.join("os").join(os_dir))
        .include(&pvxs_include)
        .include(&libevent_include) // Add libevent include path
        .flag_if_supported("-std=c++17")
        .flag_if_supported("/std:c++17"); // MSVC

    // Platform-specific flags
    if cfg!(target_os = "windows") {
        build.flag_if_supported("/EHsc"); // Enable C++ exceptions on MSVC
    } else {
        build.flag_if_supported("-fexceptions");
        build.flag_if_supported("-pthread");
    }

    build.compile("pvxs_sys");

    // Link to PVXS and EPICS libraries
    println!("cargo:rustc-link-search=native={}", pvxs_lib.display());
    println!("cargo:rustc-link-search=native={}", epics_lib.display());
    println!("cargo:rustc-link-search=native={}", libevent_lib.display());

    // Link required libraries
    println!("cargo:rustc-link-lib=pvxs");
    println!("cargo:rustc-link-lib=Com"); // EPICS Base Com library

    // Platform-specific system libraries
    if cfg!(target_os = "linux") {
        println!("cargo:rustc-link-lib=pthread");
        println!("cargo:rustc-link-lib=dl");
        println!("cargo:rustc-link-lib=rt");
    } else if cfg!(target_os = "windows") {
        println!("cargo:rustc-link-lib=ws2_32");
        println!("cargo:rustc-link-lib=advapi32");
    }

    // Copy required DLLs to target directories for seamless execution
    copy_runtime_dlls(
        &epics_base_path,
        &pvxs_base_path,
        &libevent_base_path,
        &epics_host_arch,
    );

    // Export include paths for dependent crates
    println!("cargo:include={}", pvxs_include.display());
    println!("cargo:include={}", epics_include.display());
    println!("cargo:include={}", libevent_include.display());
}

fn copy_runtime_dlls(
    epics_base: &PathBuf,
    pvxs_base: &PathBuf,
    libevent_base: &PathBuf,
    host_arch: &str,
) {
    let out_dir = PathBuf::from(env::var("OUT_DIR").unwrap());

    // Determine target directory (go up from OUT_DIR to find target/debug or target/release)
    let mut target_dir = out_dir.clone();
    while target_dir.file_name() != Some(std::ffi::OsStr::new("target")) {
        if !target_dir.pop() {
            return; // Silently skip if we can't find target directory
        }
    }

    // Determine which profile we're building (debug or release)
    let profile = if out_dir.to_string_lossy().contains("release") {
        "release"
    } else {
        "debug"
    };

    // Source paths for DLLs
    let pvxs_dll = pvxs_base.join("bin").join(host_arch).join("pvxs.dll");
    let com_dll = epics_base.join("bin").join(host_arch).join("Com.dll");
    let event_dll = libevent_base.join("lib").join("event_core.dll");

    // Copy to main profile directory and examples subdirectory
    let directories = [
        target_dir.join(profile),
        target_dir.join(profile).join("examples"),
    ];

    let mut copied_dlls = Vec::new();

    for dest_dir in &directories {
        // Only process directories that exist or can be created
        if std::fs::create_dir_all(dest_dir).is_err() {
            continue;
        }

        // Copy DLLs if they exist
        if pvxs_dll.exists() {
            std::fs::copy(&pvxs_dll, dest_dir.join("pvxs.dll")).ok();
            if !copied_dlls.contains(&"pvxs.dll") {
                copied_dlls.push("pvxs.dll");
            }
        }

        if com_dll.exists() {
            std::fs::copy(&com_dll, dest_dir.join("Com.dll")).ok();
            if !copied_dlls.contains(&"Com.dll") {
                copied_dlls.push("Com.dll");
            }
        }

        if event_dll.exists() {
            std::fs::copy(&event_dll, dest_dir.join("event_core.dll")).ok();
            if !copied_dlls.contains(&"event_core.dll") {
                copied_dlls.push("event_core.dll");
            }
        }
    }

    if !copied_dlls.is_empty() {
        println!(
            "cargo:warning=INFO: Copied {} to {}",
            copied_dlls.join(", "),
            profile
        );
    }
}