xwrust/xwos/sync/flg.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
//! XWOS RUST：事件标志
//! ========
//!
//! 事件标志使用位图来管理一组事件，位图中的每个位代表一个事件，
//! 当一个或多个事件状态发生变化时，事件对应的位也会发生变化，并唤醒正在等待的线程。
//! 线程唤醒后，就可从事件位图中获取事件的状态。
//!
//! + 线程可以等待位图中的事件位被置 **1** ，也可以等待事件位被清 **0** 。
//! + 线程可以等待位图中的事件位同时被置 **1** （事件与事件之间是逻辑 **与** 的关系），也可以等待其中任意一个位被置 **1** （事件与事件之间是逻辑 **或** 的关系）。
//! + 线程可以等待位图中的事件位同时被清 **0** （事件与事件之间是逻辑 **与** 的关系），也可以等待其中任意一个位被清 **0** （事件与事件之间是逻辑 **或** 的关系）。
//! + 线程可以选择是否 **消费** 事件。 **消费** 事件是指，当事件到来，线程被唤醒时，可以选择是否 **清除** 事件。
//! + 线程可以等待事件标志位发生 **翻转** ， **翻转** 是指事件标志位由 **1** 变为 **0** ，或由 **0** 变为 **1** 。
//!
//!
//! # 创建
//!
//! XWOS RUST的事件标志可使用 [`Flg::new()`] 创建。
//!
//! + 可以创建具有静态生命周期 [`static`] 约束的全局变量：
//!
//! ```rust
//! use xwrust::xwos::sync::flg::*;
//!
//! static GLOBAL_FLG: Flg<8> = Flg::new();
//! ```
//!
//! + 也可以使用 [`alloc::sync::Arc`] 在heap中创建：
//!
//! ```rust
//! extern crate alloc;
//! use alloc::sync::Arc;
//!
//! use xwrust::xwos::sync::flg::*;
//!
//! pub fn xwrust_example_flg() {
//! let flg = Arc::new(Flg::<8>::new());
//! }
//! ```
//!
//!
//! # 初始化
//!
//! 无论以何种方式创建的事件标志，都必须在使用前调用 [`Flg::init()`] 进行初始化：
//!
//! ```rust
//! pub fn xwrust_example_flg() {
//! GLOBAL_FLG.init();
//! flg.init();
//! }
//! ```
//!
//!
//! # 产生事件
//!
//! + [`Flg::s1m()`] 同时设置多个事件标志位
//! + [`Flg::s1i()`] 设置单个事件标志位
//! + [`Flg::c0m()`] 同时清除多个事件标志位
//! + [`Flg::c0i()`] 清除单个事件标志位
//! + [`Flg::x1m()`] 同时翻转多个事件标志位
//! + [`Flg::x1i()`] 翻转单个事件标志位
//!
//! 产生事件的方法，除了会修改事件标志位图的状态，还会通过 **广播** 唤醒所有正在等待的线程。
//! 然后，线程通过比对位图状态，确定事件是否已经满足触发条件。
//! 若满足触发条件，就退出等待；若未满足触发条件，重新进入阻塞等待状态。
//!
//!
//! # 等待事件的方法
//!
//! + [`Flg::wait()`] 可用于等待事件。
//! + [`Flg::wait_to()`] 可用于限时等待事件。
//! + [`Flg::trywait()`] 可用于检测事件。
//!
//! ## 事件的触发条件
//!
//! 等待事件时，可通过参数 `tg` 指明事件的触发条件。事件的触发条件分为两类。
//!
//! ### 电平触发
//!
//! **电平触发** 源于数字电路，是一种类比概念，是指事件位图的特定状态（ **1** 或 **0** ）所产生的触发事件，包括：
//!
//! + [`Trigger::SetAll`] 所有事件位被置 **1** 触发
//! + [`Trigger::SetAny`] 任意事件位被置 **1** 触发
//! + [`Trigger::ClearAll`] 所有事件位被清 **0** 触发
//! + [`Trigger::ClearAny`] 任意事件位被清 **0** 触发
//!
//! **电平触发** 时，可在线程读取事件位图后，**清除** 事件触发条件。
//!
//! ### 边沿触发
//!
//! **边沿触发** 源于数字电路，是一种类比概念，是指事件状态发生改变（ **1** 变 **0** 或 **0** 变 **1** ）时产生的唤醒信号，包括：
//!
//! + [`Trigger::SetAll`] 所有事件位发生翻转触发
//! + [`Trigger::SetAny`] 任意事件位发生翻转触发
//!
//! **边沿触发** 时，事件的触发条件不需要清除。
//! **边沿触发** 时，必须要有一个初始状态，就像数字电路一样：
//!
//! + 当位的初始值为 **0** (低电平)，然后跳变到 **1** (高电平)的瞬间被称为上升沿。此时触发的事件被称为上升沿触发。
//! + 当位的初始值为 **1** (高电平)，然后跳变到 **0** (低电平)的瞬间被称为下降沿。此时触发的事件被称为下降沿触发。
//!
//! ## 清除事件
//!
//! + 当采用 **电平触发** 时，需要在读取事件位图后 **清除** 事件标志位，否则事件会一直处于触发状态。
//! 可以在调用等待事件的方法时，指定参数 `action` 为 [`Action::Consumption`] 。
//! **清除** 的含义是：
//! + 当线程等待的是位图中的事件位被置 **1** ， **清除** 是指将这些位清 **0** ；
//! + 当线程等待的是位图中的事件位被清 **0** ， **清除** 是指将这些位置 **1** ；
//! + 当采用 **边沿触发** 时，不需要 **清除** 事件的触发条件。
//!
//!
//! # 读取事件
//!
//! 用户可以通过方法 [`Flg::read()`] 直接读取事件的位图状态。此函数立即返回，不会阻塞。
//!
//! # 获取事件标志中事件槽的数量
//!
//! 可以通过方法 [`Flg::get_num()`] 获取事件标志中事件槽的数量。
//!
//!
//! # 绑定到信号选择器
//!
//! 事件标志是 **同步对象** ，可以通过方法 [`Flg::bind()`] 将事件标志绑定到信号选择器 [`Sel<M>`] 上，通过 [`Sel<M>`] ，单一线程可以同时等待多个不同的 **同步对象** 。
//!
//! 事件标志采用 **非独占** 的方式进行绑定。
//!
//!
//! # 示例
//!
//! [XWOS/xwam/xwrust-example/xwrust_example_flg](https://gitee.com/xwos/XWOS/blob/main/xwam/xwrust-example/xwrust_example_flg/src/lib.rs)
//!
//!
//! [`static`]: <https://doc.rust-lang.org/std/keyword.static.html>
//! [`alloc::sync::Arc`]: <https://doc.rust-lang.org/alloc/sync/struct.Arc.html>
//! [`Sel<M>`]: super::sel::Sel
extern crate core;
use core::ffi::*;
use core::cell::UnsafeCell;
use crate::types::*;
use crate::errno::*;
use crate::xwbmp::*;
use crate::xwos::sync::sel::*;
extern "C" {
pub(crate) fn xwrustffi_flg_init(flg: *mut c_void, num: XwSz, bmp: *mut XwBmp, msk: *mut XwBmp) -> XwEr;
pub(crate) fn xwrustffi_flg_fini(flg: *mut c_void) -> XwEr;
pub(crate) fn xwrustffi_flg_grab(flg: *mut c_void) -> XwEr;
pub(crate) fn xwrustffi_flg_put(flg: *mut c_void) -> XwEr;
pub(crate) fn xwrustffi_flg_get_tik(flg: *mut c_void) -> XwSq;
pub(crate) fn xwrustffi_flg_acquire(flg: *mut c_void, tik: XwSq) -> XwEr;
pub(crate) fn xwrustffi_flg_release(flg: *mut c_void, tik: XwSq) -> XwEr;
pub(crate) fn xwrustffi_flg_bind(flg: *mut c_void, sel: *mut c_void, pos: XwSq) -> XwEr;
pub(crate) fn xwrustffi_flg_unbind(flg: *mut c_void, sel: *mut c_void) -> XwEr;
pub(crate) fn xwrustffi_flg_read(flg: *mut c_void, out: *mut XwBmp) -> XwEr;
pub(crate) fn xwrustffi_flg_s1m(flg: *mut c_void, msk: *mut XwBmp) -> XwEr;
pub(crate) fn xwrustffi_flg_s1i(flg: *mut c_void, pos: XwSq) -> XwEr;
pub(crate) fn xwrustffi_flg_c0m(flg: *mut c_void, msk: *mut XwBmp) -> XwEr;
pub(crate) fn xwrustffi_flg_c0i(flg: *mut c_void, pos: XwSq) -> XwEr;
pub(crate) fn xwrustffi_flg_x1m(flg: *mut c_void, msk: *mut XwBmp) -> XwEr;
pub(crate) fn xwrustffi_flg_x1i(flg: *mut c_void, pos: XwSq) -> XwEr;
pub(crate) fn xwrustffi_flg_wait(flg: *mut c_void, tg: XwSq, act: XwSq,
origin: *mut XwBmp, msk: *mut XwBmp) -> XwEr;
pub(crate) fn xwrustffi_flg_wait_to(flg: *mut c_void, tg: XwSq, act: XwSq,
origin: *mut XwBmp, msk: *mut XwBmp, to: XwTm) -> XwEr;
pub(crate) fn xwrustffi_flg_trywait(flg: *mut c_void, tg: XwSq, act: XwSq,
origin: *mut XwBmp, msk: *mut XwBmp) -> XwEr;
}
/// 事件标志的错误码
#[derive(Debug)]
pub enum FlgError {
/// 没有错误
Ok(XwEr),
/// 事件标志没有初始化
NotInit(XwEr),
/// 位置超出范围
OutOfRange(XwEr),
/// 等待被中断
Interrupt(XwEr),
/// 等待超时
Timedout(XwEr),
/// 没有检测到事件
NoEvent(XwEr),
/// 不在线程上下文内
NotThreadContext(XwEr),
/// 信号选择器的位置超出范围
OutOfSelPos(XwEr),
/// 事件标志已经绑定
AlreadyBound(XwEr),
/// 信号选择器的位置被占用
SelPosBusy(XwEr),
/// 未知错误
Unknown(XwEr),
}
impl FlgError {
/// 消费掉 `FlgError` 自身，返回内部的错误码。
pub fn unwrap(self) -> XwEr {
match self {
Self::Ok(rc) => rc,
Self::NotInit(rc) => rc,
Self::OutOfRange(rc) => rc,
Self::Interrupt(rc) => rc,
Self::Timedout(rc) => rc,
Self::NoEvent(rc) => rc,
Self::NotThreadContext(rc) => rc,
Self::OutOfSelPos(rc) => rc,
Self::AlreadyBound(rc) => rc,
Self::SelPosBusy(rc) => rc,
Self::Unknown(rc) => rc,
}
}
/// 如果错误码是 [`FlgError::Ok`] ，返回 `true` 。
pub const fn is_ok(&self) -> bool {
matches!(*self, Self::Ok(_))
}
/// 如果错误码不是 [`FlgError::Ok`] ，返回 `true` 。
pub const fn is_err(&self) -> bool {
!self.is_ok()
}
}
/// 触发条件
pub enum Trigger {
/// 所有事件位被置 **1** 触发
SetAll = 0,
/// 任意事件位被置 **1** 触发
SetAny = 1,
/// 所有事件位被清 **0** 触发
ClearAll = 2,
/// 任意事件位被清 **0** 触发
ClearAny = 3,
/// 所有事件位发生翻转触发
ToggleAll = 4,
/// 任意事件位发生翻转触发
ToggleAny = 5,
}
/// 触发后的动作
pub enum Action {
/// 事件触发后不做任何操作
None = 0,
/// 事件触发后清除触发条件
Consumption = 1,
}
/// XWOS事件标志对象占用的内存大小
#[cfg(target_pointer_width = "32")]
pub const SIZEOF_XWOS_FLG: usize = 64;
/// XWOS事件标志对象占用的内存大小
#[cfg(target_pointer_width = "64")]
pub const SIZEOF_XWOS_FLG: usize = 128;
/// 用于构建事件标志的内存数组类型
#[repr(C)]
#[cfg_attr(target_pointer_width = "32", repr(align(8)))]
#[cfg_attr(target_pointer_width = "64", repr(align(16)))]
pub(crate) struct XwosFlg<const N: XwSz>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{
pub(crate) obj: [u8; SIZEOF_XWOS_FLG],
pub(crate) bmp: [XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize],
pub(crate) msk: [XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize],
}
/// 事件标志对象结构体
pub struct Flg<const N: XwSz>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{
/// 用于初始化XWOS事件标志对象的内存空间
pub(crate) flg: UnsafeCell<XwosFlg<N>>,
/// 事件标志对象的标签
pub(crate) tik: UnsafeCell<XwSq>,
}
unsafe impl<const N: XwSz> Send for Flg<N>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{}
unsafe impl<const N: XwSz> Sync for Flg<N>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{}
impl<const N: XwSz> Drop for Flg<N>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{
fn drop(&mut self) {
unsafe {
xwrustffi_flg_fini(self.flg.get() as _);
}
}
}
impl<const N: XwSz> Flg<N>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{
/// 新建事件标志对象
///
/// 此方法是编译期方法。
///
/// # 示例
///
/// + 具有 [`static`] 约束的全局变量全局变量：
///
/// ```rust
/// use xwrust::xwos::sync::flg::*;
///
/// static GLOBAL_FLG: Flg<8> = Flg::new();
/// ```
///
/// + 在heap中创建：
///
/// ```rust
/// extern crate alloc;
/// use alloc::sync::Arc;
///
/// pub fn xwrust_example_flg() {
/// let flg = Arc::new(Flg::<8>::new());
/// }
/// ```
///
/// [`static`]: https://doc.rust-lang.org/std/keyword.static.html
pub const fn new() -> Self {
Self {
flg: UnsafeCell::new(XwosFlg {
obj: [0; SIZEOF_XWOS_FLG],
bmp: [0; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize],
msk: [0; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize],
}),
tik: UnsafeCell::new(0),
}
}
/// 初始化事件标志对象
///
/// 事件标志对象必须调用此方法一次，方可正常使用。
///
/// # 上下文
///
/// + 任意
///
/// # 示例
///
/// ```rust
/// use xwrust::xwos::sync::flg::*;
///
/// static GLOBAL_FLG: Flg<8> = Flg::new();
///
/// pub fn xwrust_example_flg() {
/// // ...省略...
/// GLOBAL_FLG.init();
/// // 从此处开始 GLOBAL_FLG 可正常使用
/// }
/// ```
pub fn init(&self) {
unsafe {
let rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
xwrustffi_flg_put(self.flg.get() as _);
} else {
xwrustffi_flg_init(self.flg.get() as _,
N,
&mut (*self.flg.get()).bmp as _,
&mut (*self.flg.get()).msk as _);
*self.tik.get() = xwrustffi_flg_get_tik(self.flg.get() as _);
}
}
}
/// 获取事件标志中事件槽的数量
pub const fn get_num(&self) -> XwSz {
N
}
/// 读取事件标志位图的值
///
/// 直接读取位图的值，不会等待，也不会改变位图的状态。
pub fn read(&self) -> Result<Bmp<N>, FlgError> {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
let out = Bmp::<N>::new();
rc = xwrustffi_flg_read(self.flg.get() as _, out.bmp.get() as _,);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
Ok(out)
} else {
Err(FlgError::Unknown(rc))
}
} else {
Err(FlgError::NotInit(rc))
}
}
}
/// 同时设置多个事件标志位
///
/// 此方法会将事件标志位图中，被掩码 `msk` 覆盖的位全部设置为 **1** 。
///
/// 此方法除了会修改事件标志位图的状态，还会通过 **广播** 唤醒所有正在等待的线程。
/// 然后，线程通过比对位图状态，确定事件是否已经满足触发条件。
/// 若满足触发条件，就退出等待；若未满足触发条件，重新进入阻塞等待状态。
///
/// # 参数说明
///
/// + msk: 事件的位图掩码
pub fn s1m(&self, msk: &Bmp<N>) -> FlgError {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_s1m(self.flg.get() as _, msk.bmp.get() as _);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
FlgError::Ok(rc)
} else {
FlgError::Unknown(rc)
}
} else {
FlgError::NotInit(rc)
}
}
}
/// 设置单个事件标志位
///
/// 此方法会将事件标志位图中，序号为 `pos` 的单个位设置为 **1** 。
///
/// 此函数除了会修改事件标志位图的状态，还会通过 **广播** 唤醒所有正在等待的线程。
/// 然后，线程通过比对位图状态，确定事件是否已经满足触发条件。
/// 若满足触发条件，就退出等待；若未满足触发条件，重新进入阻塞等待状态。
///
/// # 参数说明
///
/// + pos: 事件的序号
pub fn s1i(&self, pos: XwSq) -> FlgError {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_s1i(self.flg.get() as _, pos);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
FlgError::Ok(rc)
} else {
FlgError::Unknown(rc)
}
} else {
FlgError::NotInit(rc)
}
}
}
/// 同时清除多个事件标志位
///
/// 此方法会将事件标志位图中，被掩码 `msk` 覆盖的位全部清 **0** 。
///
/// 此方法除了会修改事件标志位图的状态，还会通过 **广播** 唤醒所有正在等待的线程。
/// 然后，线程通过比对位图状态，确定事件是否已经满足触发条件。
/// 若满足触发条件，就退出等待；若未满足触发条件，重新进入阻塞等待状态。
///
/// # 参数说明
///
/// + msk: 事件的位图掩码
pub fn c0m(&self, msk: &Bmp<N>) -> FlgError {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_c0m(self.flg.get() as _, msk.bmp.get() as _);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
FlgError::Ok(rc)
} else {
FlgError::Unknown(rc)
}
} else {
FlgError::NotInit(rc)
}
}
}
/// 清除单个事件标志位
///
/// 此方法会将事件标志位图中，序号为 `pos` 的单个位清 **0** 。
///
/// 此函数除了会修改事件标志位图的状态，还会通过 **广播** 唤醒所有正在等待的线程。
/// 然后，线程通过比对位图状态，确定事件是否已经满足触发条件。
/// 若满足触发条件，就退出等待；若未满足触发条件，重新进入阻塞等待状态。
///
/// # 参数说明
///
/// + pos: 事件的序号
pub fn c0i(&self, pos: XwSq) -> FlgError {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_c0i(self.flg.get() as _, pos);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
FlgError::Ok(rc)
} else {
FlgError::Unknown(rc)
}
} else {
FlgError::NotInit(rc)
}
}
}
/// 同时翻转多个事件标志位
///
/// 此方法会将事件标志位图中，被掩码 `msk` 覆盖的位全部翻转。
///
/// 此方法除了会修改事件标志位图的状态，还会通过 **广播** 唤醒所有正在等待的线程。
/// 然后，线程通过比对位图状态，确定事件是否已经满足触发条件。
/// 若满足触发条件，就退出等待；若未满足触发条件，重新进入阻塞等待状态。
///
/// # 参数说明
///
/// + msk: 事件的位图掩码
pub fn x1m(&self, msk: &Bmp<N>) -> FlgError {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_x1m(self.flg.get() as _, msk.bmp.get() as _);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
FlgError::Ok(rc)
} else {
FlgError::Unknown(rc)
}
} else {
FlgError::NotInit(rc)
}
}
}
/// 翻转单个事件标志位
///
/// 此方法会将事件标志位图中，序号为 `pos` 的单个位翻转。
///
/// 此函数除了会修改事件标志位图的状态，还会通过 **广播** 唤醒所有正在等待的线程。
/// 然后，线程通过比对位图状态，确定事件是否已经满足触发条件。
/// 若满足触发条件，就退出等待；若未满足触发条件，重新进入阻塞等待状态。
///
/// # 参数说明
///
/// + pos: 事件的序号
pub fn x1i(&self, pos: XwSq) -> FlgError {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_x1i(self.flg.get() as _, pos);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
FlgError::Ok(rc)
} else {
FlgError::Unknown(rc)
}
} else {
FlgError::NotInit(rc)
}
}
}
/// 等待事件
///
/// + 当没有检测到事件时，线程会阻塞等待。
/// + 当检测到事件时，线程被唤醒，然后返回 [`FlgError::Ok`] 。
/// + 当线程阻塞等待被中断时，返回 [`FlgError::Interrupt`] 。
///
/// # 事件的触发条件
///
/// 事件的触发条件可通过参数 `tg` 设置。事件的触发条件分为两类。
///
/// ## 电平触发
///
/// **电平触发** 源于数字电路，是一种类比概念，是指事件位图的特定状态（ **1** 或 **0** ）所产生的触发事件，包括：
///
/// + [`Trigger::SetAll`] 所有事件位被置 **1** 触发
/// + [`Trigger::SetAny`] 任意事件位被置 **1** 触发
/// + [`Trigger::ClearAll`] 所有事件位被清 **0** 触发
/// + [`Trigger::ClearAny`] 任意事件位被清 **0** 触发
///
/// **电平触发** 时，若参数 `action` 取值 [`Action::Consumption`] ，表示线程在读取事件位图后，会 **清除** 事件位图。
/// **电平触发** 时，参数 `origin` 用于返回事件发生时的位图状态。
///
/// ## 边沿触发
///
/// **边沿触发** 源于数字电路，是一种类比概念，是指事件状态发生改变（ **1** 变 **0** 或 **0** 变 **1** ）时产生的唤醒信号，包括：
///
/// + [`Trigger::SetAll`] 所有事件位发生翻转触发
/// + [`Trigger::SetAny`] 任意事件位发生翻转触发
///
/// **边沿触发** 时，参数 `action` 没有作用，取值 [`Action::None`] 即可。
/// **边沿触发** 时，必须要有一个初始状态，就像数字电路一样：
///
/// + 当位的初始值为 **0** (低电平)，然后跳变到 **1** (高电平)的瞬间被称为上升沿。此时触发的事件被称为上升沿触发。
/// + 当位的初始值为 **1** (高电平)，然后跳变到 **0** (低电平)的瞬间被称为下降沿。此时触发的事件被称为下降沿触发。
///
/// 初始值就由参数 `origin` 指明，触发后，事件位发生跳变，跳变后的结果还是由参数 `origin` 返回。
///
/// # 参数说明
///
/// + tg: 事件触发条件
/// + act: 事件触发后的动作
/// + origin: 事件位图
/// + **电平触发** 时，参数 `origin` 用于返回事件发生时的位图状态。
/// + 初始值就由参数 `origin` 指明，触发后，事件位发生跳变，跳变后的结果还是由参数 `origin` 返回。
/// + msk: 事件的位图掩码
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`FlgError::Ok`] 没有错误
/// + [`FlgError::NotInit`] 事件标志没有初始化
/// + [`FlgError::Interrupt`] 等待被中断
/// + [`FlgError::NotThreadContext`] 不在线程上下文内
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::sync::Arc;
///
/// use xwrust::xwos::sync::flg::*;
///
/// pub fn xwrust_example_flg() {
/// }
/// ```
pub fn wait(&self, tg: Trigger, act: Action,
origin: &mut Bmp<N>, msk: &Bmp<N>) -> FlgError {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_wait(self.flg.get() as _, tg as XwSq, act as XwSq,
origin.bmp.get() as _, msk.bmp.get() as _);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
FlgError::Ok(rc)
} else if -EINTR == rc {
FlgError::Interrupt(rc)
} else if -ENOTTHDCTX == rc {
FlgError::NotThreadContext(rc)
} else {
FlgError::Unknown(rc)
}
} else {
FlgError::NotInit(rc)
}
}
}
/// 限时等待事件
///
/// + 当没有检测到事件时，线程会阻塞等待，等待时会指定一个唤醒时间点 `to` 。
/// + 当检测到事件时，线程被唤醒，然后返回 [`FlgError::Ok`] 。
/// + 当线程阻塞等待被中断时，返回 [`FlgError::Interrupt`] 。
/// + 当到达指定的唤醒时间点时，线程被唤醒，并返回 [`FlgError::Timedout`] 。
///
/// # 事件的触发条件
///
/// 事件的触发条件可通过参数 `tg` 设置。事件的触发条件分为两类。
///
/// ## 电平触发
///
/// **电平触发** 源于数字电路，是一种类比概念，是指事件位图的特定状态（ **1** 或 **0** ）所产生的触发事件，包括：
///
/// + [`Trigger::SetAll`] 所有事件位被置 **1** 触发
/// + [`Trigger::SetAny`] 任意事件位被置 **1** 触发
/// + [`Trigger::ClearAll`] 所有事件位被清 **0** 触发
/// + [`Trigger::ClearAny`] 任意事件位被清 **0** 触发
///
/// **电平触发** 时，若参数 `action` 取值 [`Action::Consumption`] ，表示线程在读取事件位图后，会 **清除** 事件位图。
/// **电平触发** 时，参数 `origin` 用于返回事件发生时的位图状态。
///
/// ## 边沿触发
///
/// **边沿触发** 源于数字电路，是一种类比概念，是指事件状态发生改变（ **1** 变 **0** 或 **0** 变 **1** ）时产生的唤醒信号，包括：
///
/// + [`Trigger::SetAll`] 所有事件位发生翻转触发
/// + [`Trigger::SetAny`] 任意事件位发生翻转触发
///
/// **边沿触发** 时，参数 `action` 没有作用，取值 [`Action::None`] 即可。
/// **边沿触发** 时，必须要有一个初始状态，就像数字电路一样：
///
/// + 当位的初始值为 **0** (低电平)，然后跳变到 **1** (高电平)的瞬间被称为上升沿。此时触发的事件被称为上升沿触发。
/// + 当位的初始值为 **1** (高电平)，然后跳变到 **0** (低电平)的瞬间被称为下降沿。此时触发的事件被称为下降沿触发。
///
/// 初始值就由参数 `origin` 指明，触发后，事件位发生跳变，跳变后的结果还是由参数 `origin` 返回。
///
/// # 参数说明
///
/// + tg: 事件触发条件
/// + act: 事件触发后的动作
/// + origin: 事件位图
/// + **电平触发** 时，参数 `origin` 用于返回事件发生时的位图状态。
/// + 初始值就由参数 `origin` 指明，触发后，事件位发生跳变，跳变后的结果还是由参数 `origin` 返回。
/// + msk: 事件的位图掩码
/// + to: 期望唤醒的时间点
///
/// # 上下文
///
/// + 线程
///
/// # 错误码
///
/// + [`FlgError::Ok`] 没有错误
/// + [`FlgError::NotInit`] 事件标志没有初始化
/// + [`FlgError::Interrupt`] 等待被中断
/// + [`FlgError::Timedout`] 等待超时
/// + [`FlgError::NotThreadContext`] 不在线程上下文内
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::sync::Arc;
///
/// use xwrust::xwos::sync::flg::*;
///
/// pub fn xwrust_example_flg() {
/// }
/// ```
pub fn wait_to(&self, tg: Trigger, act: Action,
origin: &mut Bmp<N>, msk: &Bmp<N>, to: XwTm) -> FlgError {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_wait_to(self.flg.get() as _, tg as XwSq, act as XwSq,
origin.bmp.get() as _, msk.bmp.get() as _, to);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
FlgError::Ok(rc)
} else if -EINTR == rc {
FlgError::Interrupt(rc)
} else if -ETIMEDOUT == rc {
FlgError::Timedout(rc)
} else if -ENOTTHDCTX == rc {
FlgError::NotThreadContext(rc)
} else {
FlgError::Unknown(rc)
}
} else {
FlgError::NotInit(rc)
}
}
}
/// 检查事件
///
/// + 当检测到事件时，立即返回 [`FlgError::Ok`] 。
/// + 当没有检测到事件时，立即返回 [`FlgError::NoEvent`] 。
///
/// # 事件的触发条件
///
/// 事件的触发条件可通过参数 `tg` 设置。事件的触发条件分为两类。
///
/// ## 电平触发
///
/// **电平触发** 源于数字电路，是一种类比概念，是指事件位图的特定状态（ **1** 或 **0** ）所产生的触发事件，包括：
///
/// + [`Trigger::SetAll`] 所有事件位被置 **1** 触发
/// + [`Trigger::SetAny`] 任意事件位被置 **1** 触发
/// + [`Trigger::ClearAll`] 所有事件位被清 **0** 触发
/// + [`Trigger::ClearAny`] 任意事件位被清 **0** 触发
///
/// **电平触发** 时，若参数 `action` 取值 [`Action::Consumption`] ，表示线程在读取事件位图后，会 **清除** 事件位图。
/// **电平触发** 时，参数 `origin` 用于返回事件发生时的位图状态。
///
/// ## 边沿触发
///
/// **边沿触发** 源于数字电路，是一种类比概念，是指事件状态发生改变（ **1** 变 **0** 或 **0** 变 **1** ）时产生的唤醒信号，包括：
///
/// + [`Trigger::SetAll`] 所有事件位发生翻转触发
/// + [`Trigger::SetAny`] 任意事件位发生翻转触发
///
/// **边沿触发** 时，参数 `action` 没有作用，取值 [`Action::None`] 即可。
/// **边沿触发** 时，必须要有一个初始状态，就像数字电路一样：
///
/// + 当位的初始值为 **0** (低电平)，然后跳变到 **1** (高电平)的瞬间被称为上升沿。此时触发的事件被称为上升沿触发。
/// + 当位的初始值为 **1** (高电平)，然后跳变到 **0** (低电平)的瞬间被称为下降沿。此时触发的事件被称为下降沿触发。
///
/// 初始值就由参数 `origin` 指明，触发后，事件位发生跳变，跳变后的结果还是由参数 `origin` 返回。
///
/// # 参数说明
///
/// + tg: 事件触发条件
/// + act: 事件触发后的动作
/// + origin: 事件位图
/// + **电平触发** 时，参数 `origin` 用于返回事件发生时的位图状态。
/// + 初始值就由参数 `origin` 指明，触发后，事件位发生跳变，跳变后的结果还是由参数 `origin` 返回。
/// + msk: 事件的位图掩码
///
/// # 上下文
///
/// + 任意
///
/// # 错误码
///
/// + [`FlgError::Ok`] 没有错误
/// + [`FlgError::NotInit`] 事件标志没有初始化
/// + [`FlgError::NoEvent`] 没有检测到事件
///
/// # 示例
///
/// ```rust
/// extern crate alloc;
/// use alloc::sync::Arc;
///
/// use xwrust::xwos::sync::flg::*;
///
/// pub fn xwrust_example_flg() {
/// }
/// ```
pub fn trywait(&self, tg: Trigger, act: Action,
origin: &mut Bmp<N>, msk: &Bmp<N>) -> FlgError {
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_trywait(self.flg.get() as _, tg as XwSq, act as XwSq,
origin.bmp.get() as _, msk.bmp.get() as _);
xwrustffi_flg_put(self.flg.get() as _);
if XWOK == rc {
FlgError::Ok(rc)
} else if -ENODATA == rc {
FlgError::NoEvent(rc)
} else {
FlgError::Unknown(rc)
}
} else {
FlgError::NotInit(rc)
}
}
}
/// 绑定事件标志对象到信号选择器
///
/// + 事件标志绑定到信号选择器上时，采用 **非独占** 的方式进行绑定。
/// + 绑定成功，通过 [`Ok()`] 返回 [`FlgSel<'a, N, M>`] 。
/// + 如果位置已被其他 **同步对象** 以 **独占** 的方式占领，通过 [`Err()`] 返回 [`FlgError::SelPosBusy`] 。
/// + 当指定的位置超出范围（例如 [`Sel<M>`] 只有8个位置，用户偏偏要绑定到位置9 ），通过 [`Err()`] 返回 [`FlgError::OutOfSelPos`] 。
/// + 重复绑定，通过 [`Err()`] 返回 [`FlgError::AlreadyBound`] 。
///
/// [`FlgSel<'a, N, M>`] 中包含事件标志的绑定信息。 [`FlgSel<'a, N, M>`] 与 [`Flg<N>`] 与 [`Sel<M>`] 具有相同的生命周期约束 `'a` 。
/// [`FlgSel::selected()`] 可用来判断事件标志是否被选择。当 [`FlgSel<'a, N, M>`] [`drop()`] 时，会自动解绑。
///
/// # 参数说明
///
/// + sel: 信号选择器的引用
/// + pos: 位置
///
/// # 上下文
///
/// + 任意
///
/// # 错误码
///
/// + [`FlgError::OutOfSelPos`] 信号选择器的位置超出范围
/// + [`FlgError::AlreadyBound`] 事件标志已经绑定
/// + [`FlgError::SelPosBusy`] 信号选择器的位置被占用
///
/// # 示例
///
/// ```rust
/// pub fn xwrust_example_sel() {
/// // ...省略...
/// let flg0 = Arc::new(Flg::new());
/// flg0.init();
/// let flg0sel = match flg0.bind(&sel, 0) {
/// Ok(s) => { // 绑定成功，`s` 为 `FlgSel`
/// s
/// },
/// Err(e) => { // 绑定失败，`e` 为 `SelError`
/// return;
/// }
/// };
/// // ...省略...
/// }
/// ```
///
/// [`FlgSel<'a, N, M>`]: FlgSel
/// [`Ok()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Ok>
/// [`Err()`]: <https://doc.rust-lang.org/core/result/enum.Result.html#variant.Err>
/// [`Sel<M>`]: super::sel::Sel
/// [`drop()`]: https://doc.rust-lang.org/std/mem/fn.drop.html
pub fn bind<'a, const M: XwSz>(&'a self, sel: &'a Sel<M>, pos: XwSq) ->
Result<FlgSel<'a, N, M>, FlgError>
where
[XwBmp; (M + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{
unsafe {
let mut rc = xwrustffi_flg_acquire(self.flg.get() as _, *self.tik.get());
if rc == 0 {
rc = xwrustffi_flg_bind(self.flg.get() as _, sel.sel.get() as _, pos);
if XWOK == rc {
Ok(FlgSel {
flg: self,
sel: sel,
pos: pos,
})
} else if -ECHRNG == rc {
Err(FlgError::OutOfSelPos(rc))
} else if -EALREADY == rc {
Err(FlgError::AlreadyBound(rc))
} else if -EBUSY == rc {
Err(FlgError::SelPosBusy(rc))
} else {
Err(FlgError::Unknown(rc))
}
} else {
Err(FlgError::NotInit(rc))
}
}
}
}
/// 事件标志的选择子
///
/// `FlgSel<'a, N, M>` 与 [`Flg<N>`] 与 [`Sel<M>`] 具有相同的生命周期约束 `'a` 。因为 `FlgSel<'a, N, M>` 中包含了 [`Flg<N>`] 与 [`Sel<M>`] 的引用。
///
/// `FlgSel<'a, N, M>` 中包含了绑定的位置信息，事件标志采用 **非独占** 的方式进行绑定。
///
/// [`FlgSel::selected()`] 可用来判断事件标志是否被选择。
///
/// 当 `FlgSel<'a, N, M>` 被 [`drop()`] 时，会自动将 [`Flg<N>`] 从 [`Sel<M>`] 解绑。
///
/// [`Sel<M>`]: super::sel::Sel
/// [`drop()`]: https://doc.rust-lang.org/std/mem/fn.drop.html
pub struct FlgSel<'a, const N: XwSz, const M: XwSz>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized,
[XwBmp; (M + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{
/// 事件标志
pub flg: &'a Flg<N>,
/// 信号选择器
pub sel: &'a Sel<M>,
/// 位置
pub pos: XwSq,
}
unsafe impl<'a, const N: XwSz, const M: XwSz> Send for FlgSel<'a, N, M>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized,
[XwBmp; (M + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{}
unsafe impl<'a, const N: XwSz, const M: XwSz> Sync for FlgSel<'a, N, M>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized,
[XwBmp; (M + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{}
impl<'a, const N: XwSz, const M: XwSz> Drop for FlgSel<'a, N, M>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized,
[XwBmp; (M + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{
fn drop(&mut self) {
unsafe {
xwrustffi_flg_unbind(self.flg.flg.get() as _, self.flg.flg.get() as _);
xwrustffi_flg_put(self.flg.flg.get() as _);
}
}
}
impl<'a, const N: XwSz, const M: XwSz> FlgSel<'a, N, M>
where
[XwBmp; (N + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized,
[XwBmp; (M + XwBmp::BITS as usize - 1) / XwBmp::BITS as usize]: Sized
{
/// 判断触发的 **选择信号** 是否包括此事件标志
///
/// # 示例
///
/// ```rust
/// let msk = Bmp::<8>::new(); // 8位位图
/// msk.s1all(); // 掩码为0xFF
/// loop {
/// let res = sel.select(&msk);
/// match res {
/// Ok(t) => { // 信号选择器上有 **选择信号** ， `t` 为 **选择信号** 的位图。
/// if flg0sel.selected(&t) { // 事件标志被选择到
/// }
/// },
/// Err(e) => { // 等待信号选择器失败，`e` 为 `SelError`
/// flgeak;
/// },
/// }
/// }
/// ```
pub fn selected(&self, trg: &Bmp<M>) -> bool {
trg.t1i(self.pos)
}
}