mirror of
https://github.com/rwinkhart/go-winio.git
synced 2026-08-28 04:46:50 -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>
75 lines
2.1 KiB
Go
75 lines
2.1 KiB
Go
//go:build windows
|
|
// +build windows
|
|
|
|
package etw
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/binary"
|
|
"syscall"
|
|
)
|
|
|
|
// eventData maintains a buffer which builds up the data for an ETW event. It
|
|
// needs to be paired with EventMetadata which describes the event.
|
|
type eventData struct {
|
|
buffer bytes.Buffer
|
|
}
|
|
|
|
// toBytes returns the raw binary data containing the event data. The returned
|
|
// value is not copied from the internal buffer, so it can be mutated by the
|
|
// eventData object after it is returned.
|
|
func (ed *eventData) toBytes() []byte {
|
|
return ed.buffer.Bytes()
|
|
}
|
|
|
|
// writeString appends a string, including the null terminator, to the buffer.
|
|
func (ed *eventData) writeString(data string) {
|
|
_, _ = ed.buffer.WriteString(data)
|
|
_ = ed.buffer.WriteByte(0)
|
|
}
|
|
|
|
// writeInt8 appends a int8 to the buffer.
|
|
func (ed *eventData) writeInt8(value int8) {
|
|
_ = ed.buffer.WriteByte(uint8(value))
|
|
}
|
|
|
|
// writeInt16 appends a int16 to the buffer.
|
|
func (ed *eventData) writeInt16(value int16) {
|
|
_ = binary.Write(&ed.buffer, binary.LittleEndian, value)
|
|
}
|
|
|
|
// writeInt32 appends a int32 to the buffer.
|
|
func (ed *eventData) writeInt32(value int32) {
|
|
_ = binary.Write(&ed.buffer, binary.LittleEndian, value)
|
|
}
|
|
|
|
// writeInt64 appends a int64 to the buffer.
|
|
func (ed *eventData) writeInt64(value int64) {
|
|
_ = binary.Write(&ed.buffer, binary.LittleEndian, value)
|
|
}
|
|
|
|
// writeUint8 appends a uint8 to the buffer.
|
|
func (ed *eventData) writeUint8(value uint8) {
|
|
_ = ed.buffer.WriteByte(value)
|
|
}
|
|
|
|
// writeUint16 appends a uint16 to the buffer.
|
|
func (ed *eventData) writeUint16(value uint16) {
|
|
_ = binary.Write(&ed.buffer, binary.LittleEndian, value)
|
|
}
|
|
|
|
// writeUint32 appends a uint32 to the buffer.
|
|
func (ed *eventData) writeUint32(value uint32) {
|
|
_ = binary.Write(&ed.buffer, binary.LittleEndian, value)
|
|
}
|
|
|
|
// writeUint64 appends a uint64 to the buffer.
|
|
func (ed *eventData) writeUint64(value uint64) {
|
|
_ = binary.Write(&ed.buffer, binary.LittleEndian, value)
|
|
}
|
|
|
|
// writeFiletime appends a FILETIME to the buffer.
|
|
func (ed *eventData) writeFiletime(value syscall.Filetime) {
|
|
_ = binary.Write(&ed.buffer, binary.LittleEndian, value)
|
|
}
|