LMMP 4.3.0
Lamina High-Precision Arithmetic Library
载入中...
搜索中...
未找到
lmmp.h
浏览该文件的文档.
1/**
2 * Copyright (C) 2026 HJimmyK (Jericho Knox)
3 *
4 * This file is part of LMMP.
5 *
6 * LMMP is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU Lesser General Public License as
8 * published by the Free Software Foundation; either version 3 of
9 * the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library. If not, see
18 * <https://www.gnu.org/licenses/>.
19 *
20 * SPDX-License-Identifier: LGPL-3.0-or-later
21 */
22
23#ifndef LMMP_LMMP_H
24#define LMMP_LMMP_H
25
26/*
27 本库的实现部分灵感来源于或改编自
28
29 GNU-MP (https://gmplib.org/),
30 FLINT (https://www.flintlib.org/),
31
32 符号说明:
33
34 B 基数,已被硬编码为 2^64
35
36 [p,n,b] 表示指针p指向的、以b为基数的n位数
37 p[i-1] 代表其第i位最低有效位 (0<i<=n)
38 如果省略b,则默认基数为B。通常情况下,
39 用此符号表示函数参数时,一般暗指高位不存在0,
40 在不太严格场景中,比如乘法和加减法中,即使存在高位0
41 通常也不会导致错误,在严格的除法或者其他运算中,会强调
42 高位不能是0。
43 用此符号表示函数返回值时,也表示将会写入的区间,
44 即使可能写入为0。
45
46 sep 指针指向的内存区域完全分离
47
48 eqsep 完全相同的内存区域或者完全分离
49
50 备注:我们都假定地址是向上增长的,dst <= num+1
51 的内存布局可以这样表示
52 dst ──┐
53 num ──┐ |00000000|00000000|
54 |********|********|
55
56 MSB(x) x的最高有效位,比如最高有效位为1,MSB(x)=1
57 代表 x >= B / 2
58
59 [x|y] x或y,用于表示参数或返回值的取值范围
60
61*/
62
63#include <stddef.h>
64#include <stdint.h>
65#include <stdlib.h>
66#include <string.h>
67
68#ifdef __cplusplus
69extern "C" {
70#endif
71
72#if defined(LMMP_WINDOWS)
73 // Windows: MinGW GCC / GNU-driver clang
74 #if defined(LIBLMMP_EXPORTS)
75 #define LMMP_API __declspec(dllexport)
76 #else
77 #define LMMP_API __declspec(dllimport)
78 #endif
79#else
80 // Linux/macOS: GCC / Clang
81 #define LMMP_API __attribute__((visibility("default")))
82#endif
83
84#if defined(LMMP_ASM)
85#if defined(LMMP_ASM_X64) || defined(LMMP_ASM_ARM64)
86#else
87#error "LMMP_ASM is only supported on x86_64 or arm64 platforms"
88#endif
89#endif
90
91typedef uint8_t mp_byte_t; // 字节类型 (8位无符号整数)
92typedef uint64_t mp_limb_t; // 基本运算单元(limb)类型 (64位无符号整数)
93typedef uint64_t mp_size_t; // 表示limb数量的无符号整数类型
94typedef int64_t mp_slimb_t; // 有符号limb类型 (64位有符号整数)
95typedef int64_t mp_ssize_t; // 表示limb数量的有符号整数类型
96typedef mp_limb_t* mp_ptr; // 指向limb类型的指针
97typedef const mp_limb_t* mp_srcptr; // 指向const limb类型的指针(源操作数指针)
98typedef size_t mp_bitcnt_t; // 表示bit数量的无符号整数类型
99
100#define LMMP_MAX_ALIGN 16 // 最大对齐单位(字节)
101
102#define LIMB_BITS 64
103#define LIMB_BYTES 8
104#define LOG2_LIMB_BITS 6
105#define LIMB_MAX (~(mp_limb_t)0)
106#define LLIMB_BITS 32
107#define LLIMB_BYTES 4
108#define LLIMB_MASK ((mp_limb_t)0xffffffff)
109
110#if defined(LMMP_WINDOWS)
111 #if defined(__clang__)
112 #define LMMP_THREAD_LOCAL __declspec(thread)
113 #else
114 #define LMMP_THREAD_LOCAL __thread
115 #endif
116#elif defined(__GNUC__) || defined(__clang__)
117 #define LMMP_THREAD_LOCAL __thread
118#else
119 #define LMMP_THREAD_LOCAL _Thread_local
120#endif
121
122#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
123 #define STATIC_ASSERT _Static_assert
124#elif defined(__cplusplus) && __cplusplus >= 201103L
125 #define STATIC_ASSERT static_assert
126#else
127 // C99/C89 fallback (no message)
128 #define STATIC_ASSERT(cond, msg) typedef char static_assert_##__LINE__[(cond) ? 1 : -1]
129#endif
130
131STATIC_ASSERT(sizeof(void*) == 8, "64-bit architecture required");
132
133#undef STATIC_ASSERT
134
135#ifdef __cplusplus
136 /* C++ */
137 #if __cplusplus >= 201103L
138 /* C++11 and higher */
139 #define LMMP_NORETURN [[noreturn]]
140 #else
141 #if defined(__GNUC__) || defined(__clang__)
142 #define LMMP_NORETURN __attribute__((noreturn))
143 #else
144 #define LMMP_NORETURN /* no definition */
145 #endif
146 #endif
147#else
148 /* C */
149 #if defined(__STDC_VERSION__)
150 #if __STDC_VERSION__ >= 202311L
151 /* C23 and higher */
152 #define LMMP_NORETURN [[noreturn]]
153 #elif __STDC_VERSION__ >= 201112L
154 /* C11 / C17 */
155 #define LMMP_NORETURN _Noreturn
156 #endif
157 #endif
158
159 /* fallback */
160 #ifndef LMMP_NORETURN
161 #if defined(__GNUC__) || defined(__clang__)
162 #define LMMP_NORETURN __attribute__((noreturn))
163 #else
164 #define LMMP_NORETURN /* no definition */
165 #endif
166 #endif
167#endif
168
169#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L
170 /* C23 std */
171 #define LMMP_ASSUME(expr) do { [[assume(expr)]]; } while(0)
172#elif defined(__clang__)
173 /* Clang */
174 #define LMMP_ASSUME(expr) __builtin_assume(expr)
175#elif defined(__GNUC__)
176 /* GCC */
177 #if __GNUC__ >= 13
178 /* GCC 13+ */
179 #define LMMP_ASSUME(expr) do { __attribute__((assume(expr))); } while(0)
180 #else
181 /* GCC 13 lower */
182 #define LMMP_ASSUME(expr) do { if (!(expr)) __builtin_unreachable(); } while(0)
183 #endif
184#else
185 /* fallback noassume */
186 #define LMMP_ASSUME(expr) ((void)(expr))
187#endif
188
189/*
190 保守向量化豁免(用于源文件级体积控制):GCC -O3 的 dynamic 向量化成本
191 模型会对 limb 级 C 循环做投机向量化 + 运行时版本化——每个此类循环同时
192 生成向量主循环与标量回退两份代码;对热点已由手写汇编承担、或主体为
193 调用耗时较高的编译单元,版本化纯属体积膨胀而无运行收益。
194 使用本宏的文件退回 very-cheap 档(即 -O2 的默认成本模型),仅保留
195 明显受益的向量化。Clang 的 -O3 无此投机版本化行为,且不识别
196 #pragma GCC optimize,故对其静默跳过。
197*/
198#if defined(__GNUC__) && !defined(__clang__)
199 #define LMMP_VECT_CONSERVATIVE _Pragma("GCC optimize(\"vect-cost-model=very-cheap\")")
200#else
201 #define LMMP_VECT_CONSERVATIVE
202#endif
203
204/*
205 禁止内联:用于大体量算法体(整段阶梯/判定内核)的函数——被小型包装入口
206 (如 is_prime 家族的试除包装)内联会造成代码复制与 I-cache 膨胀,而单次
207 调用开销相对函数体耗时可忽略。注意与每 bit/每 limb 热循环内的小助手相反:
208 那类函数的常量传播与内联是性能来源,禁用外联属性是负收益(勿对热循环
209 助手使用)。跨编译单元(无 LTO)本就不可内联,本属性只影响同单元调用方,
210 但 Linux 构建 -fno-semantic-interposition 会放开导出函数的内联,故对
211 可能被同单元入口内联的导出接口也应显式标注。
212*/
213#if defined(__GNUC__) || defined(__clang__)
214 #define LMMP_NOINLINE __attribute__((noinline))
215#else
216 #define LMMP_NOINLINE
217#endif
218
219
220/*
221 LMMP 内存分配函数指针类型:
222 1. heap_alloc : 堆内存分配器
223 2. heap_free : 堆内存释放器
224 3. realloc : 堆内存重新分配器
225
226 默认使用 malloc、free、realloc 实现。
227 如果你需要传入自定义的分配器,为了避免重复处理,且由于LMMP内部几乎不直接
228 通过指定的指针来进行内存分配,所以为了避免不必要的错误处理,建议遵循一下的行为:
229 1. 传给free的指针应可以为NULL
230 2. malloc(size)可以假定size>0,若size为0,可以是未定义行为,可以直接中断。
231 3. realloc(p, size)可以假定size>0,若size为0,可以是未定义行为,可以直接中断。
232 4. realloc/malloc(p, size)若内存耗尽,或者无空闲块,可以返回NULL,代表分配失败。
233 */
234
235typedef void* (*lmmp_heap_alloc_fn)(size_t size);
236typedef void (*lmmp_heap_free_fn )(void* ptr);
237typedef void* (*lmmp_realloc_fn )(void* ptr, size_t size);
238
244
245/**
246 * @brief 设置 LMMP 全局堆内存分配函数
247 * @param heap 新的堆内存分配器,可以为NULL,此时会直接返回,而不进行任何操作。
248 * @warning 由于所有共享内存都采用堆内存分配。因此,传入新的堆分配器将会首先调用
249 * lmmp_global_deinit 函数,释放所有共享内存,以保证老旧的堆资源被释放。
250 * 然后将会自动调用 lmmp_global_init 函数,重新分配所有线程局部内存。
251 * 同时,为保证内存不泄露,将会对堆计数器和栈顶以及缓冲池顶进行检查。
252 * 若此时堆栈分配计数器不为 0,或当前栈帧不在栈底,都会触发lmmp_abort函数,
253 * 并输出相应的错误信息。
254 * @note 堆分配器是线程局部的,因此,创建新线程时,如有需要,请自行设置新的堆分配器。
255 * 同时也请自行保证分配器和释放器相匹配。
256 */
258
259/**
260 * @brief LMMP 全局栈释放函数(通常不需要手动调用)
261 * @warning 请注意调用此函数后,访问之前的分配的栈空间将会导致未定义行为。在定义了
262 * LMMP_DEBUG_MEMORY_LEAK 宏时,会检查默认栈是否为空,
263 * 则会触发lmmp_abort函数。
264 * @note 如果此后再使用栈内存,请调用 lmmp_stack_init 函数,以重置栈空间。
265 * @return 返回0表示成功释放,返回-1表示已经释放(并非错误)。
266 */
268
269/**
270 * @brief LMMP 全局栈初始化函数(通常不需要手动调用)
271 * @note 初始化默认栈,并分配大小为size的额外内存池。如果已经初始化,
272 * 则会直接返回-1,表示已经初始化(并非错误),且不进行任何其他操作。
273 * lmmp_global_init 函数会自动调用此函数,分配的额外缓冲池大小为 LMMP_POOL_SIZE 的大小
274 * (默认为512kb),无需手动调用。
275 * 如果你想手动设置缓冲池的大小,可以先调用 lmmp_stack_deinit 函数,再调用此函数,将 POOL_SIZE
276 * 设置为你想要的值。同时你也可以禁用缓冲池(即size为0),此时不会分配额外缓冲池。
277 * @return 返回0表示成功初始化,返回-1表示已经初始化(并非错误)。
278 */
279LMMP_API int lmmp_stack_init(size_t size);
280
291
292/**
293 * @brief LMMP 全局退出函数指针类型
294 * @param type 退出类型(可以查看lmmp_abort函数对此参数的说明,这里不再重复)
295 * @param msg 退出信息,取决于type
296 * @param func 退出处的函数名
297 * @param line 退出处的行号
298 */
299typedef void (*lmmp_abort_fn)(lmmp_error_t type, const char* msg, const char* func, int line);
300
301/**
302 * @brief 设置 LMMP 全局退出函数(所有线程均生效)
303 * @param func 退出函数指针,可以为NULL
304 * @warning 请注意,我们将不会对 func 的调用做任何保护,因此请不要在 func 里做任何危险的操作,
305 * 本库的开发者不对 func 函数的调用产生的影响做任何保证。
306 * @note 若 func 为 NULL,则代表使用默认的退出机制。lmmp_abort 函数被标记为无返回值,因此
307 * 设置的函数也应当无返回值,即使自定义的func函数真的会返回了,那么也将会调用 abort 函数中断程序。
308 * @return 返回之前的退出函数指针,若原指针为NULL,则返回NULL。
309 */
311
312/**
313 * @brief LMMP 全局退出函数,内部错误或断言失败时调用,若设置了全局退出函数,则会调用该函数,否则会调用默认的退出函数。
314 * @param msg 退出信息,assert类型的错误信息通常仅包含断言内容,其他类型的错误则因类型不同而不同。
315 * @param func 退出处的函数名
316 * @param line 退出处的行号
317 * @param type 退出类型。有以下几个类型:
318 *
319 * 1. ASSERT_FAILURE (枚举值为1)为lmmp_assert触发的退出,lmmp_assert触发的普通退出几乎不可能发生,
320 * 其通常代表不可能发生的计算错误,可能表明程序执行此处时必须正确的输入错误。比如预期无进位的加法产生了进位。
321 * 此类错误不可接受,会导致计算无法继续进行,导致程序崩溃。
322 *
323 * 2. DEBUG_ASSERT_FAILURE (枚举值为2)为lmmp_debug_assert触发的退出。其通常表明预期之外的错误,
324 * 这通常是调用者的UB,如无UB的情况下触发此错误;也可能是LMMP内部的逻辑错误,开发者期待的输入错误,
325 * 在该逻辑处仅简单考虑了某些情况。如有此类错误,可以报告给开发者。此类型只会在定义了
326 * LMMP_DEBUG_ASSERT_CHECK 宏为 1 的情况下才会触发。
327 *
328 * 3. PARAM_ASSERT_FAILURE (枚举值为3)为参数检查失败导致的退出。其通常表明调用者传入了无效的参数,
329 * 导致函数的行为不符合预期。此类错误不可接受,会导致计算无法继续进行,导致程序崩溃。此类型的错误只有在
330 * 定义了 LMMP_DEBUG_PARAM_ASSERT_CHECK 宏为 1 的情况下才会触发。
331 *
332 * 4. MEMORY_ALLOC_FAILURE (枚举值为4)为内存分配失败退出。在使用堆分配器时,申请内存失败,导致触发此错误。
333 * 此类型错误不受明确的宏调控,Realse模式下,会保留必要的触发场景,部分场景下,在一些检查宏定义时,可能会额外触发此错误。
334 *
335 * 5. MEMORY_FREE_FAILURE (枚举值为5)为内存释放错误。当释放堆内存时可能触发,原因通常为头部信息被损坏,极有可能
336 * 源于传入错误的指针,又或者缓冲区溢出导致此头部损坏。LMMP_DEBUG_MEMORY_CHECK 宏为 1 时,才可能触发。
337 *
338 * 6. OUT_OF_BOUNDS (枚举值为6)为数组越界访问导致的退出。通常表明未按规定使用空间。此类型的错误在堆分配器中,当释放
339 * 堆内存时,检测到数组尾部魔数不匹配,导致此错误。LMMP_DEBUG_MEMORY_CHECK 宏为 1 时,才可能触发。
340 *
341 * 7. MEMORY_LEAK (枚举值为7)为内存泄漏导致的退出。在检查点处,堆内存计数器不为0,或者当前栈帧不在栈底,又或者缓冲池
342 * 定不在缓冲池底,都会触发此错误。触发原因可能为,在调用堆分配器重置函数时,显式检查到此时的堆计数器不为0或者栈帧
343 * 以及缓冲池不为底部。又或者手动调用 lmmp_leak_tracker 宏来进行检查,检查到了相同的情况。需注意,手动调用此宏时,
344 * 请先调用 lmmp_global_deinit 进行全局共享的堆资源的安全释放(因为部分全局共享资源也会被计数)。
345 *
346 * 8. UNEXPECTED_ERROR (枚举值为8)为其他未知错误导致的退出。
347 *
348 * @warning LMMP内部中断都将会调用此函数,如果全局退出函数为NULL,则使用默认的退出函数,会打印出全部错误信息,并调用
349 * abort 函数中断程序。自定义全局退出函数请通过 lmmp_set_abort_fn 函数进行设置。请不要在全局退出函数里做任
350 * 何危险的操作,本库的开发者不对其调用产生的影响做任何保证。
351 */
352LMMP_NORETURN LMMP_API void lmmp_abort(lmmp_error_t type, const char *msg, const char *func, int line);
353
354#if LMMP_DEBUG_MEMORY_CHECK == 1
355LMMP_API void* lmmp_alloc(size_t size, const char* func, int line);
356/**
357 * @brief 内存分配函数(调用lmmp_heap_alloc_fn)
358 * @param size 要分配的内存字节数
359 * @warning size>0
360 * @note 调用堆内存分配器,分配失败将触发 lmmp_abort
361 * @return 返回指向分配内存的指针(分配失败不会 return NULL,而是直接触发 lmmp_abort)
362 */
363#define lmmp_alloc(size) lmmp_alloc(size, __func__, __LINE__)
364#else
365/**
366 * @brief 内存分配函数(调用lmmp_heap_alloc_fn)
367 * @param size 要分配的内存字节数
368 * @warning size>0
369 * @note 调用堆内存分配器,分配失败将触发 lmmp_abort
370 * @return 返回指向分配内存的指针(分配失败不会 return NULL,而是直接触发 lmmp_abort)
371 */
372LMMP_API void* lmmp_alloc(size_t size);
373#endif
374
375#if LMMP_DEBUG_MEMORY_CHECK == 1
376LMMP_API void* lmmp_realloc(void* ptr, size_t size, const char* func, int line);
377/**
378 * @brief 内存重分配函数(调用lmmp_realloc_fn)
379 * @param ptr 已分配的内存指针
380 * @param size 新的内存大小(字节)
381 * @warning size>0
382 * @note 调用堆内存重新分配器,分配失败将触发 lmmp_abort
383 * 在LMMP_DEBUG_PARAM_ASSERT_CHECK宏为1时,重分配 0 字节将触发 lmmp_abort
384 * @return 成功返回指向新内存区域的指针(分配失败不会 return NULL,而是直接触发 lmmp_abort)
385 */
386#define lmmp_realloc(ptr, size) lmmp_realloc(ptr, size, __func__, __LINE__)
387#else
388/**
389 * @brief 内存重分配函数(调用lmmp_realloc_fn)
390 * @param ptr 已分配的内存指针
391 * @param size 新的内存大小(字节)
392 * @warning size>0
393 * @note 调用堆内存重新分配器,分配失败将触发 lmmp_abort
394 * 在LMMP_DEBUG_PARAM_ASSERT_CHECK宏为1时,重分配 0 字节将触发 lmmp_abort
395 * @return 成功返回指向新内存区域的指针(分配失败不会 return NULL,而是直接触发 lmmp_abort)
396 */
397LMMP_API void* lmmp_realloc(void* ptr, size_t size);
398#endif
399
400#if LMMP_DEBUG_MEMORY_CHECK == 1
401LMMP_API void lmmp_free(void* ptr, const char* func, int line);
402/**
403 * @brief 内存释放函数(调用lmmp_heap_free_fn)
404 * @param ptr 要释放的内存指针
405 * @note ptr 可以为空指针
406 */
407#define lmmp_free(ptr) lmmp_free(ptr, __func__, __LINE__)
408#else
409/**
410 * @brief 内存释放函数(调用lmmp_heap_free_fn)
411 * @param ptr 要释放的内存指针
412 * @note ptr 可以为空指针
413 */
414LMMP_API void lmmp_free(void* ptr);
415#endif
416
417/**
418 * @brief 堆内存分配计数器(线程局部)
419 * @param cnt 若不为0,则将堆内存计数器置为cnt
420 * @return 返回当前的heap分配计数(如果被设置,即返回旧的计数值),即目前未被释放的堆内存数量
421 */
422LMMP_API int lmmp_alloc_count(int cnt);
423
424/**
425 * @brief 内存泄漏检测器
426 * @param func 泄漏发生的函数名
427 * @param line 泄漏发生的行号
428 * @warning 内存计数器均是线程局部的,仅会检测单线程的内存泄漏。
429 * @note 将会同时检验堆内存和栈内存,若堆内存计数器不为0,或栈内存的栈顶不在栈底,都会触发lmmp_abort
430 * 两者同时发生则将输出两者的信息。
431 */
432LMMP_API void lmmp_leak_tracker(const char* func, int line);
433
434#if LMMP_DEBUG_MEMORY_LEAK == 1
435// 同时检验堆内存和栈内存,若堆内存计数器不为0,或栈内存的栈顶不在栈底,都会触发lmmp_abort
436// 两者同时发生则将输出两者的信息。
437// 请注意,内存计数器均是线程局部的,仅会检测单线程的内存泄漏。
438#define lmmp_leak_tracker lmmp_leak_tracker(__func__, __LINE__)
439#else
440#define lmmp_leak_tracker ((void)0)
441#endif
442
443/**
444 * @brief 计算绝对值
445 */
446#define LMMP_ABS(x) ((x) >= 0 ? (x) : -(x))
447/**
448 * @brief 返回两个数中的较小值
449 */
450#define LMMP_MIN(l, o) ((l) < (o) ? (l) : (o))
451/**
452 * @brief 返回两个数中的较大值
453 */
454#define LMMP_MAX(h, i) ((h) > (i) ? (h) : (i))
455/**
456 * @brief 交换两个变量的值
457 */
458#define LMMP_SWAP(x, y, type) \
459 do { \
460 type _swap_ = (x); \
461 (x) = (y); \
462 (y) = _swap_; \
463 } while (0)
464/**
465 * @brief 检查n是否为2的幂次方
466 */
467#define LMMP_POW2_Q(n) (((n) & ((n) - 1)) == 0)
468/**
469 * @brief 将a向上取整到m的倍数
470 */
471#define LMMP_ROUND_UP_MULTIPLE(a, m) ((a) + (m) - 1 - ((a) + (m) - 1) % (m))
472
473// 内存拷贝宏:拷贝n个limb(每个8字节),使用memmove保证重叠安全
474#define lmmp_copy(dst, src, n) memmove((dst), (src), ((size_t)(n) << 3))
475// 内存置零宏:将n个limb置零(每个8字节)
476#define lmmp_zero(dst, n) memset((dst), 0, ((size_t)(n) << 3))
477
478// 断言宏:检查条件x是否成立,不成立则触发段错误(严格的错误检查)
479// RELEASE 版本也会检查
480// 不可使用有副作用的表达式
481#define lmmp_assert(x) \
482 do { \
483 if (!(x)) { \
484 lmmp_abort(LMMP_ERROR_ASSERT_FAILURE, #x, __func__, __LINE__); \
485 } \
486 } while (0)
487
488#if LMMP_DEBUG_ASSERT_CHECK == 1
489// 调试断言宏:检查条件x是否成立,不成立则触发段错误(调试版本)
490#define lmmp_debug_assert(x) \
491 do { \
492 if (!(x)) { \
493 lmmp_abort(LMMP_ERROR_DEBUG_ASSERT_FAILURE, #x, __func__, __LINE__); \
494 } \
495 } while (0)
496#else
497// 调试断言宏:检查条件x是否成立,不成立则触发段错误(调试版本)
498#define lmmp_debug_assert(x) LMMP_ASSUME(x)
499#endif
500
501#if LMMP_DEBUG_PARAM_ASSERT_CHECK == 1
502#define lmmp_param_assert(x) \
503 do { \
504 if (!(x)) { \
505 lmmp_abort(LMMP_ERROR_PARAM_ASSERT_FAILURE, #x, __func__, __LINE__); \
506 } \
507 } while (0)
508#else
509#define lmmp_param_assert(x) LMMP_ASSUME(x)
510#endif
511
512/**
513 * @brief 填充[begin,end)内的数组,值为val
514 * @param begin 起始指针(含)
515 * @param end 终止指针(不含)
516 * @param val 填充值
517 * @warning begin!=NULL, end!=NULL
518 * @note 如果begin>=end,将不会进行操作
519 */
520LMMP_API void lmmp_fill(mp_ptr begin, mp_ptr end, mp_limb_t val);
521
522/**
523 * @brief 填充从dst开始的长度为len的数组,值为val
524 * @param dst 目标数组
525 * @param len 填充长度
526 * @param val 填充值
527 * @warning dst!=NULL
528 * @note 如果len==0,将不会进行操作
529 */
530LMMP_API void lmmp_fill_n(mp_ptr dst, mp_size_t len, mp_limb_t val);
531
532/**
533 * @brief 全局初始化函数(线程局部的)
534 * @note 调用此函数将初始化库内的所有线程局部持久资源,如内部栈空间等。
535 * 部分惰性初始化的资源将在首次使用时初始化。调用此函数不会进行初始化。
536 * 此函数多次调用不会导致重复初始化。
537 * @warning 在进程或线程启动时调用此函数,以保证线程安全。
538 */
539LMMP_API void lmmp_global_init(void);
540
541/**
542 * @brief 全局释放函数(线程局部的)
543 * @note 调用此函数将释放库内的所有线程局部持久资源。
544 * 此函数多次调用不会导致重复释放。如需要再次使用,请重新调用 lmmp_global_init 初始化。
545 * 部分惰性初始化的资源将在再次首次使用时再次初始化,调用此函数可能导致部分缓存失效,导致冷启动和性能下降。
546 * @warning 在进程或线程结束时或调用此函数。多线程下,未调用此函数结束线程可能导致内存泄漏。
547 */
549
550#ifdef __cplusplus
551} // extern "C"
552#endif
553
554#endif // LMMP_LMMP_H
void * lmmp_realloc(void *ptr, size_t size)
内存重分配函数(调用lmmp_realloc_fn)
void lmmp_fill(mp_ptr begin, mp_ptr end, mp_limb_t val)
填充[begin,end)内的数组,值为val
定义 fill.c:26
mp_limb_t * mp_ptr
定义 lmmp.h:96
uint8_t mp_byte_t
定义 lmmp.h:91
void lmmp_set_heap_allocator(const lmmp_heap_allocator_t *heap)
设置 LMMP 全局堆内存分配函数
void *(*) lmmp_heap_alloc_fn(size_t size)
定义 lmmp.h:235
lmmp_realloc_fn realloc
定义 lmmp.h:242
lmmp_heap_alloc_fn alloc
定义 lmmp.h:240
void(*) lmmp_heap_free_fn(void *ptr)
定义 lmmp.h:236
#define LMMP_API
Copyright (C) 2026 HJimmyK (Jericho Knox)
定义 lmmp.h:77
size_t mp_bitcnt_t
定义 lmmp.h:98
uint64_t mp_size_t
定义 lmmp.h:93
int64_t mp_slimb_t
定义 lmmp.h:94
void lmmp_fill_n(mp_ptr dst, mp_size_t len, mp_limb_t val)
填充从dst开始的长度为len的数组,值为val
定义 fill.c:33
void * lmmp_alloc(size_t size)
内存分配函数(调用lmmp_heap_alloc_fn)
const mp_limb_t * mp_srcptr
定义 lmmp.h:97
lmmp_abort_fn lmmp_set_abort_fn(lmmp_abort_fn func)
设置 LMMP 全局退出函数(所有线程均生效)
定义 abort.c:90
void lmmp_abort(lmmp_error_t type, const char *msg, const char *func, int line)
LMMP 全局退出函数,内部错误或断言失败时调用,若设置了全局退出函数,则会调用该函数,否则会调用默认的退出函数。
int lmmp_stack_deinit(void)
LMMP 全局栈释放函数(通常不需要手动调用)
#define STATIC_ASSERT(cond, msg)
定义 lmmp.h:128
void(*) lmmp_abort_fn(lmmp_error_t type, const char *msg, const char *func, int line)
LMMP 全局退出函数指针类型
定义 lmmp.h:299
#define LMMP_NORETURN
定义 lmmp.h:164
int lmmp_stack_init(size_t size)
LMMP 全局栈初始化函数(通常不需要手动调用)
void lmmp_free(void *ptr)
内存释放函数(调用lmmp_heap_free_fn)
lmmp_heap_free_fn free
定义 lmmp.h:241
int64_t mp_ssize_t
定义 lmmp.h:95
void lmmp_global_init(void)
全局初始化函数(线程局部的)
uint64_t mp_limb_t
定义 lmmp.h:92
void lmmp_global_deinit(void)
全局释放函数(线程局部的)
void *(*) lmmp_realloc_fn(void *ptr, size_t size)
定义 lmmp.h:237
lmmp_error_t
定义 lmmp.h:281
@ LMMP_ERROR_MEMORY_ALLOC_FAILURE
定义 lmmp.h:285
@ LMMP_ERROR_ASSERT_FAILURE
定义 lmmp.h:282
@ LMMP_ERROR_PARAM_ASSERT_FAILURE
定义 lmmp.h:284
@ LMMP_ERROR_MEMORY_FREE_FAILURE
定义 lmmp.h:286
@ LMMP_ERROR_UNEXPECTED_ERROR
定义 lmmp.h:289
@ LMMP_ERROR_MEMORY_LEAK
定义 lmmp.h:288
@ LMMP_ERROR_DEBUG_ASSERT_FAILURE
定义 lmmp.h:283
@ LMMP_ERROR_OUT_OF_BOUNDS
定义 lmmp.h:287
#define lmmp_leak_tracker
定义 lmmp.h:440
int lmmp_alloc_count(int cnt)
堆内存分配计数器(线程局部)