annotate vendor/golang.org/x/sys/windows/syscall.go @ 68:4b79810863f6 draft

Ready to release 0.6.0 Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
author yakumo.izuru
date Wed, 13 Sep 2023 10:49:50 +0000
parents 787b5ee0289d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
66
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
1 // Copyright 2009 The Go Authors. All rights reserved.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
2 // Use of this source code is governed by a BSD-style
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
3 // license that can be found in the LICENSE file.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
4
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
5 //go:build windows
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
6 // +build windows
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
7
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
8 // Package windows contains an interface to the low-level operating system
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
9 // primitives. OS details vary depending on the underlying system, and
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
10 // by default, godoc will display the OS-specific documentation for the current
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
11 // system. If you want godoc to display syscall documentation for another
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
12 // system, set $GOOS and $GOARCH to the desired system. For example, if
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
13 // you want to view documentation for freebsd/arm on linux/amd64, set $GOOS
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
14 // to freebsd and $GOARCH to arm.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
15 //
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
16 // The primary use of this package is inside other packages that provide a more
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
17 // portable interface to the system, such as "os", "time" and "net". Use
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
18 // those packages rather than this one if you can.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
19 //
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
20 // For details of the functions and data types in this package consult
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
21 // the manuals for the appropriate operating system.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
22 //
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
23 // These calls return err == nil to indicate success; otherwise
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
24 // err represents an operating system error describing the failure and
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
25 // holds a value of type syscall.Errno.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
26 package windows // import "golang.org/x/sys/windows"
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
27
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
28 import (
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
29 "bytes"
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
30 "strings"
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
31 "syscall"
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
32 "unsafe"
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
33 )
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
34
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
35 // ByteSliceFromString returns a NUL-terminated slice of bytes
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
36 // containing the text of s. If s contains a NUL byte at any
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
37 // location, it returns (nil, syscall.EINVAL).
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
38 func ByteSliceFromString(s string) ([]byte, error) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
39 if strings.IndexByte(s, 0) != -1 {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
40 return nil, syscall.EINVAL
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
41 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
42 a := make([]byte, len(s)+1)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
43 copy(a, s)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
44 return a, nil
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
45 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
46
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
47 // BytePtrFromString returns a pointer to a NUL-terminated array of
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
48 // bytes containing the text of s. If s contains a NUL byte at any
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
49 // location, it returns (nil, syscall.EINVAL).
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
50 func BytePtrFromString(s string) (*byte, error) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
51 a, err := ByteSliceFromString(s)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
52 if err != nil {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
53 return nil, err
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
54 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
55 return &a[0], nil
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
56 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
57
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
58 // ByteSliceToString returns a string form of the text represented by the slice s, with a terminating NUL and any
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
59 // bytes after the NUL removed.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
60 func ByteSliceToString(s []byte) string {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
61 if i := bytes.IndexByte(s, 0); i != -1 {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
62 s = s[:i]
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
63 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
64 return string(s)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
65 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
66
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
67 // BytePtrToString takes a pointer to a sequence of text and returns the corresponding string.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
68 // If the pointer is nil, it returns the empty string. It assumes that the text sequence is terminated
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
69 // at a zero byte; if the zero byte is not present, the program may crash.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
70 func BytePtrToString(p *byte) string {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
71 if p == nil {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
72 return ""
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
73 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
74 if *p == 0 {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
75 return ""
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
76 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
77
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
78 // Find NUL terminator.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
79 n := 0
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
80 for ptr := unsafe.Pointer(p); *(*byte)(ptr) != 0; n++ {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
81 ptr = unsafe.Pointer(uintptr(ptr) + 1)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
82 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
83
68
4b79810863f6 Ready to release 0.6.0
yakumo.izuru
parents: 66
diff changeset
84 return string(unsafe.Slice(p, n))
66
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
85 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
86
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
87 // Single-word zero for use when we need a valid pointer to 0 bytes.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
88 // See mksyscall.pl.
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
89 var _zero uintptr
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
90
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
91 func (ts *Timespec) Unix() (sec int64, nsec int64) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
92 return int64(ts.Sec), int64(ts.Nsec)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
93 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
94
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
95 func (tv *Timeval) Unix() (sec int64, nsec int64) {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
96 return int64(tv.Sec), int64(tv.Usec) * 1000
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
97 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
98
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
99 func (ts *Timespec) Nano() int64 {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
100 return int64(ts.Sec)*1e9 + int64(ts.Nsec)
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
101 }
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
102
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
103 func (tv *Timeval) Nano() int64 {
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
104 return int64(tv.Sec)*1e9 + int64(tv.Usec)*1000
787b5ee0289d Use vendored modules
yakumo.izuru
parents:
diff changeset
105 }