blob: df0bb7cc4410349120c39f2a55601f6ca4fb9c46 [file] [log] [blame]
Andrew Walbranb996b4a2022-04-22 15:15:41 +00001// Copyright 2022, The Android Open Source Project
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//! Rust entry point.
16
Pierre-Clément Tosi8ca7a442023-06-22 13:47:15 +000017use crate::{console, heap, power::shutdown};
Andrew Walbranb996b4a2022-04-22 15:15:41 +000018
19/// This is the entry point to the Rust code, called from the binary entry point in `entry.S`.
20#[no_mangle]
Andrew Walbrane03395a2022-04-29 15:15:49 +000021extern "C" fn rust_entry(x0: u64, x1: u64, x2: u64, x3: u64) -> ! {
Pierre-Clément Tosi8ca7a442023-06-22 13:47:15 +000022 // SAFETY - Only called once, from here, and inaccessible to client code.
23 unsafe { heap::init() };
Andrew Walbranb996b4a2022-04-22 15:15:41 +000024 console::init();
25 unsafe {
Andrew Walbrane03395a2022-04-29 15:15:49 +000026 main(x0, x1, x2, x3);
Andrew Walbranb996b4a2022-04-22 15:15:41 +000027 }
28 shutdown();
29}
30
31extern "Rust" {
32 /// Main function provided by the application using the `main!` macro.
Andrew Walbrane03395a2022-04-29 15:15:49 +000033 fn main(arg0: u64, arg1: u64, arg2: u64, arg3: u64);
Andrew Walbranb996b4a2022-04-22 15:15:41 +000034}
35
36/// Marks the main function of the binary.
37///
38/// Example:
39///
40/// ```rust
Jakob Vukalovicef996292023-04-13 14:28:34 +000041/// use vmbase::{logger, main};
42/// use log::{info, LevelFilter};
Andrew Walbranb996b4a2022-04-22 15:15:41 +000043///
44/// main!(my_main);
45///
46/// fn my_main() {
Jakob Vukalovicef996292023-04-13 14:28:34 +000047/// logger::init(LevelFilter::Info).unwrap();
48/// info!("Hello world");
Andrew Walbranb996b4a2022-04-22 15:15:41 +000049/// }
50/// ```
51#[macro_export]
52macro_rules! main {
53 ($name:path) => {
54 // Export a symbol with a name matching the extern declaration above.
55 #[export_name = "main"]
Andrew Walbrane03395a2022-04-29 15:15:49 +000056 fn __main(arg0: u64, arg1: u64, arg2: u64, arg3: u64) {
Andrew Walbranb996b4a2022-04-22 15:15:41 +000057 // Ensure that the main function provided by the application has the correct type.
Andrew Walbrane03395a2022-04-29 15:15:49 +000058 $name(arg0, arg1, arg2, arg3)
Andrew Walbranb996b4a2022-04-22 15:15:41 +000059 }
60 };
61}