use std::path::Path; use std::{env, fs, path::PathBuf, process::Command}; // On these platforms jemalloc-sys will use a prefixed jemalloc which cannot be linked together // with RocksDB. // See https://github.com/tikv/jemallocator/blob/f7adfca5aff272b43fd3ad896252b57fbbd9c72a/jemalloc-sys/src/env.rs#L24 const NO_JEMALLOC_TARGETS: &[&str] = &["android", "dragonfly", "darwin"]; fn link(name: &str, bundled: bool) { use std::env::var; let target = var("TARGET").unwrap(); let target: Vec<_> = target.split('-').collect(); if target.get(2) == Some(&"windows") { println!("cargo:rustc-link-lib=dylib={name}"); if bundled && target.get(3) == Some(&"gnu") { let dir = var("CARGO_MANIFEST_DIR").unwrap(); println!("cargo:rustc-link-search=native={}/{}", dir, target[0]); } } } fn fail_on_empty_directory(name: &str) { if fs::read_dir(name).unwrap().count() == 0 { println!("The `{name}` directory is empty, did you forget to pull the submodules?"); println!("Try `git submodule update --init --recursive`"); panic!(); } } fn rocksdb_include_dir() -> String { match env::var("ROCKSDB_INCLUDE_DIR") { Ok(val) => val, Err(_) => "rocksdb/include".to_string(), } } fn bindgen_rocksdb() { let bindings = bindgen::Builder::default() .header(rocksdb_include_dir() + "/rocksdb/c.h") .derive_debug(false) .blocklist_type("max_align_t") // https://github.com/rust-lang-nursery/rust-bindgen/issues/550 .ctypes_prefix("libc") .size_t_is_usize(true) .generate() .expect("unable to generate rocksdb bindings"); let out_path = PathBuf::from(env::var("OUT_DIR").unwrap()); bindings .write_to_file(out_path.join("bindings.rs")) .expect("unable to write rocksdb bindings"); } fn build_rocksdb() { let target = env::var("TARGET").unwrap(); let mut config = cc::Build::new(); config.include("rocksdb/include/"); config.include("rocksdb/"); config.include("rocksdb/third-party/gtest-1.8.1/fused-src/"); if cfg!(feature = "snappy") { config.define("SNAPPY", Some("1")); config.include("snappy/"); } if cfg!(feature = "lz4") { config.define("LZ4", Some("1")); if let Some(path) = env::var_os("DEP_LZ4_INCLUDE") { config.include(path); } } if cfg!(feature = "zstd") { config.define("ZSTD", Some("1")); if let Some(path) = env::var_os("DEP_ZSTD_INCLUDE") { config.include(path); } if cfg!(feature = "zstd-static-linking-only") { config.define("ZSTD_STATIC_LINKING_ONLY", Some("1")); } } if cfg!(feature = "zlib") { config.define("ZLIB", Some("1")); if let Some(path) = env::var_os("DEP_Z_INCLUDE") { config.include(path); } } if cfg!(feature = "bzip2") { config.define("BZIP2", Some("1")); if let Some(path) = env::var_os("DEP_BZIP2_INCLUDE") { config.include(path); } } if cfg!(feature = "rtti") { config.define("USE_RTTI", Some("1")); } #[cfg(feature = "malloc-usable-size")] if target.contains("linux") { config.define("ROCKSDB_MALLOC_USABLE_SIZE", Some("1")); } config.include("."); config.define("NDEBUG", Some("1")); let mut lib_sources = include_str!("rocksdb_lib_sources.txt") .trim() .split('\n') .map(str::trim) // We have a pre-generated a version of build_version.cc in the local directory .filter(|file| !matches!(*file, "util/build_version.cc")) .collect::>(); if let (true, Ok(target_feature_value)) = ( target.contains("x86_64"), env::var("CARGO_CFG_TARGET_FEATURE"), ) { // This is needed to enable hardware CRC32C. Technically, SSE 4.2 is // only available since Intel Nehalem (about 2010) and AMD Bulldozer // (about 2011). let target_features: Vec<_> = target_feature_value.split(',').collect(); if target_features.contains(&"sse2") { config.flag_if_supported("-msse2"); } if target_features.contains(&"sse4.1") { config.flag_if_supported("-msse4.1"); } if target_features.contains(&"sse4.2") { config.flag_if_supported("-msse4.2"); } // Pass along additional target features as defined in // build_tools/build_detect_platform. if target_features.contains(&"avx2") { config.flag_if_supported("-mavx2"); } if target_features.contains(&"bmi1") { config.flag_if_supported("-mbmi"); } if target_features.contains(&"lzcnt") { config.flag_if_supported("-mlzcnt"); } if !target.contains("android") && target_features.contains(&"pclmulqdq") { config.flag_if_supported("-mpclmul"); } } if target.contains("apple-ios") { config.define("OS_MACOSX", None); config.define("IOS_CROSS_COMPILE", None); config.define("PLATFORM", "IOS"); config.define("NIOSTATS_CONTEXT", None); config.define("NPERF_CONTEXT", None); config.define("ROCKSDB_PLATFORM_POSIX", None); config.define("ROCKSDB_LIB_IO_POSIX", None); env::set_var("IPHONEOS_DEPLOYMENT_TARGET", "12.0"); } else if target.contains("darwin") { config.define("OS_MACOSX", None); config.define("ROCKSDB_PLATFORM_POSIX", None); config.define("ROCKSDB_LIB_IO_POSIX", None); } else if target.contains("android") { config.define("OS_ANDROID", None); config.define("ROCKSDB_PLATFORM_POSIX", None); config.define("ROCKSDB_LIB_IO_POSIX", None); if &target == "armv7-linux-androideabi" { config.define("_FILE_OFFSET_BITS", Some("32")); } } else if target.contains("linux") { config.define("OS_LINUX", None); config.define("ROCKSDB_PLATFORM_POSIX", None); config.define("ROCKSDB_LIB_IO_POSIX", None); } else if target.contains("freebsd") { config.define("OS_FREEBSD", None); config.define("ROCKSDB_PLATFORM_POSIX", None); config.define("ROCKSDB_LIB_IO_POSIX", None); } else if target.contains("windows") { link("rpcrt4", false); link("shlwapi", false); config.define("DWIN32", None); config.define("OS_WIN", None); config.define("_MBCS", None); config.define("WIN64", None); config.define("NOMINMAX", None); config.define("ROCKSDB_WINDOWS_UTF8_FILENAMES", None); if &target == "x86_64-pc-windows-gnu" { // Tell MinGW to create localtime_r wrapper of localtime_s function. config.define("_POSIX_C_SOURCE", Some("1")); // Tell MinGW to use at least Windows Vista headers instead of the ones of Windows XP. // (This is minimum supported version of rocksdb) config.define("_WIN32_WINNT", Some("_WIN32_WINNT_VISTA")); } // Remove POSIX-specific sources lib_sources = lib_sources .iter() .cloned() .filter(|file| { !matches!( *file, "port/port_posix.cc" | "env/env_posix.cc" | "env/fs_posix.cc" | "env/io_posix.cc" ) }) .collect::>(); // Add Windows-specific sources lib_sources.extend([ "port/win/env_default.cc", "port/win/port_win.cc", "port/win/xpress_win.cc", "port/win/io_win.cc", "port/win/win_thread.cc", "port/win/env_win.cc", "port/win/win_logger.cc", ]); if cfg!(feature = "jemalloc") { lib_sources.push("port/win/win_jemalloc.cc"); } } config.define("ROCKSDB_SUPPORT_THREAD_LOCAL", None); if cfg!(feature = "jemalloc") && NO_JEMALLOC_TARGETS.iter().all(|i| !target.contains(i)) { config.define("ROCKSDB_JEMALLOC", Some("1")); config.define("JEMALLOC_NO_DEMANGLE", Some("1")); if let Some(jemalloc_root) = env::var_os("DEP_JEMALLOC_ROOT") { config.include(Path::new(&jemalloc_root).join("include")); } } #[cfg(feature = "io-uring")] if target.contains("linux") { pkg_config::probe_library("liburing") .expect("The io-uring feature was requested but the library is not available"); config.define("ROCKSDB_IOURING_PRESENT", Some("1")); } if &target != "armv7-linux-androideabi" && env::var("CARGO_CFG_TARGET_POINTER_WIDTH").unwrap() != "64" { config.define("_FILE_OFFSET_BITS", Some("64")); config.define("_LARGEFILE64_SOURCE", Some("1")); } if target.contains("msvc") { if cfg!(feature = "mt_static") { config.static_crt(true); } config.flag("-EHsc"); config.flag("-std:c++17"); } else { config.flag(&cxx_standard()); // matches the flags in CMakeLists.txt from rocksdb config.flag("-Wsign-compare"); config.flag("-Wshadow"); config.flag("-Wno-unused-parameter"); config.flag("-Wno-unused-variable"); config.flag("-Woverloaded-virtual"); config.flag("-Wnon-virtual-dtor"); config.flag("-Wno-missing-field-initializers"); config.flag("-Wno-strict-aliasing"); config.flag("-Wno-invalid-offsetof"); } if target.contains("riscv64gc") { // link libatomic required to build for riscv64gc println!("cargo:rustc-link-lib=atomic"); } for file in lib_sources { config.file(format!("rocksdb/{file}")); } config.file("build_version.cc"); config.cpp(true); config.flag_if_supported("-std=c++17"); config.compile("librocksdb.a"); } fn build_snappy() { let target = env::var("TARGET").unwrap(); let endianness = env::var("CARGO_CFG_TARGET_ENDIAN").unwrap(); let mut config = cc::Build::new(); config.include("snappy/"); config.include("."); config.define("NDEBUG", Some("1")); config.extra_warnings(false); if target.contains("msvc") { config.flag("-EHsc"); if cfg!(feature = "mt_static") { config.static_crt(true); } } else { // Snappy requires C++11. // See: https://github.com/google/snappy/blob/master/CMakeLists.txt#L32-L38 config.flag("-std=c++11"); } if endianness == "big" { config.define("SNAPPY_IS_BIG_ENDIAN", Some("1")); } config.file("snappy/snappy.cc"); config.file("snappy/snappy-sinksource.cc"); config.file("snappy/snappy-c.cc"); config.cpp(true); config.compile("libsnappy.a"); } fn try_to_find_and_link_lib(lib_name: &str) -> bool { println!("cargo:rerun-if-env-changed={lib_name}_COMPILE"); if let Ok(v) = env::var(format!("{lib_name}_COMPILE")) { if v.to_lowercase() == "true" || v == "1" { return false; } } println!("cargo:rerun-if-env-changed={lib_name}_LIB_DIR"); println!("cargo:rerun-if-env-changed={lib_name}_STATIC"); if let Ok(lib_dir) = env::var(format!("{lib_name}_LIB_DIR")) { println!("cargo:rustc-link-search=native={lib_dir}"); let mode = match env::var_os(format!("{lib_name}_STATIC")) { Some(_) => "static", None => "dylib", }; println!("cargo:rustc-link-lib={}={}", mode, lib_name.to_lowercase()); return true; } false } fn cxx_standard() -> String { env::var("ROCKSDB_CXX_STD").map_or("-std=c++17".to_owned(), |cxx_std| { if !cxx_std.starts_with("-std=") { format!("-std={cxx_std}") } else { cxx_std } }) } fn update_submodules() { let program = "git"; let dir = "../"; let args = ["submodule", "update", "--init"]; println!( "Running command: \"{} {}\" in dir: {}", program, args.join(" "), dir ); let ret = Command::new(program).current_dir(dir).args(args).status(); match ret.map(|status| (status.success(), status.code())) { Ok((true, _)) => (), Ok((false, Some(c))) => panic!("Command failed with error code {}", c), Ok((false, None)) => panic!("Command got killed"), Err(e) => panic!("Command failed with error: {}", e), } } fn main() { if !Path::new("rocksdb/AUTHORS").exists() { update_submodules(); } bindgen_rocksdb(); let target = env::var("TARGET").unwrap(); if !try_to_find_and_link_lib("ROCKSDB") { // rocksdb only works with the prebuilt rocksdb system lib on freebsd. // we dont need to rebuild rocksdb if target.contains("freebsd") { println!("cargo:rustc-link-search=native=/usr/local/lib"); let mode = match env::var_os("ROCKSDB_STATIC") { Some(_) => "static", None => "dylib", }; println!("cargo:rustc-link-lib={}=rocksdb", mode); return; } println!("cargo:rerun-if-changed=rocksdb/"); fail_on_empty_directory("rocksdb"); build_rocksdb(); } else { // according to https://github.com/alexcrichton/cc-rs/blob/master/src/lib.rs#L2189 if target.contains("apple") || target.contains("freebsd") || target.contains("openbsd") { println!("cargo:rustc-link-lib=dylib=c++"); } else if target.contains("linux") { println!("cargo:rustc-link-lib=dylib=stdc++"); } } if cfg!(feature = "snappy") && !try_to_find_and_link_lib("SNAPPY") { println!("cargo:rerun-if-changed=snappy/"); fail_on_empty_directory("snappy"); build_snappy(); } // Allow dependent crates to locate the sources and output directory of // this crate. Notably, this allows a dependent crate to locate the RocksDB // sources and built archive artifacts provided by this crate. println!( "cargo:cargo_manifest_dir={}", env::var("CARGO_MANIFEST_DIR").unwrap() ); println!("cargo:out_dir={}", env::var("OUT_DIR").unwrap()); }