blob: baea3af021d88817196cb81920d57759e46d107e [file] [log] [blame]
Brad Bishope36358c2016-06-08 22:03:59 -04001# Common code for systemd based services.
2#
3# Prior to inheriting this class, recipes can define services like this:
4#
Patrick Williams12fc9392021-08-06 09:16:53 -05005# SYSTEMD_SERVICE:${PN} = "foo.service bar.socket baz@.service"
Brad Bishope36358c2016-06-08 22:03:59 -04006#
7# and these files will be added to the main package if they exist.
8#
9# Alternatively this class can just be inherited and
Brad Bishop62d676a2016-07-11 00:42:58 -040010# ${PN}.service will be added to the main package.
Brad Bishop687146f2016-07-11 13:05:26 -040011#
12# Other variables:
13# INHIBIT_SYSTEMD_RESTART_POLICY_${unit}
14# Inhibit the warning that is displayed if a service unit without a
15# restart policy is detected.
Brad Bishop51528fe2016-07-14 19:34:06 -040016#
Brad Bishop58ab4a02016-08-17 15:58:26 -040017# SYSTEMD_SUBSTITUTIONS = "var:val:file"
18# A specification for making python style {format} string
19# substitutions where:
20# var: the format string to search for
21# val: the value to replace with
22# file: the file in which to make the substitution
Brad Bishopf815b2e2016-07-14 19:50:19 -040023#
Brad Bishop58700d12016-08-15 22:35:58 -040024# SYSTEMD_USER_${PN}.service = "foo"
25# SYSTEMD_USER_${unit}.service = "foo"
26# The user for the unit/package.
Brad Bishopafb2e1b2016-08-08 09:29:20 -040027#
28# SYSTEMD_ENVIRONMENT_FILE_${PN} = "foo"
29# One or more environment files to be installed.
Brad Bishop0161aff2016-08-17 14:46:41 -040030#
31# SYSTEMD_LINK_${PN} = "tgt:name"
32# A specification for installing arbitrary links in
33# the ${systemd_system_unitdir} namespace, where:
34# tgt: the link target
35# name: the link name, relative to ${systemd_system_unitdir}
Brad Bishop9ca070c2016-08-18 23:59:44 -040036#
37# SYSTEMD_OVERRIDE_${PN} = "src:dest"
38# A specification for installing unit overrides where:
39# src: the override file template
40# dest: the override install location, relative to ${systemd_system_unitdir}
41#
42# Typically SYSTEMD_SUBSTITUTIONS is used to deploy a range
43# of overrides from a single template file. To simply install
44# a single override use "foo.conf:my-service.d/foo.conf"
Brad Bishop51528fe2016-07-14 19:34:06 -040045
Brad Bishop9dc56712016-07-07 15:56:02 -040046
47inherit obmc-phosphor-utils
Brad Bishop93fb5352015-09-09 03:59:20 +000048inherit systemd
Brad Bishopf815b2e2016-07-14 19:50:19 -040049inherit useradd
Brad Bishop93fb5352015-09-09 03:59:20 +000050
Brad Bishop9dc56712016-07-07 15:56:02 -040051_INSTALL_SD_UNITS=""
Brad Bishopfc81e382019-04-06 13:58:07 -040052SYSTEMD_DEFAULT_TARGET ?= "multi-user.target"
Brad Bishopafb2e1b2016-08-08 09:29:20 -040053envfiledir ?= "${sysconfdir}/default"
Brad Bishop9dc56712016-07-07 15:56:02 -040054
Brad Bishopf815b2e2016-07-14 19:50:19 -040055# Big ugly hack to prevent useradd.bbclass post-parse sanity checker failure.
56# If there are users to be added, we'll add them in our post-parse.
57# If not...there don't seem to be any ill effects...
58USERADD_PACKAGES ?= " "
Patrick Williams12fc9392021-08-06 09:16:53 -050059USERADD_PARAM:${PN} ?= ";"
Brad Bishopf815b2e2016-07-14 19:50:19 -040060
Brad Bishope36358c2016-06-08 22:03:59 -040061
Brad Bishop18645292016-08-16 08:18:07 -040062def SystemdUnit(unit):
63 class Unit(object):
64 def __init__(self, unit):
65 self.unit = unit
Brad Bishop687146f2016-07-11 13:05:26 -040066
Brad Bishop18645292016-08-16 08:18:07 -040067 def __getattr__(self, item):
Joel Stanley37c8ead2021-02-25 15:00:34 +103068 if item == 'name':
Brad Bishop18645292016-08-16 08:18:07 -040069 return self.unit
Joel Stanley37c8ead2021-02-25 15:00:34 +103070 if item == 'is_activated':
Brad Bishop18645292016-08-16 08:18:07 -040071 return self.unit.startswith('dbus-')
Joel Stanley37c8ead2021-02-25 15:00:34 +103072 if item == 'is_template':
Brad Bishop18645292016-08-16 08:18:07 -040073 return '@.' in self.unit
Joel Stanley37c8ead2021-02-25 15:00:34 +103074 if item == 'is_instance':
Brad Bishop18645292016-08-16 08:18:07 -040075 return '@' in self.unit and not self.is_template
76 if item in ['is_service', 'is_target']:
77 return self.unit.split('.')[-1] == item
Joel Stanley37c8ead2021-02-25 15:00:34 +103078 if item == 'base':
Brad Bishop18645292016-08-16 08:18:07 -040079 cls = self.unit.split('.')[-1]
80 base = self.unit.replace('dbus-', '')
81 base = base.replace('.%s' % cls, '')
82 if self.is_instance:
Robert Lippert0ccabae2017-11-28 10:59:31 -080083 base = base.replace('@%s' % self.instance, '')
Brad Bishop18645292016-08-16 08:18:07 -040084 if self.is_template:
85 base = base.rstrip('@')
86 return base
Joel Stanley37c8ead2021-02-25 15:00:34 +103087 if item == 'instance' and self.is_instance:
Brad Bishop18645292016-08-16 08:18:07 -040088 inst = self.unit.rsplit('@')[-1]
89 return inst.rsplit('.')[0]
Joel Stanley37c8ead2021-02-25 15:00:34 +103090 if item == 'template' and self.is_instance:
Brad Bishop18645292016-08-16 08:18:07 -040091 cls = self.unit.split('.')[-1]
92 return '%s@.%s' % (self.base, cls)
Joel Stanley37c8ead2021-02-25 15:00:34 +103093 if item == 'template' and self.is_template:
Brad Bishop18645292016-08-16 08:18:07 -040094 return '.'.join(self.base.split('@')[:-1])
Brad Bishop687146f2016-07-11 13:05:26 -040095
Brad Bishop18645292016-08-16 08:18:07 -040096 raise AttributeError(item)
97 return Unit(unit)
Brad Bishop687146f2016-07-11 13:05:26 -040098
99
100def systemd_parse_unit(d, path):
Saqib Khanc1401582017-03-07 06:59:20 -0600101 import configparser
102 parser = configparser.SafeConfigParser(strict=False)
Brad Bishop687146f2016-07-11 13:05:26 -0400103 parser.optionxform = str
104 parser.read('%s' % path)
105 return parser
106
107
Brad Bishope36358c2016-06-08 22:03:59 -0400108python() {
Brad Bishop687146f2016-07-11 13:05:26 -0400109 def check_sd_unit(d, unit):
Brad Bishop9dc56712016-07-07 15:56:02 -0400110 searchpaths = d.getVar('FILESPATH', True)
Brad Bishop18645292016-08-16 08:18:07 -0400111 path = bb.utils.which(searchpaths, '%s' % unit.name)
Brad Bishop9dc56712016-07-07 15:56:02 -0400112 if not os.path.isfile(path):
Lei YUf33c69c2019-03-14 13:29:07 +0800113 # Unit does not exist in tree. Allow it to install from repo.
114 # Return False here to indicate it does not exist.
115 return False
Brad Bishop687146f2016-07-11 13:05:26 -0400116
117 parser = systemd_parse_unit(d, path)
118 inhibit = listvar_to_list(d, 'INHIBIT_SYSTEMD_RESTART_POLICY_WARNING')
Brad Bishop18645292016-08-16 08:18:07 -0400119 if unit.is_service and \
120 not unit.is_template and \
121 unit.name not in inhibit and \
Brad Bishop687146f2016-07-11 13:05:26 -0400122 not parser.has_option('Service', 'Restart'):
123 bb.warn('Systemd unit \'%s\' does not '
Brad Bishop18645292016-08-16 08:18:07 -0400124 'have a restart policy defined.' % unit.name)
Lei YUf33c69c2019-03-14 13:29:07 +0800125 return True
Brad Bishop687146f2016-07-11 13:05:26 -0400126
127
Brad Bishop522234c2016-08-17 15:42:31 -0400128 def add_default_subs(d, file):
Brad Bishop51528fe2016-07-14 19:34:06 -0400129 for x in [
130 'base_bindir',
131 'bindir',
132 'sbindir',
William A. Kennington III25e10572020-04-03 11:53:09 -0700133 'libexecdir',
Brad Bishopafb2e1b2016-08-08 09:29:20 -0400134 'envfiledir',
Xo Wangd509c4c2017-01-18 17:55:50 -0800135 'sysconfdir',
William A. Kennington III25e10572020-04-03 11:53:09 -0700136 'localstatedir',
137 'datadir',
Brad Bishop51528fe2016-07-14 19:34:06 -0400138 'SYSTEMD_DEFAULT_TARGET' ]:
Patrick Williams12fc9392021-08-06 09:16:53 -0500139 set_doappend(d, 'SYSTEMD_SUBSTITUTIONS',
Brad Bishop58ab4a02016-08-17 15:58:26 -0400140 '%s:%s:%s' % (x, d.getVar(x, True), file))
Brad Bishop51528fe2016-07-14 19:34:06 -0400141
Brad Bishopf815b2e2016-07-14 19:50:19 -0400142
Lei YUf33c69c2019-03-14 13:29:07 +0800143 def add_sd_unit(d, unit, pkg, unit_exist):
144 # Do not add unit if it does not exist in tree.
145 # It will be installed from repo.
146 if not unit_exist:
147 return
148
Brad Bishop18645292016-08-16 08:18:07 -0400149 name = unit.name
Brad Bishop522234c2016-08-17 15:42:31 -0400150 unit_dir = d.getVar('systemd_system_unitdir', True)
Patrick Williams12fc9392021-08-06 09:16:53 -0500151 set_doappend(d, 'SRC_URI', 'file://%s' % name)
152 set_doappend(d, 'FILES:%s' % pkg, '%s/%s' % (unit_dir, name))
153 set_doappend(d, '_INSTALL_SD_UNITS', name)
Brad Bishop522234c2016-08-17 15:42:31 -0400154 add_default_subs(d, name)
155
156
157 def add_sd_user(d, file, pkg):
Brad Bishopf815b2e2016-07-14 19:50:19 -0400158 opts = [
159 '--system',
160 '--home',
161 '/',
162 '--no-create-home',
163 '--shell /sbin/nologin',
164 '--user-group']
165
Brad Bishop522234c2016-08-17 15:42:31 -0400166 var = 'SYSTEMD_USER_%s' % file
Brad Bishop58700d12016-08-15 22:35:58 -0400167 user = listvar_to_list(d, var)
Joel Stanley37c8ead2021-02-25 15:00:34 +1030168 if len(user) == 0:
Brad Bishop58700d12016-08-15 22:35:58 -0400169 var = 'SYSTEMD_USER_%s' % pkg
170 user = listvar_to_list(d, var)
Joel Stanley37c8ead2021-02-25 15:00:34 +1030171 if len(user) != 0:
172 if len(user) != 1:
Brad Bishop58700d12016-08-15 22:35:58 -0400173 bb.fatal('Too many users assigned to %s: \'%s\'' % (var, ' '.join(user)))
174
175 user = user[0]
Patrick Williams12fc9392021-08-06 09:16:53 -0500176 set_doappend(d, 'SYSTEMD_SUBSTITUTIONS',
Brad Bishop58ab4a02016-08-17 15:58:26 -0400177 'USER:%s:%s' % (user, file))
Patrick Williams12fc9392021-08-06 09:16:53 -0500178 if user not in d.getVar('USERADD_PARAM:%s' % pkg, True):
179 set_doappend(
Brad Bishop58700d12016-08-15 22:35:58 -0400180 d,
Patrick Williams12fc9392021-08-06 09:16:53 -0500181 'USERADD_PARAM:%s' % pkg,
Brad Bishop58700d12016-08-15 22:35:58 -0400182 '%s' % (' '.join(opts + [user])),
183 ';')
Brad Bishopf815b2e2016-07-14 19:50:19 -0400184 if pkg not in d.getVar('USERADD_PACKAGES', True):
Patrick Williams12fc9392021-08-06 09:16:53 -0500185 set_doappend(d, 'USERADD_PACKAGES', pkg)
Brad Bishopf815b2e2016-07-14 19:50:19 -0400186
Brad Bishop9dc56712016-07-07 15:56:02 -0400187
Brad Bishopafb2e1b2016-08-08 09:29:20 -0400188 def add_env_file(d, name, pkg):
Patrick Williams12fc9392021-08-06 09:16:53 -0500189 set_doappend(d, 'SRC_URI', 'file://%s' % name)
190 set_doappend(d, 'FILES:%s' % pkg, '%s/%s' \
Brad Bishopafb2e1b2016-08-08 09:29:20 -0400191 % (d.getVar('envfiledir', True), name))
Patrick Williams12fc9392021-08-06 09:16:53 -0500192 set_doappend(d, '_INSTALL_ENV_FILES', name)
Brad Bishopafb2e1b2016-08-08 09:29:20 -0400193
194
Brad Bishop0161aff2016-08-17 14:46:41 -0400195 def install_link(d, spec, pkg):
196 tgt, dest = spec.split(':')
197
Patrick Williams12fc9392021-08-06 09:16:53 -0500198 set_doappend(d, 'FILES:%s' % pkg, '%s/%s' \
Brad Bishop0161aff2016-08-17 14:46:41 -0400199 % (d.getVar('systemd_system_unitdir', True), dest))
Patrick Williams12fc9392021-08-06 09:16:53 -0500200 set_doappend(d, '_INSTALL_LINKS', spec)
Brad Bishop0161aff2016-08-17 14:46:41 -0400201
202
Brad Bishop9ca070c2016-08-18 23:59:44 -0400203 def add_override(d, spec, pkg):
204 tmpl, dest = spec.split(':')
Patrick Williams12fc9392021-08-06 09:16:53 -0500205 set_doappend(d, '_INSTALL_OVERRIDES', '%s' % spec)
Brad Bishop9ca070c2016-08-18 23:59:44 -0400206 unit_dir = d.getVar('systemd_system_unitdir', True)
Patrick Williams12fc9392021-08-06 09:16:53 -0500207 set_doappend(d, 'FILES:%s' % pkg, '%s/%s' % (unit_dir, dest))
Brad Bishop9ca070c2016-08-18 23:59:44 -0400208 add_default_subs(d, '%s' % dest)
209 add_sd_user(d, '%s' % dest, pkg)
210
211
Brad Bishop038b44b2018-01-25 07:00:27 -0500212 if d.getVar('CLASSOVERRIDE', True) != 'class-target':
213 return
214
215 d.appendVarFlag('do_install', 'postfuncs', ' systemd_do_postinst')
216
Brad Bishop62d676a2016-07-11 00:42:58 -0400217 pn = d.getVar('PN', True)
Patrick Williams12fc9392021-08-06 09:16:53 -0500218 if d.getVar('SYSTEMD_SERVICE:%s' % pn, True) is None:
219 d.setVar('SYSTEMD_SERVICE:%s' % pn, '%s.service' % pn)
Brad Bishope36358c2016-06-08 22:03:59 -0400220
Brad Bishop9dc56712016-07-07 15:56:02 -0400221 for pkg in listvar_to_list(d, 'SYSTEMD_PACKAGES'):
Patrick Williams12fc9392021-08-06 09:16:53 -0500222 svc = listvar_to_list(d, 'SYSTEMD_SERVICE:%s' % pkg)
Brad Bishop18645292016-08-16 08:18:07 -0400223 svc = [SystemdUnit(x) for x in svc]
224 tmpl = [x.template for x in svc if x.is_instance]
225 tmpl = list(set(tmpl))
226 tmpl = [SystemdUnit(x) for x in tmpl]
227 svc = [x for x in svc if not x.is_instance]
228
229 for unit in tmpl + svc:
Lei YUf33c69c2019-03-14 13:29:07 +0800230 unit_exist = check_sd_unit(d, unit)
231 add_sd_unit(d, unit, pkg, unit_exist)
Brad Bishop522234c2016-08-17 15:42:31 -0400232 add_sd_user(d, unit.name, pkg)
Brad Bishopafb2e1b2016-08-08 09:29:20 -0400233 for name in listvar_to_list(d, 'SYSTEMD_ENVIRONMENT_FILE_%s' % pkg):
234 add_env_file(d, name, pkg)
Brad Bishop0161aff2016-08-17 14:46:41 -0400235 for spec in listvar_to_list(d, 'SYSTEMD_LINK_%s' % pkg):
236 install_link(d, spec, pkg)
Brad Bishop9ca070c2016-08-18 23:59:44 -0400237 for spec in listvar_to_list(d, 'SYSTEMD_OVERRIDE_%s' % pkg):
238 add_override(d, spec, pkg)
Brad Bishope36358c2016-06-08 22:03:59 -0400239}
Brad Bishop93fb5352015-09-09 03:59:20 +0000240
Brad Bishop9dc56712016-07-07 15:56:02 -0400241
Brad Bishop51528fe2016-07-14 19:34:06 -0400242python systemd_do_postinst() {
Brad Bishop522234c2016-08-17 15:42:31 -0400243 def make_subs(d):
Brad Bishop58ab4a02016-08-17 15:58:26 -0400244 all_subs = {}
245 for spec in listvar_to_list(d, 'SYSTEMD_SUBSTITUTIONS'):
246 spec, file = spec.rsplit(':', 1)
247 all_subs.setdefault(file, []).append(spec)
248
Saqib Khancef980a2017-03-07 07:15:29 -0600249 for f, v in all_subs.items():
Brad Bishop58ab4a02016-08-17 15:58:26 -0400250 subs = dict([ x.split(':') for x in v])
Brad Bishop522234c2016-08-17 15:42:31 -0400251 if not subs:
252 continue
Brad Bishop51528fe2016-07-14 19:34:06 -0400253
Brad Bishop522234c2016-08-17 15:42:31 -0400254 path = d.getVar('D', True)
255 path += d.getVar('systemd_system_unitdir', True)
256 path += '/%s' % f
257 with open(path, 'r') as fd:
258 content = fd.read()
259 with open(path, 'w+') as fd:
260 try:
261 fd.write(content.format(**subs))
262 except KeyError as e:
263 bb.fatal('No substitution found for %s in '
264 'file \'%s\'' % (e, f))
265
266
Brad Bishopafb2e1b2016-08-08 09:29:20 -0400267 def install_envs(d):
268 install_dir = d.getVar('D', True)
269 install_dir += d.getVar('envfiledir', True)
270 searchpaths = d.getVar('FILESPATH', True)
271
272 for f in listvar_to_list(d, '_INSTALL_ENV_FILES'):
273 src = bb.utils.which(searchpaths, f)
274 if not os.path.isfile(src):
275 bb.fatal('Did not find SYSTEMD_ENVIRONMENT_FILE:'
276 '\'%s\'' % src)
277
278 dest = os.path.join(install_dir, f)
279 parent = os.path.dirname(dest)
280 if not os.path.exists(parent):
281 os.makedirs(parent)
282
283 with open(src, 'r') as fd:
284 content = fd.read()
285 with open(dest, 'w+') as fd:
286 fd.write(content)
287
288
Brad Bishop0161aff2016-08-17 14:46:41 -0400289 def install_links(d):
290 install_dir = d.getVar('D', True)
291 install_dir += d.getVar('systemd_system_unitdir', True)
292
293 for spec in listvar_to_list(d, '_INSTALL_LINKS'):
294 tgt, dest = spec.split(':')
295 dest = os.path.join(install_dir, dest)
296 parent = os.path.dirname(dest)
297 if not os.path.exists(parent):
298 os.makedirs(parent)
299 os.symlink(tgt, dest)
300
301
Brad Bishop9ca070c2016-08-18 23:59:44 -0400302 def install_overrides(d):
303 install_dir = d.getVar('D', True)
304 install_dir += d.getVar('systemd_system_unitdir', True)
305 searchpaths = d.getVar('FILESPATH', True)
306
307 for spec in listvar_to_list(d, '_INSTALL_OVERRIDES'):
308 tmpl, dest = spec.split(':')
309 source = bb.utils.which(searchpaths, tmpl)
310 if not os.path.isfile(source):
311 bb.fatal('Did not find SYSTEMD_OVERRIDE '
312 'template: \'%s\'' % source)
313
314 dest = os.path.join(install_dir, dest)
315 parent = os.path.dirname(dest)
316 if not os.path.exists(parent):
317 os.makedirs(parent)
318
319 with open(source, 'r') as fd:
320 content = fd.read()
321 with open('%s' % dest, 'w+') as fd:
322 fd.write(content)
323
324
Brad Bishop0161aff2016-08-17 14:46:41 -0400325 install_links(d)
Brad Bishopafb2e1b2016-08-08 09:29:20 -0400326 install_envs(d)
Brad Bishop9ca070c2016-08-18 23:59:44 -0400327 install_overrides(d)
Brad Bishop522234c2016-08-17 15:42:31 -0400328 make_subs(d)
Brad Bishop51528fe2016-07-14 19:34:06 -0400329}
330
331
Patrick Williams12fc9392021-08-06 09:16:53 -0500332do_install:append() {
Brad Bishope36358c2016-06-08 22:03:59 -0400333 # install systemd service/socket/template files
Brad Bishop9dc56712016-07-07 15:56:02 -0400334 [ -z "${_INSTALL_SD_UNITS}" ] || \
Brad Bishope36358c2016-06-08 22:03:59 -0400335 install -d ${D}${systemd_system_unitdir}
Brad Bishop9dc56712016-07-07 15:56:02 -0400336 for s in ${_INSTALL_SD_UNITS}; do
337 install -m 0644 ${WORKDIR}/$s \
338 ${D}${systemd_system_unitdir}/$s
Brad Bishope36358c2016-06-08 22:03:59 -0400339 sed -i -e 's,@BASE_BINDIR@,${base_bindir},g' \
340 -e 's,@BINDIR@,${bindir},g' \
341 -e 's,@SBINDIR@,${sbindir},g' \
William A. Kennington III25e10572020-04-03 11:53:09 -0700342 -e 's,@LIBEXECDIR@,${libexecdir},g' \
343 -e 's,@LOCALSTATEDIR@,${localstatedir},g' \
344 -e 's,@DATADIR@,${datadir},g' \
Brad Bishope36358c2016-06-08 22:03:59 -0400345 ${D}${systemd_system_unitdir}/$s
346 done
Brad Bishop93fb5352015-09-09 03:59:20 +0000347}