| 1 | /* $Id: SUPSvcInternal.h 106061 2024-09-16 14:03:52Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * VirtualBox Support Service - Internal header.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2008-2024 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.virtualbox.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * The contents of this file may alternatively be used under the terms
|
|---|
| 26 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 27 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 28 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 29 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 30 | *
|
|---|
| 31 | * You may elect to license modified versions of this file under the
|
|---|
| 32 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 33 | *
|
|---|
| 34 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 | #ifndef VBOX_INCLUDED_SRC_Support_SUPSvcInternal_h
|
|---|
| 38 | #define VBOX_INCLUDED_SRC_Support_SUPSvcInternal_h
|
|---|
| 39 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 40 | # pragma once
|
|---|
| 41 | #endif
|
|---|
| 42 |
|
|---|
| 43 | #include <VBox/cdefs.h>
|
|---|
| 44 | #include <VBox/types.h>
|
|---|
| 45 | #include <iprt/stdarg.h>
|
|---|
| 46 | #include <iprt/getopt.h>
|
|---|
| 47 |
|
|---|
| 48 | RT_C_DECLS_BEGIN
|
|---|
| 49 |
|
|---|
| 50 | /** @name Common Helpers
|
|---|
| 51 | * @{ */
|
|---|
| 52 | void supSvcLogErrorStr(const char *pszMsg);
|
|---|
| 53 | void supSvcLogErrorV(const char *pszFormat, va_list va);
|
|---|
| 54 | void supSvcLogError(const char *pszFormat, ...);
|
|---|
| 55 | int supSvcLogGetOptError(const char *pszAction, int rc, int argc, char **argv, int iArg, PCRTOPTIONUNION pValue);
|
|---|
| 56 | int supSvcLogTooManyArgsError(const char *pszAction, int argc, char **argv, int iArg);
|
|---|
| 57 | void supSvcDisplayErrorV(const char *pszFormat, va_list va);
|
|---|
| 58 | void supSvcDisplayError(const char *pszFormat, ...);
|
|---|
| 59 | int supSvcDisplayGetOptError(const char *pszAction, int rc, int argc, char **argv, int iArg, PCRTOPTIONUNION pValue);
|
|---|
| 60 | int supSvcDisplayTooManyArgsError(const char *pszAction, int argc, char **argv, int iArg);
|
|---|
| 61 | /** @} */
|
|---|
| 62 |
|
|---|
| 63 |
|
|---|
| 64 | /** @name OS Backend
|
|---|
| 65 | * @{ */
|
|---|
| 66 | /**
|
|---|
| 67 | * Logs the message to the appropriate system log.
|
|---|
| 68 | *
|
|---|
| 69 | * @param pszMsg The log string.
|
|---|
| 70 | */
|
|---|
| 71 | void supSvcOsLogErrorStr(const char *pszMsg);
|
|---|
| 72 | /** @} */
|
|---|
| 73 |
|
|---|
| 74 |
|
|---|
| 75 | /** @name The Service Manager
|
|---|
| 76 | * @{ */
|
|---|
| 77 | void supSvcStopAndDestroyServices(void);
|
|---|
| 78 | int supSvcTryStopServices(void);
|
|---|
| 79 | int supSvcCreateAndStartServices(void);
|
|---|
| 80 | /** @} */
|
|---|
| 81 |
|
|---|
| 82 |
|
|---|
| 83 | /** @name The Grant Service
|
|---|
| 84 | * @{ */
|
|---|
| 85 | #define SUPSVC_GRANT_SERVICE_NAME "VirtualBoxGrantSvc"
|
|---|
| 86 | DECLCALLBACK(int) supSvcGrantCreate(void **ppvInstance);
|
|---|
| 87 | DECLCALLBACK(void) supSvcGrantStart(void *pvInstance);
|
|---|
| 88 | DECLCALLBACK(int) supSvcGrantTryStop(void *pvInstance);
|
|---|
| 89 | DECLCALLBACK(void) supSvcGrantStopAndDestroy(void *pvInstance, bool fRunning);
|
|---|
| 90 | /** @} */
|
|---|
| 91 |
|
|---|
| 92 |
|
|---|
| 93 | /** @name The Global Service
|
|---|
| 94 | * @{ */
|
|---|
| 95 | DECLCALLBACK(int) supSvcGlobalCreate(void **ppvInstance);
|
|---|
| 96 | DECLCALLBACK(void) supSvcGlobalStart(void *pvInstance);
|
|---|
| 97 | DECLCALLBACK(int) supSvcGlobalTryStop(void *pvInstance);
|
|---|
| 98 | DECLCALLBACK(void) supSvcGlobalStopAndDestroy(void *pvInstance, bool fRunning);
|
|---|
| 99 | /** @} */
|
|---|
| 100 |
|
|---|
| 101 | RT_C_DECLS_END
|
|---|
| 102 |
|
|---|
| 103 | #endif /* !VBOX_INCLUDED_SRC_Support_SUPSvcInternal_h */
|
|---|
| 104 |
|
|---|
