Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dynamic logging to work with Go's 1.17+ calling convention #2108

Merged
merged 5 commits into from
Feb 11, 2025
Merged

Update dynamic logging to work with Go's 1.17+ calling convention #2108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4b5947d
Update dynamic logging to work with new Go ABI
ddelnano Dec 10, 2024
503ad02
Return error when register stored structs are used. Add CPP STRUCT_BL…
ddelnano Feb 3, 2025
66cb4ab
Add register based CPP struct test
ddelnano Feb 3, 2025
5642386
Fix linting
ddelnano Feb 3, 2025
1bcaef2
Fix misspelling
ddelnano Feb 11, 2025
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
12 changes: 12 additions & 0 deletions src/stirling/obj_tools/testdata/cc/test_exe.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,17 @@ ABCStruct64 ABCSumMixed(ABCStruct32 x, ABCStruct64 y, int32_t z_a, int64_t z_b,
return ABCStruct64{x.a + y.a + z_a + w.a, x.b + y.b + z_b + w.b, x.c + y.c + z_c + w.c};
}

void OuterStructFunc(OuterStruct x) {
x.O0++;
x.O1.M0.L0 = !x.O1.M0.L0;
x.O1.M0.L1++;
x.O1.M0.L2++;
x.O1.M1 = !x.O1.M1;
x.O1.M2.L0 = !x.O1.M2.L0;
x.O1.M2.L1++;
x.O1.M2.L2++;
}

