No OneTemporary
Actions

Size

17 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/.clang-format b/.clang-format
	new file mode 100644
	index 0000000000..1fa4590bb3
	--- /dev/null
	+++ b/.clang-format
	@@ -0,0 +1,184 @@
	+# These options seem to change all the time. I've removed things that are C++,
	+# Objective-C, or JSON specific. For reference:
	+# https://clang.llvm.org/docs/ClangFormatStyleOptions.html
	+
	+---
	+Language: Cpp
	+BasedOnStyle: GNU
	+AccessModifierOffset: -2
	+AlignAfterOpenBracket: Align
	+AlignArrayOfStructures: None
	+AlignConsecutiveAssignments:
	+ Enabled: false
	+ AcrossEmptyLines: false
	+ AcrossComments: false
	+ AlignCompound: false
	+ AlignFunctionPointers: false
	+ PadOperators: false
	+AlignConsecutiveBitFields:
	+ Enabled: false
	+ AcrossEmptyLines: false
	+ AcrossComments: false
	+ AlignCompound: false
	+ AlignFunctionPointers: false
	+ PadOperators: false
	+AlignConsecutiveDeclarations:
	+ Enabled: false
	+ AcrossEmptyLines: false
	+ AcrossComments: false
	+ AlignCompound: false
	+ AlignFunctionPointers: false
	+ PadOperators: false
	+AlignConsecutiveMacros:
	+ Enabled: false
	+ AcrossEmptyLines: false
	+ AcrossComments: false
	+ AlignCompound: false
	+ AlignFunctionPointers: false
	+ PadOperators: false
	+AlignConsecutiveShortCaseStatements:
	+ Enabled: false
	+ AcrossEmptyLines: false
	+ AcrossComments: false
	+ AlignCaseColons: false
	+AlignEscapedNewlines: Left
	+AlignOperands: Align
	+AlignTrailingComments:
	+ Kind: Always
	+ OverEmptyLines: 0
	+AllowAllArgumentsOnNextLine: false
	+AllowAllParametersOfDeclarationOnNextLine: false
	+AllowShortBlocksOnASingleLine: Never
	+AllowShortCaseLabelsOnASingleLine: false
	+AllowShortCompoundRequirementOnASingleLine: true
	+AllowShortEnumsOnASingleLine: false
	+AllowShortFunctionsOnASingleLine: None
	+AllowShortIfStatementsOnASingleLine: Never
	+AllowShortLoopsOnASingleLine: false
	+AlwaysBreakAfterDefinitionReturnType: All
	+AlwaysBreakAfterReturnType: AllDefinitions
	+AlwaysBreakBeforeMultilineStrings: false
	+AlwaysBreakTemplateDeclarations: MultiLine
	+AttributeMacros:
	+BinPackArguments: true
	+BinPackParameters: true
	+BitFieldColonSpacing: Both
	+BraceWrapping:
	+ AfterCaseLabel: false
	+ AfterControlStatement: Never
	+ AfterEnum: false
	+ AfterExternBlock: true
	+ AfterFunction: true
	+ AfterStruct: false
	+ AfterUnion: false
	+ BeforeElse: false
	+ BeforeWhile: false
	+ IndentBraces: false
	+ SplitEmptyFunction: true
	+ SplitEmptyRecord: true
	+ SplitEmptyNamespace: true
	+BreakAdjacentStringLiterals: false
	+BreakAfterAttributes: Leave
	+BreakBeforeBinaryOperators: NonAssignment
	+BreakBeforeBraces: Custom
	+BreakBeforeInlineASMColon: OnlyMultiline
	+BreakBeforeTernaryOperators: true
	+BreakStringLiterals: false
	+ColumnLimit: 80
	+CommentPragmas: '^\\.+'
	+ContinuationIndentWidth: 4
	+DerivePointerAlignment: false
	+DisableFormat: false
	+ExperimentalAutoDetectBinPacking: false
	+ForEachMacros:
	+IfMacros:
	+IncludeBlocks: Preserve
	+IncludeCategories:
	+ - Regex: '^"(llvm\|llvm-c\|clang\|clang-c)/'
	+ Priority: 2
	+ SortPriority: 0
	+ CaseSensitive: false
	+ - Regex: '.*'
	+ Priority: 1
	+ SortPriority: 0
	+ CaseSensitive: false
	+IncludeIsMainRegex: '(Test)?$'
	+IncludeIsMainSourceRegex: ''
	+IndentCaseBlocks: true
	+IndentCaseLabels: true
	+IndentGotoLabels: false
	+IndentPPDirectives: AfterHash
	+IndentWidth: 4
	+IndentWrappedFunctionNames: false
	+InsertBraces: true
	+InsertNewlineAtEOF: false
	+InsertTrailingCommas: None
	+IntegerLiteralSeparator:
	+ Binary: 0
	+ BinaryMinDigits: 0
	+ Decimal: 0
	+ DecimalMinDigits: 0
	+ Hex: 0
	+ HexMinDigits: 0
	+KeepEmptyLinesAtTheStartOfBlocks: true
	+KeepEmptyLinesAtEOF: false
	+LineEnding: DeriveLF
	+MacroBlockBegin: ''
	+MacroBlockEnd: ''
	+MaxEmptyLinesToKeep: 1
	+PenaltyBreakAssignment: 2
	+PenaltyBreakBeforeFirstCallParameter: 19
	+PenaltyBreakComment: 300
	+PenaltyBreakFirstLessLess: 120
	+PenaltyBreakOpenParenthesis: 0
	+PenaltyBreakScopeResolution: 500
	+PenaltyBreakString: 1000
	+PenaltyBreakTemplateDeclaration: 10
	+PenaltyExcessCharacter: 1000000
	+PenaltyIndentedWhitespace: 0
	+PenaltyReturnTypeOnItsOwnLine: 60
	+PointerAlignment: Right
	+PPIndentWidth: -1
	+QualifierAlignment: Leave
	+ReferenceAlignment: Pointer
	+ReflowComments: true
	+RemoveBracesLLVM: false
	+RemoveParentheses: MultipleParentheses
	+RemoveSemicolon: true
	+SeparateDefinitionBlocks: Always
	+SkipMacroDefinitionBody: false
	+SortIncludes: CaseSensitive
	+SpaceAfterCStyleCast: true
	+SpaceAfterLogicalNot: false
	+SpaceAroundPointerQualifiers: Default
	+SpaceBeforeAssignmentOperators: true
	+SpaceBeforeCaseColon: false
	+SpaceBeforeParens: Custom
	+SpaceBeforeParensOptions:
	+ AfterControlStatements: true
	+ AfterForeachMacros: false
	+ AfterFunctionDefinitionName: false
	+ AfterFunctionDeclarationName: false
	+ AfterIfMacros: false
	+ BeforeNonEmptyParentheses: false
	+SpaceBeforeSquareBrackets: false
	+SpaceInEmptyBlock: false
	+SpacesBeforeTrailingComments: 1
	+SpacesInContainerLiterals: false
	+SpacesInLineCommentPrefix:
	+ Minimum: 1
	+ Maximum: -1
	+SpacesInParens: Custom
	+SpacesInParensOptions:
	+ InCStyleCasts: false
	+ InConditionalStatements: false
	+ InEmptyParentheses: false
	+ Other: false
	+SpacesInSquareBrackets: false
	+Standard: c++03
	+StatementAttributeLikeMacros:
	+StatementMacros:
	+TabWidth: 4
	+UseTab: Never
	+WhitespaceSensitiveMacros:
	+...
	diff --git a/devel/Makefile.am b/devel/Makefile.am
	index 71cb6b02d2..2c42208eaa 100644
	--- a/devel/Makefile.am
	+++ b/devel/Makefile.am
	@@ -1,337 +1,299 @@
	#
	-# Copyright 2020-2023 the Pacemaker project contributors
	+# Copyright 2020-2025 the Pacemaker project contributors
	#
	# The version control history for this file may have further details.
	#
	# This source code is licensed under the GNU General Public License version 2
	# or later (GPLv2+) WITHOUT ANY WARRANTY.
	#

	include $(top_srcdir)/mk/common.mk
	include $(top_srcdir)/mk/release.mk

	# Coccinelle is a tool that takes special patch-like files (called semantic patches) and
	# applies them throughout a source tree. This is useful when refactoring, changing APIs,
	# catching dangerous or incorrect code, and other similar tasks. It's not especially
	# easy to write a semantic patch but most users should only be concerned about running
	# the target and inspecting the results.
	#
	# Documentation (including examples, which are the most useful):
	# https://coccinelle.gitlabpages.inria.fr/website/docs/
	#
	# Run the "make cocci" target to just output what would be done, or "make cocci-inplace"
	# to apply the changes to the source tree.
	#
	# COCCI_FILES may be set on the command line, if you want to test just a single file
	# while it's under development. Otherwise, it is a list of all the files that are ready
	# to be run.
	#
	# ref-passed-variables-inited.cocci seems to be returning some false positives around
	# GHashTableIters, so it is disabled for the moment.
	COCCI_FILES ?= coccinelle/string-any-of.cocci \
	coccinelle/string-empty.cocci \
	coccinelle/string-null-matches.cocci \
	coccinelle/use-func.cocci


	dist_noinst_SCRIPTS = coccinelle/test/testrunner.sh
	EXTRA_DIST = README \
	gdbhelpers \
	$(COCCI_FILES) \
	coccinelle/ref-passed-variables-inited.cocci \
	coccinelle/rename-fn.cocci \
	coccinelle/test/ref-passed-variables-inited.input.c \
	coccinelle/test/ref-passed-variables-inited.output

	# Any file in this list is allowed to use any of the pcmk__ internal functions.
	# Coccinelle can use any transformation that depends on "internal" to rewrite
	# code to use the internal functions.
	MAY_USE_INTERNAL_FILES = $(shell find .. -path "../lib/.c" -o -path "../lib/private.h" -o -path "../tools/.c" -o -path "../daemons/.c" -o -path '../include/pcmki/h' -o -name 'internal.h')

	# And then any file in this list is public API, which may not use internal
	# functions. Thus, only those transformations that do not depend on "internal"
	# may be applied.
	OTHER_FILES = $(shell find ../include -name 'h' -a \! -name 'internal.h' -a \! -path '../include/pcmki/*')

	.PHONY: cocci
	cocci:
	-for cf in $(COCCI_FILES); do \
	for f in $(MAY_USE_INTERNAL_FILES); do \
	spatch $(_SPATCH_FLAGS) -D internal --very-quiet --local-includes --preprocess --sp-file $$cf $$f; \
	done ; \
	for f in $(OTHER_FILES); do \
	spatch $(_SPATCH_FLAGS) --very-quiet --local-includes --preprocess --sp-file $$cf $$f; \
	done ; \
	done

	.PHONY: cocci-inplace
	cocci-inplace:
	$(MAKE) $(AM_MAKEFLAGS) _SPATCH_FLAGS=--in-place cocci

	.PHONY: cocci-test
	cocci-test:
	for f in coccinelle/test/*.c; do \
	coccinelle/test/testrunner.sh $$f; \
	done

	#
	# Static analysis
	#

	## clang

	# See scan-build(1) for possible checkers (leave empty to use default set)
	CLANG_checkers ?=

	.PHONY: clang
	clang:
	OUT=$$(cd $(top_builddir) \
	&& scan-build $(CLANG_checkers:%=-enable-checker %) \
	$(MAKE) $(AM_MAKEFLAGS) CFLAGS="-std=c99 $(CFLAGS)" \
	clean all 2>&1); \
	REPORT=$$(echo "$$OUT" \
	\| sed -n -e "s/.'scan-view $.$'.*/\1/p"); \
	[ -z "$$REPORT" ] && echo "$$OUT" \|\| scan-view "$$REPORT"

	## coverity

	# Aggressiveness (low, medium, or high)
	COVLEVEL ?= low

	# Generated outputs
	COVERITY_DIR = $(abs_top_builddir)/coverity-$(TAG)
	COVTAR = $(abs_top_builddir)/$(PACKAGE)-coverity-$(TAG).tgz
	COVEMACS = $(abs_top_builddir)/$(TAG).coverity
	COVHTML = $(COVERITY_DIR)/output/errors

	# Coverity outputs are phony so they get rebuilt every invocation

	.PHONY: $(COVERITY_DIR)
	$(COVERITY_DIR): coverity-clean
	$(MAKE) $(AM_MAKEFLAGS) -C $(top_builddir) init core-clean
	$(AM_V_GEN)cd $(top_builddir) \
	&& cov-build --dir "$@" $(MAKE) $(AM_MAKEFLAGS) core

	# Public coverity instance

	.PHONY: $(COVTAR)
	$(COVTAR): $(COVERITY_DIR)
	$(AM_V_GEN)tar czf "$@" --transform="s@.*$(TAG)@cov-int@" "$<"

	.PHONY: coverity
	coverity: $(COVTAR)
	@echo "Now go to https://scan.coverity.com/users/sign_in and upload:"
	@echo " $(COVTAR)"
	@echo "then make clean at the top level"

	# Licensed coverity instance
	#
	# The prerequisites are a little hacky; rather than actually required, some
	# of them are designed so that things execute in the proper order (which is
	# not the same as GNU make's order-only prerequisites).

	.PHONY: coverity-analyze
	coverity-analyze: $(COVERITY_DIR)
	@echo ""
	@echo "Analyzing (waiting for coverity license if necessary) ..."
	cd $(top_builddir) && cov-analyze --dir "$<" --wait-for-license \
	--security --aggressiveness-level "$(COVLEVEL)"

	.PHONY: $(COVEMACS)
	$(COVEMACS): coverity-analyze
	$(AM_V_GEN)cd $(top_builddir) \
	&& cov-format-errors --dir "$(COVERITY_DIR)" --emacs-style > "$@"

	.PHONY: $(COVHTML)
	$(COVHTML): $(COVEMACS)
	$(AM_V_GEN)cd $(top_builddir) \
	&& cov-format-errors --dir "$(COVERITY_DIR)" --html-output "$@"

	.PHONY: coverity-corp
	coverity-corp: $(COVHTML)
	$(MAKE) $(AM_MAKEFLAGS) -C $(top_builddir) core-clean
	@echo "Done. See:"
	@echo " file://$(COVHTML)/index.html"
	@echo "When no longer needed, make coverity-clean"

	# Remove all outputs regardless of tag
	.PHONY: coverity-clean
	coverity-clean:
	-rm -rf "$(abs_builddir)"/coverity-* \
	"$(abs_builddir)"/$(PACKAGE)-coverity-*.tgz \
	"$(abs_builddir)"/*.coverity


	## cppcheck

	GLIB_CFLAGS ?= $(pkg-config --cflags glib-2.0)
	GLIB_INCL_DEF_CFLAGS = $(shell echo $(GLIB_CFLAGS) \
	\| tr ' ' '\n' \| grep '^-[IDU]' \| paste -d ' ')

	# Use CPPCHECK_ARGS to pass extra cppcheck options, e.g.:
	# --enable={warning,style,performance,portability,information,all}
	# --inconclusive --std=posix
	# -DDEFAULT_CONCURRENT_FENCING_TRUE
	CPPCHECK_ARGS ?=

	CPPCHECK_DIRS = replace lib daemons tools
	CPPCHECK_OUT = $(abs_top_builddir)/cppcheck.out

	.PHONY: cppcheck
	cppcheck:
	cppcheck $(CPPCHECK_ARGS) -I $(top_srcdir)/include \
	--output-file=$(CPPCHECK_OUT) \
	--max-configs=30 --inline-suppr -q \
	--library=posix --library=gnu --library=gtk \
	$(GLIB_INCL_DEF_CFLAGS) -D__GNUC__ \
	$(foreach dir,$(CPPCHECK_DIRS),$(top_srcdir)/$(dir))
	@echo "Done: See $(CPPCHECK_OUT)"
	@echo "When no longer needed, make cppcheck-clean"

	.PHONY: cppcheck-clean
	cppcheck-clean:
	-rm -f "$(CPPCHECK_OUT)"

	#
	# Coverage/profiling
	#

	COVERAGE_DIR = $(top_builddir)/coverage

	# Check coverage of unit tests
	.PHONY: coverage
	coverage: coverage-partial-clean
	cd $(top_builddir) \
	&& $(MAKE) $(AM_MAKEFLAGS) \
	&& lcov --no-external --exclude='*_test.c' -c -i -d . \
	-o pacemaker_base.info \
	&& $(MAKE) $(AM_MAKEFLAGS) check \
	&& lcov --no-external --exclude='*_test.c' -c -d . \
	-o pacemaker_test.info \
	&& lcov -a pacemaker_base.info -a pacemaker_test.info \
	-o pacemaker_total.info \
	&& lcov --remove pacemaker_total.info -o pacemaker_filtered.info\
	"$(abs_top_builddir)/tools/*" \
	"$(abs_top_builddir)/daemons//" \
	"$(abs_top_builddir)/replace/*" \
	genhtml $(top_builddir)/pacemaker_filtered.info -o $(COVERAGE_DIR) -s -t "Pacemaker code coverage"

	# Check coverage of CLI regression tests
	.PHONY: coverage-cts
	coverage-cts: coverage-partial-clean
	cd $(top_builddir) \
	&& $(MAKE) $(AM_MAKEFLAGS) \
	&& lcov --no-external -c -i -d tools -o pacemaker_base.info \
	&& cts/cts-cli \
	&& lcov --no-external -c -d tools -o pacemaker_test.info \
	&& lcov -a pacemaker_base.info -a pacemaker_test.info \
	-o pacemaker_total.info
	genhtml $(top_builddir)/pacemaker_total.info -o $(COVERAGE_DIR) -s

	# Remove coverage-related files that aren't needed across runs
	.PHONY: coverage-partial-clean
	coverage-partial-clean:
	-rm -f $(top_builddir)/pacemaker_*.info
	-rm -rf $(COVERAGE_DIR)
	-find $(top_builddir) -name "*.gcda" -exec rm -f \{\} \;

	# This target removes all coverage-related files. It is only to be run when
	# done with coverage analysis and you are ready to go back to normal development,
	# starting with re-running ./configure. It is not to be run in between
	# "make coverage" runs.
	#
	# In particular, the *.gcno files are generated when the source is built.
	# Removing those files will break "make coverage" until the whole source tree
	# has been built and the *.gcno files generated again.
	.PHONY: coverage-clean
	coverage-clean: coverage-partial-clean
	-find $(top_builddir) -name "*.gcno" -exec rm -f \{\} \;

	-#
	-# indent cannot cope with all our exceptions and needs heavy manual editing
	-#
	-# @TODO investigate using clang-format instead
	-#
	+# Automatic code formatting - this makes use of clang-format and the .clang-format
	+# config file. It's based on GNU coding, but heavily modified for our needs
	+# and to reflect the C coding guidelines documentation.

	-# indent target: Limit indent to these directories
	+# Limit clang-format to these directories
	INDENT_DIRS ?= .

	-# indent target: Extra options to pass to indent
	+# Extra options to pass to clang-format
	INDENT_OPTS ?=

	-INDENT_IGNORE_PATHS = daemons/controld/controld_fsa.h
	-INDENT_PACEMAKER_STYLE = --blank-lines-after-declarations \
	- --blank-lines-after-procedures \
	- --braces-after-func-def-line \
	- --braces-on-if-line \
	- --braces-on-struct-decl-line \
	- --break-before-boolean-operator \
	- --case-brace-indentation4 \
	- --case-indentation4 \
	- --comment-indentation0 \
	- --continuation-indentation4 \
	- --continue-at-parentheses \
	- --cuddle-do-while \
	- --cuddle-else \
	- --declaration-comment-column0 \
	- --declaration-indentation1 \
	- --else-endif-column0 \
	- --honour-newlines \
	- --indent-label0 \
	- --indent-level4 \
	- --line-comments-indentation0 \
	- --line-length80 \
	- --no-blank-lines-after-commas \
	- --no-comment-delimiters-on-blank-lines \
	- --no-space-after-function-call-names \
	- --no-space-after-parentheses \
	- --no-tabs \
	- --preprocessor-indentation2 \
	- --procnames-start-lines \
	- --space-after-cast \
	- --start-left-side-of-comments \
	- --swallow-optional-blank-lines \
	- --tab-size8
	-
	.PHONY: indent
	indent:
	- VERSION_CONTROL=none \
	- find $(INDENT_DIRS) -type f -name "*.[ch]" \
	- $(INDENT_IGNORE_PATHS:%= ! -path '%') \
	- -exec indent $(INDENT_PACEMAKER_STYLE) $(INDENT_OPTS) \{\} \;
	+ find $(INDENT_DIRS) -type f -name "*.[ch]" \
	+ -exec clang-format $(INDENT_OPTS) \{\} \;

	#
	# Check whether copyrights have been updated appropriately
	# (Set COMMIT to desired commit or commit range to check, defaulting to HEAD,
	# or set it empty to check uncommitted changes)
	#
	YEAR = $(shell date +%Y)
	MODIFIED_FILES = $(shell case "$(COMMIT)" in \
	[0-9a-f]*$(rparen) \
	git diff-tree --no-commit-id \
	--name-only "$(COMMIT)" -r ;; \
	*$(rparen) \
	cd "$(top_srcdir)"; \
	git ls-files --modified ;; \
	esac)

	.PHONY: copyright
	copyright:
	@cd "$(top_srcdir)" && for file in $(MODIFIED_FILES); do \
	if ! grep 'opyright .$(YEAR). Pacemaker' "$$file" \
	>/dev/null 2>&1; then \
	echo "$$file"; \
	fi; \
	done

	#
	# Scratch file for ad-hoc testing
	#

	EXTRA_PROGRAMS = scratch
	nodist_scratch_SOURCES = scratch.c
	scratch_LDADD = $(top_builddir)/lib/common/libcrmcommon.la

	.PHONY: clean-local
	clean-local: coverage-clean coverity-clean cppcheck-clean
	-rm -f $(EXTRA_PROGRAMS)

File Metadata

Mime Type: text/x-diff
Expires: Mon, Apr 21, 10:36 AM (1 d, 8 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1658307
Default Alt Text: (17 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions