1 // Copyright (c) 2023 Huawei Device Co., Ltd.
2 // Licensed under the Apache License, Version 2.0 (the "License");
3 // you may not use this file except in compliance with the License.
4 // You may obtain a copy of the License at
5 //
6 //     http://www.apache.org/licenses/LICENSE-2.0
7 //
8 // Unless required by applicable law or agreed to in writing, software
9 // distributed under the License is distributed on an "AS IS" BASIS,
10 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 // See the License for the specific language governing permissions and
12 // limitations under the License.
13 
14 use libc::{c_int, c_uchar, c_uint, c_ulonglong, c_void};
15 
16 // Unstable interface, rust encapsulation temporarily not provided
17 
18 type FfrtSysEventHandleT = *mut c_void;
19 type DestroyFunc = extern "C" fn(*mut c_void);
20 type FfrtFdCallBack = extern "C" fn(*const c_void, c_uint, c_uchar);
21 type FfrtExecHook = extern "C" fn(*mut c_void);
22 type FfrtTimerHandle = *mut c_void;
23 
24 #[link(name = "ffrt")]
25 // sys_event.h
26 extern "C" {
27     #![allow(unused)]
ffrt_sys_event_create(ty: c_int, fd: usize, filter: usize) -> FfrtSysEventHandleT28     fn ffrt_sys_event_create(ty: c_int, fd: usize, filter: usize) -> FfrtSysEventHandleT;
ffrt_sys_event_wait(event: FfrtSysEventHandleT, sec: i64) -> c_int29     fn ffrt_sys_event_wait(event: FfrtSysEventHandleT, sec: i64) -> c_int;
ffrt_sys_event_destroy(event: FfrtSysEventHandleT, func: DestroyFunc, arg: *mut c_void)30     fn ffrt_sys_event_destroy(event: FfrtSysEventHandleT, func: DestroyFunc, arg: *mut c_void);
31 
32     /// Registers the fd to ffrt's epoll. Callback will be called when io events
33     /// arrived.
ffrt_poller_register( fd: c_int, events: c_uint, data: *const c_void, callback: FfrtFdCallBack, ) -> c_int34     pub fn ffrt_poller_register(
35         fd: c_int,
36         events: c_uint,
37         data: *const c_void,
38         callback: FfrtFdCallBack,
39     ) -> c_int;
40 
41     /// Deregisters the fd from ffrt's epoll.
ffrt_poller_deregister(fd: c_int) -> c_int42     pub fn ffrt_poller_deregister(fd: c_int) -> c_int;
43 
44     /// Registers a timer to ffrt's timer poller. Callback will be called when
45     /// timer events arrived.
ffrt_timer_start( duration: c_ulonglong, waker: *mut c_void, callback: FfrtExecHook, ) -> FfrtTimerHandle46     pub fn ffrt_timer_start(
47         duration: c_ulonglong,
48         waker: *mut c_void,
49         callback: FfrtExecHook,
50     ) -> FfrtTimerHandle;
51 
52     /// Deregisters the timer from ffrt's timer poller
ffrt_timer_stop(handle: FfrtTimerHandle)53     pub fn ffrt_timer_stop(handle: FfrtTimerHandle);
54 
55     /// Checks whether the timer has expired. A returned value of 1 indicates
56     /// the timer has reached its deadline, otherwise, the timer has not expired
57     /// yet.
ffrt_timer_query(handle: FfrtTimerHandle) -> c_int58     pub fn ffrt_timer_query(handle: FfrtTimerHandle) -> c_int;
59 
60     /// Wakes up the poller to poll timer/io events.
ffrt_poller_wakeup()61     pub fn ffrt_poller_wakeup();
62 }
63