initial commit

g3proxy/doc/configuration/values/runtime.rst

@@ -0,0 +1,81 @@
+
+.. _configure_runtime_value_types:
+
+*******
+Runtime
+*******
+
+.. _conf_value_cpu_set:
+
+cpu set
+=======
+
+**yaml value** seq | usize
+
+A `CPU_SET(3)`_ for use with `sched_setaffinity(2)`_.
+
+The value should be a CPU ID, starting from 0, or a sequence of CPU IDs.
+
+.. _CPU_SET(3): https://man7.org/linux/man-pages/man3/CPU_SET.3.html
+.. _sched_setaffinity(2): https://man7.org/linux/man-pages/man2/sched_setaffinity.2.html
+
+.. versionadded:: 1.3.1
+
+.. _conf_value_unaided_runtime_config:
+
+unaided runtime config
+======================
+
+**yaml value**: map
+
+This is the config for unaided runtime.
+
+The keys are:
+
+thread_number
+-------------
+
+**optional**, **type**: usize
+
+Set the thread number.
+
+**default**: the number of logic CPU cores
+
+thread_stack_size
+-----------------
+
+**optional**, **type**: :ref:`humanize usize <conf_value_humanize_usize>`
+
+Set the stack size for worker threads. For *<int>* value, the unit is bytes.
+
+**default**: system default
+
+sched_affinity
+--------------
+
+**optional**, **type**: map | bool
+
+Set the sched affinity for each threads.
+
+For map value, the key should be the thread id starting from 0, and the value should be :ref:`cpu set <conf_value_cpu_set>`.
+
+For bool value:
+
+* if true, a default CPU SET will be set for each thread, the CPU ID in the set will match the thread ID.
+
+* if false, no sched affinity will be set, just as if this config option is not present.
+
+**default**: no sched affinity set
+
+.. versionadded:: 1.3.1
+
+max_io_events_per_tick
+----------------------
+
+**optional**, **type**: usize
+
+Configures the max number of events to be processed per tick.
+
+**default**: 1024, tokio default value
+
+.. versionadded:: 1.7.6