ebpf: encode platform in type constants

Linux and Windows share the concept of program types, map types and so on.
For example, XDP is supported on both platforms. Unfortunately the constant
values used by both platforms are different. On Linux, XDP has value 0x6
while on Windows it is 0x1.

This problem extends to a CollectionSpec parsed from an ELF. Because of the
different values a Windows PerCPUHash aliases with a Linux ProgramArray.
This causes all sorts of mayhem that is hard to avoid without making too
many changes to the code base.

Introduce a Platform type which enumerates the supported platforms.
That type is then used to tag constant values. This means that there are
distinct constants even when a type exists on both platforms. Instead of
overloading the XDP constant we will introduce WindowsXDP.
This will allow the ELF reader to remain fully deterministic as well:
we can parse Linux ELF on Windows and vice versa.

The value of the Platform tag is chosen so that on Linux the constant
values do not change and are identical with the value in upstream
headers. On Windows the constants have a fixed (but implementation
defined) offset.

The downside of this approach is that Windows constants will all require
a prefix of some sort to distinguish them from Linux ones. This is probably
most onerous for map types, because those tend to be created manually more
frequently than programs, for example. We can add some behind the scenes
translation of Linux map types to Windows ones if need be.

Another downside is that constant values are now limited to 28 bits since
we steal the top 4 bits to store the platform. The constants we're applying
this to are all sequentially numbered from 0, so this is hopefully enough.

Signed-off-by: Lorenz Bauer <[email protected]>

asm/func.go

@@ -1,239 +1,21 @@
 package asm
 
+import (
+	"github.com/cilium/ebpf/internal"
+)
+
 //go:generate go run golang.org/x/tools/cmd/stringer@latest -output func_string.go -type=BuiltinFunc
 
 // BuiltinFunc is a built-in eBPF function.
-type BuiltinFunc int32
+type BuiltinFunc uint32
 
