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