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