Merge pull request facebookresearch#67 from SkyFan2002/master

Support static link as a feature

.gitignore

@@ -1,3 +1,4 @@
 /target/
 **/*.rs.bk
 Cargo.lock
+.vscode/

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "faiss-sys/faiss"]
+	path = faiss-sys/faiss
+	url = https://github.com/Enet4/faiss.git
+	branch = c_api_head

Cargo.toml

@@ -12,6 +12,7 @@ edition = "2018"
 
 [features]
 gpu = ["faiss-sys/gpu"]
+static = ["faiss-sys/static"]
 
 [badges.maintenance]
 status = "passively-maintained"

faiss-sys/Cargo.toml

@@ -11,9 +11,14 @@ keywords = ["cbir", "clustering", "index", "similarity", "bindings"]
 
 [features]
 gpu = []
+static = ["cmake"]
+
+
+[build-dependencies]
+cmake = {version = "0.1.50",optional = true}
 
 [badges.maintenance]
 status = "passively-maintained"
 
 [package.metadata.docs.rs]
-features = ["gpu"]
+features = ["gpu"]

faiss-sys/build.rs

@@ -1,3 +1,59 @@
 fn main() {
+    #[cfg(feature = "static")]
+    static_link_faiss();
+    #[cfg(not(feature = "static"))]
     println!("cargo:rustc-link-lib=faiss_c");
 }
+
+#[cfg(feature = "static")]
+fn static_link_faiss() {
+    let mut cfg = cmake::Config::new("faiss");
+    cfg.define("FAISS_ENABLE_C_API", "ON")
+        .define("BUILD_SHARED_LIBS", "OFF")
+        .define("CMAKE_BUILD_TYPE", "Release")
+        .define("FAISS_ENABLE_GPU", "OFF")
+        .define("FAISS_ENABLE_PYTHON", "OFF")
+        .define("BUILD_TESTING", "OFF")
+        .very_verbose(true);
+    let dst = cfg.build();
+    let faiss_location = dst.join("lib");
+    let faiss_c_location = dst.join("build/c_api");
+    println!(
+        "cargo:rustc-link-search=native={}",
+        faiss_location.display()
+    );
+    println!(
+        "cargo:rustc-link-search=native={}",
+        faiss_c_location.display()
+    );
+    println!("cargo:rustc-link-lib=static=faiss_c");
+    println!("cargo:rustc-link-lib=static=faiss");
+    link_cxx();
+    println!("cargo:rustc-link-lib=gomp");
+    println!("cargo:rustc-link-lib=blas");
+    println!("cargo:rustc-link-lib=lapack");
+}
+
+#[cfg(feature = "static")]
+fn link_cxx() {
+    let cxx = match std::env::var("CXXSTDLIB") {
+        Ok(s) if s.is_empty() => None,
+        Ok(s) => Some(s),
+        Err(_) => {
+            let target = std::env::var("TARGET").unwrap();
+            if target.contains("msvc") {
+                None
+            } else if target.contains("apple")
+                | target.contains("freebsd")
+                | target.contains("openbsd")
+            {
+                Some("c++".to_string())
+            } else {
+                Some("stdc++".to_string())
+            }
+        }
+    };
+    if let Some(cxx) = cxx {
+        println!("cargo:rustc-link-lib={}", cxx);
+    }
+}

faiss-sys/gen_bindings.sh

@@ -9,7 +9,9 @@ repo_url=https://github.com/facebookresearch/faiss
 repo_rev=v1.7.2
 cuda_root=/opt/cuda
 
-git clone "$repo_url" faiss --branch "$repo_rev" --depth 1
+if [ ! -d faiss ]; then
+    git clone "$repo_url" faiss --branch "$repo_rev" --depth 1
+fi
 
 bindgen_opt='--size_t-is-usize --whitelist-function faiss_.* --whitelist-type idx_t|Faiss.* --opaque-type FILE'
 

src/index/id_map.rs

@@ -368,7 +368,7 @@ where
 
 impl IndexImpl {
     /// Attempt a dynamic cast of the index to one that is [ID-mapped][1].
-    /// 
+    ///
     /// [1]: crate::IdMap
     pub fn into_id_map(self) -> Result<IdMap<IndexImpl>> {
         unsafe {
@@ -378,7 +378,11 @@ impl IndexImpl {
             } else {
                 mem::forget(self);
                 let index_inner = faiss_IndexIDMap_sub_index(new_inner);
-                Ok(IdMap { inner: new_inner, index_inner, phantom: PhantomData })
+                Ok(IdMap {
+                    inner: new_inner,
+                    index_inner,
+                    phantom: PhantomData,
+                })
             }
         }
     }