|
| 1 | +/* |
| 2 | +Copyright 2023 The bpfman Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package v1alpha1 |
| 18 | + |
| 19 | +import ( |
| 20 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 21 | + metav1types "k8s.io/apimachinery/pkg/types" |
| 22 | + "sigs.k8s.io/controller-runtime/pkg/client" |
| 23 | +) |
| 24 | + |
| 25 | +// BpfApplicationProgramState defines the desired state of BpfApplication |
| 26 | +// +union |
| 27 | +// +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'XDP' ? has(self.xdp) : !has(self.xdp)",message="xdp configuration is required when type is XDP, and forbidden otherwise" |
| 28 | +// // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'TC' ? has(self.tc) : !has(self.tc)",message="tc configuration is required when type is TC, and forbidden otherwise" |
| 29 | +// +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'TCX' ? has(self.tcx) : !has(self.tcx)",message="tcx configuration is required when type is TCX, and forbidden otherwise" |
| 30 | +// +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Fentry' ? has(self.fentry) : !has(self.fentry)",message="fentry configuration is required when type is Fentry, and forbidden otherwise" |
| 31 | +// // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Fexit' ? has(self.fexit) : !has(self.fexit)",message="fexit configuration is required when type is Fexit, and forbidden otherwise" |
| 32 | +// // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Kprobe' ? has(self.kprobe) : !has(self.kprobe)",message="kprobe configuration is required when type is Kprobe, and forbidden otherwise" |
| 33 | +// // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Kretprobe' ? has(self.kretprobe) : !has(self.kretprobe)",message="kretprobe configuration is required when type is Kretprobe, and forbidden otherwise" |
| 34 | +// // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Uprobe' ? has(self.uprobe) : !has(self.uprobe)",message="uprobe configuration is required when type is Uprobe, and forbidden otherwise" |
| 35 | +// // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Uretprobe' ? has(self.uretprobe) : !has(self.uretprobe)",message="uretprobe configuration is required when type is Uretprobe, and forbidden otherwise" |
| 36 | +// // +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Tracepoint' ? has(self.tracepoint) : !has(self.tracepoint)",message="tracepoint configuration is required when type is Tracepoint, and forbidden otherwise" |
| 37 | +type BpfApplicationProgramState struct { |
| 38 | + // ProgramAttachStatus records whether the program should be loaded and whether |
| 39 | + // the program is loaded. |
| 40 | + ProgramAttachStatus BpfProgramConditionType `json:"programattachstatus"` |
| 41 | + |
| 42 | + // ProgramId is the id of the program in the kernel. Not set until the |
| 43 | + // program is loaded. |
| 44 | + // +optional |
| 45 | + ProgramId *uint32 `json:"program_id"` |
| 46 | + |
| 47 | + // Type specifies the bpf program type |
| 48 | + // +unionDiscriminator |
| 49 | + // +kubebuilder:validation:Required |
| 50 | + // +kubebuilder:validation:Enum:="XDP";"TC";"TCX";"Fentry";"Fexit";"Kprobe";"Kretprobe";"Uprobe";"Uretprobe";"Tracepoint" |
| 51 | + Type EBPFProgType `json:"type,omitempty"` |
| 52 | + |
| 53 | + // xdp defines the desired state of the application's XdpPrograms. |
| 54 | + // +unionMember |
| 55 | + // +optional |
| 56 | + XDP *XdpProgramInfoState `json:"xdp,omitempty"` |
| 57 | + |
| 58 | + // // tc defines the desired state of the application's TcPrograms. |
| 59 | + // // +unionMember |
| 60 | + // // +optional |
| 61 | + // TC *TcProgramInfoState `json:"tc,omitempty"` |
| 62 | + |
| 63 | + // tcx defines the desired state of the application's TcxPrograms. |
| 64 | + // +unionMember |
| 65 | + // +optional |
| 66 | + TCX *TcxProgramInfoState `json:"tcx,omitempty"` |
| 67 | + |
| 68 | + // fentry defines the desired state of the application's FentryPrograms. |
| 69 | + // +unionMember |
| 70 | + // +optional |
| 71 | + Fentry *FentryProgramInfoState `json:"fentry,omitempty"` |
| 72 | + |
| 73 | + // // fexit defines the desired state of the application's FexitPrograms. |
| 74 | + // // +unionMember |
| 75 | + // // +optional |
| 76 | + // Fexit *FexitProgramInfoState `json:"fexit,omitempty"` |
| 77 | + |
| 78 | + // // kprobe defines the desired state of the application's KprobePrograms. |
| 79 | + // // +unionMember |
| 80 | + // // +optional |
| 81 | + // Kprobe *KprobeProgramInfoState `json:"kprobe,omitempty"` |
| 82 | + |
| 83 | + // // kretprobe defines the desired state of the application's KretprobePrograms. |
| 84 | + // // +unionMember |
| 85 | + // // +optional |
| 86 | + // Kretprobe *KprobeProgramInfoState `json:"kretprobe,omitempty"` |
| 87 | + |
| 88 | + // // uprobe defines the desired state of the application's UprobePrograms. |
| 89 | + // // +unionMember |
| 90 | + // // +optional |
| 91 | + // Uprobe *UprobeProgramInfoState `json:"uprobe,omitempty"` |
| 92 | + |
| 93 | + // // uretprobe defines the desired state of the application's UretprobePrograms. |
| 94 | + // // +unionMember |
| 95 | + // // +optional |
| 96 | + // Uretprobe *UprobeProgramInfoState `json:"uretprobe,omitempty"` |
| 97 | + |
| 98 | + // // tracepoint defines the desired state of the application's TracepointPrograms. |
| 99 | + // // +unionMember |
| 100 | + // // +optional |
| 101 | + // Tracepoint *TracepointProgramInfoState `json:"tracepoint,omitempty"` |
| 102 | +} |
| 103 | + |
| 104 | +// BpfApplicationSpec defines the desired state of BpfApplication |
| 105 | +type BpfApplicationStateSpec struct { |
| 106 | + // The number of times the BpfApplicationState has been updated. Set to 1 |
| 107 | + // when the object is created, then it is incremented prior to each update. |
| 108 | + // This allows us to verify that the API server has the updated object prior |
| 109 | + // to starting a new Reconcile operation. |
| 110 | + UpdateCount int64 `json:"updatecount"` |
| 111 | + // AppLoadStatus reflects the status of loading the bpf application on the |
| 112 | + // given node. |
| 113 | + AppLoadStatus BpfProgramConditionType `json:"apploadstatus"` |
| 114 | + // Programs is a list of bpf programs contained in the parent application. |
| 115 | + // It is a map from the bpf program name to BpfApplicationProgramState |
| 116 | + // elements. |
| 117 | + Programs map[string]BpfApplicationProgramState `json:"programs,omitempty"` |
| 118 | +} |
| 119 | + |
| 120 | +// +genclient |
| 121 | +// +genclient:nonNamespaced |
| 122 | +// +kubebuilder:object:root=true |
| 123 | +// +kubebuilder:subresource:status |
| 124 | +// +kubebuilder:resource:scope=Cluster |
| 125 | + |
| 126 | +// BpfApplicationState contains the per-node state of a BpfApplication. |
| 127 | +// ANF-TODO: I can't get the Node to display in the kubectl output. |
| 128 | +// // +kubebuilder:printcolumn:name="Node",type=string,JSONPath=".metadata.labels['kubernetes.io/hostname']" |
| 129 | +// +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.conditions[0].reason` |
| 130 | +// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" |
| 131 | +type BpfApplicationState struct { |
| 132 | + metav1.TypeMeta `json:",inline"` |
| 133 | + metav1.ObjectMeta `json:"metadata,omitempty"` |
| 134 | + |
| 135 | + Spec BpfApplicationStateSpec `json:"spec,omitempty"` |
| 136 | + Status BpfAppStatus `json:"status,omitempty"` |
| 137 | +} |
| 138 | + |
| 139 | +// +kubebuilder:object:root=true |
| 140 | +// BpfApplicationStateList contains a list of BpfApplicationState objects |
| 141 | +type BpfApplicationStateList struct { |
| 142 | + metav1.TypeMeta `json:",inline"` |
| 143 | + metav1.ListMeta `json:"metadata,omitempty"` |
| 144 | + Items []BpfApplicationState `json:"items"` |
| 145 | +} |
| 146 | + |
| 147 | +func (an BpfApplicationState) GetName() string { |
| 148 | + return an.Name |
| 149 | +} |
| 150 | + |
| 151 | +func (an BpfApplicationState) GetUID() metav1types.UID { |
| 152 | + return an.UID |
| 153 | +} |
| 154 | + |
| 155 | +func (an BpfApplicationState) GetAnnotations() map[string]string { |
| 156 | + return an.Annotations |
| 157 | +} |
| 158 | + |
| 159 | +func (an BpfApplicationState) GetLabels() map[string]string { |
| 160 | + return an.Labels |
| 161 | +} |
| 162 | + |
| 163 | +func (an BpfApplicationState) GetStatus() *BpfAppStatus { |
| 164 | + return &an.Status |
| 165 | +} |
| 166 | + |
| 167 | +func (an BpfApplicationState) GetClientObject() client.Object { |
| 168 | + return &an |
| 169 | +} |
| 170 | + |
| 171 | +func (anl BpfApplicationStateList) GetItems() []BpfApplicationState { |
| 172 | + return anl.Items |
| 173 | +} |
0 commit comments