void SomeFunctionWithPointerArgs(int* a, ABCStruct32* x) {
x->a = *a;
a++;
Expand Down Expand Up @@ -113,6 +124,7 @@ int main() {

sleep(1);
}
OuterStructFunc(OuterStruct{1, MidStruct{{true, 2, nullptr}, false, {true, 3, nullptr}}});

return 0;
}
4 changes: 3 additions & 1 deletion src/stirling/source_connectors/dynamic_tracer/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@ pl_cc_bpf_test(
srcs = ["dynamic_trace_bpf_test.cc"],
data = [
"//src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_client:golang_1_16_grpc_client",
"//src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_client:golang_1_21_grpc_client",
"//src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_server:golang_1_16_grpc_server_with_certs",
"//src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_server:golang_1_21_grpc_server_with_certs",
],
tags = [
"cpu:16",
Expand All @@ -69,7 +71,7 @@ pl_cc_bpf_test(
srcs = ["stirling_dt_bpf_test.cc"],
data = [
"//src/stirling/obj_tools/testdata/cc:test_exe",
"//src/stirling/obj_tools/testdata/go:test_go_1_16_binary",
"//src/stirling/obj_tools/testdata/go:test_go_1_21_binary",
"//src/stirling/testing/dns:dns_hammer",
"//src/stirling/testing/dns:dns_hammer_image.tar",
],
Expand Down
5 changes: 3 additions & 2 deletions src/stirling/source_connectors/dynamic_tracer/dynamic_trace_bpf_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,12 @@

constexpr std::string_view kClientPath =
"src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_client/"
"golang_1_16_grpc_client";
"golang_1_21_grpc_client";
constexpr std::string_view kServerPath =
"src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_server/"
"golang_1_16_grpc_server";
"golang_1_21_grpc_server";

DECLARE_bool(debug_dt_pipeline);
namespace px {
namespace stirling {

Expand Down
15 changes: 8 additions & 7 deletions src/stirling/source_connectors/dynamic_tracer/dynamic_tracing/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ pl_cc_test(
name = "code_gen_test",
srcs = ["code_gen_test.cc"],
data = [
"//src/stirling/obj_tools/testdata/go:test_go_1_16_binary",
"//src/stirling/obj_tools/testdata/go:test_go_1_21_binary",
],
deps = [
":cc_library",
Expand All @@ -56,7 +56,8 @@ pl_cc_test(
name = "dwarvifier_test",
srcs = ["dwarvifier_test.cc"],
data = [
"//src/stirling/obj_tools/testdata/go:test_go_1_16_binary",
"//src/stirling/obj_tools/testdata/cc:test_exe",
"//src/stirling/obj_tools/testdata/go:test_go_1_21_binary",
],
deps = [
":cc_library",
Expand All @@ -67,7 +68,7 @@ pl_cc_test(
name = "probe_transformer_test",
srcs = ["probe_transformer_test.cc"],
data = [
"//src/stirling/obj_tools/testdata/go:test_go_1_16_binary",
"//src/stirling/obj_tools/testdata/go:test_go_1_21_binary",
],
deps = [
":cc_library",
Expand All @@ -79,7 +80,7 @@ pl_cc_test(
name = "autogen_test",
srcs = ["autogen_test.cc"],
data = [
"//src/stirling/obj_tools/testdata/go:test_go_1_16_binary",
"//src/stirling/obj_tools/testdata/go:test_go_1_21_binary",
],
deps = [
":cc_library",
Expand All @@ -91,9 +92,9 @@ pl_cc_test(
name = "dynamic_tracer_test",
srcs = ["dynamic_tracer_test.cc"],
data = [
"//src/stirling/obj_tools/testdata/go:test_go_1_16_binary",
"//src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_client:golang_1_16_grpc_client",
"//src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_server:golang_1_16_grpc_server_with_certs",
"//src/stirling/obj_tools/testdata/go:test_go_1_21_binary",
"//src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_client:golang_1_21_grpc_client",
"//src/stirling/source_connectors/socket_tracer/protocols/http2/testing/go_grpc_server:golang_1_21_grpc_server_with_certs",
],
tags = [
"exclusive",
Expand Down
14 changes: 8 additions & 6 deletions src/stirling/source_connectors/dynamic_tracer/dynamic_tracing/autogen_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
#include "src/common/testing/testing.h"
#include "src/stirling/source_connectors/dynamic_tracer/dynamic_tracing/autogen.h"

constexpr std::string_view kBinaryPath = "src/stirling/obj_tools/testdata/go/test_go_1_16_binary";
constexpr std::string_view kBinaryPath = "src/stirling/obj_tools/testdata/go/test_go_1_21_binary";

namespace px {
namespace stirling {
Expand Down Expand Up @@ -111,8 +111,8 @@ tracepoints {
fields: "i1"
fields: "i2"
fields: "i3"
fields: "__tilde__r6"
fields: "__tilde__r7"
fields: "__tilde__r0"
fields: "__tilde__r1"
fields: "latency"
}
probes {
Expand Down Expand Up @@ -147,13 +147,15 @@ tracepoints {
}
ret_vals {
id: "retval6"
expr: "~r6"
expr: "~r0"
}
ret_vals {
id: "retval7"
expr: "~r7"
expr: "~r1"
}
function_latency {
id: "fn_latency"
}
function_latency { id: "fn_latency" }
output_actions {
output_name: "main__d__MixedArgTypes_table"
variable_names: "arg0"
Expand Down
2 changes: 1 addition & 1 deletion src/stirling/source_connectors/dynamic_tracer/dynamic_tracing/code_gen_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

#include "src/common/testing/testing.h"

constexpr std::string_view kBinaryPath = "src/stirling/obj_tools/testdata/go/test_go_1_16_binary";
constexpr std::string_view kBinaryPath = "src/stirling/obj_tools/testdata/go/test_go_1_21_binary";

namespace px {
namespace stirling {
Expand Down
64 changes: 49 additions & 15 deletions src/stirling/source_connectors/dynamic_tracer/dynamic_tracing/dwarvifier.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,9 @@ class Dwarvifier {
uint64_t offset, const TypeInfo& type_info);

// Used by ProcessVarExpr() to handle a Struct variable.
Status ProcessStructBlob(const std::string& base, uint64_t offset, const TypeInfo& type_info,
const std::string& var_name, ir::physical::Probe* output_probe);
Status ProcessStructBlob(const ArgInfo& arg_info, const std::string& base, uint64_t offset,
const TypeInfo& type_info, const std::string& var_name,
ir::physical::Probe* output_probe);

// The input components describes a sequence of field of nesting structures. The first component
// is the name of an input argument of a function, or an expression to describe the index of an
Expand Down Expand Up @@ -569,11 +570,11 @@ void Dwarvifier::AddEntryProbeVariables(ir::physical::Probe* output_probe) {
auto* parm_ptr_var =
AddVariable<ScalarVariable>(output_probe, kParmPtrVarName, ir::shared::VOID_POINTER);
parm_ptr_var->set_reg(ir::physical::Register::SYSV_AMD64_ARGS_PTR);
} else if (language_ == ir::shared::GOLANG) {
auto* parm_ptr_var =
AddVariable<ScalarVariable>(output_probe, kParmPtrVarName, ir::shared::VOID_POINTER);
parm_ptr_var->set_reg(ir::physical::Register::GOLANG_ARGS_PTR);
}
// TODO(oazizi): For Golang 1.17+, will need the following:
// auto* parm_ptr_var =
// AddVariable<ScalarVariable>(output_probe, kParmPtrVarName, ir::shared::VOID_POINTER);
// parm_ptr_var->set_reg(ir::physical::Register::GOLANG_ARGS_PTR);
}

void Dwarvifier::AddRetProbeVariables(ir::physical::Probe* output_probe) {
Expand All @@ -585,6 +586,10 @@ void Dwarvifier::AddRetProbeVariables(ir::physical::Probe* output_probe) {
auto* rc_ptr_var =
AddVariable<ScalarVariable>(output_probe, kRCPtrVarName, ir::shared::VOID_POINTER);
rc_ptr_var->set_reg(ir::physical::Register::RC_PTR);
} else if (language_ == ir::shared::GOLANG) {
auto* parm_ptr_var =
AddVariable<ScalarVariable>(output_probe, kParmPtrVarName, ir::shared::VOID_POINTER);
parm_ptr_var->set_reg(ir::physical::Register::GOLANG_ARGS_PTR);
}
}

Expand Down Expand Up @@ -788,11 +793,22 @@ Status Dwarvifier::ProcessGolangInterfaceExpr(const std::string& base, uint64_t
return Status::OK();
}

Status Dwarvifier::ProcessStructBlob(const std::string& base, uint64_t offset,
const TypeInfo& type_info, const std::string& var_name,
Status Dwarvifier::ProcessStructBlob(const ArgInfo& arg_info, const std::string& base,
uint64_t offset, const TypeInfo& type_info,
const std::string& var_name,
ir::physical::Probe* output_probe) {
PX_ASSIGN_OR_RETURN(std::vector<StructSpecEntry> struct_spec_entires,
dwarf_reader_->GetStructSpec(type_info.type_name));
VLOG(1) << arg_info.ToString();
// TODO(ddelnano): Remove once structs in registers are supported (gh#2106)
if (arg_info.location.loc_type == LocationType::kRegister) {
auto message = absl::Substitute(
"Structs variables from registers aren't supported yet. Add an expr to '$0' to access an "
"individual, non struct field (e.g. expr: \"struct_name.field_a\") until this is supported "
"(gh#2106).",
var_name);
return error::InvalidArgument(message);
}
PX_ASSIGN_OR_RETURN(ir::physical::StructSpec struct_spec_proto,
CreateStructSpecProto(struct_spec_entires, language_));

Expand Down Expand Up @@ -917,7 +933,8 @@ Status Dwarvifier::ProcessVarExpr(const std::string& var_name, const ArgInfo& ar
PX_RETURN_IF_ERROR(
ProcessGolangInterfaceExpr(base, offset, type_info, var_name, output_probe));
} else {
PX_RETURN_IF_ERROR(ProcessStructBlob(base, offset, type_info, var_name, output_probe));
PX_RETURN_IF_ERROR(
ProcessStructBlob(arg_info, base, offset, type_info, var_name, output_probe));
}
} else {
return error::Internal("Expected struct or base type, but got type: $0", type_info.ToString());
Expand All @@ -936,13 +953,23 @@ Status Dwarvifier::ProcessArgExpr(const ir::logical::Argument& arg,

PX_ASSIGN_OR_RETURN(ArgInfo arg_info, GetArgInfo(args_map_, components.front()));

std::string base_var;
switch (language_) {
case ir::shared::GOLANG:
return ProcessVarExpr(arg.id(), arg_info, kSPVarName, components, output_probe);
switch (arg_info.location.loc_type) {
case LocationType::kStack:
base_var = kSPVarName;
break;
case LocationType::kRegister:
base_var = kParmPtrVarName;
break;
default:
return error::Internal("Unsupported argument LocationType $0",
magic_enum::enum_name(arg_info.location.loc_type));
}
return ProcessVarExpr(arg.id(), arg_info, base_var, components, output_probe);
case ir::shared::CPP:
case ir::shared::C: {
std::string base_var;

switch (arg_info.location.loc_type) {
case LocationType::kStack:
base_var = kSPVarName;
Expand Down Expand Up @@ -999,7 +1026,7 @@ Status Dwarvifier::ProcessRetValExpr(const ir::logical::ReturnValue& ret_val,

switch (language_) {
case ir::shared::GOLANG: {
// This represents the actualy return value being returned,
// This represents the actual return value being returned,
// without sub-field accesses.
std::string ret_val_name(components.front());

Expand Down Expand Up @@ -1029,8 +1056,15 @@ Status Dwarvifier::ProcessRetValExpr(const ir::logical::ReturnValue& ret_val,

// Golang return values are really arguments located on the stack, so get the arg info.
PX_ASSIGN_OR_RETURN(ArgInfo arg_info, GetArgInfo(args_map_, ret_val_name));

return ProcessVarExpr(ret_val.id(), arg_info, kSPVarName, components, output_probe);
switch (arg_info.location.loc_type) {
case LocationType::kStack:
return ProcessVarExpr(ret_val.id(), arg_info, kSPVarName, components, output_probe);
case LocationType::kRegister:
return ProcessVarExpr(ret_val.id(), arg_info, kParmPtrVarName, components, output_probe);
default:
return error::Internal("Unsupported return value LocationType $0",
magic_enum::enum_name(arg_info.location.loc_type));
}
}
case ir::shared::CPP:
case ir::shared::C: {
Expand Down
Loading
Loading