upstream/haproxy
1
0
Fork 0
mirror of https://github.com/haproxy/haproxy.git synced 2026-02-11 14:53:05 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
haproxy/include/haproxy/cpuset.h

77 lines
2.5 KiB
C
Raw Normal View History

MINOR: cpuset: define a platform-independent cpuset type This module can be used to manipulate a cpu sets in a platform agnostic way. Use the type cpu_set_t/cpuset_t if available on the platform, or fallback to unsigned long, which limits de facto the maximum cpu index to LONGBITS.
2021-04-14 09:03:51 -04:00
#ifndef _HAPROXY_CPUSET_H
#define _HAPROXY_CPUSET_H
#include <haproxy/cpuset-t.h>
MINOR: cpuset: dynamically allocate cpu_map cpu_map is 8.2kB/entry and there's one such entry per group, that's ~520kB total. In addition, the init code is still in haproxy.c enclosed in ifdefs. Let's make this a dynamically allocated array in the cpuset code and remove that init code. Later we may even consider reallocating it once the number of threads and groups is known, in order to shrink it a little bit, as the typical setup with a single group will only need 8.2kB, thus saving half a MB of RAM. This would require that the upper bound is placed in a variable though.
2023-07-12 05:35:32 -04:00
extern struct cpu_map *cpu_map;
BUG/MAJOR: fix build on musl with cpu_set_t support Move cpu_map structure outside of the global struct to a global variable defined in cpuset.c compilation unit. This allows to reorganize the includes without having to define _GNU_SOURCE everywhere for the support of the cpu_set_t. This fixes the compilation with musl libc, most notably used for the alpine based docker image. This fixes the github issue #1235. No need to backport as this feature is new in the current 2.4-dev.
2021-04-27 04:46:36 -04:00
MINOR: cpuset: define a platform-independent cpuset type This module can be used to manipulate a cpu sets in a platform agnostic way. Use the type cpu_set_t/cpuset_t if available on the platform, or fallback to unsigned long, which limits de facto the maximum cpu index to LONGBITS.
2021-04-14 09:03:51 -04:00
/* Unset all indexes in <set>.
*/
void ha_cpuset_zero(struct hap_cpuset *set);
/* Set <cpu> index in <set> if not present.
* Returns 0 on success otherwise non-zero.
*/
int ha_cpuset_set(struct hap_cpuset *set, int cpu);
/* Clear <cpu> index in <set> if present.
* Returns 0 on success otherwise non-zero.
*/
int ha_cpuset_clr(struct hap_cpuset *set, int cpu);
/* Bitwise and equivalent operation between <src> and <dst> stored in <dst>.
*/
BUILD: cpuset: do not use const on the source of CPU_AND/CPU_ASSIGN The man page indicates that CPU_AND() and CPU_ASSIGN() take a variable, not a const on the source, even though it doesn't make much sense. But with older libcs, this triggers a build warning: src/cpuset.c: In function 'ha_cpuset_and': src/cpuset.c:53: warning: initialization discards qualifiers from pointer target type src/cpuset.c: In function 'ha_cpuset_assign': src/cpuset.c:101: warning: initialization discards qualifiers from pointer target type Better stick stricter to the documented API as this is really harmless here. There's no need to backport it (unless build issues are reported, which is quite unlikely).
2022-01-28 03:10:52 -05:00
void ha_cpuset_and(struct hap_cpuset *dst, struct hap_cpuset *src);
MINOR: cpuset: define a platform-independent cpuset type This module can be used to manipulate a cpu sets in a platform agnostic way. Use the type cpu_set_t/cpuset_t if available on the platform, or fallback to unsigned long, which limits de facto the maximum cpu index to LONGBITS.
2021-04-14 09:03:51 -04:00
MINOR: cpuset: add ha_cpuset_or() to bitwise-OR two CPU sets This operation was not implemented and will be needed later.
2023-07-12 06:08:36 -04:00
/* Bitwise OR equivalent operation between <src> and <dst> stored in <dst>.
*/
void ha_cpuset_or(struct hap_cpuset *dst, struct hap_cpuset *src);
MINOR: cpuset: add ha_cpuset_isset() to check for the presence of a CPU in a set This function will be convenient to test for the presence of a given CPU in a set.
2023-07-06 10:39:08 -04:00
/* returns non-zero if CPU index <cpu> is set in <set>, otherwise 0. */
int ha_cpuset_isset(const struct hap_cpuset *set, int cpu);
MINOR: cpuset: define a platform-independent cpuset type This module can be used to manipulate a cpu sets in a platform agnostic way. Use the type cpu_set_t/cpuset_t if available on the platform, or fallback to unsigned long, which limits de facto the maximum cpu index to LONGBITS.
2021-04-14 09:03:51 -04:00
/* Returns the count of set index in <set>.
*/
int ha_cpuset_count(const struct hap_cpuset *set);
/* Returns the first index set plus one in <set> starting from the lowest.
* Returns 0 if no index set.
CLEANUP: assorted typo fixes in the code and comments This is 22nd iteration of typo fixes
2021-04-24 04:25:42 -04:00
* Do not forget to subtract the result by one if using it for set/clr.
MINOR: cpuset: define a platform-independent cpuset type This module can be used to manipulate a cpu sets in a platform agnostic way. Use the type cpu_set_t/cpuset_t if available on the platform, or fallback to unsigned long, which limits de facto the maximum cpu index to LONGBITS.
2021-04-14 09:03:51 -04:00
*/
int ha_cpuset_ffs(const struct hap_cpuset *set);
/* Copy <src> set into <dst>.
*/
BUILD: cpuset: do not use const on the source of CPU_AND/CPU_ASSIGN The man page indicates that CPU_AND() and CPU_ASSIGN() take a variable, not a const on the source, even though it doesn't make much sense. But with older libcs, this triggers a build warning: src/cpuset.c: In function 'ha_cpuset_and': src/cpuset.c:53: warning: initialization discards qualifiers from pointer target type src/cpuset.c: In function 'ha_cpuset_assign': src/cpuset.c:101: warning: initialization discards qualifiers from pointer target type Better stick stricter to the documented API as this is really harmless here. There's no need to backport it (unless build issues are reported, which is quite unlikely).
2022-01-28 03:10:52 -05:00
void ha_cpuset_assign(struct hap_cpuset *dst, struct hap_cpuset *src);
MINOR: cpuset: define a platform-independent cpuset type This module can be used to manipulate a cpu sets in a platform agnostic way. Use the type cpu_set_t/cpuset_t if available on the platform, or fallback to unsigned long, which limits de facto the maximum cpu index to LONGBITS.
2021-04-14 09:03:51 -04:00
/* Returns the biggest index plus one usable on the platform.
*/
CLEANUP: tree-wide: fix prototypes for functions taking no arguments. "f(void)" is the correct and preferred form for a function taking no argument, while some places use the older "f()". These were reported by clang's -Wmissing-prototypes, for example: src/cpuset.c:111:5: warning: no previous prototype for function 'ha_cpuset_size' [-Wmissing-prototypes] int ha_cpuset_size() include/haproxy/cpuset.h:42:5: note: this declaration is not a prototype; add 'void' to make it a prototype for a zero-parameter function int ha_cpuset_size(); ^ void This aggregate patch fixes this for the following functions: ha_backtrace_to_stderr(), ha_cpuset_size(), ha_panic(), ha_random64(), ha_thread_dump_all_to_trash(), get_exec_path(), check_config_validity(), mworker_child_nb(), mworker_cli_proxy_(create|stop)(), mworker_cleantasks(), mworker_cleanlisteners(), mworker_ext_launch_all(), mworker_reload(), mworker_(env|proc_list)_to_(proc_list|env)(), mworker_(un|)block_signals(), proxy_adjust_all_maxconn(), proxy_destroy_all_defaults(), get_tainted(), pool_total_(allocated|used)(), thread_isolate(_full|)(), thread(_sync|)_release(), thread_harmless_till_end(), thread_cpu_mask_forced(), dequeue_all_listeners(), next_timer_expiry(), wake_expired_tasks(), process_runnable_tasks(), init_acl(), init_buffer(), (de|)init_log_buffers(), (de|)init_pollers(), fork_poller(), pool_destroy_all(), pool_evict_from_local_caches(), pool_total_failures(), dump_pools_to_trash(), cfg_run_diagnostics(), tv_init_(process|thread)_date(), __signal_process_queue(), deinit_signals(), haproxy_unblock_signals()
2021-09-12 06:49:33 -04:00
int ha_cpuset_size(void);
MINOR: cpuset: define a platform-independent cpuset type This module can be used to manipulate a cpu sets in a platform agnostic way. Use the type cpu_set_t/cpuset_t if available on the platform, or fallback to unsigned long, which limits de facto the maximum cpu index to LONGBITS.
2021-04-14 09:03:51 -04:00
MINOR: cpuset: centralize a reliable bound cpu detection Till now the CPUs that were bound were only retrieved in thread_cpus_enabled() in order to count the number of CPUs allowed, and it relied on arch-specific code. Let's slightly arrange this into ha_cpuset_detect_bound() that reuses the ha_cpuset struct and the accompanying code. This makes the code much clearer without having to carry along some arch-specific stuff out of this area. Note that the macos-specific code used in thread.c to only count online CPUs but not retrieve a mask, so for now we can't infer anything from it and can't implement it. In addition and more importantly, this function is reliable in that it will only return a value when the detection is accurate, and will not return incomplete sets on operating systems where we don't have an exact list, such as online CPUs.
2023-07-11 10:51:22 -04:00
/* Detects CPUs that are bound to the current process. Returns the number of
* CPUs detected or 0 if the detection failed.
*/
int ha_cpuset_detect_bound(struct hap_cpuset *set);
REORG: cpuset: move parse_cpu_set() and parse_cpumap() to cpuset.c These ones were still in cfgparse.c but they're not specific to the config at all and may actually be used even when parsing cpu list entries in /sys. Better move them where they can be reused.
2023-07-06 08:35:11 -04:00
/* Parse cpu sets. Each CPU set is either a unique number between 0 and
* ha_cpuset_size() - 1 or a range with two such numbers delimited by a dash
* ('-'). Each CPU set can be a list of unique numbers or ranges separated by
* a comma. It is also possible to specify multiple cpu numbers or ranges in
* distinct argument in <args>. On success, it returns 0, otherwise it returns
* 1 with an error message in <err>.
*/
int parse_cpu_set(const char **args, struct hap_cpuset *cpu_set, char **err);
/* Parse a linux cpu map string representing to a numeric cpu mask map
* The cpu map string is a list of 4-byte hex strings separated by commas, with
* most-significant byte first, one bit per cpu number.
*/
void parse_cpumap(char *cpumap_str, struct hap_cpuset *cpu_set);
MINOR: cpuset: add cpu_map_configured() to know if a cpu-map was found Since we'll soon want to adjust the "thread-groups" degree of freedom based on the presence of cpu-map, we first need to be able to detect if cpu-map was used. This function scans all cpu-map sets to detect if any is present, and returns true accordingly.
2023-07-18 11:14:10 -04:00
/* Returns true if at least one cpu-map directive was configured, otherwise
* false.
*/
int cpu_map_configured(void);
MINOR: cpuset: define a platform-independent cpuset type This module can be used to manipulate a cpu sets in a platform agnostic way. Use the type cpu_set_t/cpuset_t if available on the platform, or fallback to unsigned long, which limits de facto the maximum cpu index to LONGBITS.
2021-04-14 09:03:51 -04:00
#endif /* _HAPROXY_CPUSET_H */
Reference in a new issue Copy permalink