-// eBPF built-in functions
-//
-// You can regenerate this list using the following gawk script:
-//
-//	/FN\(.+\),/ {
-//	  match($1, /\(([a-z_0-9]+),/, r)
-//	  split(r[1], p, "_")
-//	  printf "Fn"
-//	  for (i in p) {
-//	    printf "%s%s", toupper(substr(p[i], 1, 1)), substr(p[i], 2)
-//	  }
-//	  print ""
-//	}
-//
-// The script expects include/uapi/linux/bpf.h as it's input.
-const (
-	FnUnspec BuiltinFunc = iota
-	FnMapLookupElem
-	FnMapUpdateElem
-	FnMapDeleteElem
-	FnProbeRead
-	FnKtimeGetNs
-	FnTracePrintk
-	FnGetPrandomU32
-	FnGetSmpProcessorId
-	FnSkbStoreBytes
-	FnL3CsumReplace
-	FnL4CsumReplace
-	FnTailCall
-	FnCloneRedirect
-	FnGetCurrentPidTgid
-	FnGetCurrentUidGid
-	FnGetCurrentComm
-	FnGetCgroupClassid
-	FnSkbVlanPush
-	FnSkbVlanPop
-	FnSkbGetTunnelKey
-	FnSkbSetTunnelKey
-	FnPerfEventRead
-	FnRedirect
-	FnGetRouteRealm
-	FnPerfEventOutput
-	FnSkbLoadBytes
-	FnGetStackid
-	FnCsumDiff
-	FnSkbGetTunnelOpt
-	FnSkbSetTunnelOpt
-	FnSkbChangeProto
-	FnSkbChangeType
-	FnSkbUnderCgroup
-	FnGetHashRecalc
-	FnGetCurrentTask
-	FnProbeWriteUser
-	FnCurrentTaskUnderCgroup
-	FnSkbChangeTail
-	FnSkbPullData
-	FnCsumUpdate
-	FnSetHashInvalid
-	FnGetNumaNodeId
-	FnSkbChangeHead
-	FnXdpAdjustHead
-	FnProbeReadStr
-	FnGetSocketCookie
-	FnGetSocketUid
-	FnSetHash
-	FnSetsockopt
-	FnSkbAdjustRoom
-	FnRedirectMap
-	FnSkRedirectMap
-	FnSockMapUpdate
-	FnXdpAdjustMeta
-	FnPerfEventReadValue
-	FnPerfProgReadValue
-	FnGetsockopt
-	FnOverrideReturn
-	FnSockOpsCbFlagsSet
-	FnMsgRedirectMap
-	FnMsgApplyBytes
-	FnMsgCorkBytes
-	FnMsgPullData
-	FnBind
-	FnXdpAdjustTail
-	FnSkbGetXfrmState
-	FnGetStack
-	FnSkbLoadBytesRelative
-	FnFibLookup
-	FnSockHashUpdate
-	FnMsgRedirectHash
-	FnSkRedirectHash
-	FnLwtPushEncap
-	FnLwtSeg6StoreBytes
-	FnLwtSeg6AdjustSrh
-	FnLwtSeg6Action
-	FnRcRepeat
-	FnRcKeydown
-	FnSkbCgroupId
-	FnGetCurrentCgroupId
-	FnGetLocalStorage
-	FnSkSelectReuseport
-	FnSkbAncestorCgroupId
-	FnSkLookupTcp
-	FnSkLookupUdp
-	FnSkRelease
-	FnMapPushElem
-	FnMapPopElem
-	FnMapPeekElem
-	FnMsgPushData
-	FnMsgPopData
-	FnRcPointerRel
-	FnSpinLock
-	FnSpinUnlock
-	FnSkFullsock
-	FnTcpSock
-	FnSkbEcnSetCe
-	FnGetListenerSock
-	FnSkcLookupTcp
-	FnTcpCheckSyncookie
-	FnSysctlGetName
-	FnSysctlGetCurrentValue
-	FnSysctlGetNewValue
-	FnSysctlSetNewValue
-	FnStrtol
-	FnStrtoul
-	FnSkStorageGet
-	FnSkStorageDelete
-	FnSendSignal
-	FnTcpGenSyncookie
-	FnSkbOutput
-	FnProbeReadUser
-	FnProbeReadKernel
-	FnProbeReadUserStr
-	FnProbeReadKernelStr
-	FnTcpSendAck
-	FnSendSignalThread
-	FnJiffies64
-	FnReadBranchRecords
-	FnGetNsCurrentPidTgid
-	FnXdpOutput
-	FnGetNetnsCookie
-	FnGetCurrentAncestorCgroupId
-	FnSkAssign
-	FnKtimeGetBootNs
-	FnSeqPrintf
-	FnSeqWrite
-	FnSkCgroupId
-	FnSkAncestorCgroupId
-	FnRingbufOutput
-	FnRingbufReserve
-	FnRingbufSubmit
-	FnRingbufDiscard
-	FnRingbufQuery
-	FnCsumLevel
-	FnSkcToTcp6Sock
-	FnSkcToTcpSock
-	FnSkcToTcpTimewaitSock
-	FnSkcToTcpRequestSock
-	FnSkcToUdp6Sock
-	FnGetTaskStack
-	FnLoadHdrOpt
-	FnStoreHdrOpt
-	FnReserveHdrOpt
-	FnInodeStorageGet
-	FnInodeStorageDelete
-	FnDPath
-	FnCopyFromUser
-	FnSnprintfBtf
-	FnSeqPrintfBtf
-	FnSkbCgroupClassid
-	FnRedirectNeigh
-	FnPerCpuPtr
-	FnThisCpuPtr
-	FnRedirectPeer
-	FnTaskStorageGet
-	FnTaskStorageDelete
-	FnGetCurrentTaskBtf
-	FnBprmOptsSet
-	FnKtimeGetCoarseNs
-	FnImaInodeHash
-	FnSockFromFile
-	FnCheckMtu
-	FnForEachMapElem
-	FnSnprintf
-	FnSysBpf
-	FnBtfFindByNameKind
-	FnSysClose
-	FnTimerInit
-	FnTimerSetCallback
-	FnTimerStart
-	FnTimerCancel
-	FnGetFuncIp
-	FnGetAttachCookie
-	FnTaskPtRegs
-	FnGetBranchSnapshot
-	FnTraceVprintk
-	FnSkcToUnixSock
-	FnKallsymsLookupName
-	FnFindVma
-	FnLoop
-	FnStrncmp
-	FnGetFuncArg
-	FnGetFuncRet
-	FnGetFuncArgCnt
-	FnGetRetval
-	FnSetRetval
-	FnXdpGetBuffLen
-	FnXdpLoadBytes
-	FnXdpStoreBytes
-	FnCopyFromUserTask
-	FnSkbSetTstamp
-	FnImaFileHash
-	FnKptrXchg
-	FnMapLookupPercpuElem
-	FnSkcToMptcpSock
-	FnDynptrFromMem
-	FnRingbufReserveDynptr
-	FnRingbufSubmitDynptr
-	FnRingbufDiscardDynptr
-	FnDynptrRead
-	FnDynptrWrite
-	FnDynptrData
-	FnTcpRawGenSyncookieIpv4
-	FnTcpRawGenSyncookieIpv6
-	FnTcpRawCheckSyncookieIpv4
-	FnTcpRawCheckSyncookieIpv6
-	FnKtimeGetTaiNs
-	FnUserRingbufDrain
-	FnCgrpStorageGet
-	FnCgrpStorageDelete
-)
+func BuiltinFuncForPlatform(p internal.Platform, value uint32) (BuiltinFunc, error) {
+	return internal.EncodePlatformConstant[BuiltinFunc](p, value)
+}
+
+func (fn BuiltinFunc) Decode() (internal.Platform, uint32) {
+	return internal.DecodePlatformConstant(fn)
+}
 
 // Call emits a function call.
 func (fn BuiltinFunc) Call() Instruction {