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// Package syscall contains an interface to the low-level operating system
6// primitives. The details vary depending on the underlying system, and
7// by default, godoc will display the syscall documentation for the current
8// system. If you want godoc to display syscall documentation for another
9// system, set $GOOS and $GOARCH to the desired system. For example, if
10// you want to view documentation for freebsd/arm on linux/amd64, set $GOOS
11// to freebsd and $GOARCH to arm.
12// The primary use of syscall is inside other packages that provide a more
13// portable interface to the system, such as "os", "time" and "net".  Use
14// those packages rather than this one if you can.
15// For details of the functions and data types in this package consult
16// the manuals for the appropriate operating system.
17// These calls return err == nil to indicate success; otherwise
18// err is an operating system error describing the failure.
19// On most systems, that error has type syscall.Errno.
20//
21// Deprecated: this package is locked down. Callers should use the
22// corresponding package in the golang.org/x/sys repository instead.
23// That is also where updates required by new systems or versions
24// should be applied. See https://golang.org/s/go1.4-syscall for more
25// information.
26//
27package syscall
28
29import "unsafe"
30
31//go:generate go run ./mksyscall_windows.go -systemdll -output zsyscall_windows.go syscall_windows.go security_windows.go
32
33// StringByteSlice converts a string to a NUL-terminated []byte,
34// If s contains a NUL byte this function panics instead of
35// returning an error.
36//
37// Deprecated: Use ByteSliceFromString instead.
38func StringByteSlice(s string) []byte {
39	a, err := ByteSliceFromString(s)
40	if err != nil {
41		panic("syscall: string with NUL passed to StringByteSlice")
42	}
43	return a
44}
45
46// ByteSliceFromString returns a NUL-terminated slice of bytes
47// containing the text of s. If s contains a NUL byte at any
48// location, it returns (nil, EINVAL).
49func ByteSliceFromString(s string) ([]byte, error) {
50	for i := 0; i < len(s); i++ {
51		if s[i] == 0 {
52			return nil, EINVAL
53		}
54	}
55	a := make([]byte, len(s)+1)
56	copy(a, s)
57	return a, nil
58}
59
60// StringBytePtr returns a pointer to a NUL-terminated array of bytes.
61// If s contains a NUL byte this function panics instead of returning
62// an error.
63//
64// Deprecated: Use BytePtrFromString instead.
65func StringBytePtr(s string) *byte { return &StringByteSlice(s)[0] }
66
67// BytePtrFromString returns a pointer to a NUL-terminated array of
68// bytes containing the text of s. If s contains a NUL byte at any
69// location, it returns (nil, EINVAL).
70func BytePtrFromString(s string) (*byte, error) {
71	a, err := ByteSliceFromString(s)
72	if err != nil {
73		return nil, err
74	}
75	return &a[0], nil
76}
77
78// Single-word zero for use when we need a valid pointer to 0 bytes.
79// See mksyscall.pl.
80var _zero uintptr
81
82var dummy *byte
83
84const sizeofPtr uintptr = uintptr(unsafe.Sizeof(dummy))
85
86// Unix returns the time stored in ts as seconds plus nanoseconds.
87func (ts *Timespec) Unix() (sec int64, nsec int64) {
88	return int64(ts.Sec), int64(ts.Nsec)
89}
90
91// Unix returns the time stored in tv as seconds plus nanoseconds.
92func (tv *Timeval) Unix() (sec int64, nsec int64) {
93	return int64(tv.Sec), int64(tv.Usec) * 1000
94}
95
96// Nano returns the time stored in ts as nanoseconds.
97func (ts *Timespec) Nano() int64 {
98	return int64(ts.Sec)*1e9 + int64(ts.Nsec)
99}
100
101// Nano returns the time stored in tv as nanoseconds.
102func (tv *Timeval) Nano() int64 {
103	return int64(tv.Sec)*1e9 + int64(tv.Usec)*1000
104}
105
106// Getpagesize and Exit are provided by the runtime.
107
108func Getpagesize() int
109func Exit(code int)
110