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
//! Syscall Wrappers use core::slice; use crate::types::*; pub use sunrise_libkern::nr; pub use sunrise_libkern::{MemoryInfo, MemoryPermissions}; pub use sunrise_libkern::process::*; use crate::error::KernelError; // Assembly blob can't get documented, but clippy requires it. #[allow(clippy::missing_docs_in_private_items)] mod syscall_inner { #[cfg(all(target_arch = "x86", target_os = "sunrise", not(test), not(feature = "build-for-std-app")))] global_asm!(" .intel_syntax noprefix .global syscall_inner // Call the syscall using arch-specific syscall ABI. syscall_inner: push ebp mov ebp, esp push ebx push esi push edi // Eax contains Register struct mov eax, [esp + 0x14] mov ebx, [eax + 0x04] mov ecx, [eax + 0x08] mov edx, [eax + 0x0C] mov esi, [eax + 0x10] mov edi, [eax + 0x14] mov ebp, [eax + 0x18] mov eax, [eax + 0x00] int 0x80 push eax mov eax, [esp + 0x18] mov [eax + 0x04], ebx mov [eax + 0x08], ecx mov [eax + 0x0C], edx mov [eax + 0x10], esi mov [eax + 0x14], edi mov [eax + 0x18], ebp pop ebx mov [eax + 0x00], ebx pop edi pop esi pop ebx pop ebp ret "); // Should only be used for rustdocs!!! #[cfg(not(target_os = "sunrise"))] #[no_mangle] extern fn syscall_inner(regs: &mut super::Registers) { regs.eax = crate::error::KernelError::NotImplemented.make_ret() as usize; } } /// Register backup structure. The syscall_inner will pop the registers from this /// structure before jumping into the kernel, and then update the structure with /// the registers set by the syscall. #[repr(C)] #[allow(clippy::missing_docs_in_private_items)] struct Registers { eax: usize, ebx: usize, ecx: usize, edx: usize, esi: usize, edi: usize, ebp: usize, } extern { fn syscall_inner(registers: &mut Registers); } /// Generic syscall function. unsafe fn syscall(nr: usize, arg1: usize, arg2: usize, arg3: usize, arg4: usize, arg5: usize, arg6: usize) -> Result<(usize, usize, usize, usize), KernelError> { let mut registers = Registers { eax: nr, ebx: arg1, ecx: arg2, edx: arg3, esi: arg4, edi: arg5, ebp: arg6 }; syscall_inner(&mut registers); if registers.eax == 0 { Ok((registers.ebx, registers.ecx, registers.edx, registers.esi)) } else { Err(KernelError::from_syscall_ret(registers.eax as u32)) } } /// Resize the heap of a process, just like a brk. /// It can both expand, and shrink the heap. /// /// If `new_size` == 0, the heap space is entirely de-allocated. /// /// # Return /// /// The address of the start of the heap. /// /// # Error /// /// * `new_size` must be PAGE_SIZE aligned. /// /// # Safety /// /// This function can free memory, potentially invalidating references to structs that were in it. pub unsafe fn set_heap_size(new_size: usize) -> Result<usize, KernelError> { let (heap_address_base, ..) = unsafe { syscall(nr::SetHeapSize, new_size, 0, 0, 0, 0, 0)? }; Ok(heap_address_base) } /// Query information about an address. Will fetch the page-aligned mapping `addr` falls in. /// mapping that contains the provided address. /// /// # Return /// /// Information about the mapping the address fell into, and an unknown usize. pub fn query_memory(addr: usize) -> Result<(MemoryInfo, usize), KernelError> { let mut meminfo = MemoryInfo::default(); let (pageinfo, ..) = unsafe { syscall(nr::QueryMemory, &mut meminfo as *mut _ as usize, 0, addr, 0, 0, 0)? }; Ok((meminfo, pageinfo)) } /// Exits the process, killing all threads. pub fn exit_process() -> ! { unsafe { match syscall(nr::ExitProcess, 0, 0, 0, 0, 0, 0) { Ok(_) => (), Err(err) => { let _ = output_debug_string(&format!("Failed to exit: {}", err), 10, "sunrise_libuser::syscalls::exit_process"); }, } #[allow(clippy::empty_loop)] loop {} // unreachable, but we can't panic, as panic! calls exit_process } } /// Creates a thread in the current process. /// /// # Safety /// /// `sp` must a valid pointer to a stack that is uniquely owned, as the thread will write to it. pub unsafe fn create_thread(ip: extern "fastcall" fn(usize) -> !, arg: usize, sp: *const u8, priority: u32, processor_id: u32) -> Result<Thread, KernelError> { unsafe { let (out_handle, ..) = syscall(nr::CreateThread, ip as usize, arg, sp as _, priority as _, processor_id as _, 0)?; Ok(Thread(Handle::new(out_handle as _))) } } /// Starts the thread for the provided handle. pub fn start_thread(thread_handle: &Thread) -> Result<(), KernelError> { unsafe { syscall(nr::StartThread, (thread_handle.0).0.get() as usize, 0, 0, 0, 0, 0)?; Ok(()) } } /// Exits the current thread. #[allow(unused_must_use)] pub fn exit_thread() -> ! { unsafe { syscall(nr::ExitThread, 0, 0, 0, 0, 0, 0); } unreachable!("svcExitThread returned, WTF ???") } /// Sleeps for a specified amount of time, or yield thread. pub fn sleep_thread(nanos: usize) -> Result<(), KernelError> { unsafe { syscall(nr::SleepThread, nanos, 0, 0, 0, 0, 0)?; Ok(()) } } /// Sets the "signaled" state of an event. Calling this on an unsignalled event /// will cause any thread waiting on this event through [wait_synchronization()] /// to wake up. Any future calls to [wait_synchronization()] with this handle /// will immediately return - the user has to clear the "signaled" state through /// [clear_event()]. /// /// Takes either a [ReadableEvent] or a [WritableEvent]. pub fn signal_event(event: &WritableEvent) -> Result<(), KernelError> { unsafe { syscall(nr::SignalEvent, (event.0).0.get() as _, 0, 0, 0, 0, 0)?; Ok(()) } } /// Clear the "signaled" state of an event. After calling this on a signaled /// event, [wait_synchronization()] on this handle will wait until /// [signal_event()] is called once again. /// /// Takes either a [ReadableEvent] or a [WritableEvent]. /// /// # Errors /// /// - `InvalidState` /// - The event wasn't signaled. pub(crate) fn clear_event(event: HandleRef) -> Result<(), KernelError> { unsafe { syscall(nr::ClearEvent, event.inner.get() as _, 0, 0, 0, 0, 0)?; Ok(()) } } /// Creates a shared memory handle. /// /// Allocates the given size bytes of physical memory to back the SharedMemory. /// myperm dictates the memory permissions this handle can be mapped as in the /// current process, while otherperm dictates the permissions for other /// processes. /// /// # Errors /// /// - Errors if size is not page-aligned. pub fn create_shared_memory(size: usize, myperm: MemoryPermissions, otherperm: MemoryPermissions) -> Result<SharedMemory, KernelError> { unsafe { let (out_handle, ..) = syscall(nr::CreateSharedMemory, size, myperm.bits() as _, otherperm.bits() as _, 0, 0, 0)?; Ok(SharedMemory(Handle::new(out_handle as _))) } } /// Maps a shared memory. /// /// Maps a SharedMemory handle at the given address, with the given permission. /// /// # Errors /// /// - addr must be page-aligned. /// - size must be equal to the size of the backing shared memory handle. /// - perm must be allowed. pub fn map_shared_memory(handle: &SharedMemory, addr: usize, size: usize, perm: MemoryPermissions) -> Result<(), KernelError> { unsafe { syscall(nr::MapSharedMemory, (handle.0).0.get() as _, addr, size, perm.bits() as _, 0, 0)?; Ok(()) } } /// Unmaps a shared memory. /// /// Unmaps a shared memory mapping at the given address. /// /// # Safety /// /// This function unmaps the memory, invalidating any pointer to the given /// region. The user must take care that no pointers point to this region before /// calling this function. /// /// # Errors: /// /// - addr must point to a mapping backed by the given handle /// - Size must be equal to the size of the backing shared memory handle. pub unsafe fn unmap_shared_memory(handle: &SharedMemory, addr: usize, size: usize) -> Result<(), KernelError> { syscall(nr::UnmapSharedMemory, (handle.0).0.get() as _, addr, size, 0, 0, 0)?; Ok(()) } // Not totally public because it's not safe to use directly /// Close the given handle. pub(crate) fn close_handle(handle: u32) -> Result<(), KernelError> { unsafe { syscall(nr::CloseHandle, handle as _, 0, 0, 0, 0, 0)?; Ok(()) } } /// Wait for an event on the given handles. /// /// When zero handles are passed, this will wait forever until either timeout or /// cancellation occurs. /// /// If a timeout of 0 is passed, this function is guaranteed not to reschedule. /// /// Does not accept 0xFFFF8001 or 0xFFFF8000 meta-handles. /// /// # Object types /// /// - KDebug: signals when there is a new DebugEvent (retrievable via /// GetDebugEvent). /// - KClientPort: signals when the number of sessions is less than the maximum /// allowed. /// - KProcess: signals when the process undergoes a state change (retrievable /// via #svcGetProcessInfo). /// - KReadableEvent: signals when the event's corresponding KWritableEvent has /// been signaled via svcSignalEvent. /// - KServerPort: signals when there is an incoming connection waiting to be /// accepted. /// - KServerSession: signals when there is an incoming message waiting to be /// received or the pipe is closed. /// - KThread: signals when the thread has exited. /// /// # Result codes /// /// - 0x0000: Success. One of the objects was signaled before the timeout /// expired, or one of the objects is a Session with a closed remote. Handle /// index is updated to indicate which object signaled. /// - 0x7601: Thread termination requested. Handle index is not updated. Cannot /// happen when timeout is 0. /// - 0xe401: Invalid handle. Returned when one of the handles passed is invalid. /// Handle index is not updated. /// - 0xe601: Invalid address. Returned when the handles pointer is not a /// readable address. Handle index is not updated. /// - 0xea01: Timeout. Returned when no objects have been signaled within the /// timeout. Handle index is not updated. /// - 0xec01: Interrupted. Returned when another thread uses /// svcCancelSynchronization to cancel this thread. Handle index is not /// updated. Cannot happen when timeout is 0. /// - 0xee01: Too many handles. Returned when the number of handles passed is /// >0x40. Note: Sunrise kernel currently does not return this error. It is perfectly able /// to wait on more than 0x40 handles. pub fn wait_synchronization(handles: &[HandleRef<'_>], timeout_ns: Option<usize>) -> Result<usize, KernelError> { unsafe { let (handleidx, ..) = syscall(nr::WaitSynchronization, handles.as_ptr() as _, handles.len(), timeout_ns.unwrap_or_else(usize::max_value), 0, 0, 0)?; Ok(handleidx) } } /// Creates a session to the given named port. pub fn connect_to_named_port(s: &str) -> Result<ClientSession, KernelError> { unsafe { let (out_handle, ..) = syscall(nr::ConnectToNamedPort, s.as_ptr() as _, 0, 0, 0, 0, 0)?; Ok(ClientSession(Handle::new(out_handle as _))) } } /// Send an IPC request through the given pipe. /// /// Please see the IPC module for more information on IPC. pub fn send_sync_request_with_user_buffer(buf: &mut [u8], handle: &ClientSession) -> Result<(), KernelError> { unsafe { syscall(nr::SendSyncRequestWithUserBuffer, buf.as_ptr() as _, buf.len(), (handle.0).0.get() as _, 0, 0, 0)?; Ok(()) } } /// Print the given string to the kernel's debug output. /// /// Currently, this prints the string to the serial port. pub fn output_debug_string(s: &str, level: usize, target: &str) -> Result<(), KernelError> { unsafe { syscall(nr::OutputDebugString, s.as_ptr() as _, s.len(), level, target.as_ptr() as _, target.len(), 0)?; Ok(()) } } /// Create an anonymous session. pub fn create_session(is_light: bool, unk: usize) -> Result<(ServerSession, ClientSession), KernelError> { unsafe { let (serverhandle, clienthandle, ..) = syscall(nr::CreateSession, is_light as _, unk, 0, 0, 0, 0)?; Ok((ServerSession(Handle::new(serverhandle as _)), ClientSession(Handle::new(clienthandle as _)))) } } /// Accept a connection on the given port. pub fn accept_session(port: &ServerPort) -> Result<ServerSession, KernelError> { unsafe { let (out_handle, ..) = syscall(nr::AcceptSession, (port.0).0.get() as _, 0, 0, 0, 0, 0)?; Ok(ServerSession(Handle::new(out_handle as _))) } } /// Reply and Receive IPC requests on the given handles. /// /// If ReplyTarget is not None, a reply from the cmdbuf will be sent to that /// session. Then it will wait until either of the passed sessions has an /// incoming message, is closed, a passed port has an incoming connection, or /// the timeout expires. If there is an incoming message, it is copied to the /// cmdbuf. /// /// If ReplyTarget is None, the cmdbuf should contain a blank message. If this /// message has a C descriptor, the buffer it points to will be used as the /// pointer buffer. See [switchbrew's IPC marshalling page]. Note that a pointer /// buffer cannot be specified if ReplyTarget is not zero. /// /// After being validated, passed handles will be enumerated in order; even if a /// session has been closed, if one that appears earlier in the list has an /// incoming message, it will take priority and a result code of 0x0 will be /// returned. /// /// [switchbrew's IPC marshalling page]: https://http://switchbrew.org/index.php?title=IPC_Marshalling pub fn reply_and_receive_with_user_buffer(buf: &mut [u8], handles: &[HandleRef<'_>], replytarget: Option<HandleRef<'_>>, timeout: Option<usize>) -> Result<usize, KernelError> { unsafe { let (idx, ..) = syscall(nr::ReplyAndReceiveWithUserBuffer, buf.as_ptr() as _, buf.len(), handles.as_ptr() as _, handles.len(), match replytarget { Some(s) => s.inner.get() as _, None => 0 }, timeout.unwrap_or_else(usize::max_value))?; Ok(idx) } } /// Create a [ReadableEvent]/[WritableEvent] pair. pub fn create_event() -> Result<(WritableEvent, ReadableEvent), KernelError> { unsafe { let (wevent, revent, ..) = syscall(nr::CreateEvent, 0, 0, 0, 0, 0, 0)?; Ok((WritableEvent(Handle::new(wevent as _)), ReadableEvent(Handle::new(revent as _)))) } } /// Create a waitable object for the given IRQ number. /// /// Note that the process needs to be authorized to listen for the given IRQ. pub fn create_interrupt_event(irqnum: usize, flag: u32) -> Result<ReadableEvent, KernelError> { unsafe { let (out_handle, ..) = syscall(nr::CreateInterruptEvent, irqnum, flag as usize, 0, 0, 0, 0)?; Ok(ReadableEvent(Handle::new(out_handle as _))) } } /// Gets the physical region a given virtual address maps. /// /// This syscall is mostly used for DMAs, where the physical address of a buffer needs to be known /// by userspace. /// /// # Return /// /// 0. The start address of the physical region. /// 1. The start address of the virtual region. /// 2. The length of the region. /// /// # Error /// /// - InvalidAddress: This address does not map physical memory. pub fn query_physical_address(virtual_address: usize) -> Result<(usize, usize, usize), KernelError> { unsafe { let (phys_addr, base_addr, phys_len, ..) = syscall(nr::QueryPhysicalAddress, virtual_address, 0, 0, 0, 0, 0)?; Ok((phys_addr, base_addr, phys_len)) } } /// Creates an anonymous port. pub fn create_port(max_sessions: u32, is_light: bool, name_ptr: &[u8]) -> Result<(ClientPort, ServerPort), KernelError> { unsafe { let (out_client_handle, out_server_handle, ..) = syscall(nr::CreatePort, max_sessions as _, is_light as _, name_ptr.as_ptr() as _, 0, 0, 0)?; Ok((ClientPort(Handle::new(out_client_handle as _)), ServerPort(Handle::new(out_server_handle as _)))) } } /// Creates a named port. pub fn manage_named_port(name: &str, max_handles: u32) -> Result<ServerPort, KernelError> { unsafe { let (out_handle, ..) = syscall(nr::ManageNamedPort, name.as_ptr() as _, max_handles as _, 0, 0, 0, 0)?; Ok(ServerPort(Handle::new(out_handle as _))) } } /// Connects to the given named port. pub fn connect_to_port(port: &ClientPort) -> Result<ClientSession, KernelError> { unsafe { let (out_handle, ..) = syscall(nr::ConnectToPort, (port.0).0.get() as _, 0, 0, 0, 0, 0)?; Ok(ClientSession(Handle::new(out_handle as _))) } } /// Maps the framebuffer to a kernel-chosen address. pub fn map_framebuffer() -> Result<(&'static mut [u8], usize, usize, usize), KernelError> { unsafe { let (addr, width, height, bpp) = syscall(nr::MapFramebuffer, 0, 0, 0, 0, 0, 0)?; let framebuffer_size = bpp * width * height / 8; Ok((slice::from_raw_parts_mut(addr as *mut u8, framebuffer_size), width, height, bpp)) } } /// Maps a physical region in the address space of the process. /// /// # Errors /// /// * InvalidAddress: /// * `virtual_address` is already occupied. /// * `virtual_address` is not PAGE_SIZE aligned. /// * `physical_address` points to a physical region in DRAM (it's not MMIO). /// * InvalidLength: /// * `length` is not PAGE_SIZE aligned. /// * `length` is zero. pub fn map_mmio_region(physical_address: usize, size: usize, virtual_address: usize, writable: bool) -> Result<(), KernelError> { unsafe { syscall(nr::MapMmioRegion, physical_address, size, virtual_address, writable as usize, 0, 0)?; Ok(()) } } /// Set thread local area pointer. /// /// Akin to `set_thread_area` on Linux, this syscall sets the `gs` segment selector's base address /// to the address passed as argument. /// /// The user will likely want to make it point to its elf thread local storage, as `gs:0` is expected /// to contain the thread pointer `tp`. /// /// Unlike linux, you only have **one** user controlled segment, found in `gs`, and you can only set its address. /// /// The limit will always be set to `0xFFFFFFFF`, and adding this offset to a non-zero base address /// means that the resulting address will "wrap around" the address space, and end-up **under** /// the base address. /// You can use this property to implement thread local storage variant II - gnu model, /// as thread local variable are expected to be found "below" `gs:0`, with "negative" offset such as /// `gs:0xFFFFFFFC`. /// /// ## x86_64 /// /// ![same, but different, but still same](https://media.giphy.com/media/C6JQPEUsZUyVq/giphy.gif) /// /// `fs` is used instead of `gs`, because reasons. /// /// # Safety /// /// `address` should point to a valid TLS image, unique to the current thread. /// Setting `gs` to random data, malformed image, or shared image is UB. /// /// # Errors /// /// * The whole initial design of TLS on x86 should be considered an error. /// * No returned error otherwise. pub unsafe fn set_thread_area(address: usize) -> Result<(), KernelError> { unsafe { syscall(nr::SetThreadArea, address, 0, 0, 0, 0, 0)?; Ok(()) } } /// Change permission of a page-aligned memory region. Acceptable permissions /// are ---, r-- and rw-. In other words, it is not allowed to set the /// executable bit, nor is it acceptable to use write-only permissions. /// /// This can only be used on memory regions with the /// [`process_permission_change_allowed`] state. /// /// # Errors /// /// - `InvalidAddress` /// - Supplied address is not page-aligned. /// - `InvalidSize` /// - Supplied size is zero or not page-aligned. /// - `InvalidMemState` /// - Supplied memory range is not contained within the target process /// address space. /// - Supplied memory range does not have the [`process_permission_change_allowed`] /// state. /// /// [`process_permission_change_allowed`]: sunrise_libkern::MemoryState::PROCESS_PERMISSION_CHANGE_ALLOWED pub fn set_process_memory_permission(proc_hnd: &Process, addr: usize, size: usize, perms: MemoryPermissions) -> Result<(), KernelError> { unsafe { syscall(nr::SetProcessMemoryPermission, (proc_hnd.0).0.get() as _, addr, size, perms.bits() as _, 0, 0)?; Ok(()) } } /// Maps the given src memory range from a remote process into the current /// process as RW-. This is used by the Loader to load binaries into the memory /// region allocated by the kernel in [`create_process`](create_process). /// /// The src region should have the MAP_PROCESS state, which is only available on /// CodeStatic/CodeMutable and ModuleCodeStatic/ModuleCodeMutable. /// /// # Errors /// /// - `InvalidAddress` /// - src_addr or dst_addr is not aligned to 0x1000. /// - `InvalidSize` /// - size is 0 /// - size is not aligned to 0x1000. /// - `InvalidMemState` /// - `src_addr + size` overflows /// - `dst_addr + size` overflows /// - The src region is outside of the UserLand address space. /// - The dst region is outside of the UserLand address space, or within the /// heap or map memory region. /// - The src memory pages does not have the MAP_PROCESS state. /// - The dst memory pages is not of the Unmapped type. /// - `InvalidHandle` /// - The handle passed as an argument does not exist or is not a Process /// handle. pub fn map_process_memory(dstaddr: usize, proc_handle: &Process, srcaddr: usize, size: usize) -> Result<(), KernelError> { unsafe { syscall(nr::MapProcessMemory, dstaddr, (proc_handle.0).0.get() as _, srcaddr, size, 0, 0)?; Ok(()) } } /// Unmaps a memory range mapped with [map_process_memory()]. `dst_addr` is an /// address in the current address space, while `src_addr` is the address in the /// remote address space that was previously mapped. /// /// It is possible to partially unmap a ProcessMemory. /// /// # Safety /// /// This function unmaps the memory, invalidating any pointer to the given /// region. The user must take care that no pointers point to this region before /// calling this function. /// /// # Errors /// /// - `InvalidAddress` /// - src_addr or dst_addr is not aligned to 0x1000. /// - `InvalidSize` /// - size is 0 /// - size is not aligned to 0x1000. /// - `InvalidMemState` /// - `src_addr + size` overflows /// - `dst_addr + size` overflows /// - The src region is outside of the UserLand address space. /// - The dst region is outside of the UserLand address space, or within the /// heap or map memory region. /// - The src memory pages does not have the MAP_PROCESS state. /// - The src memory pages is not of the ProcessMemory type. /// - `InvalidMemRange` /// - The given source range does not map the same pages as the given dst /// range. /// - `InvalidHandle` /// - The handle passed as an argument does not exist or is not a Process /// handle. pub unsafe fn unmap_process_memory(dstaddr: usize, proc_handle: &Process, srcaddr: usize, size: usize) -> Result<(), KernelError> { syscall(nr::UnmapProcessMemory, dstaddr, (proc_handle.0).0.get() as _, srcaddr, size, 0, 0)?; Ok(()) } /// Creates a new process with the given parameters. /// /// Note that you probably don't want to use this! Look instead for /// ProcessMana's `LaunchTitle` function. pub fn create_process(procinfo: &ProcInfo, caps: &[u8]) -> Result<Process, KernelError> { unsafe { let (hnd, ..) = syscall(nr::CreateProcess, procinfo as *const _ as usize, caps.as_ptr() as usize, caps.len() / 4, 0, 0, 0)?; Ok(Process(Handle::new(hnd as _))) } } /// Start the given process on the provided CPU with the provided scheduler /// priority. /// /// A stack of the given size will be allocated using the process' memory /// resource limit and memory pool. /// /// The entrypoint is assumed to be the first address of the `code_addr` region /// provided in [create_process()]. It takes two parameters: the first is the /// usermode exception handling context, and should always be NULL. The second /// is a handle to the main thread. /// /// # Errors /// /// - `InvalidProcessorId` /// - Attempted to start the process on a processor that doesn't exist on the /// current machine, or a processor that the process is not allowed to use. /// - `InvalidThreadPriority` /// - Attempted to use a priority above 0x3F, or a priority that the created /// process is not allowed to use. /// - `MemoryFull` /// - Provided stack size is bigger than available vmem space. pub fn start_process(process_handle: &Process, main_thread_prio: u32, default_cpuid: u32, main_thread_stacksz: u32) -> Result<(), KernelError> { unsafe { syscall(nr::StartProcess, (process_handle.0).0.get() as usize, main_thread_prio as _, default_cpuid as _, main_thread_stacksz as _, 0, 0)?; Ok(()) } } /// Extract information from a process. /// /// Info Type | Description /// -----------------|-------------------------- /// ProcessState = 0 | The state the current process is in. Returns an instance /// | of [sunrise_libkern::process::ProcessState]. /// /// # Errors /// /// - `InvalidHandle` /// - The passed handle is invalid or not a process. /// - `InvalidEnum` /// - The passed info_type is unknown. pub fn get_process_info(process_handle: &Process, ty: ProcessInfoType) -> Result<u32, KernelError> { unsafe { let (info, ..) = syscall(nr::GetProcessInfo, (process_handle.0).0.get() as usize, ty.0 as usize, 0, 0, 0, 0)?; Ok(info as _) } } /// Clear the "signaled" state of a readable event or process. After calling /// this on a signaled event, [wait_synchronization()] on this handle will wait /// until the handle is signaled again. /// /// Takes either a [ReadableEvent] or a [Process]. /// /// Note that once a Process enters the Exited state, it is permanently signaled /// and cannot be reset. Calling ResetSignal will return an InvalidState error. /// /// # Errors /// /// - `InvalidState` /// - The event wasn't signaled. /// - The process was in Exited state. pub(crate) fn reset_signal(event: HandleRef) -> Result<(), KernelError> { unsafe { syscall(nr::ResetSignal, event.inner.get() as _, 0, 0, 0, 0, 0)?; Ok(()) } } /// Gets the PID of the given Process handle. Alias handles (0xFFFF8000 and /// 0xFFFF8001) are not allowed here. PIDs are global, unique identifiers for a /// given process. PIDs are never reused, and can be passed over IPC safely (the /// kernel ensures the correct pid is passed when a process does a request), /// making them the best way for sysmodule to identify a calling process. /// /// # Errors /// /// - `InvalidHandle` /// - The given handle is invalid or not a process. pub fn get_process_id(process_handle: &Process) -> Result<u64, KernelError> { unsafe { let (pid, ..) = syscall(nr::GetProcessId, (process_handle.0).0.get() as usize, 0, 0, 0, 0, 0)?; Ok(pid as _) } } /// Kills the given process, terminating the execution of all of its thread and /// putting its state to Exiting/Exited. /// /// Returns an error if used on a process that wasn't started. /// /// # Errors /// /// - `InvalidState` /// - The process wasn't started (it is in Created or CreatedAttached state). pub fn terminate_process(process_handle: &Process) -> Result<(), KernelError> { unsafe { syscall(nr::TerminateProcess, (process_handle.0).0.get() as usize, 0, 0, 0, 0, 0)?; Ok(()) } } /// Fills the provided array with the pids of currently living processes. A /// process "lives" so long as it is currently running or a handle to it still /// exists. /// /// It returns the total number of processes currently alive. If this number is /// bigger than the size of PidBuffer, the user won't have all the pids. pub fn get_process_list(list: &mut [u64]) -> Result<usize, KernelError> { unsafe { let (read, ..) = syscall(nr::GetProcessList, list.as_ptr() as usize, list.len(), 0, 0, 0, 0)?; Ok(read) } }