mirror of
https://github.com/rwinkhart/go-winio.git
synced 2026-08-30 13:56:51 -04:00
Hamza El-Saawy
e268c11e27
* Add lint and go generate stages to CI
Add CI step to verify `go generate` was run on repo.
Add linter stage to CI along with linter config file,
`.golangci.yml`.
Will likely prefer revive over static-check.
Updated README Contributing section on linting requirements.
Added sequence ordering to make sure lint and go generate stages run
before tests and build.
This way, build and tests are not run on code that could potentially:
1. not build due to `gofmt` issues;
2. contain bugs;
3. have to be re-submitted after issues are fixed; or
4. contain outdated Win32 syscall or other auto-generated files.
Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>
* Fixed linter issues
Code changes to satisfy linters:
- Ran `gofmt -s -w` on repo.
- Broke up long lines.
- When possible, changed names with incorrect initialism formatting
- Added exceptions for exported variables.
- Added exceptions for ALL_CAPS_WITH_UNDERSCORES code.
- Switched to using `windows` or `syscall` definitions if possible;
especially if some constants were unused.
- Added `_ =` to satisfy error linter, and acknowledge that errors are
being ignored.
- Switched to using `errors.Is` and `As` in places, elsewhere added
exceptions if error value was known to be `syscall.Errno`.
- Removed bare returns.
- Prevented variables from being overshadowed in certain places
(ignoring cases of overshadowing `err`).
- Renamed variables and functions (eg, `len`, `eventMetadata.bytes`) to
prevent shadowing pre-built functions and imported pacakges.
- Removed unused method receivers.
- Added exceptions to certain unused (unexported) constants and
functions.
- Deleted unused `once` from `pkg/etw.providerMap`.
- Renamed `noop.go` files to `main_other.go` or `doc.go`, to better fit
style recommendations.
- Added exceptions for non-secure use of SHA1 and weak crypto
libraries.
- Replaced `ioutil` with `io` and `os` (and `t.TempDir` in tests).
- Added fully exhaustive checks for `switch` statements in `pkg/etw`.
- Defined constant strings for `tools/mkwinsyscall`.
- Removed unnecessary conversions.
- Made sure `context.Cancel` was called.
Additionally, added `//go:build windows" constraints on files with
unexported code, since linter will complain about unused code on
non-Windows platforms.
Added a stub `main() {}` for `mkwinsyscall` for non-Windows builds, just in
case `//go:generate` directives are added to OS-agnostic files.
Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>
* PR: spelling, constants, fuzzing
Moved HVSocket fuzzing tests to separate file with go 1.18 build
constraint.
Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>
Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>
93 lines
2.7 KiB
Go
93 lines
2.7 KiB
Go
//go:build windows
|
|
|
|
package etw
|
|
|
|
// Channel represents the ETW logging channel that is used. It can be used by
|
|
// event consumers to give an event special treatment.
|
|
type Channel uint8
|
|
|
|
const (
|
|
// ChannelTraceLogging is the default channel for TraceLogging events. It is
|
|
// not required to be used for TraceLogging, but will prevent decoding
|
|
// issues for these events on older operating systems.
|
|
ChannelTraceLogging Channel = 11
|
|
)
|
|
|
|
// Level represents the ETW logging level. There are several predefined levels
|
|
// that are commonly used, but technically anything from 0-255 is allowed.
|
|
// Lower levels indicate more important events, and 0 indicates an event that
|
|
// will always be collected.
|
|
type Level uint8
|
|
|
|
// Predefined ETW log levels from winmeta.xml in the Windows SDK.
|
|
const (
|
|
LevelAlways Level = iota
|
|
LevelCritical
|
|
LevelError
|
|
LevelWarning
|
|
LevelInfo
|
|
LevelVerbose
|
|
)
|
|
|
|
// Opcode represents the operation that the event indicates is being performed.
|
|
type Opcode uint8
|
|
|
|
// Predefined ETW opcodes from winmeta.xml in the Windows SDK.
|
|
const (
|
|
// OpcodeInfo indicates an informational event.
|
|
OpcodeInfo Opcode = iota
|
|
// OpcodeStart indicates the start of an operation.
|
|
OpcodeStart
|
|
// OpcodeStop indicates the end of an operation.
|
|
OpcodeStop
|
|
// OpcodeDCStart indicates the start of a provider capture state operation.
|
|
OpcodeDCStart
|
|
// OpcodeDCStop indicates the end of a provider capture state operation.
|
|
OpcodeDCStop
|
|
)
|
|
|
|
// EventDescriptor represents various metadata for an ETW event.
|
|
//
|
|
//nolint:structcheck // task is currently unused
|
|
type eventDescriptor struct {
|
|
id uint16
|
|
version uint8
|
|
channel Channel
|
|
level Level
|
|
opcode Opcode
|
|
task uint16
|
|
keyword uint64
|
|
}
|
|
|
|
// NewEventDescriptor returns an EventDescriptor initialized for use with
|
|
// TraceLogging.
|
|
func newEventDescriptor() *eventDescriptor {
|
|
// Standard TraceLogging events default to the TraceLogging channel, and
|
|
// verbose level.
|
|
return &eventDescriptor{
|
|
channel: ChannelTraceLogging,
|
|
level: LevelVerbose,
|
|
}
|
|
}
|
|
|
|
// Identity returns the identity of the event. If the identity is not 0, it
|
|
// should uniquely identify the other event metadata (contained in
|
|
// EventDescriptor, and field metadata). Only the lower 24 bits of this value
|
|
// are relevant.
|
|
//
|
|
//nolint:unused // keep for future use
|
|
func (ed *eventDescriptor) identity() uint32 {
|
|
return (uint32(ed.version) << 16) | uint32(ed.id)
|
|
}
|
|
|
|
// SetIdentity sets the identity of the event. If the identity is not 0, it
|
|
// should uniquely identify the other event metadata (contained in
|
|
// EventDescriptor, and field metadata). Only the lower 24 bits of this value
|
|
// are relevant.
|
|
//
|
|
//nolint:unused // keep for future use
|
|
func (ed *eventDescriptor) setIdentity(identity uint32) {
|
|
ed.id = uint16(identity)
|
|
ed.version = uint8(identity >> 16)
|
|
}
|