├── .editorconfig ├── .gitignore ├── Cargo.toml ├── LICENSE ├── README.md └── src └── lib.rs /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style=tab 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by Cargo 2 | # will have compiled files and executables 3 | /target/ 4 | target 5 | Cargo.lock 6 | 7 | # idea 8 | .idea -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "fdlimit" 3 | version = "0.3.0" 4 | authors = ["Parity Technologies"] 5 | edition = "2021" 6 | license = "Apache-2.0" 7 | description = "Utility crate for raising file descriptors limit for OSX and Linux" 8 | repository = "https://github.com/paritytech/fdlimit" 9 | 10 | [dependencies] 11 | libc = "0.2" 12 | thiserror = "1.0.50" 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fdlimit 2 | Cross-platform raise open file descriptors limit 3 | 4 | [![crates.io link](https://img.shields.io/crates/v/fdlimit.svg)](https://crates.io/crates/fdlimit) 5 | 6 | Applicable for OSX and Linux 7 | 8 | on Windows does nothing 9 | 10 | ## Dependency 11 | 12 | add in Cargo.toml: 13 | ``` 14 | [dependencies] 15 | fdlimit = "0.2.1" 16 | ``` 17 | 18 | # License 19 | 20 | `fdlimit` is distributed under the terms of the Apache License (Version 2.0). 21 | 22 | See LICENSE for details. 23 | 24 | ### Contribution 25 | 26 | Unless you explicitly state otherwise, any contribution intentionally submitted 27 | for inclusion in `fdlimit` by you, as defined in the Apache-2.0 license, shall be 28 | licensed as above, without any additional terms or conditions. 29 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | // Copyright 2016-2020 Parity Technologies (UK) Ltd. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | /// Outcome of raising file descriptor resource limit 16 | pub enum Outcome { 17 | /// Limit was raised successfully 18 | LimitRaised { 19 | /// Previous limit (likely soft limit) 20 | from: u64, 21 | /// New limit (likely hard limit) 22 | to: u64, 23 | }, 24 | /// Raising limit is not supported on this platform 25 | Unsupported, 26 | } 27 | 28 | /// Errors that happen when trying to raise file descriptor resource limit 29 | #[derive(Debug, thiserror::Error)] 30 | pub enum Error { 31 | /// Failed to call sysctl to get max supported value configured in sysctl 32 | #[error("Failed to call sysctl to get max supported value configured in sysctl: {0}")] 33 | #[cfg(any(target_os = "macos", target_os = "ios"))] 34 | FailedToCallSysctl(std::io::Error), 35 | /// Failed to get current limit 36 | #[error("Failed to get current limit: {0}")] 37 | FailedToGetLimit(std::io::Error), 38 | /// Failed to set new limit 39 | #[error("Failed to set new limit ({from}->{to}): {error}")] 40 | FailedToSetLimit { 41 | /// Current limit 42 | from: u64, 43 | /// New desired limit 44 | to: u64, 45 | /// Low level OS error 46 | error: std::io::Error, 47 | }, 48 | } 49 | 50 | /// Raise the soft open file descriptor resource limit to the smaller of the 51 | /// kernel limit and the hard resource limit. 52 | /// 53 | /// darwin_fd_limit exists to work around an issue where launchctl on Mac OS X 54 | /// defaults the rlimit maxfiles to 256/unlimited. The default soft limit of 256 55 | /// ends up being far too low for our multithreaded scheduler testing, depending 56 | /// on the number of cores available. 57 | #[cfg(any(target_os = "macos", target_os = "ios"))] 58 | #[allow(clippy::useless_conversion, non_camel_case_types)] 59 | pub fn raise_fd_limit() -> Result { 60 | use std::cmp; 61 | use std::io; 62 | use std::mem::size_of_val; 63 | use std::ptr::null_mut; 64 | 65 | unsafe { 66 | static CTL_KERN: libc::c_int = 1; 67 | static KERN_MAXFILESPERPROC: libc::c_int = 29; 68 | 69 | // The strategy here is to fetch the current resource limits, read the 70 | // kern.maxfilesperproc sysctl value, and bump the soft resource limit for 71 | // maxfiles up to the sysctl value. 72 | 73 | // Fetch the kern.maxfilesperproc value 74 | let mut mib: [libc::c_int; 2] = [CTL_KERN, KERN_MAXFILESPERPROC]; 75 | let mut maxfiles: libc::c_int = 0; 76 | let mut size: libc::size_t = size_of_val(&maxfiles) as libc::size_t; 77 | if libc::sysctl(&mut mib[0], 2, &mut maxfiles as *mut _ as *mut _, &mut size, null_mut(), 0) 78 | != 0 79 | { 80 | return Err(Error::FailedToCallSysctl(io::Error::last_os_error())); 81 | } 82 | 83 | // Fetch the current resource limits 84 | let mut rlim = libc::rlimit { rlim_cur: 0, rlim_max: 0 }; 85 | if libc::getrlimit(libc::RLIMIT_NOFILE, &mut rlim) != 0 { 86 | return Err(Error::FailedToGetLimit(io::Error::last_os_error())); 87 | } 88 | 89 | let old_value = rlim.rlim_cur; 90 | 91 | // Bump the soft limit to the smaller of kern.maxfilesperproc and the hard 92 | // limit 93 | rlim.rlim_cur = cmp::min(maxfiles as libc::rlim_t, rlim.rlim_max); 94 | 95 | // Set our newly-increased resource limit 96 | if libc::setrlimit(libc::RLIMIT_NOFILE, &rlim) != 0 { 97 | return Err(Error::FailedToSetLimit { 98 | from: old_value.into(), 99 | to: rlim.rlim_cur.into(), 100 | error: io::Error::last_os_error(), 101 | }); 102 | } 103 | 104 | Ok(Outcome::LimitRaised { from: old_value.into(), to: rlim.rlim_cur.into() }) 105 | } 106 | } 107 | 108 | /// Raise the soft open file descriptor resource limit to the hard resource 109 | /// limit. 110 | #[cfg(target_os = "linux")] 111 | #[allow(clippy::useless_conversion, non_camel_case_types)] 112 | pub fn raise_fd_limit() -> Result { 113 | use std::io; 114 | 115 | unsafe { 116 | // Fetch the current resource limits 117 | let mut rlim = libc::rlimit { rlim_cur: 0, rlim_max: 0 }; 118 | if libc::getrlimit(libc::RLIMIT_NOFILE, &mut rlim) != 0 { 119 | return Err(Error::FailedToGetLimit(io::Error::last_os_error())); 120 | } 121 | 122 | let old_value = rlim.rlim_cur; 123 | 124 | // Set soft limit to hard imit 125 | rlim.rlim_cur = rlim.rlim_max; 126 | 127 | // Set our newly-increased resource limit 128 | if libc::setrlimit(libc::RLIMIT_NOFILE, &rlim) != 0 { 129 | return Err(Error::FailedToSetLimit { 130 | from: old_value.into(), 131 | to: rlim.rlim_cur.into(), 132 | error: io::Error::last_os_error(), 133 | }); 134 | } 135 | 136 | Ok(Outcome::LimitRaised { from: old_value.into(), to: rlim.rlim_cur.into() }) 137 | } 138 | } 139 | 140 | /// Does nothing on unsupported platform 141 | #[cfg(not(any(target_os = "macos", target_os = "ios", target_os = "linux")))] 142 | pub fn raise_fd_limit() -> Result { 143 | Ok(Outcome::Unsupported) 144 | } 145 | --------------------------------------------------------------------------------