Skip to content
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update clog sidecar and update documentation about this.
  • Loading branch information
sm-msft committed May 28, 2025
commit 4b7d523c9cb2eba5564d16608fbfb86097269b8c
7 changes: 7 additions & 0 deletions docs/BUILD.md
Original file line number Diff line number Diff line change
@@ -155,6 +155,13 @@ For more info, take a look at the [build.ps1](../scripts/build.ps1) script.

By default the build output will go in the `build` folder and the final build binaries in the `artifacts` folder. Under that it will create per-platform folders with subfolders for architecture/tls combinations. This allows for building different platforms and configurations at the same time.

## Updating Clog Sidecar
Some code changes such as adding/updating new Quic traces require updating the Clog sidecar for successful Linux builds. This is done by running the following command:
```PowerShell
./scripts/update-sidecar.ps1
```
This makes any necessary updates to the clog sidecar manifest and the generated files under `src/generated/` folder. The modified files must be committed along with the rest of the code changes for addressing the Linux build failures.

# Building with CMake

The following section details how to build MsQuic purely with CMake commands.
60 changes: 60 additions & 0 deletions src/generated/linux/settings.c.clog.h
Original file line number Diff line number Diff line change
@@ -842,6 +842,36 @@ tracepoint(CLOG_SETTINGS_C, SettingsStreamMultiReceiveEnabled , arg2);\



/*----------------------------------------------------------
// Decoder Ring for SettingsDumpResumptionTicketMinVersion
// [sett] ResumptionTicketMinVersion= %hhu
// QuicTraceLogVerbose(SettingsDumpResumptionTicketMinVersion, "[sett] ResumptionTicketMinVersion= %hhu", Settings->ResumptionTicketMinVersion);
// arg2 = arg2 = Settings->ResumptionTicketMinVersion = arg2
----------------------------------------------------------*/
#ifndef _clog_3_ARGS_TRACE_SettingsDumpResumptionTicketMinVersion
#define _clog_3_ARGS_TRACE_SettingsDumpResumptionTicketMinVersion(uniqueId, encoded_arg_string, arg2)\
tracepoint(CLOG_SETTINGS_C, SettingsDumpResumptionTicketMinVersion , arg2);\

#endif




/*----------------------------------------------------------
// Decoder Ring for SettingsDumpResumptionTicketMaxVersion
// [sett] ResumptionTicketMaxVersion= %hhu
// QuicTraceLogVerbose(SettingsDumpResumptionTicketMaxVersion, "[sett] ResumptionTicketMaxVersion= %hhu", Settings->ResumptionTicketMaxVersion);
// arg2 = arg2 = Settings->ResumptionTicketMaxVersion = arg2
----------------------------------------------------------*/
#ifndef _clog_3_ARGS_TRACE_SettingsDumpResumptionTicketMaxVersion
#define _clog_3_ARGS_TRACE_SettingsDumpResumptionTicketMaxVersion(uniqueId, encoded_arg_string, arg2)\
tracepoint(CLOG_SETTINGS_C, SettingsDumpResumptionTicketMaxVersion , arg2);\

#endif




/*----------------------------------------------------------
// Decoder Ring for SettingDumpLFixedServerID
// [sett] FixedServerID = %u
@@ -887,6 +917,36 @@ tracepoint(CLOG_SETTINGS_C, SettingStreamMultiReceiveEnabled , arg2);\



/*----------------------------------------------------------
// Decoder Ring for SettingResumptionTicketMinVersion
// [sett] ResumptionTicketMinVersion= %hhu
// QuicTraceLogVerbose(SettingResumptionTicketMinVersion, "[sett] ResumptionTicketMinVersion= %hhu", Settings->ResumptionTicketMinVersion);
// arg2 = arg2 = Settings->ResumptionTicketMinVersion = arg2
----------------------------------------------------------*/
#ifndef _clog_3_ARGS_TRACE_SettingResumptionTicketMinVersion
#define _clog_3_ARGS_TRACE_SettingResumptionTicketMinVersion(uniqueId, encoded_arg_string, arg2)\
tracepoint(CLOG_SETTINGS_C, SettingResumptionTicketMinVersion , arg2);\

#endif




