Common Lisp通过CFFI操作mmap

;; Load CFFI if not already loaded
(ql:quickload :cffi)

;; Define mmap-prot enum
(cffi:defcenum mmap-prot
  (:none 0)
  (:read 1)
  (:write 2)
  (:read-write 3))

;; Define mmap-struct structure
(cffi:defcstruct mmap-struct
  (addr :pointer)
  (length :size)
  (prot :int)
  (flags :int))

;; Create mmap-struct instance
(defun create-mmap-struct ()
  (cffi:foreign-alloc '(:struct mmap-struct)))

;; Set mmap-struct fields
(defun set-mmap-struct-fields (mmap-struct)
  (setf (cffi:foreign-slot-value mmap-struct '(:struct mmap-struct) 'addr) (cffi:foreign-alloc :pointer))
  (setf (cffi:foreign-slot-value mmap-struct '(:struct mmap-struct) 'length) 4096)
  (setf (cffi:foreign-slot-value mmap-struct '(:struct mmap-struct) 'prot) (cffi:foreign-enum-value 'mmap-prot :read))
  (setf (cffi:foreign-slot-value mmap-struct '(:struct mmap-struct) 'flags) 0))

;; Usage example
(let ((mmap (create-mmap-struct)))
  (set-mmap-struct-fields mmap)
  ;; You can now use mmap for further operations...
  ;; For example, print the fields
  (format t "Address: ~A~%" (cffi:foreign-slot-value mmap '(:struct mmap-struct) 'addr))
  (format t "Length: ~A~%" (cffi:foreign-slot-value mmap '(:struct mmap-struct) 'length))
  (format t "Protection: ~A~%" (cffi:foreign-slot-value mmap '(:struct mmap-struct) 'prot))
  (format t "Flags: ~A~%" (cffi:foreign-slot-value mmap '(:struct mmap-struct) 'flags)))

让我们详细解析上面的 Common Lisp 代码。

1. 加载 CFFI 库

(ql:quickload :cffi)

ql:quickload：这个函数属于 Quicklisp，它用于加载指定的库。在这里，加载的是 CFFI（Common Foreign Function Interface），一个用于与 C 库交互的库。
:cffi：:cffi 是 CFFI 库的名称。通过 ql:quickload，如果 CFFI 还没有安装，它将自动下载并加载它。

2. 定义枚举类型 `mmap-prot`

(cffi:defcenum mmap-prot
  (:none 0)
  (:read 1)
  (:write 2)
  (:read-write 3))

cffi:defcenum：CFFI 的一个宏，用于定义 C 风格的枚举类型。
mmap-prot：枚举的名称，表示内存映射的保护模式。
(:none 0)：定义枚举的第一个值，:none 对应的值是 0。
(:read 1)：:read 表示读权限，对应的值是 1。
(:write 2)：:write 表示写权限，对应的值是 2。
(:read-write 3)：:read-write 表示读写权限，对应的值是 3。

此枚举类型将用于指示内存映射的权限。

3. 定义 C 结构体 `mmap-struct`

(cffi:defcstruct mmap-struct
  (addr :pointer)
  (length :size)
  (prot :int)
  (flags :int))

cffi:defcstruct：定义一个 C 结构体。
mmap-struct：结构体的名称。
(addr :pointer)：addr 是结构体中的第一个字段，它的类型是 :pointer，表示这是一个指针。
(length :size)：length 是结构体中的第二个字段，类型为 :size，表示一个大小（通常是无符号整数类型）。
(prot :int)：prot 是结构体中的第三个字段，类型为 :int，表示一个整数，通常用于存储保护权限。
(flags :int)：flags 是结构体中的第四个字段，类型为 :int，表示标志位。

这个结构体类似于 C 中的结构体，通常用于存储内存映射相关的信息。

4. 创建 `mmap-struct` 实例

(defun create-mmap-struct ()
  (cffi:foreign-alloc '(:struct mmap-struct)))

defun：定义一个函数，函数名是 create-mmap-struct。
cffi:foreign-alloc：这个函数用于在 C 的堆上分配内存。它会分配可以存储 mmap-struct 结构体的内存。
'(:struct mmap-struct)：指定分配的内存类型是一个 mmap-struct 结构体。

这个函数返回的是一个指向分配的内存的指针，该指针将被我们用来访问和操作 mmap-struct 结构体的字段。

5. 设置 `mmap-struct` 的字段

(defun set-mmap-struct-fields (mmap-struct)
  (setf (cffi:foreign-slot-value mmap-struct '(:struct mmap-struct) 'addr) (cffi:foreign-alloc :pointer))
  (setf (cffi:foreign-slot-value mmap-struct '(:struct mmap-struct) 'length) 4096)
  (setf (cffi:foreign-slot-value mmap-struct '(:struct mmap-struct) 'prot) (cffi:foreign-enum-value 'mmap-prot :read))
  (setf (cffi:foreign-slot-value mmap-struct '(:struct mmap-struct) 'flags) 0))

defun：定义一个函数，函数名是 set-mmap-struct-fields。
mmap-struct：这是函数的参数，表示 mmap-struct 结构体的指针。
setf：setf 是 Lisp 的赋值操作符，用于设置某个位置的值。
cffi:foreign-slot-value：这个函数用于访问或修改 C 结构体的字段。
- 第一个参数是 mmap-struct，表示结构体的指针。
- 第二个参数是 (:struct mmap-struct)，它指定了结构体的类型。
- 第三个参数是字段的名称，如 'addr、'length、'prot 和 'flags。
(cffi:foreign-alloc :pointer)：分配一个指针类型的内存块，并将它赋值给 addr 字段。
4096：将 4096 赋值给 length 字段，这通常表示内存映射的大小。
(cffi:foreign-enum-value 'mmap-prot :read)：获取枚举类型 mmap-prot 中 :read 对应的值（即 1），并将它赋值给 prot 字段。
0：将 0 赋值给 flags 字段。

这个函数的作用是：通过传入一个 mmap-struct 的指针，给它的各个字段赋值。

6. 使用示例

(let ((mmap (create-mmap-struct)))
  (set-mmap-struct-fields mmap)
  ;; 你现在可以使用 mmap 进行其他操作
  ;; 例如，打印字段的值
  (format t "Address: ~A~%" (cffi:foreign-slot-value mmap '(:struct mmap-struct) 'addr))
  (format t "Length: ~A~%" (cffi:foreign-slot-value mmap '(:struct mmap-struct) 'length))
  (format t "Protection: ~A~%" (cffi:foreign-slot-value mmap '(:struct mmap-struct) 'prot))
  (format t "Flags: ~A~%" (cffi:foreign-slot-value mmap '(:struct mmap-struct) 'flags)))

let：创建一个局部变量 mmap，并将 create-mmap-struct 的返回值赋值给它。这里 mmap 是指向 mmap-struct 结构体的指针。
(set-mmap-struct-fields mmap)：调用 set-mmap-struct-fields，设置 mmap 结构体的字段。
format：format 是 Lisp 中用于字符串格式化和输出的函数。
t：表示输出到标准输出（通常是控制台）。
"Address: ~A~%"：输出的字符串模板，~A 是一个占位符，表示通用输出（可以是任何类型的对象），~% 表示换行符。
cffi:foreign-slot-value：从 mmap 中读取各个字段的值，分别是 addr、length、prot 和 flags，并输出它们的值。

运行结果：

Address：输出结构体中的 addr 字段的值，这是一个指针。
Length：输出 length 字段的值，即 4096。
Protection：输出 prot 字段的值，即 1（代表 :read 权限）。
Flags：输出 flags 字段的值，即 0。

总结

我们首先定义了一个 mmap-struct 结构体，该结构体包含了指针、长度、权限和标志字段。
然后，我们创建了一个函数 create-mmap-struct 来分配该结构体的内存。
通过 set-mmap-struct-fields 函数，我们设置了结构体的各个字段。
最后，在 let 块中，我们创建并初始化了一个结构体实例，并打印其各个字段的值。

这段代码展示了如何使用 CFFI 在 Lisp 中定义并操作一个 C 风格的结构体。

1. 加载 CFFI 库

2. 定义枚举类型 mmap-prot

3. 定义 C 结构体 mmap-struct

4. 创建 mmap-struct 实例

5. 设置 mmap-struct 的字段