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