File: windows.lisp

package info (click to toggle)
acl2 8.6%2Bdfsg-2
  • links: PTS
  • area: main
  • in suites: trixie
  • size: 1,111,420 kB
  • sloc: lisp: 17,818,294; java: 125,359; python: 28,122; javascript: 23,458; cpp: 18,851; ansic: 11,569; perl: 7,678; xml: 5,591; sh: 3,976; makefile: 3,833; ruby: 2,633; yacc: 1,126; ml: 763; awk: 295; csh: 233; lex: 197; php: 178; tcl: 49; asm: 23; haskell: 17
file content (259 lines) | stat: -rw-r--r-- 9,969 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
(in-package #:org.shirakumo.fraf.trial.mmap)

(pushnew :mmap *features*)

(defconstant create-new 1)
(defconstant file-attribute-normal 128)
(defconstant file-flag-no-buffering 536870912)
(defconstant file-flag-write-through 2147483648)
(defconstant file-map-copy 1)
(defconstant file-map-execute 32)
(defconstant file-map-read 4)
(defconstant file-map-write 2)
(defconstant file-share-delete 4)
(defconstant file-share-read 1)
(defconstant file-share-write 2)
(defconstant format-message-from-system 4096)
(defconstant format-message-ignore-inserts 512)
(defconstant generic-read 2147483648)
(defconstant generic-write 1073741824)
(defconstant invalid-file-size 4294967295)
(defconstant invalid-handle-value
  (if (boundp 'invalid-handle-value)
      invalid-handle-value
      (if (= 8 (cffi:foreign-type-size :pointer))
          (cffi:make-pointer (ldb (byte 64 0) -1))
          (cffi:make-pointer (ldb (byte 32 0) -1)))))
(defconstant open-always 4)
(defconstant open-existing 3)
(defconstant page-execute-read 32)
(defconstant page-execute-readwrite 64)
(defconstant page-readonly 2)
(defconstant page-readwrite 4)
(defconstant truncate-existing 5)

(cffi:defctype wchar_t :uint16)
(cffi:defctype handle :pointer)
(cffi:defctype lpsecurity-attributes :pointer)
(cffi:defctype dword :uint32)
(cffi:defctype large-integer :uint64)
(cffi:defctype size_t #+x86-64 :uint64 #+x86 :uint32)

;; https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-createfilew
(cffi:defcfun (create-file "CreateFileW") handle
  (path :pointer)
  (access dword)
  (share-mode dword)
  (attributes lpsecurity-attributes)
  (creation-disposition dword)
  (flags-and-attributes dword)
  (template-file handle))

;; https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-getfilesize
(cffi:defcfun (get-file-size-ex "GetFileSizeEx") :boolean
  (file handle)
  (file-size :pointer))

;; https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-createfilemappinga
(cffi:defcfun (create-file-mapping "CreateFileMappingA") handle
  (file handle)
  (attributes lpsecurity-attributes)
  (protect dword)
  (maximum-size-high dword)
  (maximum-size-low dword)
  (name :pointer))

(cffi:defcfun (close-handle "CloseHandle") :boolean
  (object handle))

;; https://msdn.microsoft.com/en-us/library/windows/desktop/aa366761(v=vs.85).aspx
(cffi:defcfun (map-view-of-file "MapViewOfFile") :pointer
  (file-mapping-object handle)
  (desired-access dword)
  (file-offset-high dword)
  (file-offset-low dword)
  (number-of-bytes-to-map size_t))

;; https://msdn.microsoft.com/en-us/library/windows/desktop/aa366882(v=vs.85).aspx
(cffi:defcfun (unmap-view-of-file "UnmapViewOfFile") :boolean
  (base-address :pointer))

;; https://msdn.microsoft.com/en-us/library/windows/desktop/aa366563(v=vs.85).aspx
(cffi:defcfun (flush-view-of-file "FlushViewOfFile") :boolean
  (base-address :pointer)
  (number-of-bytes-to-flush size_t))

;; https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-flushfilebuffers
(cffi:defcfun (flush-file-buffers "FlushFileBuffers") :boolean
  (file handle))

;; https://msdn.microsoft.com/en-us/library/windows/desktop/aa366898(v=vs.85).aspx
(cffi:defcfun (virtual-protect "VirtualProtect") :boolean
  (address :pointer)
  (size size_t)
  (new-protect dword)
  (old-protect :pointer))

(cffi:defcfun (get-last-error "GetLastError") dword)

(cffi:defcfun (format-message "FormatMessageW") dword
  (flags dword)
  (source :pointer)
  (message-id dword)
  (language-id dword)
  (buffer :pointer)
  (size dword)
  (arguments :pointer))

(defmacro check-windows (condition)
  `(unless ,condition
     (let ((errno (get-last-error)))
       (cffi:with-foreign-object (string 'wchar_t 256)
         (format-message (logior format-message-from-system format-message-ignore-inserts)
                         (cffi:null-pointer) errno 0 string 256 (cffi:null-pointer))
         ;; cffi defaults to BE when decoding without BOM, so specify
         ;; LE. Not sure if that is correct for BE windows systems if
         ;; they exist?
         (error-mmap errno (cffi:foreign-string-to-lisp string :encoding :utf-16le))))))

(declaim (inline %mmap))
(defun %mmap (path size offset open-access open-disposition open-flags protection map-access)
  (declare (type fixnum open-access open-disposition open-flags protection map-access offset))
  (declare (optimize speed))
  (let ((fd invalid-handle-value))
    (declare (type (or null (unsigned-byte 64)) size))
    (declare (type cffi:foreign-pointer fd))
    (etypecase path
      (string
       (cffi:with-foreign-string (string path :encoding :utf-16)
         (setf fd (create-file string
                               open-access
                               (logior file-share-delete
                                       file-share-read
                                       file-share-write)
                               (cffi:null-pointer)
                               open-disposition
                               open-flags
                               (cffi:null-pointer))))
       (check-windows (not (cffi:pointer-eq fd invalid-handle-value)))
       (unless size
         (cffi:with-foreign-object (tmp 'large-integer)
           (let ((ret (get-file-size-ex fd tmp)))
             (check-windows ret)
             (setf size (- (cffi:mem-ref tmp 'large-integer) offset))))))
      (null))
    (let* ((end (+ (the (unsigned-byte 64) size) offset))
           (handle (create-file-mapping fd
                                        (cffi:null-pointer)
                                        protection
                                        (ldb (byte 32 32) end)
                                        (ldb (byte 32 0) end)
                                        (cffi:null-pointer)))
           (pointer (map-view-of-file handle
                                      map-access
                                      (ldb (byte 32 32) offset)
                                      (ldb (byte 32 0) offset)
                                      size)))
      (declare (type (unsigned-byte 64) end))
      (handler-bind ((mmap-error (lambda (e)
                                   (declare (ignore e))
                                   (close-handle handle)
                                   (unless (cffi:pointer-eq invalid-handle-value fd)
                                     (close-handle fd)))))
        (check-windows (not (cffi:null-pointer-p pointer)))
        (values pointer (cons fd handle) size)))))

(defun flagp (flags &rest tests)
  (loop for test in tests
        always (find test flags)))

(defmacro set-flag (var flags test value)
  `(when (flagp ,flags ,test)
     (setf ,var (logior ,var ,value))))

(defun translate-open-access (flags)
  (let ((flag 0))
    (or (set-flag flag flags :read generic-read)
        (error "OPEN flags must include :READ."))
    (set-flag flag flags :write generic-write)
    flag))

(defun translate-open-disposition (flags)
  (if (flagp flags :create)
      (if (flagp flags :ensure-create)
          create-new
          open-always)
      (if (flagp flags :truncate)
          truncate-existing
          open-existing)))

(defun translate-open-flags (flags)
  (let ((flag file-attribute-normal))
    (set-flag flag flags :direct file-flag-no-buffering)
    (set-flag flag flags :file-sync file-flag-write-through)
    flag))

(defun translate-protection-flags (flags)
  (cond ((flagp flags :read :write :exec)
         page-execute-readwrite)
        ((flagp flags :read :write)
         page-readwrite)
        ((flagp flags :read :exec)
         page-execute-read)
        ((flagp flags :read)
         page-readonly)
        (T
         (error "PROTECTION flags must include :READ."))))

(defun translate-access-flags (protection flags)
  (let ((flag (if (flagp protection :write)
                  file-map-write
                  file-map-read)))
    (set-flag flag protection :exec file-map-execute)
    (unless (or (set-flag flag flags :private file-map-copy)
                (flagp flags :shared))
      (error "MMAP flags must include either :PRIVATE or :SHARED."))
    flag))

(defun mmap (path &key (open '(:read)) (protection '(:read)) (mmap '(:private)) size (offset 0))
  (%mmap (translate-path path)
         size offset
         (translate-open-access open)
         (translate-open-disposition open)
         (translate-open-flags open)
         (translate-protection-flags protection)
         (translate-access-flags protection mmap)))

(define-compiler-macro mmap (&environment env path &key (open ''(:read)) (protection ''(:read)) (mmap ''(:private)) size (offset 0))
  `(%mmap ,(cfold env `(translate-path ,path) path)
          ,size ,offset
          ,(cfold env `(translate-open-access ,open) open)
          ,(cfold env `(translate-open-disposition ,open) open)
          ,(cfold env `(translate-open-flags ,open) open)
          ,(cfold env `(translate-protection-flags ,protection) protection)
          ,(cfold env `(translate-access-flags ,protection ,mmap) protection mmap)))

(defun munmap (addr fd size)
  (declare (ignore size))
  (check-windows (unmap-view-of-file addr))
  (when fd
    (destructuring-bind (fd . handle) fd
      (check-windows (close-handle handle))
      (check-windows (close-handle fd))))
  NIL)

(defun msync (addr fd size &key (flags '(:sync)))
  (check-windows (flush-view-of-file addr size))
  (when (find :sync flags)
    (check-windows (flush-file-buffers (car fd))))
  NIL)

(defun mprotect (addr size protection)
  (cffi:with-foreign-object (oldprotect 'dword)
    (check-windows (virtual-protect addr size (translate-protection-flags protection) oldprotect))
    NIL))

(define-compiler-macro mprotect (&environment env addr size protection)
  `(cffi:with-foreign-object (oldprotect 'dword)
     (check-windows (virtual-protect ,addr ,size ,(cfold env `(translate-protection-flags ,protection) protection) oldprotect))
     NIL))