/*----------------------------------------------------------
// Decoder Ring for SettingResumptionTicketMaxVersion
// [sett] ResumptionTicketMaxVersion= %hhu
// QuicTraceLogVerbose(SettingResumptionTicketMaxVersion, "[sett] ResumptionTicketMaxVersion= %hhu", Settings->ResumptionTicketMaxVersion);
// arg2 = arg2 = Settings->ResumptionTicketMaxVersion = arg2
----------------------------------------------------------*/
#ifndef _clog_3_ARGS_TRACE_SettingResumptionTicketMaxVersion
#define _clog_3_ARGS_TRACE_SettingResumptionTicketMaxVersion(uniqueId, encoded_arg_string, arg2)\
tracepoint(CLOG_SETTINGS_C, SettingResumptionTicketMaxVersion , arg2);\

#endif




/*----------------------------------------------------------
// Decoder Ring for SettingsLoadInvalidAcceptableVersion
// Invalid AcceptableVersion loaded from storage! 0x%x at position %d
64 changes: 64 additions & 0 deletions src/generated/linux/settings.c.clog.h.lttng.h
Original file line number Diff line number Diff line change
@@ -874,6 +874,38 @@ TRACEPOINT_EVENT(CLOG_SETTINGS_C, SettingsStreamMultiReceiveEnabled,



/*----------------------------------------------------------
// Decoder Ring for SettingsDumpResumptionTicketMinVersion
// [sett] ResumptionTicketMinVersion= %hhu
// QuicTraceLogVerbose(SettingsDumpResumptionTicketMinVersion, "[sett] ResumptionTicketMinVersion= %hhu", Settings->ResumptionTicketMinVersion);
// arg2 = arg2 = Settings->ResumptionTicketMinVersion = arg2
----------------------------------------------------------*/
TRACEPOINT_EVENT(CLOG_SETTINGS_C, SettingsDumpResumptionTicketMinVersion,
TP_ARGS(
unsigned char, arg2),
TP_FIELDS(
ctf_integer(unsigned char, arg2, arg2)
)
)



/*----------------------------------------------------------
// Decoder Ring for SettingsDumpResumptionTicketMaxVersion
// [sett] ResumptionTicketMaxVersion= %hhu
// QuicTraceLogVerbose(SettingsDumpResumptionTicketMaxVersion, "[sett] ResumptionTicketMaxVersion= %hhu", Settings->ResumptionTicketMaxVersion);
// arg2 = arg2 = Settings->ResumptionTicketMaxVersion = arg2
----------------------------------------------------------*/
TRACEPOINT_EVENT(CLOG_SETTINGS_C, SettingsDumpResumptionTicketMaxVersion,
TP_ARGS(
unsigned char, arg2),
TP_FIELDS(
ctf_integer(unsigned char, arg2, arg2)
)
)



/*----------------------------------------------------------
// Decoder Ring for SettingDumpLFixedServerID
// [sett] FixedServerID = %u
@@ -922,6 +954,38 @@ TRACEPOINT_EVENT(CLOG_SETTINGS_C, SettingStreamMultiReceiveEnabled,



/*----------------------------------------------------------
// Decoder Ring for SettingResumptionTicketMinVersion
// [sett] ResumptionTicketMinVersion= %hhu
// QuicTraceLogVerbose(SettingResumptionTicketMinVersion, "[sett] ResumptionTicketMinVersion= %hhu", Settings->ResumptionTicketMinVersion);
// arg2 = arg2 = Settings->ResumptionTicketMinVersion = arg2
----------------------------------------------------------*/
TRACEPOINT_EVENT(CLOG_SETTINGS_C, SettingResumptionTicketMinVersion,
TP_ARGS(
unsigned char, arg2),
TP_FIELDS(
ctf_integer(unsigned char, arg2, arg2)
)
)



/*----------------------------------------------------------
// Decoder Ring for SettingResumptionTicketMaxVersion
// [sett] ResumptionTicketMaxVersion= %hhu
// QuicTraceLogVerbose(SettingResumptionTicketMaxVersion, "[sett] ResumptionTicketMaxVersion= %hhu", Settings->ResumptionTicketMaxVersion);
// arg2 = arg2 = Settings->ResumptionTicketMaxVersion = arg2
----------------------------------------------------------*/
TRACEPOINT_EVENT(CLOG_SETTINGS_C, SettingResumptionTicketMaxVersion,
TP_ARGS(
unsigned char, arg2),
TP_FIELDS(
ctf_integer(unsigned char, arg2, arg2)
)
)



