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