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