/*----------------------------------------------------------
// Decoder Ring for SettingsLoadInvalidAcceptableVersion
// Invalid AcceptableVersion loaded from storage! 0x%x at position %d
68 changes: 68 additions & 0 deletions src/manifest/clog.sidecar
Original file line number Diff line number Diff line change
@@ -11353,6 +11353,30 @@
],
"macroName": "QuicTraceLogVerbose"
},
"SettingResumptionTicketMaxVersion": {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why this didnt get updated....

"ModuleProperites": {},
"TraceString": "[sett] ResumptionTicketMaxVersion= %hhu",
"UniqueId": "SettingResumptionTicketMaxVersion",
"splitArgs": [
{
"DefinationEncoding": "hhu",
"MacroVariableName": "arg2"
}
],
"macroName": "QuicTraceLogVerbose"
},
"SettingResumptionTicketMinVersion": {
"ModuleProperites": {},
"TraceString": "[sett] ResumptionTicketMinVersion= %hhu",
"UniqueId": "SettingResumptionTicketMinVersion",
"splitArgs": [
{
"DefinationEncoding": "hhu",
"MacroVariableName": "arg2"
}
],
"macroName": "QuicTraceLogVerbose"
},
"SettingRioEnabled": {
"ModuleProperites": {},
"TraceString": "[sett] RioEnabled = %hhu",
@@ -11365,6 +11389,30 @@
],
"macroName": "QuicTraceLogVerbose"
},
"SettingsDumpResumptionTicketMaxVersion": {
"ModuleProperites": {},
"TraceString": "[sett] ResumptionTicketMaxVersion= %hhu",
"UniqueId": "SettingsDumpResumptionTicketMaxVersion",
"splitArgs": [
{
"DefinationEncoding": "hhu",
"MacroVariableName": "arg2"
}
],
"macroName": "QuicTraceLogVerbose"
},
"SettingsDumpResumptionTicketMinVersion": {
"ModuleProperites": {},
"TraceString": "[sett] ResumptionTicketMinVersion= %hhu",
"UniqueId": "SettingsDumpResumptionTicketMinVersion",
"splitArgs": [
{
"DefinationEncoding": "hhu",
"MacroVariableName": "arg2"
}
],
"macroName": "QuicTraceLogVerbose"
},
"SettingsInvalidAcceptableVersion": {
"ModuleProperites": {},
"TraceString": "Invalid AcceptableVersion supplied to settings! 0x%x at position %d",
@@ -17424,11 +17472,31 @@
"TraceID": "SettingReliableResetEnabled",
"EncodingString": "[sett] ReliableResetEnabled = %hhu"
},
{
"UniquenessHash": "30a62c5f-fa32-fb3e-1b75-c6f4771f9b4e",
"TraceID": "SettingResumptionTicketMaxVersion",
"EncodingString": "[sett] ResumptionTicketMaxVersion= %hhu"
},
{
"UniquenessHash": "7538eb29-720e-f7d4-4d3c-5f42c0816fff",
"TraceID": "SettingResumptionTicketMinVersion",
"EncodingString": "[sett] ResumptionTicketMinVersion= %hhu"
},
{
"UniquenessHash": "aa851418-62e3-4895-b4a2-bedcbcf06d0d",
"TraceID": "SettingRioEnabled",
"EncodingString": "[sett] RioEnabled = %hhu"
},
{
"UniquenessHash": "be82ba99-613b-6ebb-b656-2adbadba2912",
"TraceID": "SettingsDumpResumptionTicketMaxVersion",
"EncodingString": "[sett] ResumptionTicketMaxVersion= %hhu"
},
{
"UniquenessHash": "41b7b56d-db24-ecf0-d909-64aba6ed2f98",
"TraceID": "SettingsDumpResumptionTicketMinVersion",
"EncodingString": "[sett] ResumptionTicketMinVersion= %hhu"
},
{
"UniquenessHash": "e7d29156-fb54-8f96-f3e2-1aa999886c12",
"TraceID": "SettingsInvalidAcceptableVersion",
Loading
Oops, something went wrong.