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
|
/* $Id: VUSBSnifferVmx.cpp $ */
/** @file
* Virtual USB Sniffer facility - VMX USBIO format.
*/
/*
* Copyright (C) 2016-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
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#define LOG_GROUP LOG_GROUP_DRV_VUSB
#include <VBox/log.h>
#include <iprt/mem.h>
#include <iprt/buildconfig.h>
#include <iprt/string.h>
#include <iprt/system.h>
#include <iprt/time.h>
#include "VUSBSnifferInternal.h"
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
/**
* The internal VUSB sniffer state.
*/
typedef struct VUSBSNIFFERFMTINT
{
/** Stream handle. */
PVUSBSNIFFERSTRM pStrm;
} VUSBSNIFFERFMTINT;
/*********************************************************************************************************************************
* Static Variables *
*********************************************************************************************************************************/
/**
* Supported file extensions.
*/
static const char *s_apszFileExts[] =
{
"vmx",
"vmware",
"usbio",
NULL
};
/**
* Month strings.
*/
static const char *s_apszMonths[] =
{
"Jan",
"Feb",
"Mar",
"Apr",
"May",
"Jun",
"Jul",
"Aug",
"Sep",
"Oct",
"Nov",
"Dec"
};
/*********************************************************************************************************************************
* Internal Functions *
*********************************************************************************************************************************/
static int vusbSnifferFmtVmxLogData(PVUSBSNIFFERFMTINT pThis, PRTTIME pTime, uint8_t *pbBuf, size_t cbBuf)
{
int rc;
char szLineBuf[256];
size_t off = 0;
do
{
size_t cch = RTStrPrintf(&szLineBuf[0], sizeof(szLineBuf),
"%s %02u %02u:%02u:%02u.%3.*u: vmx| USBIO: %03zx: %16.*Rhxs\n",
s_apszMonths[pTime->u8Month - 1], pTime->u8MonthDay,
pTime->u8Hour, pTime->u8Minute, pTime->u8Second, 3, pTime->u32Nanosecond,
off, RT_MIN(cbBuf - off, 16), pbBuf);
rc = pThis->pStrm->pfnWrite(pThis->pStrm, &szLineBuf[0], cch);
off += RT_MIN(cbBuf, 16);
pbBuf += RT_MIN(cbBuf, 16);
} while (RT_SUCCESS(rc) && off < cbBuf);
return rc;
}
/** @interface_method_impl{VUSBSNIFFERFMT,pfnInit} */
static DECLCALLBACK(int) vusbSnifferFmtVmxInit(PVUSBSNIFFERFMTINT pThis, PVUSBSNIFFERSTRM pStrm)
{
pThis->pStrm = pStrm;
return VINF_SUCCESS;
}
/** @interface_method_impl{VUSBSNIFFERFMT,pfnDestroy} */
static DECLCALLBACK(void) vusbSnifferFmtVmxDestroy(PVUSBSNIFFERFMTINT pThis)
{
NOREF(pThis);
}
/** @interface_method_impl{VUSBSNIFFERFMT,pfnRecordEvent} */
static DECLCALLBACK(int) vusbSnifferFmtVmxRecordEvent(PVUSBSNIFFERFMTINT pThis, PVUSBURB pUrb, VUSBSNIFFEREVENT enmEvent)
{
RTTIMESPEC TimeNow;
RTTIME Time;
char szLineBuf[256];
const char *pszEvt = enmEvent == VUSBSNIFFEREVENT_SUBMIT ? "Down" : "Up";
uint8_t cIsocPkts = pUrb->enmType == VUSBXFERTYPE_ISOC ? pUrb->cIsocPkts : 0;
if (pUrb->enmType == VUSBXFERTYPE_MSG)
return VINF_SUCCESS;
RT_ZERO(szLineBuf);
RTTimeNow(&TimeNow);
RTTimeExplode(&Time, &TimeNow);
size_t cch = RTStrPrintf(&szLineBuf[0], sizeof(szLineBuf),
"%s %02u %02u:%02u:%02u.%3.*u: vmx| USBIO: %s dev=%u endpt=%x datalen=%u numPackets=%u status=%u 0\n",
s_apszMonths[Time.u8Month - 1], Time.u8MonthDay, Time.u8Hour, Time.u8Minute, Time.u8Second, 3, Time.u32Nanosecond,
pszEvt, pUrb->DstAddress, pUrb->EndPt | (pUrb->enmDir == VUSBDIRECTION_IN ? 0x80 : 0x00),
pUrb->cbData, cIsocPkts, pUrb->enmStatus);
int rc = pThis->pStrm->pfnWrite(pThis->pStrm, &szLineBuf[0], cch);
if (RT_SUCCESS(rc))
{
/* Log the data in the appropriate stage. */
if ( pUrb->enmType == VUSBXFERTYPE_CTRL
|| pUrb->enmType == VUSBXFERTYPE_MSG)
{
if (enmEvent == VUSBSNIFFEREVENT_SUBMIT)
rc = vusbSnifferFmtVmxLogData(pThis, &Time, &pUrb->abData[0], sizeof(VUSBSETUP));
else if (enmEvent == VUSBSNIFFEREVENT_COMPLETE)
{
rc = vusbSnifferFmtVmxLogData(pThis, &Time, &pUrb->abData[0], sizeof(VUSBSETUP));
if ( RT_SUCCESS(rc)
&& pUrb->cbData > sizeof(VUSBSETUP))
rc = vusbSnifferFmtVmxLogData(pThis, &Time, &pUrb->abData[sizeof(VUSBSETUP)], pUrb->cbData - sizeof(VUSBSETUP));
}
}
else
{
if ( enmEvent == VUSBSNIFFEREVENT_SUBMIT
&& pUrb->enmDir == VUSBDIRECTION_OUT)
rc = vusbSnifferFmtVmxLogData(pThis, &Time, &pUrb->abData[0], pUrb->cbData);
else if ( enmEvent == VUSBSNIFFEREVENT_COMPLETE
&& pUrb->enmDir == VUSBDIRECTION_IN)
rc = vusbSnifferFmtVmxLogData(pThis, &Time, &pUrb->abData[0], pUrb->cbData);
}
}
return rc;
}
/**
* VUSB sniffer format writer.
*/
const VUSBSNIFFERFMT g_VUsbSnifferFmtVmx =
{
/** szName */
"VMX",
/** pszDesc */
"VMX log format writer supported by vusb-analyzer: http://vusb-analyzer.sourceforge.net",
/** papszFileExts */
&s_apszFileExts[0],
/** cbFmt */
sizeof(VUSBSNIFFERFMTINT),
/** pfnInit */
vusbSnifferFmtVmxInit,
/** pfnDestroy */
vusbSnifferFmtVmxDestroy,
/** pfnRecordEvent */
vusbSnifferFmtVmxRecordEvent
};
|
