aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeongik Cha <jeongik@google.com>2023-09-27 11:05:43 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2023-09-27 11:05:43 +0000
commit03507b0a9cbd598a8c98a2528223c2ea40afe220 (patch)
tree5a8a11f576d2ac6d8d617265193aa4e143cf5f5d
parentc736b5b00d4d00a488675ea2a0197f458f234314 (diff)
parentc7cb29e40565f70036dd0ac82027c82a7431ebda (diff)
downloadepoll-03507b0a9cbd598a8c98a2528223c2ea40afe220.tar.gz
Import epoll am: a91672c7c1 am: b7f4de0da4 am: 165f2d1b98 am: c7cb29e405
Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/epoll/+/2752231 Change-Id: I70e4fe0a00f33ba47fbc112eb69ad51a1c22b8cf Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
-rw-r--r--.cargo_vcs_info.json6
-rw-r--r--.gitignore2
-rw-r--r--.travis.yml1
-rw-r--r--Android.bp17
-rw-r--r--Cargo.toml27
-rw-r--r--Cargo.toml.orig14
-rw-r--r--LICENSE362
-rw-r--r--METADATA19
-rw-r--r--MODULE_LICENSE_BSD_LIKE0
-rw-r--r--OWNERS1
-rw-r--r--README.md20
-rw-r--r--rustfmt.toml1
-rw-r--r--src/lib.rs188
13 files changed, 658 insertions, 0 deletions
diff --git a/.cargo_vcs_info.json b/.cargo_vcs_info.json
new file mode 100644
index 0000000..b6d2b23
--- /dev/null
+++ b/.cargo_vcs_info.json
@@ -0,0 +1,6 @@
+{
+ "git": {
+ "sha1": "a3f893c54e4e064c66adf7a927db3f93579c027e"
+ },
+ "path_in_vcs": ""
+} \ No newline at end of file
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..d569ccf
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+target
+*.lock
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..22761ba
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1 @@
+language: rust
diff --git a/Android.bp b/Android.bp
new file mode 100644
index 0000000..e970f5a
--- /dev/null
+++ b/Android.bp
@@ -0,0 +1,17 @@
+// This file is generated by cargo2android.py --run.
+// Do not modify this file as changes will be overridden on upgrade.
+
+
+
+rust_library_host {
+ name: "libepoll",
+ crate_name: "epoll",
+ cargo_env_compat: true,
+ cargo_pkg_version: "4.3.3",
+ srcs: ["src/lib.rs"],
+ edition: "2015",
+ rustlibs: [
+ "libbitflags",
+ "liblibc",
+ ],
+}
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..8cb833c
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,27 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+name = "epoll"
+version = "4.3.3"
+authors = ["Nathan Sizemore <nathanrsizemore@gmail.com>"]
+description = "Safe epoll interface."
+documentation = "https://docs.rs/epoll/"
+readme = "README.md"
+keywords = ["epoll"]
+license = "MPL-2.0"
+repository = "https://github.com/nathansizemore/epoll"
+
+[dependencies.bitflags]
+version = "2"
+
+[dependencies.libc]
+version = "0.2"
diff --git a/Cargo.toml.orig b/Cargo.toml.orig
new file mode 100644
index 0000000..099f628
--- /dev/null
+++ b/Cargo.toml.orig
@@ -0,0 +1,14 @@
+[package]
+name = "epoll"
+version = "4.3.3"
+authors = ["Nathan Sizemore <nathanrsizemore@gmail.com>"]
+description = "Safe epoll interface."
+readme = "README.md"
+keywords = ["epoll"]
+license = "MPL-2.0"
+repository = "https://github.com/nathansizemore/epoll"
+documentation = "https://docs.rs/epoll/"
+
+[dependencies]
+libc = "0.2"
+bitflags = "2"
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..be2cc4d
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,362 @@
+Mozilla Public License, version 2.0
+
+1. Definitions
+
+1.1. "Contributor"
+
+ means each individual or legal entity that creates, contributes to the
+ creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+
+ means the combination of the Contributions of others (if any) used by a
+ Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+
+ means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+
+ means Source Code Form to which the initial Contributor has attached the
+ notice in Exhibit A, the Executable Form of such Source Code Form, and
+ Modifications of such Source Code Form, in each case including portions
+ thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+ means
+
+ a. that the initial Contributor has attached the notice described in
+ Exhibit B to the Covered Software; or
+
+ b. that the Covered Software was made available under the terms of
+ version 1.1 or earlier of the License, but not also under the terms of
+ a Secondary License.
+
+1.6. "Executable Form"
+
+ means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+
+ means a work that combines Covered Software with other material, in a
+ separate file or files, that is not Covered Software.
+
+1.8. "License"
+
+ means this document.
+
+1.9. "Licensable"
+
+ means having the right to grant, to the maximum extent possible, whether
+ at the time of the initial grant or subsequently, any and all of the
+ rights conveyed by this License.
+
+1.10. "Modifications"
+
+ means any of the following:
+
+ a. any file in Source Code Form that results from an addition to,
+ deletion from, or modification of the contents of Covered Software; or
+
+ b. any new file in Source Code Form that contains any Covered Software.
+
+1.11. "Patent Claims" of a Contributor
+
+ means any patent claim(s), including without limitation, method,
+ process, and apparatus claims, in any patent Licensable by such
+ Contributor that would be infringed, but for the grant of the License,
+ by the making, using, selling, offering for sale, having made, import,
+ or transfer of either its Contributions or its Contributor Version.
+
+1.12. "Secondary License"
+
+ means either the GNU General Public License, Version 2.0, the GNU Lesser
+ General Public License, Version 2.1, the GNU Affero General Public
+ License, Version 3.0, or any later versions of those licenses.
+
+1.13. "Source Code Form"
+
+ means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+
+ means an individual or a legal entity exercising rights under this
+ License. For legal entities, "You" includes any entity that controls, is
+ controlled by, or is under common control with You. For purposes of this
+ definition, "control" means (a) the power, direct or indirect, to cause
+ the direction or management of such entity, whether by contract or
+ otherwise, or (b) ownership of more than fifty percent (50%) of the
+ outstanding shares or beneficial ownership of such entity.
+
+
+2. License Grants and Conditions
+
+2.1. Grants
+
+ Each Contributor hereby grants You a world-wide, royalty-free,
+ non-exclusive license:
+
+ a. under intellectual property rights (other than patent or trademark)
+ Licensable by such Contributor to use, reproduce, make available,
+ modify, display, perform, distribute, and otherwise exploit its
+ Contributions, either on an unmodified basis, with Modifications, or
+ as part of a Larger Work; and
+
+ b. under Patent Claims of such Contributor to make, use, sell, offer for
+ sale, have made, import, and otherwise transfer either its
+ Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+ The licenses granted in Section 2.1 with respect to any Contribution
+ become effective for each Contribution on the date the Contributor first
+ distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+ The licenses granted in this Section 2 are the only rights granted under
+ this License. No additional rights or licenses will be implied from the
+ distribution or licensing of Covered Software under this License.
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
+ Contributor:
+
+ a. for any code that a Contributor has removed from Covered Software; or
+
+ b. for infringements caused by: (i) Your and any other third party's
+ modifications of Covered Software, or (ii) the combination of its
+ Contributions with other software (except as part of its Contributor
+ Version); or
+
+ c. under Patent Claims infringed by Covered Software in the absence of
+ its Contributions.
+
+ This License does not grant any rights in the trademarks, service marks,
+ or logos of any Contributor (except as may be necessary to comply with
+ the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+ No Contributor makes additional grants as a result of Your choice to
+ distribute the Covered Software under a subsequent version of this
+ License (see Section 10.2) or under the terms of a Secondary License (if
+ permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+ Each Contributor represents that the Contributor believes its
+ Contributions are its original creation(s) or it has sufficient rights to
+ grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+ This License is not intended to limit any rights You have under
+ applicable copyright doctrines of fair use, fair dealing, or other
+ equivalents.
+
+2.7. Conditions
+
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
+ Section 2.1.
+
+
+3. Responsibilities
+
+3.1. Distribution of Source Form
+
+ All distribution of Covered Software in Source Code Form, including any
+ Modifications that You create or to which You contribute, must be under
+ the terms of this License. You must inform recipients that the Source
+ Code Form of the Covered Software is governed by the terms of this
+ License, and how they can obtain a copy of this License. You may not
+ attempt to alter or restrict the recipients' rights in the Source Code
+ Form.
+
+3.2. Distribution of Executable Form
+
+ If You distribute Covered Software in Executable Form then:
+
+ a. such Covered Software must also be made available in Source Code Form,
+ as described in Section 3.1, and You must inform recipients of the
+ Executable Form how they can obtain a copy of such Source Code Form by
+ reasonable means in a timely manner, at a charge no more than the cost
+ of distribution to the recipient; and
+
+ b. You may distribute such Executable Form under the terms of this
+ License, or sublicense it under different terms, provided that the
+ license for the Executable Form does not attempt to limit or alter the
+ recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+ You may create and distribute a Larger Work under terms of Your choice,
+ provided that You also comply with the requirements of this License for
+ the Covered Software. If the Larger Work is a combination of Covered
+ Software with a work governed by one or more Secondary Licenses, and the
+ Covered Software is not Incompatible With Secondary Licenses, this
+ License permits You to additionally distribute such Covered Software
+ under the terms of such Secondary License(s), so that the recipient of
+ the Larger Work may, at their option, further distribute the Covered
+ Software under the terms of either this License or such Secondary
+ License(s).
+
+3.4. Notices
+
+ You may not remove or alter the substance of any license notices
+ (including copyright notices, patent notices, disclaimers of warranty, or
+ limitations of liability) contained within the Source Code Form of the
+ Covered Software, except that You may alter any license notices to the
+ extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+ You may choose to offer, and to charge a fee for, warranty, support,
+ indemnity or liability obligations to one or more recipients of Covered
+ Software. However, You may do so only on Your own behalf, and not on
+ behalf of any Contributor. You must make it absolutely clear that any
+ such warranty, support, indemnity, or liability obligation is offered by
+ You alone, and You hereby agree to indemnify every Contributor for any
+ liability incurred by such Contributor as a result of warranty, support,
+ indemnity or liability terms You offer. You may include additional
+ disclaimers of warranty and limitations of liability specific to any
+ jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+
+ If it is impossible for You to comply with any of the terms of this License
+ with respect to some or all of the Covered Software due to statute,
+ judicial order, or regulation then You must: (a) comply with the terms of
+ this License to the maximum extent possible; and (b) describe the
+ limitations and the code they affect. Such description must be placed in a
+ text file included with all distributions of the Covered Software under
+ this License. Except to the extent prohibited by statute or regulation,
+ such description must be sufficiently detailed for a recipient of ordinary
+ skill to be able to understand it.
+
+5. Termination
+
+5.1. The rights granted under this License will terminate automatically if You
+ fail to comply with any of its terms. However, if You become compliant,
+ then the rights granted under this License from a particular Contributor
+ are reinstated (a) provisionally, unless and until such Contributor
+ explicitly and finally terminates Your grants, and (b) on an ongoing
+ basis, if such Contributor fails to notify You of the non-compliance by
+ some reasonable means prior to 60 days after You have come back into
+ compliance. Moreover, Your grants from a particular Contributor are
+ reinstated on an ongoing basis if such Contributor notifies You of the
+ non-compliance by some reasonable means, this is the first time You have
+ received notice of non-compliance with this License from such
+ Contributor, and You become compliant prior to 30 days after Your receipt
+ of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+ infringement claim (excluding declaratory judgment actions,
+ counter-claims, and cross-claims) alleging that a Contributor Version
+ directly or indirectly infringes any patent, then the rights granted to
+ You by any and all Contributors for the Covered Software under Section
+ 2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
+ license agreements (excluding distributors and resellers) which have been
+ validly granted by You or Your distributors under this License prior to
+ termination shall survive termination.
+
+6. Disclaimer of Warranty
+
+ Covered Software is provided under this License on an "as is" basis,
+ without warranty of any kind, either expressed, implied, or statutory,
+ including, without limitation, warranties that the Covered Software is free
+ of defects, merchantable, fit for a particular purpose or non-infringing.
+ The entire risk as to the quality and performance of the Covered Software
+ is with You. Should any Covered Software prove defective in any respect,
+ You (not any Contributor) assume the cost of any necessary servicing,
+ repair, or correction. This disclaimer of warranty constitutes an essential
+ part of this License. No use of any Covered Software is authorized under
+ this License except under this disclaimer.
+
+7. Limitation of Liability
+
+ Under no circumstances and under no legal theory, whether tort (including
+ negligence), contract, or otherwise, shall any Contributor, or anyone who
+ distributes Covered Software as permitted above, be liable to You for any
+ direct, indirect, special, incidental, or consequential damages of any
+ character including, without limitation, damages for lost profits, loss of
+ goodwill, work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses, even if such party shall have been
+ informed of the possibility of such damages. This limitation of liability
+ shall not apply to liability for death or personal injury resulting from
+ such party's negligence to the extent applicable law prohibits such
+ limitation. Some jurisdictions do not allow the exclusion or limitation of
+ incidental or consequential damages, so this exclusion and limitation may
+ not apply to You.
+
+8. Litigation
+
+ Any litigation relating to this License may be brought only in the courts
+ of a jurisdiction where the defendant maintains its principal place of
+ business and such litigation shall be governed by laws of that
+ jurisdiction, without reference to its conflict-of-law provisions. Nothing
+ in this Section shall prevent a party's ability to bring cross-claims or
+ counter-claims.
+
+9. Miscellaneous
+
+ This License represents the complete agreement concerning the subject
+ matter hereof. If any provision of this License is held to be
+ unenforceable, such provision shall be reformed only to the extent
+ necessary to make it enforceable. Any law or regulation which provides that
+ the language of a contract shall be construed against the drafter shall not
+ be used to construe this License against a Contributor.
+
+
+10. Versions of the License
+
+10.1. New Versions
+
+ Mozilla Foundation is the license steward. Except as provided in Section
+ 10.3, no one other than the license steward has the right to modify or
+ publish new versions of this License. Each version will be given a
+ distinguishing version number.
+
+10.2. Effect of New Versions
+
+ You may distribute the Covered Software under the terms of the version
+ of the License under which You originally received the Covered Software,
+ or under the terms of any subsequent version published by the license
+ steward.
+
+10.3. Modified Versions
+
+ If you create software not governed by this License, and you want to
+ create a new license for such software, you may create and use a
+ modified version of this License if you rename the license and remove
+ any references to the name of the license steward (except to note that
+ such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+ Licenses If You choose to distribute Source Code Form that is
+ Incompatible With Secondary Licenses under the terms of this version of
+ the License, the notice described in Exhibit B of this License must be
+ attached.
+
+Exhibit A - Source Code Form License Notice
+
+ This Source Code Form is subject to the
+ terms of the Mozilla Public License, v.
+ 2.0. If a copy of the MPL was not
+ distributed with this file, You can
+ obtain one at
+ http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular file,
+then You may include the notice in a location (such as a LICENSE file in a
+relevant directory) where a recipient would be likely to look for such a
+notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+
+ This Source Code Form is "Incompatible
+ With Secondary Licenses", as defined by
+ the Mozilla Public License, v. 2.0.
diff --git a/METADATA b/METADATA
new file mode 100644
index 0000000..b27c236
--- /dev/null
+++ b/METADATA
@@ -0,0 +1,19 @@
+name: "epoll"
+description: "Safe epoll interface."
+third_party {
+ identifier {
+ type: "crates.io"
+ value: "https://crates.io/crates/epoll"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/epoll/epoll-4.3.3.crate"
+ }
+ version: "4.3.3"
+ license_type: RECIPROCAL
+ last_upgrade_date {
+ year: 2023
+ month: 8
+ day: 23
+ }
+}
diff --git a/MODULE_LICENSE_BSD_LIKE b/MODULE_LICENSE_BSD_LIKE
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/MODULE_LICENSE_BSD_LIKE
diff --git a/OWNERS b/OWNERS
new file mode 100644
index 0000000..45dc4dd
--- /dev/null
+++ b/OWNERS
@@ -0,0 +1 @@
+include platform/prebuilts/rust:master:/OWNERS
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e00a9b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# epoll [<img src="https://travis-ci.org/nathansizemore/epoll.svg?branch=master">][travis-badge]
+
+Safe wrapper around the Linux kernel's [epoll][epoll-man-page] API.
+
+[Documentation][docs]
+
+
+### Author
+
+Nathan Sizemore, nathanrsizemore@gmail.com
+
+### License
+
+epoll is available under the MPL-2.0 license. See the LICENSE file for more info.
+
+
+
+[travis-badge]: https://travis-ci.org/nathansizemore/epoll
+[docs]: https://docs.rs/epoll
+[epoll-man-page]: http://man7.org/linux/man-pages/man7/epoll.7.html
diff --git a/rustfmt.toml b/rustfmt.toml
new file mode 100644
index 0000000..5c8d931
--- /dev/null
+++ b/rustfmt.toml
@@ -0,0 +1 @@
+max_width = 80 \ No newline at end of file
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..f2f8c4d
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,188 @@
+// Copyright 2015 Nathan Sizemore <nathanrsizemore@gmail.com>
+//
+// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
+// If a copy of the MPL was not distributed with this file,
+// You can obtain one at http://mozilla.org/MPL/2.0/.
+
+#[macro_use]
+extern crate bitflags;
+extern crate libc;
+
+use std::fmt::{Debug, Formatter, Result};
+use std::io::{self, Error};
+use std::os::unix::io::RawFd;
+
+#[repr(i32)]
+#[allow(non_camel_case_types)]
+pub enum ControlOptions {
+ /// Indicates an addition to the interest list.
+ EPOLL_CTL_ADD = libc::EPOLL_CTL_ADD,
+ /// Indicates a modification of flags for an interest already in list.
+ EPOLL_CTL_MOD = libc::EPOLL_CTL_MOD,
+ /// Indicates a removal of an interest from the list.
+ EPOLL_CTL_DEL = libc::EPOLL_CTL_DEL,
+}
+
+bitflags! {
+
+ #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
+ pub struct Events: u32 {
+ /// Sets the Edge Triggered behavior for the associated file descriptor.
+ ///
+ /// The default behavior for epoll is Level Triggered.
+ const EPOLLET = libc::EPOLLET as u32;
+ /// The associated file is available for read operations.
+ const EPOLLIN = libc::EPOLLIN as u32;
+ /// Error condition happened on the associated file descriptor.
+ ///
+ /// `wait` will always wait for this event; is not necessary to set it in events.
+ const EPOLLERR = libc::EPOLLERR as u32;
+ /// Hang up happened on the associated file descriptor.
+ ///
+ /// `wait` will always wait for this event; it is not necessary to set it in events.
+ /// Note that when reading from a channel such as a pipe or a stream socket, this event
+ /// merely indicates that the peer closed its end of the channel. Subsequent reads from
+ /// the channel will return 0 (end of file) only after all outstanding data in the
+ /// channel has been consumed.
+ const EPOLLHUP = libc::EPOLLHUP as u32;
+ /// The associated file is available for write operations.
+ const EPOLLOUT = libc::EPOLLOUT as u32;
+ /// There is urgent data available for read operations.
+ const EPOLLPRI = libc::EPOLLPRI as u32;
+ /// Stream socket peer closed connection, or shut down writing half of connection.
+ ///
+ /// This flag is especially useful for writing simple code to detect peer shutdown when
+ /// using Edge Triggered monitoring.
+ const EPOLLRDHUP = libc::EPOLLRDHUP as u32;
+ /// If `EPOLLONESHOT` and `EPOLLET` are clear and the process has the `CAP_BLOCK_SUSPEND`
+ /// capability, ensure that the system does not enter "suspend" or "hibernate" while this
+ /// event is pending or being processed.
+ ///
+ /// The event is considered as being "processed" from the time when it is returned by
+ /// a call to `wait` until the next call to `wait` on the same `EpollInstance`
+ /// descriptor, the closure of that file descriptor, the removal of the event file
+ /// descriptor with `EPOLL_CTL_DEL`, or the clearing of `EPOLLWAKEUP` for the event file
+ /// descriptor with `EPOLL_CTL_MOD`.
+ const EPOLLWAKEUP = libc::EPOLLWAKEUP as u32;
+ /// Sets the one-shot behavior for the associated file descriptor.
+ ///
+ /// This means that after an event is pulled out with `wait` the associated file
+ /// descriptor is internally disabled and no other events will be reported by the epoll
+ /// interface. The user must call `ctl` with `EPOLL_CTL_MOD` to rearm the file
+ /// descriptor with a new event mask.
+ const EPOLLONESHOT = libc::EPOLLONESHOT as u32;
+ /// Sets an exclusive wakeup mode for the epoll file descriptor that is being attached to
+ /// the target file descriptor, `fd`. When a wakeup event occurs and multiple epoll file
+ /// descriptors are attached to the same target file using `EPOLLEXCLUSIVE`, one or more of
+ /// the epoll file descriptors will receive an event with `wait`. The default in this
+ /// scenario (when `EPOLLEXCLUSIVE` is not set) is for all epoll file descriptors to
+ /// receive an event. `EPOLLEXCLUSIVE` is thus useful for avoiding thundering herd problems
+ /// in certain scenarios.
+ ///
+ /// If the same file descriptor is in multiple epoll instances, some with the
+ /// `EPOLLEXCLUSIVE` flag, and others without, then events will be provided to all epoll
+ /// instances that did not specify `EPOLLEXCLUSIVE`, and at least one of the epoll
+ /// instances that did specify `EPOLLEXCLUSIVE`.
+ ///
+ /// The following values may be specified in conjunction with `EPOLLEXCLUSIVE`: `EPOLLIN`,
+ /// `EPOLLOUT`, `EPOLLWAKEUP`, and `EPOLLET`. `EPOLLHUP` and `EPOLLERR` can also be
+ /// specified, but this is not required: as usual, these events are always reported if they
+ /// occur, regardless of whether they are specified in `Events`. Attempts to specify other
+ /// values in `Events` yield the error `EINVAL`.
+ ///
+ /// `EPOLLEXCLUSIVE` may be used only in an `EPOLL_CTL_ADD` operation; attempts to employ
+ /// it with `EPOLL_CTL_MOD` yield an error. If `EPOLLEXCLUSIVE` has been set using `ctl`,
+ /// then a subsequent `EPOLL_CTL_MOD` on the same `epfd`, `fd` pair yields an error. A call
+ /// to `ctl` that specifies `EPOLLEXCLUSIVE` in `Events` and specifies the target file
+ /// descriptor `fd` as an epoll instance will likewise fail. The error in all of these
+ /// cases is `EINVAL`.
+ ///
+ /// The `EPOLLEXCLUSIVE` flag is an input flag for the `Event.events` field when calling
+ /// `ctl`; it is never returned by `wait`.
+ const EPOLLEXCLUSIVE = libc::EPOLLEXCLUSIVE as u32;
+ }
+}
+
+/// 'libc::epoll_event' equivalent.
+#[repr(C)]
+#[cfg_attr(target_arch = "x86_64", repr(packed))]
+#[derive(Clone, Copy)]
+pub struct Event {
+ pub events: u32,
+ pub data: u64,
+}
+
+impl Event {
+ pub fn new(events: Events, data: u64) -> Event {
+ Event {
+ events: events.bits(),
+ data: data,
+ }
+ }
+}
+
+impl Debug for Event {
+ fn fmt(&self, f: &mut Formatter<'_>) -> Result {
+ let data = self.data;
+ f.debug_struct("Event")
+ .field("events", &Events::from_bits_retain(self.events)) // Retain so we can see erroneously set bits too
+ .field("data", &data)
+ .finish()
+ }
+}
+
+/// Creates a new epoll file descriptor.
+///
+/// If `cloexec` is true, `FD_CLOEXEC` will be set on the returned file descriptor.
+///
+/// ## Notes
+///
+/// * `epoll_create1()` is the underlying syscall.
+pub fn create(cloexec: bool) -> io::Result<RawFd> {
+ let flags = if cloexec { libc::EPOLL_CLOEXEC } else { 0 };
+ unsafe { cvt(libc::epoll_create1(flags)) }
+}
+
+/// Safe wrapper for `libc::epoll_ctl`
+pub fn ctl(
+ epfd: RawFd,
+ op: ControlOptions,
+ fd: RawFd,
+ mut event: Event,
+) -> io::Result<()> {
+ let e = &mut event as *mut _ as *mut libc::epoll_event;
+ unsafe { cvt(libc::epoll_ctl(epfd, op as i32, fd, e))? };
+ Ok(())
+}
+
+/// Safe wrapper for `libc::epoll_wait`
+///
+/// ## Notes
+///
+/// * If `timeout` is negative, it will block until an event is received.
+pub fn wait(epfd: RawFd, timeout: i32, buf: &mut [Event]) -> io::Result<usize> {
+ let timeout = if timeout < -1 { -1 } else { timeout };
+ let num_events = unsafe {
+ cvt(libc::epoll_wait(
+ epfd,
+ buf.as_mut_ptr() as *mut libc::epoll_event,
+ buf.len() as i32,
+ timeout,
+ ))? as usize
+ };
+ Ok(num_events)
+}
+
+/// Safe wrapper for `libc::close`
+pub fn close(epfd: RawFd) -> io::Result<()> {
+ cvt(unsafe { libc::close(epfd) })?;
+ Ok(())
+}
+
+fn cvt(result: libc::c_int) -> io::Result<libc::c_int> {
+ if result < 0 {
+ Err(Error::last_os_error())
+ } else {
+ Ok(result)
+ }
+}