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