Fri, 07 Jul 2023 17:59:52 +0200
add overridable macros to the install docs
docs/src/install.md | file | annotate | diff | comparison | revisions |
1.1 --- a/docs/src/install.md Fri Jul 07 17:51:54 2023 +0200 1.2 +++ b/docs/src/install.md Fri Jul 07 17:59:52 2023 +0200 1.3 @@ -18,6 +18,35 @@ 1.4 cmake --build . 1.5 sudo cmake --install . 1.6 1.7 +When compiling UCX 3, you can tweak the buffer sizes for small-buffer-optimization. 1.8 +You can do this, be pre-defining one or more of the following macros: 1.9 + 1.10 +--------------------------------- --------------------------------------------------------------------- ---------- 1.11 +Macro Description Default 1.12 +--------------------------------- --------------------------------------------------------------------- ---------- 1.13 +CX_ARRAY_SWAP_SBO_SIZE The maximum item size in an array list that uses SBO. 128 1.14 + 1.15 +CX_LINKED_LIST_SORT_SBO_SIZE The maximum list size that uses SBO during sort. 1024 1.16 + 1.17 +CX_LINKED_LIST_SWAP_SBO_SIZE The maximum item size that uses SBO swap instead of relinking. 128 1.18 + 1.19 +CX_PRINTF_SBO_SIZE The maximum string length printf.h uses stack memory for. 512 1.20 + 1.21 +CX_STRSTR_SBO_SIZE The maximum length of the "needle" in strstr that can use SBO. 512 1.22 +--------------------------------- --------------------------------------------------------------------- ---------- 1.23 + 1.24 +You can also tweak some other buffer sizes with the same technique: 1.25 + 1.26 +--------------------------------- --------------------------------------------------- ---------- 1.27 +Macro Description Default 1.28 +--------------------------------- --------------------------------------------------- ---------- 1.29 +CX_STRREPLACE_INDEX_BUFFER_SIZE The number of matches one index buffer can store. 64 1.30 + 1.31 +CX_STREAM_COPY_BUF_SIZE The buffer size on the stack for a stream copy. 1024 1.32 + 1.33 +CX_STREAM_BCOPY_BUF_SIZE The buffer size on the heap for a stream copy. 8192 1.34 +--------------------------------- --------------------------------------------------- ---------- 1.35 + 1.36 --- 1.37 1.38 ### UCX 2.1