Skip to content

Utility Commands

Paul Nilsson edited this page Apr 25, 2022 · 1 revision

The Pilot may execute special utility commands, defined by the following constants (set in pilot/util/constants.py):

UTILITY_BEFORE_PAYLOAD = 1
UTILITY_WITH_PAYLOAD = 2
UTILITY_AFTER_PAYLOAD_STARTED = 3
UTILITY_AFTER_PAYLOAD_STARTED2 = 4
UTILITY_AFTER_PAYLOAD = 5
UTILITY_AFTER_PAYLOAD_FINISHED = 6
UTILITY_BEFORE_STAGEIN = 7
UTILITY_WITH_STAGEIN = 8

The command itself is defined in pilot/users/[user]/common.py and returned by get_utility_command(). Examples of utility commands include memory monitoring (launched before payload starts, killed after payload finishes), xcache service (launched before stage-in starts, stopped after payload finishes), pre-process (launched before main payload), co-process (launched after payload started), post-process (launched after payload finishes).