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>
58 lines
2.0 KiB
Go
58 lines
2.0 KiB
Go
/*
|
|
mkwinsyscall generates windows system call bodies
|
|
|
|
It parses all files specified on command line containing function
|
|
prototypes (like syscall_windows.go) and prints system call bodies
|
|
to standard output.
|
|
|
|
The prototypes are marked by lines beginning with "//sys" and read
|
|
like func declarations if //sys is replaced by func, but:
|
|
|
|
- The parameter lists must give a name for each argument. This
|
|
includes return parameters.
|
|
|
|
- The parameter lists must give a type for each argument:
|
|
the (x, y, z int) shorthand is not allowed.
|
|
|
|
- If the return parameter is an error number, it must be named err.
|
|
|
|
- If go func name needs to be different from its winapi dll name,
|
|
the winapi name could be specified at the end, after "=" sign, like
|
|
|
|
//sys LoadLibrary(libname string) (handle uint32, err error) = LoadLibraryA
|
|
|
|
- Each function that returns err needs to supply a condition, that
|
|
return value of winapi will be tested against to detect failure.
|
|
This would set err to windows "last-error", otherwise it will be nil.
|
|
The value can be provided at end of //sys declaration, like
|
|
|
|
//sys LoadLibrary(libname string) (handle uint32, err error) [failretval==-1] = LoadLibraryA
|
|
|
|
and is [failretval==0] by default.
|
|
|
|
- If the function name ends in a "?", then the function not existing is non-
|
|
fatal, and an error will be returned instead of panicking.
|
|
|
|
Usage:
|
|
|
|
mkwinsyscall [flags] [path ...]
|
|
|
|
Flags
|
|
|
|
-output string
|
|
Output file name (standard output if omitted).
|
|
-sort
|
|
Sort DLL and function declarations (default true).
|
|
Intended to help transition from older versions of mkwinsyscall by making diffs
|
|
easier to read and understand.
|
|
-systemdll
|
|
Whether all DLLs should be loaded from the Windows system directory (default true).
|
|
-trace
|
|
Generate print statement after every syscall.
|
|
-utf16
|
|
Encode string arguments as UTF-16 for syscalls not ending in 'A' or 'W' (default true).
|
|
-winio
|
|
Import this package ("github.com/Microsoft/go-winio").
|
|
*/
|
|
package main
|