blob: e3b16c22e17920fe2e610ec7fdc2f23439c23666 [file] [log] [blame]
Zack Williamse940c7a2019-08-21 14:25:39 -07001// Copyright 2009 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
5// Windows system calls.
6
7package windows
8
9import (
10 errorspkg "errors"
11 "sync"
12 "syscall"
David Bainbridge86971522019-09-26 22:09:39 +000013 "time"
Zack Williamse940c7a2019-08-21 14:25:39 -070014 "unicode/utf16"
15 "unsafe"
16)
17
18type Handle uintptr
19
20const (
21 InvalidHandle = ^Handle(0)
22
23 // Flags for DefineDosDevice.
24 DDD_EXACT_MATCH_ON_REMOVE = 0x00000004
25 DDD_NO_BROADCAST_SYSTEM = 0x00000008
26 DDD_RAW_TARGET_PATH = 0x00000001
27 DDD_REMOVE_DEFINITION = 0x00000002
28
29 // Return values for GetDriveType.
30 DRIVE_UNKNOWN = 0
31 DRIVE_NO_ROOT_DIR = 1
32 DRIVE_REMOVABLE = 2
33 DRIVE_FIXED = 3
34 DRIVE_REMOTE = 4
35 DRIVE_CDROM = 5
36 DRIVE_RAMDISK = 6
37
38 // File system flags from GetVolumeInformation and GetVolumeInformationByHandle.
39 FILE_CASE_SENSITIVE_SEARCH = 0x00000001
40 FILE_CASE_PRESERVED_NAMES = 0x00000002
41 FILE_FILE_COMPRESSION = 0x00000010
42 FILE_DAX_VOLUME = 0x20000000
43 FILE_NAMED_STREAMS = 0x00040000
44 FILE_PERSISTENT_ACLS = 0x00000008
45 FILE_READ_ONLY_VOLUME = 0x00080000
46 FILE_SEQUENTIAL_WRITE_ONCE = 0x00100000
47 FILE_SUPPORTS_ENCRYPTION = 0x00020000
48 FILE_SUPPORTS_EXTENDED_ATTRIBUTES = 0x00800000
49 FILE_SUPPORTS_HARD_LINKS = 0x00400000
50 FILE_SUPPORTS_OBJECT_IDS = 0x00010000
51 FILE_SUPPORTS_OPEN_BY_FILE_ID = 0x01000000
52 FILE_SUPPORTS_REPARSE_POINTS = 0x00000080
53 FILE_SUPPORTS_SPARSE_FILES = 0x00000040
54 FILE_SUPPORTS_TRANSACTIONS = 0x00200000
55 FILE_SUPPORTS_USN_JOURNAL = 0x02000000
56 FILE_UNICODE_ON_DISK = 0x00000004
57 FILE_VOLUME_IS_COMPRESSED = 0x00008000
58 FILE_VOLUME_QUOTAS = 0x00000020
59
divyadesai19009132020-03-04 12:58:08 +000060 // Flags for LockFileEx.
61 LOCKFILE_FAIL_IMMEDIATELY = 0x00000001
62 LOCKFILE_EXCLUSIVE_LOCK = 0x00000002
63
Zack Williamse940c7a2019-08-21 14:25:39 -070064 // Return values of SleepEx and other APC functions
65 STATUS_USER_APC = 0x000000C0
66 WAIT_IO_COMPLETION = STATUS_USER_APC
67)
68
69// StringToUTF16 is deprecated. Use UTF16FromString instead.
70// If s contains a NUL byte this function panics instead of
71// returning an error.
72func StringToUTF16(s string) []uint16 {
73 a, err := UTF16FromString(s)
74 if err != nil {
75 panic("windows: string with NUL passed to StringToUTF16")
76 }
77 return a
78}
79
80// UTF16FromString returns the UTF-16 encoding of the UTF-8 string
81// s, with a terminating NUL added. If s contains a NUL byte at any
82// location, it returns (nil, syscall.EINVAL).
83func UTF16FromString(s string) ([]uint16, error) {
84 for i := 0; i < len(s); i++ {
85 if s[i] == 0 {
86 return nil, syscall.EINVAL
87 }
88 }
89 return utf16.Encode([]rune(s + "\x00")), nil
90}
91
92// UTF16ToString returns the UTF-8 encoding of the UTF-16 sequence s,
93// with a terminating NUL removed.
94func UTF16ToString(s []uint16) string {
95 for i, v := range s {
96 if v == 0 {
97 s = s[0:i]
98 break
99 }
100 }
101 return string(utf16.Decode(s))
102}
103
104// StringToUTF16Ptr is deprecated. Use UTF16PtrFromString instead.
105// If s contains a NUL byte this function panics instead of
106// returning an error.
107func StringToUTF16Ptr(s string) *uint16 { return &StringToUTF16(s)[0] }
108
109// UTF16PtrFromString returns pointer to the UTF-16 encoding of
110// the UTF-8 string s, with a terminating NUL added. If s
111// contains a NUL byte at any location, it returns (nil, syscall.EINVAL).
112func UTF16PtrFromString(s string) (*uint16, error) {
113 a, err := UTF16FromString(s)
114 if err != nil {
115 return nil, err
116 }
117 return &a[0], nil
118}
119
120func Getpagesize() int { return 4096 }
121
122// NewCallback converts a Go function to a function pointer conforming to the stdcall calling convention.
123// This is useful when interoperating with Windows code requiring callbacks.
124// The argument is expected to be a function with with one uintptr-sized result. The function must not have arguments with size larger than the size of uintptr.
125func NewCallback(fn interface{}) uintptr {
126 return syscall.NewCallback(fn)
127}
128
129// NewCallbackCDecl converts a Go function to a function pointer conforming to the cdecl calling convention.
130// This is useful when interoperating with Windows code requiring callbacks.
131// The argument is expected to be a function with with one uintptr-sized result. The function must not have arguments with size larger than the size of uintptr.
132func NewCallbackCDecl(fn interface{}) uintptr {
133 return syscall.NewCallbackCDecl(fn)
134}
135
136// windows api calls
137
138//sys GetLastError() (lasterr error)
139//sys LoadLibrary(libname string) (handle Handle, err error) = LoadLibraryW
140//sys LoadLibraryEx(libname string, zero Handle, flags uintptr) (handle Handle, err error) = LoadLibraryExW
141//sys FreeLibrary(handle Handle) (err error)
142//sys GetProcAddress(module Handle, procname string) (proc uintptr, err error)
143//sys GetVersion() (ver uint32, err error)
144//sys FormatMessage(flags uint32, msgsrc uintptr, msgid uint32, langid uint32, buf []uint16, args *byte) (n uint32, err error) = FormatMessageW
145//sys ExitProcess(exitcode uint32)
146//sys IsWow64Process(handle Handle, isWow64 *bool) (err error) = IsWow64Process
147//sys CreateFile(name *uint16, access uint32, mode uint32, sa *SecurityAttributes, createmode uint32, attrs uint32, templatefile Handle) (handle Handle, err error) [failretval==InvalidHandle] = CreateFileW
148//sys ReadFile(handle Handle, buf []byte, done *uint32, overlapped *Overlapped) (err error)
149//sys WriteFile(handle Handle, buf []byte, done *uint32, overlapped *Overlapped) (err error)
150//sys GetOverlappedResult(handle Handle, overlapped *Overlapped, done *uint32, wait bool) (err error)
151//sys SetFilePointer(handle Handle, lowoffset int32, highoffsetptr *int32, whence uint32) (newlowoffset uint32, err error) [failretval==0xffffffff]
152//sys CloseHandle(handle Handle) (err error)
153//sys GetStdHandle(stdhandle uint32) (handle Handle, err error) [failretval==InvalidHandle]
154//sys SetStdHandle(stdhandle uint32, handle Handle) (err error)
155//sys findFirstFile1(name *uint16, data *win32finddata1) (handle Handle, err error) [failretval==InvalidHandle] = FindFirstFileW
156//sys findNextFile1(handle Handle, data *win32finddata1) (err error) = FindNextFileW
157//sys FindClose(handle Handle) (err error)
158//sys GetFileInformationByHandle(handle Handle, data *ByHandleFileInformation) (err error)
159//sys GetFileInformationByHandleEx(handle Handle, class uint32, outBuffer *byte, outBufferLen uint32) (err error)
160//sys GetCurrentDirectory(buflen uint32, buf *uint16) (n uint32, err error) = GetCurrentDirectoryW
161//sys SetCurrentDirectory(path *uint16) (err error) = SetCurrentDirectoryW
162//sys CreateDirectory(path *uint16, sa *SecurityAttributes) (err error) = CreateDirectoryW
163//sys RemoveDirectory(path *uint16) (err error) = RemoveDirectoryW
164//sys DeleteFile(path *uint16) (err error) = DeleteFileW
165//sys MoveFile(from *uint16, to *uint16) (err error) = MoveFileW
166//sys MoveFileEx(from *uint16, to *uint16, flags uint32) (err error) = MoveFileExW
divyadesai19009132020-03-04 12:58:08 +0000167//sys LockFileEx(file Handle, flags uint32, reserved uint32, bytesLow uint32, bytesHigh uint32, overlapped *Overlapped) (err error)
168//sys UnlockFileEx(file Handle, reserved uint32, bytesLow uint32, bytesHigh uint32, overlapped *Overlapped) (err error)
Zack Williamse940c7a2019-08-21 14:25:39 -0700169//sys GetComputerName(buf *uint16, n *uint32) (err error) = GetComputerNameW
170//sys GetComputerNameEx(nametype uint32, buf *uint16, n *uint32) (err error) = GetComputerNameExW
171//sys SetEndOfFile(handle Handle) (err error)
172//sys GetSystemTimeAsFileTime(time *Filetime)
173//sys GetSystemTimePreciseAsFileTime(time *Filetime)
174//sys GetTimeZoneInformation(tzi *Timezoneinformation) (rc uint32, err error) [failretval==0xffffffff]
175//sys CreateIoCompletionPort(filehandle Handle, cphandle Handle, key uint32, threadcnt uint32) (handle Handle, err error)
176//sys GetQueuedCompletionStatus(cphandle Handle, qty *uint32, key *uint32, overlapped **Overlapped, timeout uint32) (err error)
177//sys PostQueuedCompletionStatus(cphandle Handle, qty uint32, key uint32, overlapped *Overlapped) (err error)
178//sys CancelIo(s Handle) (err error)
179//sys CancelIoEx(s Handle, o *Overlapped) (err error)
180//sys CreateProcess(appName *uint16, commandLine *uint16, procSecurity *SecurityAttributes, threadSecurity *SecurityAttributes, inheritHandles bool, creationFlags uint32, env *uint16, currentDir *uint16, startupInfo *StartupInfo, outProcInfo *ProcessInformation) (err error) = CreateProcessW
divyadesai19009132020-03-04 12:58:08 +0000181//sys OpenProcess(desiredAccess uint32, inheritHandle bool, processId uint32) (handle Handle, err error)
Zack Williamse940c7a2019-08-21 14:25:39 -0700182//sys ShellExecute(hwnd Handle, verb *uint16, file *uint16, args *uint16, cwd *uint16, showCmd int32) (err error) = shell32.ShellExecuteW
divyadesai19009132020-03-04 12:58:08 +0000183//sys shGetKnownFolderPath(id *KNOWNFOLDERID, flags uint32, token Token, path **uint16) (ret error) = shell32.SHGetKnownFolderPath
Zack Williamse940c7a2019-08-21 14:25:39 -0700184//sys TerminateProcess(handle Handle, exitcode uint32) (err error)
185//sys GetExitCodeProcess(handle Handle, exitcode *uint32) (err error)
186//sys GetStartupInfo(startupInfo *StartupInfo) (err error) = GetStartupInfoW
Zack Williamse940c7a2019-08-21 14:25:39 -0700187//sys GetProcessTimes(handle Handle, creationTime *Filetime, exitTime *Filetime, kernelTime *Filetime, userTime *Filetime) (err error)
188//sys DuplicateHandle(hSourceProcessHandle Handle, hSourceHandle Handle, hTargetProcessHandle Handle, lpTargetHandle *Handle, dwDesiredAccess uint32, bInheritHandle bool, dwOptions uint32) (err error)
189//sys WaitForSingleObject(handle Handle, waitMilliseconds uint32) (event uint32, err error) [failretval==0xffffffff]
190//sys waitForMultipleObjects(count uint32, handles uintptr, waitAll bool, waitMilliseconds uint32) (event uint32, err error) [failretval==0xffffffff] = WaitForMultipleObjects
191//sys GetTempPath(buflen uint32, buf *uint16) (n uint32, err error) = GetTempPathW
192//sys CreatePipe(readhandle *Handle, writehandle *Handle, sa *SecurityAttributes, size uint32) (err error)
193//sys GetFileType(filehandle Handle) (n uint32, err error)
194//sys CryptAcquireContext(provhandle *Handle, container *uint16, provider *uint16, provtype uint32, flags uint32) (err error) = advapi32.CryptAcquireContextW
195//sys CryptReleaseContext(provhandle Handle, flags uint32) (err error) = advapi32.CryptReleaseContext
196//sys CryptGenRandom(provhandle Handle, buflen uint32, buf *byte) (err error) = advapi32.CryptGenRandom
197//sys GetEnvironmentStrings() (envs *uint16, err error) [failretval==nil] = kernel32.GetEnvironmentStringsW
198//sys FreeEnvironmentStrings(envs *uint16) (err error) = kernel32.FreeEnvironmentStringsW
199//sys GetEnvironmentVariable(name *uint16, buffer *uint16, size uint32) (n uint32, err error) = kernel32.GetEnvironmentVariableW
200//sys SetEnvironmentVariable(name *uint16, value *uint16) (err error) = kernel32.SetEnvironmentVariableW
201//sys CreateEnvironmentBlock(block **uint16, token Token, inheritExisting bool) (err error) = userenv.CreateEnvironmentBlock
202//sys DestroyEnvironmentBlock(block *uint16) (err error) = userenv.DestroyEnvironmentBlock
David Bainbridge86971522019-09-26 22:09:39 +0000203//sys getTickCount64() (ms uint64) = kernel32.GetTickCount64
Zack Williamse940c7a2019-08-21 14:25:39 -0700204//sys SetFileTime(handle Handle, ctime *Filetime, atime *Filetime, wtime *Filetime) (err error)
205//sys GetFileAttributes(name *uint16) (attrs uint32, err error) [failretval==INVALID_FILE_ATTRIBUTES] = kernel32.GetFileAttributesW
206//sys SetFileAttributes(name *uint16, attrs uint32) (err error) = kernel32.SetFileAttributesW
207//sys GetFileAttributesEx(name *uint16, level uint32, info *byte) (err error) = kernel32.GetFileAttributesExW
208//sys GetCommandLine() (cmd *uint16) = kernel32.GetCommandLineW
209//sys CommandLineToArgv(cmd *uint16, argc *int32) (argv *[8192]*[8192]uint16, err error) [failretval==nil] = shell32.CommandLineToArgvW
210//sys LocalFree(hmem Handle) (handle Handle, err error) [failretval!=0]
211//sys SetHandleInformation(handle Handle, mask uint32, flags uint32) (err error)
212//sys FlushFileBuffers(handle Handle) (err error)
213//sys GetFullPathName(path *uint16, buflen uint32, buf *uint16, fname **uint16) (n uint32, err error) = kernel32.GetFullPathNameW
214//sys GetLongPathName(path *uint16, buf *uint16, buflen uint32) (n uint32, err error) = kernel32.GetLongPathNameW
215//sys GetShortPathName(longpath *uint16, shortpath *uint16, buflen uint32) (n uint32, err error) = kernel32.GetShortPathNameW
216//sys CreateFileMapping(fhandle Handle, sa *SecurityAttributes, prot uint32, maxSizeHigh uint32, maxSizeLow uint32, name *uint16) (handle Handle, err error) = kernel32.CreateFileMappingW
217//sys MapViewOfFile(handle Handle, access uint32, offsetHigh uint32, offsetLow uint32, length uintptr) (addr uintptr, err error)
218//sys UnmapViewOfFile(addr uintptr) (err error)
219//sys FlushViewOfFile(addr uintptr, length uintptr) (err error)
220//sys VirtualLock(addr uintptr, length uintptr) (err error)
221//sys VirtualUnlock(addr uintptr, length uintptr) (err error)
222//sys VirtualAlloc(address uintptr, size uintptr, alloctype uint32, protect uint32) (value uintptr, err error) = kernel32.VirtualAlloc
223//sys VirtualFree(address uintptr, size uintptr, freetype uint32) (err error) = kernel32.VirtualFree
224//sys VirtualProtect(address uintptr, size uintptr, newprotect uint32, oldprotect *uint32) (err error) = kernel32.VirtualProtect
225//sys TransmitFile(s Handle, handle Handle, bytesToWrite uint32, bytsPerSend uint32, overlapped *Overlapped, transmitFileBuf *TransmitFileBuffers, flags uint32) (err error) = mswsock.TransmitFile
226//sys ReadDirectoryChanges(handle Handle, buf *byte, buflen uint32, watchSubTree bool, mask uint32, retlen *uint32, overlapped *Overlapped, completionRoutine uintptr) (err error) = kernel32.ReadDirectoryChangesW
227//sys CertOpenSystemStore(hprov Handle, name *uint16) (store Handle, err error) = crypt32.CertOpenSystemStoreW
228//sys CertOpenStore(storeProvider uintptr, msgAndCertEncodingType uint32, cryptProv uintptr, flags uint32, para uintptr) (handle Handle, err error) [failretval==InvalidHandle] = crypt32.CertOpenStore
229//sys CertEnumCertificatesInStore(store Handle, prevContext *CertContext) (context *CertContext, err error) [failretval==nil] = crypt32.CertEnumCertificatesInStore
230//sys CertAddCertificateContextToStore(store Handle, certContext *CertContext, addDisposition uint32, storeContext **CertContext) (err error) = crypt32.CertAddCertificateContextToStore
231//sys CertCloseStore(store Handle, flags uint32) (err error) = crypt32.CertCloseStore
232//sys CertGetCertificateChain(engine Handle, leaf *CertContext, time *Filetime, additionalStore Handle, para *CertChainPara, flags uint32, reserved uintptr, chainCtx **CertChainContext) (err error) = crypt32.CertGetCertificateChain
233//sys CertFreeCertificateChain(ctx *CertChainContext) = crypt32.CertFreeCertificateChain
234//sys CertCreateCertificateContext(certEncodingType uint32, certEncoded *byte, encodedLen uint32) (context *CertContext, err error) [failretval==nil] = crypt32.CertCreateCertificateContext
235//sys CertFreeCertificateContext(ctx *CertContext) (err error) = crypt32.CertFreeCertificateContext
236//sys CertVerifyCertificateChainPolicy(policyOID uintptr, chain *CertChainContext, para *CertChainPolicyPara, status *CertChainPolicyStatus) (err error) = crypt32.CertVerifyCertificateChainPolicy
237//sys RegOpenKeyEx(key Handle, subkey *uint16, options uint32, desiredAccess uint32, result *Handle) (regerrno error) = advapi32.RegOpenKeyExW
238//sys RegCloseKey(key Handle) (regerrno error) = advapi32.RegCloseKey
239//sys RegQueryInfoKey(key Handle, class *uint16, classLen *uint32, reserved *uint32, subkeysLen *uint32, maxSubkeyLen *uint32, maxClassLen *uint32, valuesLen *uint32, maxValueNameLen *uint32, maxValueLen *uint32, saLen *uint32, lastWriteTime *Filetime) (regerrno error) = advapi32.RegQueryInfoKeyW
240//sys RegEnumKeyEx(key Handle, index uint32, name *uint16, nameLen *uint32, reserved *uint32, class *uint16, classLen *uint32, lastWriteTime *Filetime) (regerrno error) = advapi32.RegEnumKeyExW
241//sys RegQueryValueEx(key Handle, name *uint16, reserved *uint32, valtype *uint32, buf *byte, buflen *uint32) (regerrno error) = advapi32.RegQueryValueExW
divyadesai19009132020-03-04 12:58:08 +0000242//sys GetCurrentProcessId() (pid uint32) = kernel32.GetCurrentProcessId
Zack Williamse940c7a2019-08-21 14:25:39 -0700243//sys GetConsoleMode(console Handle, mode *uint32) (err error) = kernel32.GetConsoleMode
244//sys SetConsoleMode(console Handle, mode uint32) (err error) = kernel32.SetConsoleMode
245//sys GetConsoleScreenBufferInfo(console Handle, info *ConsoleScreenBufferInfo) (err error) = kernel32.GetConsoleScreenBufferInfo
246//sys WriteConsole(console Handle, buf *uint16, towrite uint32, written *uint32, reserved *byte) (err error) = kernel32.WriteConsoleW
247//sys ReadConsole(console Handle, buf *uint16, toread uint32, read *uint32, inputControl *byte) (err error) = kernel32.ReadConsoleW
248//sys CreateToolhelp32Snapshot(flags uint32, processId uint32) (handle Handle, err error) [failretval==InvalidHandle] = kernel32.CreateToolhelp32Snapshot
249//sys Process32First(snapshot Handle, procEntry *ProcessEntry32) (err error) = kernel32.Process32FirstW
250//sys Process32Next(snapshot Handle, procEntry *ProcessEntry32) (err error) = kernel32.Process32NextW
divyadesai19009132020-03-04 12:58:08 +0000251//sys Thread32First(snapshot Handle, threadEntry *ThreadEntry32) (err error)
252//sys Thread32Next(snapshot Handle, threadEntry *ThreadEntry32) (err error)
Zack Williamse940c7a2019-08-21 14:25:39 -0700253//sys DeviceIoControl(handle Handle, ioControlCode uint32, inBuffer *byte, inBufferSize uint32, outBuffer *byte, outBufferSize uint32, bytesReturned *uint32, overlapped *Overlapped) (err error)
254// This function returns 1 byte BOOLEAN rather than the 4 byte BOOL.
255//sys CreateSymbolicLink(symlinkfilename *uint16, targetfilename *uint16, flags uint32) (err error) [failretval&0xff==0] = CreateSymbolicLinkW
256//sys CreateHardLink(filename *uint16, existingfilename *uint16, reserved uintptr) (err error) [failretval&0xff==0] = CreateHardLinkW
257//sys GetCurrentThreadId() (id uint32)
258//sys CreateEvent(eventAttrs *SecurityAttributes, manualReset uint32, initialState uint32, name *uint16) (handle Handle, err error) = kernel32.CreateEventW
259//sys CreateEventEx(eventAttrs *SecurityAttributes, name *uint16, flags uint32, desiredAccess uint32) (handle Handle, err error) = kernel32.CreateEventExW
260//sys OpenEvent(desiredAccess uint32, inheritHandle bool, name *uint16) (handle Handle, err error) = kernel32.OpenEventW
261//sys SetEvent(event Handle) (err error) = kernel32.SetEvent
262//sys ResetEvent(event Handle) (err error) = kernel32.ResetEvent
263//sys PulseEvent(event Handle) (err error) = kernel32.PulseEvent
divyadesai19009132020-03-04 12:58:08 +0000264//sys CreateMutex(mutexAttrs *SecurityAttributes, initialOwner bool, name *uint16) (handle Handle, err error) = kernel32.CreateMutexW
265//sys CreateMutexEx(mutexAttrs *SecurityAttributes, name *uint16, flags uint32, desiredAccess uint32) (handle Handle, err error) = kernel32.CreateMutexExW
266//sys OpenMutex(desiredAccess uint32, inheritHandle bool, name *uint16) (handle Handle, err error) = kernel32.OpenMutexW
267//sys ReleaseMutex(mutex Handle) (err error) = kernel32.ReleaseMutex
Zack Williamse940c7a2019-08-21 14:25:39 -0700268//sys SleepEx(milliseconds uint32, alertable bool) (ret uint32) = kernel32.SleepEx
269//sys CreateJobObject(jobAttr *SecurityAttributes, name *uint16) (handle Handle, err error) = kernel32.CreateJobObjectW
270//sys AssignProcessToJobObject(job Handle, process Handle) (err error) = kernel32.AssignProcessToJobObject
271//sys TerminateJobObject(job Handle, exitCode uint32) (err error) = kernel32.TerminateJobObject
272//sys SetErrorMode(mode uint32) (ret uint32) = kernel32.SetErrorMode
273//sys ResumeThread(thread Handle) (ret uint32, err error) [failretval==0xffffffff] = kernel32.ResumeThread
274//sys SetPriorityClass(process Handle, priorityClass uint32) (err error) = kernel32.SetPriorityClass
275//sys GetPriorityClass(process Handle) (ret uint32, err error) = kernel32.GetPriorityClass
276//sys SetInformationJobObject(job Handle, JobObjectInformationClass uint32, JobObjectInformation uintptr, JobObjectInformationLength uint32) (ret int, err error)
David Bainbridge86971522019-09-26 22:09:39 +0000277//sys GenerateConsoleCtrlEvent(ctrlEvent uint32, processGroupID uint32) (err error)
divyadesai19009132020-03-04 12:58:08 +0000278//sys GetProcessId(process Handle) (id uint32, err error)
279//sys OpenThread(desiredAccess uint32, inheritHandle bool, threadId uint32) (handle Handle, err error)
280//sys SetProcessPriorityBoost(process Handle, disable bool) (err error) = kernel32.SetProcessPriorityBoost
Zack Williamse940c7a2019-08-21 14:25:39 -0700281
282// Volume Management Functions
283//sys DefineDosDevice(flags uint32, deviceName *uint16, targetPath *uint16) (err error) = DefineDosDeviceW
284//sys DeleteVolumeMountPoint(volumeMountPoint *uint16) (err error) = DeleteVolumeMountPointW
285//sys FindFirstVolume(volumeName *uint16, bufferLength uint32) (handle Handle, err error) [failretval==InvalidHandle] = FindFirstVolumeW
286//sys FindFirstVolumeMountPoint(rootPathName *uint16, volumeMountPoint *uint16, bufferLength uint32) (handle Handle, err error) [failretval==InvalidHandle] = FindFirstVolumeMountPointW
287//sys FindNextVolume(findVolume Handle, volumeName *uint16, bufferLength uint32) (err error) = FindNextVolumeW
288//sys FindNextVolumeMountPoint(findVolumeMountPoint Handle, volumeMountPoint *uint16, bufferLength uint32) (err error) = FindNextVolumeMountPointW
289//sys FindVolumeClose(findVolume Handle) (err error)
290//sys FindVolumeMountPointClose(findVolumeMountPoint Handle) (err error)
291//sys GetDriveType(rootPathName *uint16) (driveType uint32) = GetDriveTypeW
292//sys GetLogicalDrives() (drivesBitMask uint32, err error) [failretval==0]
293//sys GetLogicalDriveStrings(bufferLength uint32, buffer *uint16) (n uint32, err error) [failretval==0] = GetLogicalDriveStringsW
294//sys GetVolumeInformation(rootPathName *uint16, volumeNameBuffer *uint16, volumeNameSize uint32, volumeNameSerialNumber *uint32, maximumComponentLength *uint32, fileSystemFlags *uint32, fileSystemNameBuffer *uint16, fileSystemNameSize uint32) (err error) = GetVolumeInformationW
295//sys GetVolumeInformationByHandle(file Handle, volumeNameBuffer *uint16, volumeNameSize uint32, volumeNameSerialNumber *uint32, maximumComponentLength *uint32, fileSystemFlags *uint32, fileSystemNameBuffer *uint16, fileSystemNameSize uint32) (err error) = GetVolumeInformationByHandleW
296//sys GetVolumeNameForVolumeMountPoint(volumeMountPoint *uint16, volumeName *uint16, bufferlength uint32) (err error) = GetVolumeNameForVolumeMountPointW
297//sys GetVolumePathName(fileName *uint16, volumePathName *uint16, bufferLength uint32) (err error) = GetVolumePathNameW
298//sys GetVolumePathNamesForVolumeName(volumeName *uint16, volumePathNames *uint16, bufferLength uint32, returnLength *uint32) (err error) = GetVolumePathNamesForVolumeNameW
299//sys QueryDosDevice(deviceName *uint16, targetPath *uint16, max uint32) (n uint32, err error) [failretval==0] = QueryDosDeviceW
300//sys SetVolumeLabel(rootPathName *uint16, volumeName *uint16) (err error) = SetVolumeLabelW
301//sys SetVolumeMountPoint(volumeMountPoint *uint16, volumeName *uint16) (err error) = SetVolumeMountPointW
302//sys MessageBox(hwnd Handle, text *uint16, caption *uint16, boxtype uint32) (ret int32, err error) [failretval==0] = user32.MessageBoxW
divyadesai19009132020-03-04 12:58:08 +0000303//sys ExitWindowsEx(flags uint32, reason uint32) (err error) = user32.ExitWindowsEx
304//sys InitiateSystemShutdownEx(machineName *uint16, message *uint16, timeout uint32, forceAppsClosed bool, rebootAfterShutdown bool, reason uint32) (err error) = advapi32.InitiateSystemShutdownExW
305//sys SetProcessShutdownParameters(level uint32, flags uint32) (err error) = kernel32.SetProcessShutdownParameters
306//sys GetProcessShutdownParameters(level *uint32, flags *uint32) (err error) = kernel32.GetProcessShutdownParameters
307//sys clsidFromString(lpsz *uint16, pclsid *GUID) (ret error) = ole32.CLSIDFromString
308//sys stringFromGUID2(rguid *GUID, lpsz *uint16, cchMax int32) (chars int32) = ole32.StringFromGUID2
309//sys coCreateGuid(pguid *GUID) (ret error) = ole32.CoCreateGuid
310//sys CoTaskMemFree(address unsafe.Pointer) = ole32.CoTaskMemFree
311//sys rtlGetVersion(info *OsVersionInfoEx) (ret error) = ntdll.RtlGetVersion
312//sys rtlGetNtVersionNumbers(majorVersion *uint32, minorVersion *uint32, buildNumber *uint32) = ntdll.RtlGetNtVersionNumbers
Zack Williamse940c7a2019-08-21 14:25:39 -0700313
314// syscall interface implementation for other packages
315
divyadesai19009132020-03-04 12:58:08 +0000316// GetCurrentProcess returns the handle for the current process.
317// It is a pseudo handle that does not need to be closed.
318// The returned error is always nil.
319//
320// Deprecated: use CurrentProcess for the same Handle without the nil
321// error.
322func GetCurrentProcess() (Handle, error) {
323 return CurrentProcess(), nil
324}
325
326// CurrentProcess returns the handle for the current process.
327// It is a pseudo handle that does not need to be closed.
328func CurrentProcess() Handle { return Handle(^uintptr(1 - 1)) }
329
330// GetCurrentThread returns the handle for the current thread.
331// It is a pseudo handle that does not need to be closed.
332// The returned error is always nil.
333//
334// Deprecated: use CurrentThread for the same Handle without the nil
335// error.
336func GetCurrentThread() (Handle, error) {
337 return CurrentThread(), nil
338}
339
340// CurrentThread returns the handle for the current thread.
341// It is a pseudo handle that does not need to be closed.
342func CurrentThread() Handle { return Handle(^uintptr(2 - 1)) }
343
Zack Williamse940c7a2019-08-21 14:25:39 -0700344// GetProcAddressByOrdinal retrieves the address of the exported
345// function from module by ordinal.
346func GetProcAddressByOrdinal(module Handle, ordinal uintptr) (proc uintptr, err error) {
347 r0, _, e1 := syscall.Syscall(procGetProcAddress.Addr(), 2, uintptr(module), ordinal, 0)
348 proc = uintptr(r0)
349 if proc == 0 {
350 if e1 != 0 {
351 err = errnoErr(e1)
352 } else {
353 err = syscall.EINVAL
354 }
355 }
356 return
357}
358
359func Exit(code int) { ExitProcess(uint32(code)) }
360
361func makeInheritSa() *SecurityAttributes {
362 var sa SecurityAttributes
363 sa.Length = uint32(unsafe.Sizeof(sa))
364 sa.InheritHandle = 1
365 return &sa
366}
367
368func Open(path string, mode int, perm uint32) (fd Handle, err error) {
369 if len(path) == 0 {
370 return InvalidHandle, ERROR_FILE_NOT_FOUND
371 }
372 pathp, err := UTF16PtrFromString(path)
373 if err != nil {
374 return InvalidHandle, err
375 }
376 var access uint32
377 switch mode & (O_RDONLY | O_WRONLY | O_RDWR) {
378 case O_RDONLY:
379 access = GENERIC_READ
380 case O_WRONLY:
381 access = GENERIC_WRITE
382 case O_RDWR:
383 access = GENERIC_READ | GENERIC_WRITE
384 }
385 if mode&O_CREAT != 0 {
386 access |= GENERIC_WRITE
387 }
388 if mode&O_APPEND != 0 {
389 access &^= GENERIC_WRITE
390 access |= FILE_APPEND_DATA
391 }
392 sharemode := uint32(FILE_SHARE_READ | FILE_SHARE_WRITE)
393 var sa *SecurityAttributes
394 if mode&O_CLOEXEC == 0 {
395 sa = makeInheritSa()
396 }
397 var createmode uint32
398 switch {
399 case mode&(O_CREAT|O_EXCL) == (O_CREAT | O_EXCL):
400 createmode = CREATE_NEW
401 case mode&(O_CREAT|O_TRUNC) == (O_CREAT | O_TRUNC):
402 createmode = CREATE_ALWAYS
403 case mode&O_CREAT == O_CREAT:
404 createmode = OPEN_ALWAYS
405 case mode&O_TRUNC == O_TRUNC:
406 createmode = TRUNCATE_EXISTING
407 default:
408 createmode = OPEN_EXISTING
409 }
410 h, e := CreateFile(pathp, access, sharemode, sa, createmode, FILE_ATTRIBUTE_NORMAL, 0)
411 return h, e
412}
413
414func Read(fd Handle, p []byte) (n int, err error) {
415 var done uint32
416 e := ReadFile(fd, p, &done, nil)
417 if e != nil {
418 if e == ERROR_BROKEN_PIPE {
419 // NOTE(brainman): work around ERROR_BROKEN_PIPE is returned on reading EOF from stdin
420 return 0, nil
421 }
422 return 0, e
423 }
424 if raceenabled {
425 if done > 0 {
426 raceWriteRange(unsafe.Pointer(&p[0]), int(done))
427 }
428 raceAcquire(unsafe.Pointer(&ioSync))
429 }
430 return int(done), nil
431}
432
433func Write(fd Handle, p []byte) (n int, err error) {
434 if raceenabled {
435 raceReleaseMerge(unsafe.Pointer(&ioSync))
436 }
437 var done uint32
438 e := WriteFile(fd, p, &done, nil)
439 if e != nil {
440 return 0, e
441 }
442 if raceenabled && done > 0 {
443 raceReadRange(unsafe.Pointer(&p[0]), int(done))
444 }
445 return int(done), nil
446}
447
448var ioSync int64
449
450func Seek(fd Handle, offset int64, whence int) (newoffset int64, err error) {
451 var w uint32
452 switch whence {
453 case 0:
454 w = FILE_BEGIN
455 case 1:
456 w = FILE_CURRENT
457 case 2:
458 w = FILE_END
459 }
460 hi := int32(offset >> 32)
461 lo := int32(offset)
462 // use GetFileType to check pipe, pipe can't do seek
463 ft, _ := GetFileType(fd)
464 if ft == FILE_TYPE_PIPE {
465 return 0, syscall.EPIPE
466 }
467 rlo, e := SetFilePointer(fd, lo, &hi, w)
468 if e != nil {
469 return 0, e
470 }
471 return int64(hi)<<32 + int64(rlo), nil
472}
473
474func Close(fd Handle) (err error) {
475 return CloseHandle(fd)
476}
477
478var (
479 Stdin = getStdHandle(STD_INPUT_HANDLE)
480 Stdout = getStdHandle(STD_OUTPUT_HANDLE)
481 Stderr = getStdHandle(STD_ERROR_HANDLE)
482)
483
484func getStdHandle(stdhandle uint32) (fd Handle) {
485 r, _ := GetStdHandle(stdhandle)
486 CloseOnExec(r)
487 return r
488}
489
490const ImplementsGetwd = true
491
492func Getwd() (wd string, err error) {
493 b := make([]uint16, 300)
494 n, e := GetCurrentDirectory(uint32(len(b)), &b[0])
495 if e != nil {
496 return "", e
497 }
498 return string(utf16.Decode(b[0:n])), nil
499}
500
501func Chdir(path string) (err error) {
502 pathp, err := UTF16PtrFromString(path)
503 if err != nil {
504 return err
505 }
506 return SetCurrentDirectory(pathp)
507}
508
509func Mkdir(path string, mode uint32) (err error) {
510 pathp, err := UTF16PtrFromString(path)
511 if err != nil {
512 return err
513 }
514 return CreateDirectory(pathp, nil)
515}
516
517func Rmdir(path string) (err error) {
518 pathp, err := UTF16PtrFromString(path)
519 if err != nil {
520 return err
521 }
522 return RemoveDirectory(pathp)
523}
524
525func Unlink(path string) (err error) {
526 pathp, err := UTF16PtrFromString(path)
527 if err != nil {
528 return err
529 }
530 return DeleteFile(pathp)
531}
532
533func Rename(oldpath, newpath string) (err error) {
534 from, err := UTF16PtrFromString(oldpath)
535 if err != nil {
536 return err
537 }
538 to, err := UTF16PtrFromString(newpath)
539 if err != nil {
540 return err
541 }
542 return MoveFileEx(from, to, MOVEFILE_REPLACE_EXISTING)
543}
544
545func ComputerName() (name string, err error) {
546 var n uint32 = MAX_COMPUTERNAME_LENGTH + 1
547 b := make([]uint16, n)
548 e := GetComputerName(&b[0], &n)
549 if e != nil {
550 return "", e
551 }
552 return string(utf16.Decode(b[0:n])), nil
553}
554
David Bainbridge86971522019-09-26 22:09:39 +0000555func DurationSinceBoot() time.Duration {
556 return time.Duration(getTickCount64()) * time.Millisecond
557}
558
Zack Williamse940c7a2019-08-21 14:25:39 -0700559func Ftruncate(fd Handle, length int64) (err error) {
560 curoffset, e := Seek(fd, 0, 1)
561 if e != nil {
562 return e
563 }
564 defer Seek(fd, curoffset, 0)
565 _, e = Seek(fd, length, 0)
566 if e != nil {
567 return e
568 }
569 e = SetEndOfFile(fd)
570 if e != nil {
571 return e
572 }
573 return nil
574}
575
576func Gettimeofday(tv *Timeval) (err error) {
577 var ft Filetime
578 GetSystemTimeAsFileTime(&ft)
579 *tv = NsecToTimeval(ft.Nanoseconds())
580 return nil
581}
582
583func Pipe(p []Handle) (err error) {
584 if len(p) != 2 {
585 return syscall.EINVAL
586 }
587 var r, w Handle
588 e := CreatePipe(&r, &w, makeInheritSa(), 0)
589 if e != nil {
590 return e
591 }
592 p[0] = r
593 p[1] = w
594 return nil
595}
596
597func Utimes(path string, tv []Timeval) (err error) {
598 if len(tv) != 2 {
599 return syscall.EINVAL
600 }
601 pathp, e := UTF16PtrFromString(path)
602 if e != nil {
603 return e
604 }
605 h, e := CreateFile(pathp,
606 FILE_WRITE_ATTRIBUTES, FILE_SHARE_WRITE, nil,
607 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0)
608 if e != nil {
609 return e
610 }
611 defer Close(h)
612 a := NsecToFiletime(tv[0].Nanoseconds())
613 w := NsecToFiletime(tv[1].Nanoseconds())
614 return SetFileTime(h, nil, &a, &w)
615}
616
617func UtimesNano(path string, ts []Timespec) (err error) {
618 if len(ts) != 2 {
619 return syscall.EINVAL
620 }
621 pathp, e := UTF16PtrFromString(path)
622 if e != nil {
623 return e
624 }
625 h, e := CreateFile(pathp,
626 FILE_WRITE_ATTRIBUTES, FILE_SHARE_WRITE, nil,
627 OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0)
628 if e != nil {
629 return e
630 }
631 defer Close(h)
632 a := NsecToFiletime(TimespecToNsec(ts[0]))
633 w := NsecToFiletime(TimespecToNsec(ts[1]))
634 return SetFileTime(h, nil, &a, &w)
635}
636
637func Fsync(fd Handle) (err error) {
638 return FlushFileBuffers(fd)
639}
640
641func Chmod(path string, mode uint32) (err error) {
642 p, e := UTF16PtrFromString(path)
643 if e != nil {
644 return e
645 }
646 attrs, e := GetFileAttributes(p)
647 if e != nil {
648 return e
649 }
650 if mode&S_IWRITE != 0 {
651 attrs &^= FILE_ATTRIBUTE_READONLY
652 } else {
653 attrs |= FILE_ATTRIBUTE_READONLY
654 }
655 return SetFileAttributes(p, attrs)
656}
657
658func LoadGetSystemTimePreciseAsFileTime() error {
659 return procGetSystemTimePreciseAsFileTime.Find()
660}
661
662func LoadCancelIoEx() error {
663 return procCancelIoEx.Find()
664}
665
666func LoadSetFileCompletionNotificationModes() error {
667 return procSetFileCompletionNotificationModes.Find()
668}
669
670func WaitForMultipleObjects(handles []Handle, waitAll bool, waitMilliseconds uint32) (event uint32, err error) {
671 // Every other win32 array API takes arguments as "pointer, count", except for this function. So we
672 // can't declare it as a usual [] type, because mksyscall will use the opposite order. We therefore
673 // trivially stub this ourselves.
674
675 var handlePtr *Handle
676 if len(handles) > 0 {
677 handlePtr = &handles[0]
678 }
679 return waitForMultipleObjects(uint32(len(handles)), uintptr(unsafe.Pointer(handlePtr)), waitAll, waitMilliseconds)
680}
681
682// net api calls
683
684const socket_error = uintptr(^uint32(0))
685
686//sys WSAStartup(verreq uint32, data *WSAData) (sockerr error) = ws2_32.WSAStartup
687//sys WSACleanup() (err error) [failretval==socket_error] = ws2_32.WSACleanup
688//sys WSAIoctl(s Handle, iocc uint32, inbuf *byte, cbif uint32, outbuf *byte, cbob uint32, cbbr *uint32, overlapped *Overlapped, completionRoutine uintptr) (err error) [failretval==socket_error] = ws2_32.WSAIoctl
689//sys socket(af int32, typ int32, protocol int32) (handle Handle, err error) [failretval==InvalidHandle] = ws2_32.socket
690//sys Setsockopt(s Handle, level int32, optname int32, optval *byte, optlen int32) (err error) [failretval==socket_error] = ws2_32.setsockopt
691//sys Getsockopt(s Handle, level int32, optname int32, optval *byte, optlen *int32) (err error) [failretval==socket_error] = ws2_32.getsockopt
692//sys bind(s Handle, name unsafe.Pointer, namelen int32) (err error) [failretval==socket_error] = ws2_32.bind
693//sys connect(s Handle, name unsafe.Pointer, namelen int32) (err error) [failretval==socket_error] = ws2_32.connect
694//sys getsockname(s Handle, rsa *RawSockaddrAny, addrlen *int32) (err error) [failretval==socket_error] = ws2_32.getsockname
695//sys getpeername(s Handle, rsa *RawSockaddrAny, addrlen *int32) (err error) [failretval==socket_error] = ws2_32.getpeername
696//sys listen(s Handle, backlog int32) (err error) [failretval==socket_error] = ws2_32.listen
697//sys shutdown(s Handle, how int32) (err error) [failretval==socket_error] = ws2_32.shutdown
698//sys Closesocket(s Handle) (err error) [failretval==socket_error] = ws2_32.closesocket
699//sys AcceptEx(ls Handle, as Handle, buf *byte, rxdatalen uint32, laddrlen uint32, raddrlen uint32, recvd *uint32, overlapped *Overlapped) (err error) = mswsock.AcceptEx
700//sys GetAcceptExSockaddrs(buf *byte, rxdatalen uint32, laddrlen uint32, raddrlen uint32, lrsa **RawSockaddrAny, lrsalen *int32, rrsa **RawSockaddrAny, rrsalen *int32) = mswsock.GetAcceptExSockaddrs
701//sys WSARecv(s Handle, bufs *WSABuf, bufcnt uint32, recvd *uint32, flags *uint32, overlapped *Overlapped, croutine *byte) (err error) [failretval==socket_error] = ws2_32.WSARecv
702//sys WSASend(s Handle, bufs *WSABuf, bufcnt uint32, sent *uint32, flags uint32, overlapped *Overlapped, croutine *byte) (err error) [failretval==socket_error] = ws2_32.WSASend
703//sys WSARecvFrom(s Handle, bufs *WSABuf, bufcnt uint32, recvd *uint32, flags *uint32, from *RawSockaddrAny, fromlen *int32, overlapped *Overlapped, croutine *byte) (err error) [failretval==socket_error] = ws2_32.WSARecvFrom
704//sys WSASendTo(s Handle, bufs *WSABuf, bufcnt uint32, sent *uint32, flags uint32, to *RawSockaddrAny, tolen int32, overlapped *Overlapped, croutine *byte) (err error) [failretval==socket_error] = ws2_32.WSASendTo
705//sys GetHostByName(name string) (h *Hostent, err error) [failretval==nil] = ws2_32.gethostbyname
706//sys GetServByName(name string, proto string) (s *Servent, err error) [failretval==nil] = ws2_32.getservbyname
707//sys Ntohs(netshort uint16) (u uint16) = ws2_32.ntohs
708//sys GetProtoByName(name string) (p *Protoent, err error) [failretval==nil] = ws2_32.getprotobyname
709//sys DnsQuery(name string, qtype uint16, options uint32, extra *byte, qrs **DNSRecord, pr *byte) (status error) = dnsapi.DnsQuery_W
710//sys DnsRecordListFree(rl *DNSRecord, freetype uint32) = dnsapi.DnsRecordListFree
711//sys DnsNameCompare(name1 *uint16, name2 *uint16) (same bool) = dnsapi.DnsNameCompare_W
712//sys GetAddrInfoW(nodename *uint16, servicename *uint16, hints *AddrinfoW, result **AddrinfoW) (sockerr error) = ws2_32.GetAddrInfoW
713//sys FreeAddrInfoW(addrinfo *AddrinfoW) = ws2_32.FreeAddrInfoW
714//sys GetIfEntry(pIfRow *MibIfRow) (errcode error) = iphlpapi.GetIfEntry
715//sys GetAdaptersInfo(ai *IpAdapterInfo, ol *uint32) (errcode error) = iphlpapi.GetAdaptersInfo
716//sys SetFileCompletionNotificationModes(handle Handle, flags uint8) (err error) = kernel32.SetFileCompletionNotificationModes
717//sys WSAEnumProtocols(protocols *int32, protocolBuffer *WSAProtocolInfo, bufferLength *uint32) (n int32, err error) [failretval==-1] = ws2_32.WSAEnumProtocolsW
718//sys GetAdaptersAddresses(family uint32, flags uint32, reserved uintptr, adapterAddresses *IpAdapterAddresses, sizePointer *uint32) (errcode error) = iphlpapi.GetAdaptersAddresses
719//sys GetACP() (acp uint32) = kernel32.GetACP
720//sys MultiByteToWideChar(codePage uint32, dwFlags uint32, str *byte, nstr int32, wchar *uint16, nwchar int32) (nwrite int32, err error) = kernel32.MultiByteToWideChar
721
722// For testing: clients can set this flag to force
723// creation of IPv6 sockets to return EAFNOSUPPORT.
724var SocketDisableIPv6 bool
725
726type RawSockaddrInet4 struct {
727 Family uint16
728 Port uint16
729 Addr [4]byte /* in_addr */
730 Zero [8]uint8
731}
732
733type RawSockaddrInet6 struct {
734 Family uint16
735 Port uint16
736 Flowinfo uint32
737 Addr [16]byte /* in6_addr */
738 Scope_id uint32
739}
740
741type RawSockaddr struct {
742 Family uint16
743 Data [14]int8
744}
745
746type RawSockaddrAny struct {
747 Addr RawSockaddr
748 Pad [100]int8
749}
750
751type Sockaddr interface {
752 sockaddr() (ptr unsafe.Pointer, len int32, err error) // lowercase; only we can define Sockaddrs
753}
754
755type SockaddrInet4 struct {
756 Port int
757 Addr [4]byte
758 raw RawSockaddrInet4
759}
760
761func (sa *SockaddrInet4) sockaddr() (unsafe.Pointer, int32, error) {
762 if sa.Port < 0 || sa.Port > 0xFFFF {
763 return nil, 0, syscall.EINVAL
764 }
765 sa.raw.Family = AF_INET
766 p := (*[2]byte)(unsafe.Pointer(&sa.raw.Port))
767 p[0] = byte(sa.Port >> 8)
768 p[1] = byte(sa.Port)
769 for i := 0; i < len(sa.Addr); i++ {
770 sa.raw.Addr[i] = sa.Addr[i]
771 }
772 return unsafe.Pointer(&sa.raw), int32(unsafe.Sizeof(sa.raw)), nil
773}
774
775type SockaddrInet6 struct {
776 Port int
777 ZoneId uint32
778 Addr [16]byte
779 raw RawSockaddrInet6
780}
781
782func (sa *SockaddrInet6) sockaddr() (unsafe.Pointer, int32, error) {
783 if sa.Port < 0 || sa.Port > 0xFFFF {
784 return nil, 0, syscall.EINVAL
785 }
786 sa.raw.Family = AF_INET6
787 p := (*[2]byte)(unsafe.Pointer(&sa.raw.Port))
788 p[0] = byte(sa.Port >> 8)
789 p[1] = byte(sa.Port)
790 sa.raw.Scope_id = sa.ZoneId
791 for i := 0; i < len(sa.Addr); i++ {
792 sa.raw.Addr[i] = sa.Addr[i]
793 }
794 return unsafe.Pointer(&sa.raw), int32(unsafe.Sizeof(sa.raw)), nil
795}
796
797type RawSockaddrUnix struct {
798 Family uint16
799 Path [UNIX_PATH_MAX]int8
800}
801
802type SockaddrUnix struct {
803 Name string
804 raw RawSockaddrUnix
805}
806
807func (sa *SockaddrUnix) sockaddr() (unsafe.Pointer, int32, error) {
808 name := sa.Name
809 n := len(name)
810 if n > len(sa.raw.Path) {
811 return nil, 0, syscall.EINVAL
812 }
813 if n == len(sa.raw.Path) && name[0] != '@' {
814 return nil, 0, syscall.EINVAL
815 }
816 sa.raw.Family = AF_UNIX
817 for i := 0; i < n; i++ {
818 sa.raw.Path[i] = int8(name[i])
819 }
820 // length is family (uint16), name, NUL.
821 sl := int32(2)
822 if n > 0 {
823 sl += int32(n) + 1
824 }
825 if sa.raw.Path[0] == '@' {
826 sa.raw.Path[0] = 0
827 // Don't count trailing NUL for abstract address.
828 sl--
829 }
830
831 return unsafe.Pointer(&sa.raw), sl, nil
832}
833
834func (rsa *RawSockaddrAny) Sockaddr() (Sockaddr, error) {
835 switch rsa.Addr.Family {
836 case AF_UNIX:
837 pp := (*RawSockaddrUnix)(unsafe.Pointer(rsa))
838 sa := new(SockaddrUnix)
839 if pp.Path[0] == 0 {
840 // "Abstract" Unix domain socket.
841 // Rewrite leading NUL as @ for textual display.
842 // (This is the standard convention.)
843 // Not friendly to overwrite in place,
844 // but the callers below don't care.
845 pp.Path[0] = '@'
846 }
847
848 // Assume path ends at NUL.
849 // This is not technically the Linux semantics for
850 // abstract Unix domain sockets--they are supposed
851 // to be uninterpreted fixed-size binary blobs--but
852 // everyone uses this convention.
853 n := 0
854 for n < len(pp.Path) && pp.Path[n] != 0 {
855 n++
856 }
857 bytes := (*[10000]byte)(unsafe.Pointer(&pp.Path[0]))[0:n]
858 sa.Name = string(bytes)
859 return sa, nil
860
861 case AF_INET:
862 pp := (*RawSockaddrInet4)(unsafe.Pointer(rsa))
863 sa := new(SockaddrInet4)
864 p := (*[2]byte)(unsafe.Pointer(&pp.Port))
865 sa.Port = int(p[0])<<8 + int(p[1])
866 for i := 0; i < len(sa.Addr); i++ {
867 sa.Addr[i] = pp.Addr[i]
868 }
869 return sa, nil
870
871 case AF_INET6:
872 pp := (*RawSockaddrInet6)(unsafe.Pointer(rsa))
873 sa := new(SockaddrInet6)
874 p := (*[2]byte)(unsafe.Pointer(&pp.Port))
875 sa.Port = int(p[0])<<8 + int(p[1])
876 sa.ZoneId = pp.Scope_id
877 for i := 0; i < len(sa.Addr); i++ {
878 sa.Addr[i] = pp.Addr[i]
879 }
880 return sa, nil
881 }
882 return nil, syscall.EAFNOSUPPORT
883}
884
885func Socket(domain, typ, proto int) (fd Handle, err error) {
886 if domain == AF_INET6 && SocketDisableIPv6 {
887 return InvalidHandle, syscall.EAFNOSUPPORT
888 }
889 return socket(int32(domain), int32(typ), int32(proto))
890}
891
892func SetsockoptInt(fd Handle, level, opt int, value int) (err error) {
893 v := int32(value)
894 return Setsockopt(fd, int32(level), int32(opt), (*byte)(unsafe.Pointer(&v)), int32(unsafe.Sizeof(v)))
895}
896
897func Bind(fd Handle, sa Sockaddr) (err error) {
898 ptr, n, err := sa.sockaddr()
899 if err != nil {
900 return err
901 }
902 return bind(fd, ptr, n)
903}
904
905func Connect(fd Handle, sa Sockaddr) (err error) {
906 ptr, n, err := sa.sockaddr()
907 if err != nil {
908 return err
909 }
910 return connect(fd, ptr, n)
911}
912
913func Getsockname(fd Handle) (sa Sockaddr, err error) {
914 var rsa RawSockaddrAny
915 l := int32(unsafe.Sizeof(rsa))
916 if err = getsockname(fd, &rsa, &l); err != nil {
917 return
918 }
919 return rsa.Sockaddr()
920}
921
922func Getpeername(fd Handle) (sa Sockaddr, err error) {
923 var rsa RawSockaddrAny
924 l := int32(unsafe.Sizeof(rsa))
925 if err = getpeername(fd, &rsa, &l); err != nil {
926 return
927 }
928 return rsa.Sockaddr()
929}
930
931func Listen(s Handle, n int) (err error) {
932 return listen(s, int32(n))
933}
934
935func Shutdown(fd Handle, how int) (err error) {
936 return shutdown(fd, int32(how))
937}
938
939func WSASendto(s Handle, bufs *WSABuf, bufcnt uint32, sent *uint32, flags uint32, to Sockaddr, overlapped *Overlapped, croutine *byte) (err error) {
940 rsa, l, err := to.sockaddr()
941 if err != nil {
942 return err
943 }
944 return WSASendTo(s, bufs, bufcnt, sent, flags, (*RawSockaddrAny)(unsafe.Pointer(rsa)), l, overlapped, croutine)
945}
946
947func LoadGetAddrInfo() error {
948 return procGetAddrInfoW.Find()
949}
950
951var connectExFunc struct {
952 once sync.Once
953 addr uintptr
954 err error
955}
956
957func LoadConnectEx() error {
958 connectExFunc.once.Do(func() {
959 var s Handle
960 s, connectExFunc.err = Socket(AF_INET, SOCK_STREAM, IPPROTO_TCP)
961 if connectExFunc.err != nil {
962 return
963 }
964 defer CloseHandle(s)
965 var n uint32
966 connectExFunc.err = WSAIoctl(s,
967 SIO_GET_EXTENSION_FUNCTION_POINTER,
968 (*byte)(unsafe.Pointer(&WSAID_CONNECTEX)),
969 uint32(unsafe.Sizeof(WSAID_CONNECTEX)),
970 (*byte)(unsafe.Pointer(&connectExFunc.addr)),
971 uint32(unsafe.Sizeof(connectExFunc.addr)),
972 &n, nil, 0)
973 })
974 return connectExFunc.err
975}
976
977func connectEx(s Handle, name unsafe.Pointer, namelen int32, sendBuf *byte, sendDataLen uint32, bytesSent *uint32, overlapped *Overlapped) (err error) {
978 r1, _, e1 := syscall.Syscall9(connectExFunc.addr, 7, uintptr(s), uintptr(name), uintptr(namelen), uintptr(unsafe.Pointer(sendBuf)), uintptr(sendDataLen), uintptr(unsafe.Pointer(bytesSent)), uintptr(unsafe.Pointer(overlapped)), 0, 0)
979 if r1 == 0 {
980 if e1 != 0 {
981 err = error(e1)
982 } else {
983 err = syscall.EINVAL
984 }
985 }
986 return
987}
988
989func ConnectEx(fd Handle, sa Sockaddr, sendBuf *byte, sendDataLen uint32, bytesSent *uint32, overlapped *Overlapped) error {
990 err := LoadConnectEx()
991 if err != nil {
992 return errorspkg.New("failed to find ConnectEx: " + err.Error())
993 }
994 ptr, n, err := sa.sockaddr()
995 if err != nil {
996 return err
997 }
998 return connectEx(fd, ptr, n, sendBuf, sendDataLen, bytesSent, overlapped)
999}
1000
1001var sendRecvMsgFunc struct {
1002 once sync.Once
1003 sendAddr uintptr
1004 recvAddr uintptr
1005 err error
1006}
1007
1008func loadWSASendRecvMsg() error {
1009 sendRecvMsgFunc.once.Do(func() {
1010 var s Handle
1011 s, sendRecvMsgFunc.err = Socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP)
1012 if sendRecvMsgFunc.err != nil {
1013 return
1014 }
1015 defer CloseHandle(s)
1016 var n uint32
1017 sendRecvMsgFunc.err = WSAIoctl(s,
1018 SIO_GET_EXTENSION_FUNCTION_POINTER,
1019 (*byte)(unsafe.Pointer(&WSAID_WSARECVMSG)),
1020 uint32(unsafe.Sizeof(WSAID_WSARECVMSG)),
1021 (*byte)(unsafe.Pointer(&sendRecvMsgFunc.recvAddr)),
1022 uint32(unsafe.Sizeof(sendRecvMsgFunc.recvAddr)),
1023 &n, nil, 0)
1024 if sendRecvMsgFunc.err != nil {
1025 return
1026 }
1027 sendRecvMsgFunc.err = WSAIoctl(s,
1028 SIO_GET_EXTENSION_FUNCTION_POINTER,
1029 (*byte)(unsafe.Pointer(&WSAID_WSASENDMSG)),
1030 uint32(unsafe.Sizeof(WSAID_WSASENDMSG)),
1031 (*byte)(unsafe.Pointer(&sendRecvMsgFunc.sendAddr)),
1032 uint32(unsafe.Sizeof(sendRecvMsgFunc.sendAddr)),
1033 &n, nil, 0)
1034 })
1035 return sendRecvMsgFunc.err
1036}
1037
1038func WSASendMsg(fd Handle, msg *WSAMsg, flags uint32, bytesSent *uint32, overlapped *Overlapped, croutine *byte) error {
1039 err := loadWSASendRecvMsg()
1040 if err != nil {
1041 return err
1042 }
1043 r1, _, e1 := syscall.Syscall6(sendRecvMsgFunc.sendAddr, 6, uintptr(fd), uintptr(unsafe.Pointer(msg)), uintptr(flags), uintptr(unsafe.Pointer(bytesSent)), uintptr(unsafe.Pointer(overlapped)), uintptr(unsafe.Pointer(croutine)))
1044 if r1 == socket_error {
1045 if e1 != 0 {
1046 err = errnoErr(e1)
1047 } else {
1048 err = syscall.EINVAL
1049 }
1050 }
1051 return err
1052}
1053
1054func WSARecvMsg(fd Handle, msg *WSAMsg, bytesReceived *uint32, overlapped *Overlapped, croutine *byte) error {
1055 err := loadWSASendRecvMsg()
1056 if err != nil {
1057 return err
1058 }
1059 r1, _, e1 := syscall.Syscall6(sendRecvMsgFunc.recvAddr, 5, uintptr(fd), uintptr(unsafe.Pointer(msg)), uintptr(unsafe.Pointer(bytesReceived)), uintptr(unsafe.Pointer(overlapped)), uintptr(unsafe.Pointer(croutine)), 0)
1060 if r1 == socket_error {
1061 if e1 != 0 {
1062 err = errnoErr(e1)
1063 } else {
1064 err = syscall.EINVAL
1065 }
1066 }
1067 return err
1068}
1069
1070// Invented structures to support what package os expects.
1071type Rusage struct {
1072 CreationTime Filetime
1073 ExitTime Filetime
1074 KernelTime Filetime
1075 UserTime Filetime
1076}
1077
1078type WaitStatus struct {
1079 ExitCode uint32
1080}
1081
1082func (w WaitStatus) Exited() bool { return true }
1083
1084func (w WaitStatus) ExitStatus() int { return int(w.ExitCode) }
1085
1086func (w WaitStatus) Signal() Signal { return -1 }
1087
1088func (w WaitStatus) CoreDump() bool { return false }
1089
1090func (w WaitStatus) Stopped() bool { return false }
1091
1092func (w WaitStatus) Continued() bool { return false }
1093
1094func (w WaitStatus) StopSignal() Signal { return -1 }
1095
1096func (w WaitStatus) Signaled() bool { return false }
1097
1098func (w WaitStatus) TrapCause() int { return -1 }
1099
1100// Timespec is an invented structure on Windows, but here for
1101// consistency with the corresponding package for other operating systems.
1102type Timespec struct {
1103 Sec int64
1104 Nsec int64
1105}
1106
1107func TimespecToNsec(ts Timespec) int64 { return int64(ts.Sec)*1e9 + int64(ts.Nsec) }
1108
1109func NsecToTimespec(nsec int64) (ts Timespec) {
1110 ts.Sec = nsec / 1e9
1111 ts.Nsec = nsec % 1e9
1112 return
1113}
1114
1115// TODO(brainman): fix all needed for net
1116
1117func Accept(fd Handle) (nfd Handle, sa Sockaddr, err error) { return 0, nil, syscall.EWINDOWS }
1118func Recvfrom(fd Handle, p []byte, flags int) (n int, from Sockaddr, err error) {
1119 return 0, nil, syscall.EWINDOWS
1120}
1121func Sendto(fd Handle, p []byte, flags int, to Sockaddr) (err error) { return syscall.EWINDOWS }
1122func SetsockoptTimeval(fd Handle, level, opt int, tv *Timeval) (err error) { return syscall.EWINDOWS }
1123
1124// The Linger struct is wrong but we only noticed after Go 1.
1125// sysLinger is the real system call structure.
1126
1127// BUG(brainman): The definition of Linger is not appropriate for direct use
1128// with Setsockopt and Getsockopt.
1129// Use SetsockoptLinger instead.
1130
1131type Linger struct {
1132 Onoff int32
1133 Linger int32
1134}
1135
1136type sysLinger struct {
1137 Onoff uint16
1138 Linger uint16
1139}
1140
1141type IPMreq struct {
1142 Multiaddr [4]byte /* in_addr */
1143 Interface [4]byte /* in_addr */
1144}
1145
1146type IPv6Mreq struct {
1147 Multiaddr [16]byte /* in6_addr */
1148 Interface uint32
1149}
1150
1151func GetsockoptInt(fd Handle, level, opt int) (int, error) { return -1, syscall.EWINDOWS }
1152
1153func SetsockoptLinger(fd Handle, level, opt int, l *Linger) (err error) {
1154 sys := sysLinger{Onoff: uint16(l.Onoff), Linger: uint16(l.Linger)}
1155 return Setsockopt(fd, int32(level), int32(opt), (*byte)(unsafe.Pointer(&sys)), int32(unsafe.Sizeof(sys)))
1156}
1157
1158func SetsockoptInet4Addr(fd Handle, level, opt int, value [4]byte) (err error) {
1159 return Setsockopt(fd, int32(level), int32(opt), (*byte)(unsafe.Pointer(&value[0])), 4)
1160}
1161func SetsockoptIPMreq(fd Handle, level, opt int, mreq *IPMreq) (err error) {
1162 return Setsockopt(fd, int32(level), int32(opt), (*byte)(unsafe.Pointer(mreq)), int32(unsafe.Sizeof(*mreq)))
1163}
1164func SetsockoptIPv6Mreq(fd Handle, level, opt int, mreq *IPv6Mreq) (err error) {
1165 return syscall.EWINDOWS
1166}
1167
divyadesai19009132020-03-04 12:58:08 +00001168func Getpid() (pid int) { return int(GetCurrentProcessId()) }
Zack Williamse940c7a2019-08-21 14:25:39 -07001169
1170func FindFirstFile(name *uint16, data *Win32finddata) (handle Handle, err error) {
1171 // NOTE(rsc): The Win32finddata struct is wrong for the system call:
1172 // the two paths are each one uint16 short. Use the correct struct,
1173 // a win32finddata1, and then copy the results out.
1174 // There is no loss of expressivity here, because the final
1175 // uint16, if it is used, is supposed to be a NUL, and Go doesn't need that.
1176 // For Go 1.1, we might avoid the allocation of win32finddata1 here
1177 // by adding a final Bug [2]uint16 field to the struct and then
1178 // adjusting the fields in the result directly.
1179 var data1 win32finddata1
1180 handle, err = findFirstFile1(name, &data1)
1181 if err == nil {
1182 copyFindData(data, &data1)
1183 }
1184 return
1185}
1186
1187func FindNextFile(handle Handle, data *Win32finddata) (err error) {
1188 var data1 win32finddata1
1189 err = findNextFile1(handle, &data1)
1190 if err == nil {
1191 copyFindData(data, &data1)
1192 }
1193 return
1194}
1195
1196func getProcessEntry(pid int) (*ProcessEntry32, error) {
1197 snapshot, err := CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0)
1198 if err != nil {
1199 return nil, err
1200 }
1201 defer CloseHandle(snapshot)
1202 var procEntry ProcessEntry32
1203 procEntry.Size = uint32(unsafe.Sizeof(procEntry))
1204 if err = Process32First(snapshot, &procEntry); err != nil {
1205 return nil, err
1206 }
1207 for {
1208 if procEntry.ProcessID == uint32(pid) {
1209 return &procEntry, nil
1210 }
1211 err = Process32Next(snapshot, &procEntry)
1212 if err != nil {
1213 return nil, err
1214 }
1215 }
1216}
1217
1218func Getppid() (ppid int) {
1219 pe, err := getProcessEntry(Getpid())
1220 if err != nil {
1221 return -1
1222 }
1223 return int(pe.ParentProcessID)
1224}
1225
1226// TODO(brainman): fix all needed for os
1227func Fchdir(fd Handle) (err error) { return syscall.EWINDOWS }
1228func Link(oldpath, newpath string) (err error) { return syscall.EWINDOWS }
1229func Symlink(path, link string) (err error) { return syscall.EWINDOWS }
1230
1231func Fchmod(fd Handle, mode uint32) (err error) { return syscall.EWINDOWS }
1232func Chown(path string, uid int, gid int) (err error) { return syscall.EWINDOWS }
1233func Lchown(path string, uid int, gid int) (err error) { return syscall.EWINDOWS }
1234func Fchown(fd Handle, uid int, gid int) (err error) { return syscall.EWINDOWS }
1235
1236func Getuid() (uid int) { return -1 }
1237func Geteuid() (euid int) { return -1 }
1238func Getgid() (gid int) { return -1 }
1239func Getegid() (egid int) { return -1 }
1240func Getgroups() (gids []int, err error) { return nil, syscall.EWINDOWS }
1241
1242type Signal int
1243
1244func (s Signal) Signal() {}
1245
1246func (s Signal) String() string {
1247 if 0 <= s && int(s) < len(signals) {
1248 str := signals[s]
1249 if str != "" {
1250 return str
1251 }
1252 }
1253 return "signal " + itoa(int(s))
1254}
1255
1256func LoadCreateSymbolicLink() error {
1257 return procCreateSymbolicLinkW.Find()
1258}
1259
1260// Readlink returns the destination of the named symbolic link.
1261func Readlink(path string, buf []byte) (n int, err error) {
1262 fd, err := CreateFile(StringToUTF16Ptr(path), GENERIC_READ, 0, nil, OPEN_EXISTING,
1263 FILE_FLAG_OPEN_REPARSE_POINT|FILE_FLAG_BACKUP_SEMANTICS, 0)
1264 if err != nil {
1265 return -1, err
1266 }
1267 defer CloseHandle(fd)
1268
1269 rdbbuf := make([]byte, MAXIMUM_REPARSE_DATA_BUFFER_SIZE)
1270 var bytesReturned uint32
1271 err = DeviceIoControl(fd, FSCTL_GET_REPARSE_POINT, nil, 0, &rdbbuf[0], uint32(len(rdbbuf)), &bytesReturned, nil)
1272 if err != nil {
1273 return -1, err
1274 }
1275
1276 rdb := (*reparseDataBuffer)(unsafe.Pointer(&rdbbuf[0]))
1277 var s string
1278 switch rdb.ReparseTag {
1279 case IO_REPARSE_TAG_SYMLINK:
1280 data := (*symbolicLinkReparseBuffer)(unsafe.Pointer(&rdb.reparseBuffer))
1281 p := (*[0xffff]uint16)(unsafe.Pointer(&data.PathBuffer[0]))
1282 s = UTF16ToString(p[data.PrintNameOffset/2 : (data.PrintNameLength-data.PrintNameOffset)/2])
1283 case IO_REPARSE_TAG_MOUNT_POINT:
1284 data := (*mountPointReparseBuffer)(unsafe.Pointer(&rdb.reparseBuffer))
1285 p := (*[0xffff]uint16)(unsafe.Pointer(&data.PathBuffer[0]))
1286 s = UTF16ToString(p[data.PrintNameOffset/2 : (data.PrintNameLength-data.PrintNameOffset)/2])
1287 default:
1288 // the path is not a symlink or junction but another type of reparse
1289 // point
1290 return -1, syscall.ENOENT
1291 }
1292 n = copy(buf, []byte(s))
1293
1294 return n, nil
1295}
divyadesai19009132020-03-04 12:58:08 +00001296
1297// GUIDFromString parses a string in the form of
1298// "{XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}" into a GUID.
1299func GUIDFromString(str string) (GUID, error) {
1300 guid := GUID{}
1301 str16, err := syscall.UTF16PtrFromString(str)
1302 if err != nil {
1303 return guid, err
1304 }
1305 err = clsidFromString(str16, &guid)
1306 if err != nil {
1307 return guid, err
1308 }
1309 return guid, nil
1310}
1311
1312// GenerateGUID creates a new random GUID.
1313func GenerateGUID() (GUID, error) {
1314 guid := GUID{}
1315 err := coCreateGuid(&guid)
1316 if err != nil {
1317 return guid, err
1318 }
1319 return guid, nil
1320}
1321
1322// String returns the canonical string form of the GUID,
1323// in the form of "{XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}".
1324func (guid GUID) String() string {
1325 var str [100]uint16
1326 chars := stringFromGUID2(&guid, &str[0], int32(len(str)))
1327 if chars <= 1 {
1328 return ""
1329 }
1330 return string(utf16.Decode(str[:chars-1]))
1331}
1332
1333// KnownFolderPath returns a well-known folder path for the current user, specified by one of
1334// the FOLDERID_ constants, and chosen and optionally created based on a KF_ flag.
1335func KnownFolderPath(folderID *KNOWNFOLDERID, flags uint32) (string, error) {
1336 return Token(0).KnownFolderPath(folderID, flags)
1337}
1338
1339// KnownFolderPath returns a well-known folder path for the user token, specified by one of
1340// the FOLDERID_ constants, and chosen and optionally created based on a KF_ flag.
1341func (t Token) KnownFolderPath(folderID *KNOWNFOLDERID, flags uint32) (string, error) {
1342 var p *uint16
1343 err := shGetKnownFolderPath(folderID, flags, t, &p)
1344 if err != nil {
1345 return "", err
1346 }
1347 defer CoTaskMemFree(unsafe.Pointer(p))
1348 return UTF16ToString((*[(1 << 30) - 1]uint16)(unsafe.Pointer(p))[:]), nil
1349}
1350
1351// RtlGetVersion returns the version of the underlying operating system, ignoring
1352// manifest semantics but is affected by the application compatibility layer.
1353func RtlGetVersion() *OsVersionInfoEx {
1354 info := &OsVersionInfoEx{}
1355 info.osVersionInfoSize = uint32(unsafe.Sizeof(*info))
1356 // According to documentation, this function always succeeds.
1357 // The function doesn't even check the validity of the
1358 // osVersionInfoSize member. Disassembling ntdll.dll indicates
1359 // that the documentation is indeed correct about that.
1360 _ = rtlGetVersion(info)
1361 return info
1362}
1363
1364// RtlGetNtVersionNumbers returns the version of the underlying operating system,
1365// ignoring manifest semantics and the application compatibility layer.
1366func RtlGetNtVersionNumbers() (majorVersion, minorVersion, buildNumber uint32) {
1367 rtlGetNtVersionNumbers(&majorVersion, &minorVersion, &buildNumber)
1368 buildNumber &= 0xffff
1369 return
1370}