blob: 5158b4319f353ac9d2c32dc5620b93ae11d4f21d [file] [log] [blame]
Alan Stokes52d3c722022-10-04 17:27:13 +01001/*
2 * Copyright 2022 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#pragma once
18
19#ifdef __cplusplus
20extern "C" {
21typedef int AVmPayload_main_t();
22AVmPayload_main_t AVmPayload_main;
23}
24#else
25typedef int AVmPayload_main_t(void);
Alan Stokes4273fe52022-12-06 17:04:05 +000026
27/**
28 * Entry point for the VM payload. This function must be implemented by the
29 * payload binary, and is called by Microdroid to start the payload inside the
30 * VM.
31 *
32 * When the function returns the VM will be shut down. If the host app has set
33 * a `VirtualMachineCallback` for the VM, its `onPayloadFinished` method will be
34 * called with the VM's exit code.
35 *
36 * \return the exit code of the VM.
37 */
Alan Stokes52d3c722022-10-04 17:27:13 +010038extern int AVmPayload_main(void);
39#endif