Add support for local memory pooling for data objects (#13678)

This feature is protected by a featuregate that is not yet enabled and
only marked as alpha. Preliminary results show > 20% CPU performance
improvement and at least 40% allocations improvement. I still need to
generate UnmarshalProto for AnyValue which should improve even more
results.

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

Author: bogdandrutu

.chloggen/add-pooling.yaml

@@ -0,0 +1,26 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: pdata
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add support for local memory pooling for data objects.
+
+# One or more tracking issues or pull requests related to the change
+issues: [13678]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: This is still an early experimental (alpha) feature. Do not recommended to be used production.
+  To enable use "--featuregate=+pdata.useProtoPooling"
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api, user]

internal/cmd/pdatagen/internal/pdata/field.go

@@ -14,6 +14,8 @@ type Field interface {
 
 	GenerateTestEncodingValues(ms *messageStruct) string
 
+	GenerateDeleteOrig(ms *messageStruct) string
+
 	GenerateCopyOrig(ms *messageStruct) string
 
 	GenerateMarshalJSON(ms *messageStruct) string

internal/cmd/pdatagen/internal/pdata/message_field.go

@@ -63,6 +63,10 @@ func (mf *MessageField) GenerateTestEncodingValues(*messageStruct) string {
 	return mf.toProtoField().GenTestEncodingValues()
 }
 
+func (mf *MessageField) GenerateDeleteOrig(*messageStruct) string {
+	return mf.toProtoField().GenDeleteOrig()
+}
+
 func (mf *MessageField) GenerateCopyOrig(ms *messageStruct) string {
 	t := template.Parse("messageCopyOrigTemplate", []byte(messageCopyOrigTemplate))
 	return template.Execute(t, mf.templateFields(ms))

internal/cmd/pdatagen/internal/pdata/one_of_field.go

@@ -44,6 +44,13 @@ const oneOfTestValuesTemplate = `
 	{{ .GenerateTestEncodingValues $.baseStruct $.OneOfField }}
 	{{- end }}`
 
+const oneOfDeleteOrigTemplate = `switch ov := orig.{{ .originFieldName }}.(type) {
+	{{ range .values -}}
+	case *{{ $.originTypePrefix }}{{ .GetOriginFieldName }}:
+		{{ .GenerateDeleteOrig $.baseStruct $.OneOfField }}{{- end }}
+	}
+`
+
 const oneOfCopyOrigTemplate = `switch t := src.{{ .originFieldName }}.(type) {
 {{- range .values }}
 {{ .GenerateCopyOrig $.baseStruct $.OneOfField }}
@@ -117,6 +124,20 @@ func (of *OneOfField) GenerateTestEncodingValues(ms *messageStruct) string {
 	return template.Execute(template.Parse("oneOfTestValuesTemplate", []byte(oneOfTestValuesTemplate)), of.templateFields(ms))
 }
 
+func (of *OneOfField) GenerateDeleteOrig(ms *messageStruct) string {
+	atLeastOneMessage := false
+	for i := range of.values {
+		if _, ok := of.values[i].(*OneOfMessageValue); ok {
+			atLeastOneMessage = true
+			break
+		}
+	}
+	if atLeastOneMessage {
+		return template.Execute(template.Parse("oneOfDeleteOrigTemplate", []byte(oneOfDeleteOrigTemplate)), of.templateFields(ms))
+	}
+	return ""
+}
+
 func (of *OneOfField) GenerateCopyOrig(ms *messageStruct) string {
 	return template.Execute(template.Parse("oneOfCopyOrigTemplate", []byte(oneOfCopyOrigTemplate)), of.templateFields(ms))
 }
@@ -170,6 +191,7 @@ type oneOfValue interface {
 	GenerateTestValue(ms *messageStruct, of *OneOfField) string
 	GenerateTestFailingUnmarshalProtoValues(ms *messageStruct, of *OneOfField) string
 	GenerateTestEncodingValues(ms *messageStruct, of *OneOfField) string
+	GenerateDeleteOrig(ms *messageStruct, of *OneOfField) string
 	GenerateCopyOrig(ms *messageStruct, of *OneOfField) string
 	GenerateType(ms *messageStruct, of *OneOfField) string
 	GenerateMarshalJSON(ms *messageStruct, of *OneOfField) string

internal/cmd/pdatagen/internal/pdata/one_of_message_value.go

@@ -96,6 +96,10 @@ func (omv *OneOfMessageValue) GenerateTestEncodingValues(ms *messageStruct, of *
 	return omv.toProtoField(ms, of, false).GenTestEncodingValues()
 }
 
+func (omv *OneOfMessageValue) GenerateDeleteOrig(ms *messageStruct, of *OneOfField) string {
+	return omv.toProtoField(ms, of, false).GenDeleteOrig()
+}
+
 func (omv *OneOfMessageValue) GenerateCopyOrig(ms *messageStruct, of *OneOfField) string {
 	t := template.Parse("oneOfMessageCopyOrigTemplate", []byte(oneOfMessageCopyOrigTemplate))
 	return template.Execute(t, omv.templateFields(ms, of))

internal/cmd/pdatagen/internal/pdata/one_of_primitive_value.go

@@ -91,6 +91,10 @@ func (opv *OneOfPrimitiveValue) GenerateTestEncodingValues(ms *messageStruct, of
 	return opv.toProtoField(ms, of, false).GenTestEncodingValues()
 }
 
+func (opv *OneOfPrimitiveValue) GenerateDeleteOrig(ms *messageStruct, of *OneOfField) string {
+	return opv.toProtoField(ms, of, false).GenDeleteOrig()
+}
+
 func (opv *OneOfPrimitiveValue) GenerateCopyOrig(ms *messageStruct, of *OneOfField) string {
 	t := template.Parse("oneOfPrimitiveCopyOrigTemplate", []byte(oneOfPrimitiveCopyOrigTemplate))
 	return template.Execute(t, opv.templateFields(ms, of))

internal/cmd/pdatagen/internal/pdata/optional_primitive_field.go

@@ -98,6 +98,10 @@ func (opv *OptionalPrimitiveField) GenerateTestEncodingValues(ms *messageStruct)
 	return opv.toProtoField(ms, false).GenTestEncodingValues()
 }
 
+func (opv *OptionalPrimitiveField) GenerateDeleteOrig(ms *messageStruct) string {
+	return opv.toProtoField(ms, false).GenDeleteOrig()
+}
+
 func (opv *OptionalPrimitiveField) GenerateCopyOrig(ms *messageStruct) string {
 	t := template.Parse("optionalPrimitiveCopyOrigTemplate", []byte(optionalPrimitiveCopyOrigTemplate))
 	return template.Execute(t, opv.templateFields(ms))

internal/cmd/pdatagen/internal/pdata/primitive_field.go

@@ -80,6 +80,10 @@ func (pf *PrimitiveField) GenerateTestEncodingValues(*messageStruct) string {
 	return pf.toProtoField().GenTestEncodingValues()
 }
 
+func (pf *PrimitiveField) GenerateDeleteOrig(*messageStruct) string {
+	return pf.toProtoField().GenDeleteOrig()
+}
+
 func (pf *PrimitiveField) GenerateCopyOrig(ms *messageStruct) string {
 	t := template.Parse("primitiveCopyOrigTemplate", []byte(primitiveCopyOrigTemplate))
 	return template.Execute(t, pf.templateFields(ms))

internal/cmd/pdatagen/internal/pdata/slice_field.go

@@ -69,6 +69,10 @@ func (sf *SliceField) GenerateTestEncodingValues(*messageStruct) string {
 	return sf.toProtoField().GenTestEncodingValues()
 }
 
+func (sf *SliceField) GenerateDeleteOrig(*messageStruct) string {
+	return sf.toProtoField().GenDeleteOrig()
+}
+
 func (sf *SliceField) GenerateCopyOrig(ms *messageStruct) string {
 	t := template.Parse("sliceCopyOrigTemplate", []byte(sliceCopyOrigTemplate))
 	return template.Execute(t, sf.templateFields(ms))

internal/cmd/pdatagen/internal/pdata/templates/message_internal.go.tmpl

@@ -32,8 +32,34 @@ func New{{ .structName }}(orig *{{ .originFullName }}, state *State) {{ .structN
 
 {{ end }}
 
+var protoPool{{ .originName }} = sync.Pool{
+    New: func() any {
+        return &{{ .originFullName }}{}
+    },
+}
+
 func NewOrig{{ .originName }}() *{{ .originFullName }} {
-    return &{{ .originFullName }}{}
+    if !UseProtoPooling.IsEnabled() {
+        return &{{ .originFullName }}{}
+    }
+    return protoPool{{ .originName }}.Get().(*{{ .originFullName }})
+}
+
+func DeleteOrig{{ .originName }}(orig *{{ .originFullName }}, nullable bool) {
+    if orig == nil {
+        return
+    }
+
+    if !UseProtoPooling.IsEnabled() {
+        orig.Reset()
+        return
+    }
+
+    {{ range .fields }}{{ .GenerateDeleteOrig $.messageStruct }}{{ end }}
+    orig.Reset()
+	if nullable {
+        protoPool{{ .originName }}.Put(orig)
+    }
 }
 
 func CopyOrig{{ .originName }}(dest, src *{{ .originFullName }}) {