├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md └── src ├── lib.rs └── main.rs /.gitignore: -------------------------------------------------------------------------------- 1 | target/ 2 | **/*.rs.bk 3 | Cargo.lock 4 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "static-ldd" 3 | version = "0.1.0" 4 | authors = ["Jamey Sharp "] 5 | license = "MIT/Apache-2.0" 6 | repository = "https://github.com/jameysharp/static-ldd" 7 | homepage = "https://github.com/jameysharp/static-ldd" 8 | readme = "README.md" 9 | description = """A library and command-line tool for inferring 10 | dependencies between static libraries.""" 11 | 12 | [dependencies] 13 | filebuffer = "0.2.0" 14 | goblin = "0.0.10" 15 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2017 Jamey Sharp 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE. 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | static-ldd 2 | ========== 3 | 4 | This is a library and command-line tool for inferring dependencies 5 | between static libraries. 6 | 7 | Each dynamic library (also known as a shared object) on Unix-like 8 | systems includes machine-readable information about other libraries that 9 | you also need to link against if you want to use it, and the dynamic 10 | linker automatically loads those dependencies, recursively, as needed. 11 | 12 | Since modern software engineering encourages small, well-encapsulated, 13 | reusable software, applications generally have transitive dependencies 14 | on at least a few dozen libraries, and sometimes more. If the 15 | application developer had to identify every library their software had a 16 | transitive dependency on, it would be a nightmare to build anything new. 17 | So this automatic dependency tracking behavior for dynamic libraries is 18 | super helpful. 19 | 20 | Unfortunately, static libraries do not carry library dependency 21 | information, so linking against static libraries is more troublesome. 22 | Making matters worse, the order in which the libraries are listed to the 23 | linker is important, because during static linking each library is 24 | visited only once, and the linker may not find the symbols one library 25 | needs if the library that provides them is listed in the wrong place. 26 | 27 | Many projects provide 28 | [`pkg-config`](https://www.freedesktop.org/wiki/Software/pkg-config/) 29 | metadata as an external record of dependencies, which is an excellent 30 | solution and should be your first choice when possible. However, not all 31 | do. 32 | 33 | When `pkg-config` metadata is not available, you can use `static-ldd` to 34 | infer the dependencies within a group of static libraries, and determine 35 | a correct link order that respects those dependencies. 36 | 37 | Usage 38 | ----- 39 | 40 | From the command line: 41 | 42 | ``` 43 | static-ldd ... -- ... 44 | ``` 45 | 46 | `` are the libraries or object files that contain code you know 47 | you need. This could be your object files produced by compiling your 48 | project's source code. 49 | 50 | `` are the libraries that you think you might need. If there's 51 | no transitive dependency from a root to one of these libraries, it won't 52 | be included in the final link list. 53 | 54 | The output of the command-line tool is currently only really suitable 55 | for human consumption (and hardly even that). I'd love to receive 56 | patches making the command-line tool usable in build systems. 57 | 58 | Using this crate as a Rust library involves first calling 59 | `dependency_map` with an iterable listing all the libraries, both roots 60 | and others, to get a map of all the dependencies; and then passing that 61 | map and the iterable list of roots to `needed_libraries` to get the 62 | final link list. 63 | 64 | Eventually there should be a helper function for use in Cargo build 65 | scripts that will automatically add all the discovered libraries to the 66 | linker flags, but that isn't implemented yet. 67 | 68 | License 69 | ------- 70 | 71 | This crate is dual-licensed Apache-2.0/MIT, which probably allows any 72 | use you care about. However, you should verify that your use is 73 | compatible with the licenses of this crate's dependencies. In 74 | particular, [`filebuffer`](https://crates.io/crates/filebuffer) is (as 75 | of this writing) licensed only under Apache-2.0, which might create 76 | issues for you if you want to use GPLv2-licensed code with it. This is 77 | not legal advice; if in doubt, consult a lawyer. 78 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | extern crate filebuffer; 2 | extern crate goblin; 3 | 4 | use goblin::{parse, Object, elf, archive}; 5 | use std::collections::{HashMap, HashSet, BTreeMap, BTreeSet}; 6 | use std::iter::FromIterator; 7 | 8 | pub fn needed_libraries<'a, R>(map: &'a BTreeMap<&'a str, BTreeSet<&'a str>>, roots: R) -> Vec<&'a str> 9 | where R: IntoIterator 10 | { 11 | struct Result<'a> { 12 | map: &'a BTreeMap<&'a str, BTreeSet<&'a str>>, 13 | libs: Vec<&'a str>, 14 | seen: HashSet<&'a str>, 15 | } 16 | 17 | impl<'a> Result<'a> { 18 | fn go(&mut self, root: &'a str) { 19 | if self.seen.insert(root) { 20 | if let Some(deps) = self.map.get(root) { 21 | for dep in deps.iter() { 22 | self.go(dep); 23 | } 24 | } 25 | self.libs.push(root); 26 | } 27 | } 28 | } 29 | 30 | let mut result = Result { 31 | map: map, 32 | libs: Vec::new(), 33 | seen: HashSet::new(), 34 | }; 35 | for root in roots { 36 | result.go(root); 37 | } 38 | 39 | result.libs.reverse(); 40 | result.libs 41 | } 42 | 43 | pub fn dependency_map<'a, N>(fnames: N) -> BTreeMap<&'a str, BTreeSet<&'a str>> 44 | where N: IntoIterator 45 | { 46 | let bufs: Vec<_> = fnames.into_iter().filter_map(|fname| { 47 | if let Ok(buf) = filebuffer::FileBuffer::open(fname) { 48 | Some((fname, buf)) 49 | } else { 50 | None 51 | } 52 | }).collect(); 53 | let bufrefs: Vec<_> = bufs.iter().map(|&(fname, ref buf)| (fname, buf as &[u8])).collect(); 54 | 55 | let mut defined = HashMap::new(); 56 | let needed: Vec<_> = bufrefs.iter().filter_map(|&(fname, ref buf)| { 57 | let (obj_defined, obj_needed) = match parse(buf) { 58 | Ok(Object::Elf(elf)) => elf_symbols(elf), 59 | Ok(Object::Archive(archive)) => archive_symbols(archive, buf), 60 | _ => return None, 61 | }; 62 | for sym in obj_defined { 63 | defined.entry(sym).or_insert_with(HashSet::new).insert(fname); 64 | } 65 | Some((fname, obj_needed)) 66 | }).collect(); 67 | 68 | needed.into_iter().map(|(fname, obj_needed)| { 69 | let mut seen = BTreeSet::new(); 70 | for sym in obj_needed { 71 | if let Some(choices) = defined.get(sym) { 72 | if !choices.iter().any(|tgt| seen.contains(tgt)) { 73 | // TODO: if choices.len() > 1, do something clever 74 | seen.extend(choices.iter()); 75 | } 76 | } 77 | } 78 | (fname, seen) 79 | }).collect() 80 | } 81 | 82 | type Syms<'a> = Vec<&'a str>; 83 | 84 | fn elf_symbols<'a>(obj: elf::Elf<'a>) -> (Syms<'a>, Syms<'a>) { 85 | (elf_symbols_group(&obj, true), elf_symbols_group(&obj, false)) 86 | } 87 | 88 | fn elf_symbols_group<'a>(obj: &elf::Elf<'a>, want_defined: bool) -> Syms<'a> { 89 | obj.syms.iter() 90 | .filter(|sym| { 91 | elf::sym::st_bind(sym.st_info) != elf::sym::STB_LOCAL && 92 | match elf::sym::st_type(sym.st_info) { 93 | elf::sym::STT_OBJECT | elf::sym::STT_FUNC => want_defined, 94 | elf::sym::STT_NOTYPE => !want_defined, 95 | _ => false, 96 | } 97 | }) 98 | .map(|sym| obj.strtab.get(sym.st_name).expect("symbol not in string table")) 99 | .collect() 100 | } 101 | 102 | fn archive_symbols<'a>(obj: archive::Archive<'a>, bufref: &'a &[u8]) -> (Syms<'a>, Syms<'a>) { 103 | let mut defined = Vec::new(); 104 | let mut needed = HashSet::new(); 105 | for member in obj.members() { 106 | if let Ok(buf) = obj.extract(member, bufref) { 107 | if let Ok(Object::Elf(elf)) = parse(buf) { 108 | let (member_defined, member_needed) = elf_symbols(elf); 109 | defined.extend(member_defined); 110 | needed.extend(member_needed); 111 | } 112 | } 113 | } 114 | for sym in defined.iter() { 115 | needed.remove(sym); 116 | } 117 | (defined, Vec::from_iter(needed)) 118 | } 119 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | extern crate static_ldd; 2 | 3 | use std::env; 4 | 5 | fn main() { 6 | let args: Vec = env::args().skip(1).collect(); 7 | let fnames; 8 | let roots; 9 | if let Some(dashdash) = args.iter().position(|arg| arg == "--") { 10 | let (before, after) = args.split_at(dashdash); 11 | fnames = before.iter().chain(after.iter().skip(1)); 12 | roots = before.iter(); 13 | } else { 14 | fnames = args.iter().chain([].iter().skip(0)); 15 | roots = args.iter(); 16 | } 17 | 18 | let deps = static_ldd::dependency_map(fnames.map(|f| f as &str)); 19 | 20 | for (lib1, libs) in deps.iter() { 21 | for lib2 in libs { 22 | println!("{}\t{}", lib1, lib2); 23 | } 24 | } 25 | 26 | for lib in static_ldd::needed_libraries(&deps, roots.map(|f| f as &str)) { 27 | println!("{}", lib); 28 | } 29 | } 30 | --------------------------------------------------------------------------------