shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2025-01-31 05:47:30 +03:00
Code
systemd/src/shared/main-func.h

43 lines
2.0 KiB
C
Raw Normal View History

license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 13:23:58 +09:00
/* SPDX-License-Identifier: LGPL-2.1-or-later */
util-lib: move main() definition macros to its own header file This way, we can extend the macro a bit with stuff pulled in from other headers without this affecting everything which pulls in macro.h, which is one of our most basic headers. This is just refactoring, no change in behaviour, in prepartion for later changes.
2018-11-19 20:26:37 +01:00
#pragma once
#include <stdlib.h>
main-func: send main exit code to parent via sd_notify() on exit So far we silently convert negative return values from run() as EXIT_FAILURE, which is how UNIX expects it. In many cases it would be very useful for the caller to retrieve the actual error number we exit with. Let's generically return that via sd_notify()'s ERRNO= attribute. This means callers can set $NOTIFY_SOCKET and get the actual error number delivered at their doorstep just like that.
2019-05-17 10:17:06 +02:00
#include "sd-daemon.h"
basic: move a bunch of cmdline-related funcs to new argv-util.c+h I wanted to move saved_arg[cv] to process-util.c+h, but this causes problems: process-util.h includes format-util.h which includes net/if.h, which conflicts with linux/if.h. So we can't include process-util.h in some files. But process-util.c is very long anyway, so it seems nice to create a new file. rename_process(), invoked_as(), invoked_by_systemd(), and argv_looks_like_help() which lived in process-util.c refer to saved_argc and saved_argv, so it seems reasonable to move them to the new file too. util.c is now empty, so it is removed. util.h remains.
2022-11-06 16:45:48 +01:00
#include "argv-util.h"
basic/main-func: also close the pager automatically We generally want to close the pager last. This patch closes the pager last, after the static destuctor calls. This means that they can do logging and such like during normal program runtime.
2018-11-20 14:03:46 +01:00
#include "pager.h"
Call mac_selinux_close() from main func macros, convert user-sessions and test-udev
2018-11-20 16:40:49 +01:00
#include "selinux-util.h"
systemctl: define main through macro and call ask_password_agent_close() from the macro This doesn't save us anything, but I like consistency.
2018-11-20 10:22:26 +01:00
#include "spawn-ask-password-agent.h"
shared/main-func: also close the polkit agent automatically The agent is closed after the static destuctors but before the pager. No users of DEFINE_MAIN_FUNCTION* were using a polkit agent, so this makes no functional difference.
2018-11-20 15:52:40 +01:00
#include "spawn-polkit-agent.h"
main-func: automatically call static destructors from main-func.h macros
2018-11-19 20:47:46 +01:00
#include "static-destruct.h"
generators: define custom main func definer and use it where applicable There should be no functional difference, except that the error message is changd from "three or no arguments" to "zero or three arguments". Somehow the inverted form always seemed strange. umask() call is also dropped from run-generator. I think it wasn't dropped in 053254e3cb215df3b8c905bc39b920f8817e1c7d because the run generator was merged around the same time.
2018-12-04 11:49:42 +01:00
#define _DEFINE_MAIN_FUNCTION(intro, impl, ret) \
util-lib: move main() definition macros to its own header file This way, we can extend the macro a bit with stuff pulled in from other headers without this affecting everything which pulls in macro.h, which is one of our most basic headers. This is just refactoring, no change in behaviour, in prepartion for later changes.
2018-11-19 20:26:37 +01:00
int main(int argc, char *argv[]) { \
int r; \
core: check argc/argv uncoditionally as `assert()` might be dropped with `-DNDEBUG`. Follow-up to cf3095a and 1637e75.
2022-01-30 15:49:27 +01:00
assert_se(argc > 0 && !isempty(argv[0])); \
main-func: implicitly save argc/argv in DEFINE_MAIN_FUNCTION() functions Let's remove the risk of forgetting to save argc/argv if DEFINE_MAIN_FUNCTION() is used.
2019-03-15 14:49:43 +01:00
save_argc_argv(argc, argv); \
generators: define custom main func definer and use it where applicable There should be no functional difference, except that the error message is changd from "three or no arguments" to "zero or three arguments". Somehow the inverted form always seemed strange. umask() call is also dropped from run-generator. I think it wasn't dropped in 053254e3cb215df3b8c905bc39b920f8817e1c7d because the run generator was merged around the same time.
2018-12-04 11:49:42 +01:00
intro; \
r = impl; \
main-func: send main exit code to parent via sd_notify() on exit So far we silently convert negative return values from run() as EXIT_FAILURE, which is how UNIX expects it. In many cases it would be very useful for the caller to retrieve the actual error number we exit with. Let's generically return that via sd_notify()'s ERRNO= attribute. This means callers can set $NOTIFY_SOCKET and get the actual error number delivered at their doorstep just like that.
2019-05-17 10:17:06 +02:00
if (r < 0) \
(void) sd_notifyf(0, "ERRNO=%i", -r); \
notify: Add EXIT_STATUS field Whenever one of our tools or daemons exits, let's send the exit status via sd-notify in the EXIT_STATUS field.
2023-04-12 11:56:00 +02:00
(void) sd_notifyf(0, "EXIT_STATUS=%i", ret); \
systemctl: define main through macro and call ask_password_agent_close() from the macro This doesn't save us anything, but I like consistency.
2018-11-20 10:22:26 +01:00
ask_password_agent_close(); \
shared/main-func: also close the polkit agent automatically The agent is closed after the static destuctors but before the pager. No users of DEFINE_MAIN_FUNCTION* were using a polkit agent, so this makes no functional difference.
2018-11-20 15:52:40 +01:00
polkit_agent_close(); \
basic/main-func: also close the pager automatically We generally want to close the pager last. This patch closes the pager last, after the static destuctor calls. This means that they can do logging and such like during normal program runtime.
2018-11-20 14:03:46 +01:00
pager_close(); \
main-func: make sure we destruct memory and stuff last Let's terminate pagers and agents before releasing all memory.
2019-03-21 17:57:16 +01:00
mac_selinux_finish(); \
static_destruct(); \
basic/main-func: unify the two macros No functional change.
2018-11-20 13:54:12 +01:00
return ret; \
util-lib: move main() definition macros to its own header file This way, we can extend the macro a bit with stuff pulled in from other headers without this affecting everything which pulls in macro.h, which is one of our most basic headers. This is just refactoring, no change in behaviour, in prepartion for later changes.
2018-11-19 20:26:37 +01:00
}
basic/main-func: unify the two macros No functional change.
2018-11-20 13:54:12 +01:00
/* Negative return values from impl are mapped to EXIT_FAILURE, and
* everything else means success! */
#define DEFINE_MAIN_FUNCTION(impl) \
generators: define custom main func definer and use it where applicable There should be no functional difference, except that the error message is changd from "three or no arguments" to "zero or three arguments". Somehow the inverted form always seemed strange. umask() call is also dropped from run-generator. I think it wasn't dropped in 053254e3cb215df3b8c905bc39b920f8817e1c7d because the run generator was merged around the same time.
2018-12-04 11:49:42 +01:00
_DEFINE_MAIN_FUNCTION(,impl(argc, argv), r < 0 ? EXIT_FAILURE : EXIT_SUCCESS)
basic/main-func: unify the two macros No functional change.
2018-11-20 13:54:12 +01:00
basic/main-func: propagate all positive return values This changes DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE() to propagate positive return values as they were, i.e. stops mapping them all to EXIT_FAILURE. This was suggested in review, but I thought that we only ever return EXIT_FAILURE, so we don't need to propagate multiple return values. I was wrong. Turns out that we already *do* have multiple positive return values, when we call external binaries and propagate the result. systemd-inhibit is one example, and b453c447e0fb4a1e9eccd42120731c1700220b21 actually broke this propagation. This commit fixes it. In systemd-fsck we have the opposite case: we have only one failure value, and the code needs to be adjusted, so that it keeps returning EXIT_FAILURE. All other users of DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE() return <= 1, and are unaffected by this change.
2018-11-20 09:49:42 +01:00
/* Zero is mapped to EXIT_SUCCESS, negative values are mapped to EXIT_FAILURE,
codespell: fix spelling errors
2019-04-26 20:22:40 -04:00
* and positive values are propagated.
basic/main-func: propagate all positive return values This changes DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE() to propagate positive return values as they were, i.e. stops mapping them all to EXIT_FAILURE. This was suggested in review, but I thought that we only ever return EXIT_FAILURE, so we don't need to propagate multiple return values. I was wrong. Turns out that we already *do* have multiple positive return values, when we call external binaries and propagate the result. systemd-inhibit is one example, and b453c447e0fb4a1e9eccd42120731c1700220b21 actually broke this propagation. This commit fixes it. In systemd-fsck we have the opposite case: we have only one failure value, and the code needs to be adjusted, so that it keeps returning EXIT_FAILURE. All other users of DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE() return <= 1, and are unaffected by this change.
2018-11-20 09:49:42 +01:00
* Note: "true" means failure! */
util-lib: move main() definition macros to its own header file This way, we can extend the macro a bit with stuff pulled in from other headers without this affecting everything which pulls in macro.h, which is one of our most basic headers. This is just refactoring, no change in behaviour, in prepartion for later changes.
2018-11-19 20:26:37 +01:00
#define DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(impl) \
generators: define custom main func definer and use it where applicable There should be no functional difference, except that the error message is changd from "three or no arguments" to "zero or three arguments". Somehow the inverted form always seemed strange. umask() call is also dropped from run-generator. I think it wasn't dropped in 053254e3cb215df3b8c905bc39b920f8817e1c7d because the run generator was merged around the same time.
2018-12-04 11:49:42 +01:00
_DEFINE_MAIN_FUNCTION(,impl(argc, argv), r < 0 ? EXIT_FAILURE : r)
Copy Permalink