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
|
/* $Id: DBGCIoProvInternal.h $ */
/** @file
* DBGC - Debugger Console, Internal I/O provider header file.
*/
/*
* Copyright (C) 2020-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef DEBUGGER_INCLUDED_SRC_DBGCIoProvInternal_h
#define DEBUGGER_INCLUDED_SRC_DBGCIoProvInternal_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include <VBox/dbg.h>
#include <VBox/err.h>
#include <VBox/vmm/cfgm.h>
/*******************************************************************************
* Structures and Typedefs *
*******************************************************************************/
/** An Opaque I/O provider handle. */
typedef struct DBGCIOPROVINT *DBGCIOPROV;
/** Pointer to an opaque I/O provider handle. */
typedef DBGCIOPROV *PDBGCIOPROV;
/**
* I/O provider registration record.
*/
typedef struct DBGCIOPROVREG
{
/** Unique name for the I/O provider. */
const char *pszName;
/** I/O provider description. */
const char *pszDesc;
/**
* Creates an I/O provider instance from the given config.
*
* @returns VBox status code.
* @param phDbgcIoProv Where to store the handle to the I/O provider instance on success.
* @param pCfg The config to use.
*/
DECLCALLBACKMEMBER(int, pfnCreate, (PDBGCIOPROV phDbgcIoProv, PCFGMNODE pCfg));
/**
* Destroys the given I/O provider instance.
*
* @param hDbgcIoProv The I/O provider instance handle to destroy.
*/
DECLCALLBACKMEMBER(void, pfnDestroy, (DBGCIOPROV hDbgcIoProv));
/**
* Waits for someone to connect to the provider instance.
*
* @returns VBox status code.
* @retval VERR_TIMEOUT if the waiting time was exceeded without anyone connecting.
* @retval VERR_INTERRUPTED if the waiting was interrupted by DBGCIOPROVREG::pfnWaitInterrupt.
* @param hDbgcIoProv The I/O provider instance handle.
* @param cMsTimeout Number of milliseconds to wait, use RT_INDEFINITE_WAIT to wait indefinitely.
* @param ppDbgcIo Where to return the I/O connection callback table upon a succesful return.
*/
DECLCALLBACKMEMBER(int, pfnWaitForConnect, (DBGCIOPROV hDbgcIoProv, RTMSINTERVAL cMsTimeout, PCDBGCIO *ppDbgcIo));
/**
* Interrupts the thread waiting in DBGCIOPROVREG::pfnWaitForConnect.
*
* @returns VBox status code.
* @param hDbgcIoProv The I/O provider instance handle.
*/
DECLCALLBACKMEMBER(int, pfnWaitInterrupt, (DBGCIOPROV hDbgcIoProv));
} DBGCIOPROVREG;
/** Pointer to an I/O provider registration record. */
typedef DBGCIOPROVREG *PDBGCIOPROVREG;
/** Pointer toa const I/O provider registration record. */
typedef const DBGCIOPROVREG *PCDBGCIOPROVREG;
/*******************************************************************************
* Global Variables *
*******************************************************************************/
extern const DBGCIOPROVREG g_DbgcIoProvTcp;
extern const DBGCIOPROVREG g_DbgcIoProvUdp;
extern const DBGCIOPROVREG g_DbgcIoProvIpc;
#endif /* !DEBUGGER_INCLUDED_SRC_DBGCIoProvInternal_h */
|
