chiark / gitweb /
gc: remove a lot of unused code
[elogind.git] / src / job.c
1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
2
3 /***
4   This file is part of systemd.
5
6   Copyright 2010 Lennart Poettering
7
8   systemd is free software; you can redistribute it and/or modify it
9   under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 2 of the License, or
11   (at your option) any later version.
12
13   systemd is distributed in the hope that it will be useful, but
14   WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   General Public License for more details.
17
18   You should have received a copy of the GNU General Public License
19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
20 ***/
21
22 #include <assert.h>
23 #include <errno.h>
24 #include <sys/timerfd.h>
25 #include <sys/epoll.h>
26
27 #include "set.h"
28 #include "unit.h"
29 #include "macro.h"
30 #include "strv.h"
31 #include "load-fragment.h"
32 #include "load-dropin.h"
33 #include "log.h"
34 #include "dbus-job.h"
35
36 Job* job_new(Manager *m, JobType type, Unit *unit) {
37         Job *j;
38
39         assert(m);
40         assert(type < _JOB_TYPE_MAX);
41         assert(unit);
42
43         if (!(j = new0(Job, 1)))
44                 return NULL;
45
46         j->manager = m;
47         j->id = m->current_job_id++;
48         j->type = type;
49         j->unit = unit;
50
51         j->timer_watch.type = WATCH_INVALID;
52
53         /* We don't link it here, that's what job_dependency() is for */
54
55         return j;
56 }
57
58 void job_free(Job *j) {
59         assert(j);
60
61         /* Detach from next 'bigger' objects */
62         if (j->installed) {
63                 bus_job_send_removed_signal(j, !j->failed);
64
65                 if (j->unit->meta.job == j) {
66                         j->unit->meta.job = NULL;
67                         unit_add_to_gc_queue(j->unit);
68                 }
69
70                 hashmap_remove(j->manager->jobs, UINT32_TO_PTR(j->id));
71                 j->installed = false;
72         }
73
74         /* Detach from next 'smaller' objects */
75         manager_transaction_unlink_job(j->manager, j, true);
76
77         if (j->in_run_queue)
78                 LIST_REMOVE(Job, run_queue, j->manager->run_queue, j);
79
80         if (j->in_dbus_queue)
81                 LIST_REMOVE(Job, dbus_queue, j->manager->dbus_job_queue, j);
82
83         if (j->timer_watch.type != WATCH_INVALID) {
84                 assert(j->timer_watch.type == WATCH_JOB_TIMER);
85                 assert(j->timer_watch.data.job == j);
86                 assert(j->timer_watch.fd >= 0);
87
88                 assert_se(epoll_ctl(j->manager->epoll_fd, EPOLL_CTL_DEL, j->timer_watch.fd, NULL) >= 0);
89                 close_nointr_nofail(j->timer_watch.fd);
90         }
91
92         free(j->bus_client);
93         free(j);
94 }
95
96 JobDependency* job_dependency_new(Job *subject, Job *object, bool matters, bool conflicts) {
97         JobDependency *l;
98
99         assert(object);
100
101         /* Adds a new job link, which encodes that the 'subject' job
102          * needs the 'object' job in some way. If 'subject' is NULL
103          * this means the 'anchor' job (i.e. the one the user
104          * explcitily asked for) is the requester. */
105
106         if (!(l = new0(JobDependency, 1)))
107                 return NULL;
108
109         l->subject = subject;
110         l->object = object;
111         l->matters = matters;
112         l->conflicts = conflicts;
113
114         if (subject)
115                 LIST_PREPEND(JobDependency, subject, subject->subject_list, l);
116         else
117                 LIST_PREPEND(JobDependency, subject, object->manager->transaction_anchor, l);
118
119         LIST_PREPEND(JobDependency, object, object->object_list, l);
120
121         return l;
122 }
123
124 void job_dependency_free(JobDependency *l) {
125         assert(l);
126
127         if (l->subject)
128                 LIST_REMOVE(JobDependency, subject, l->subject->subject_list, l);
129         else
130                 LIST_REMOVE(JobDependency, subject, l->object->manager->transaction_anchor, l);
131
132         LIST_REMOVE(JobDependency, object, l->object->object_list, l);
133
134         free(l);
135 }
136
137 void job_dump(Job *j, FILE*f, const char *prefix) {
138         assert(j);
139         assert(f);
140
141         if (!prefix)
142                 prefix = "";
143
144         fprintf(f,
145                 "%s-> Job %u:\n"
146                 "%s\tAction: %s -> %s\n"
147                 "%s\tState: %s\n"
148                 "%s\tForced: %s\n",
149                 prefix, j->id,
150                 prefix, j->unit->meta.id, job_type_to_string(j->type),
151                 prefix, job_state_to_string(j->state),
152                 prefix, yes_no(j->override));
153 }
154
155 bool job_is_anchor(Job *j) {
156         JobDependency *l;
157
158         assert(j);
159
160         LIST_FOREACH(object, l, j->object_list)
161                 if (!l->subject)
162                         return true;
163
164         return false;
165 }
166
167 static bool types_match(JobType a, JobType b, JobType c, JobType d) {
168         return
169                 (a == c && b == d) ||
170                 (a == d && b == c);
171 }
172
173 int job_type_merge(JobType *a, JobType b) {
174         if (*a == b)
175                 return 0;
176
177         /* Merging is associative! a merged with b merged with c is
178          * the same as a merged with c merged with b. */
179
180         /* Mergeability is transitive! if a can be merged with b and b
181          * with c then a also with c */
182
183         /* Also, if a merged with b cannot be merged with c, then
184          * either a or b cannot be merged with c either */
185
186         if (types_match(*a, b, JOB_START, JOB_VERIFY_ACTIVE))
187                 *a = JOB_START;
188         else if (types_match(*a, b, JOB_START, JOB_RELOAD) ||
189                  types_match(*a, b, JOB_START, JOB_RELOAD_OR_START) ||
190                  types_match(*a, b, JOB_VERIFY_ACTIVE, JOB_RELOAD_OR_START) ||
191                  types_match(*a, b, JOB_RELOAD, JOB_RELOAD_OR_START))
192                 *a = JOB_RELOAD_OR_START;
193         else if (types_match(*a, b, JOB_START, JOB_RESTART) ||
194                  types_match(*a, b, JOB_START, JOB_TRY_RESTART) ||
195                  types_match(*a, b, JOB_VERIFY_ACTIVE, JOB_RESTART) ||
196                  types_match(*a, b, JOB_RELOAD, JOB_RESTART) ||
197                  types_match(*a, b, JOB_RELOAD_OR_START, JOB_RESTART) ||
198                  types_match(*a, b, JOB_RELOAD_OR_START, JOB_TRY_RESTART) ||
199                  types_match(*a, b, JOB_RESTART, JOB_TRY_RESTART))
200                 *a = JOB_RESTART;
201         else if (types_match(*a, b, JOB_VERIFY_ACTIVE, JOB_RELOAD))
202                 *a = JOB_RELOAD;
203         else if (types_match(*a, b, JOB_VERIFY_ACTIVE, JOB_TRY_RESTART) ||
204                  types_match(*a, b, JOB_RELOAD, JOB_TRY_RESTART))
205                 *a = JOB_TRY_RESTART;
206         else
207                 return -EEXIST;
208
209         return 0;
210 }
211
212 bool job_type_is_mergeable(JobType a, JobType b) {
213         return job_type_merge(&a, b) >= 0;
214 }
215
216 bool job_type_is_superset(JobType a, JobType b) {
217
218         /* Checks whether operation a is a "superset" of b in its
219          * actions */
220
221         if (a == b)
222                 return true;
223
224         switch (a) {
225                 case JOB_START:
226                         return b == JOB_VERIFY_ACTIVE;
227
228                 case JOB_RELOAD:
229                         return
230                                 b == JOB_VERIFY_ACTIVE;
231
232                 case JOB_RELOAD_OR_START:
233                         return
234                                 b == JOB_RELOAD ||
235                                 b == JOB_START ||
236                                 b == JOB_VERIFY_ACTIVE;
237
238                 case JOB_RESTART:
239                         return
240                                 b == JOB_START ||
241                                 b == JOB_VERIFY_ACTIVE ||
242                                 b == JOB_RELOAD ||
243                                 b == JOB_RELOAD_OR_START ||
244                                 b == JOB_TRY_RESTART;
245
246                 case JOB_TRY_RESTART:
247                         return
248                                 b == JOB_VERIFY_ACTIVE ||
249                                 b == JOB_RELOAD;
250                 default:
251                         return false;
252
253         }
254 }
255
256 bool job_type_is_conflicting(JobType a, JobType b) {
257         assert(a >= 0 && a < _JOB_TYPE_MAX);
258         assert(b >= 0 && b < _JOB_TYPE_MAX);
259
260         return (a == JOB_STOP) != (b == JOB_STOP);
261 }
262
263 bool job_type_is_redundant(JobType a, UnitActiveState b) {
264         switch (a) {
265
266         case JOB_START:
267                 return
268                         b == UNIT_ACTIVE ||
269                         b == UNIT_RELOADING;
270
271         case JOB_STOP:
272                 return
273                         b == UNIT_INACTIVE ||
274                         b == UNIT_MAINTENANCE;
275
276         case JOB_VERIFY_ACTIVE:
277                 return
278                         b == UNIT_ACTIVE ||
279                         b == UNIT_RELOADING;
280
281         case JOB_RELOAD:
282                 return
283                         b == UNIT_RELOADING;
284
285         case JOB_RELOAD_OR_START:
286                 return
287                         b == UNIT_ACTIVATING ||
288                         b == UNIT_RELOADING;
289
290         case JOB_RESTART:
291                 return
292                         b == UNIT_ACTIVATING;
293
294         case JOB_TRY_RESTART:
295                 return
296                         b == UNIT_ACTIVATING;
297
298         default:
299                 assert_not_reached("Invalid job type");
300         }
301 }
302
303 bool job_is_runnable(Job *j) {
304         Iterator i;
305         Unit *other;
306
307         assert(j);
308         assert(j->installed);
309
310         /* Checks whether there is any job running for the units this
311          * job needs to be running after (in the case of a 'positive'
312          * job type) or before (in the case of a 'negative' job type
313          * . */
314
315         if (j->type == JOB_START ||
316             j->type == JOB_VERIFY_ACTIVE ||
317             j->type == JOB_RELOAD ||
318             j->type == JOB_RELOAD_OR_START) {
319
320                 /* Immediate result is that the job is or might be
321                  * started. In this case lets wait for the
322                  * dependencies, regardless whether they are
323                  * starting or stopping something. */
324
325                 SET_FOREACH(other, j->unit->meta.dependencies[UNIT_AFTER], i)
326                         if (other->meta.job)
327                                 return false;
328         }
329
330         /* Also, if something else is being stopped and we should
331          * change state after it, then lets wait. */
332
333         SET_FOREACH(other, j->unit->meta.dependencies[UNIT_BEFORE], i)
334                 if (other->meta.job &&
335                     (other->meta.job->type == JOB_STOP ||
336                      other->meta.job->type == JOB_RESTART ||
337                      other->meta.job->type == JOB_TRY_RESTART))
338                         return false;
339
340         /* This means that for a service a and a service b where b
341          * shall be started after a:
342          *
343          *  start a + start b → 1st step start a, 2nd step start b
344          *  start a + stop b  → 1st step stop b,  2nd step start a
345          *  stop a  + start b → 1st step stop a,  2nd step start b
346          *  stop a  + stop b  → 1st step stop b,  2nd step stop a
347          *
348          *  This has the side effect that restarts are properly
349          *  synchronized too. */
350
351         return true;
352 }
353
354 int job_run_and_invalidate(Job *j) {
355         int r;
356
357         assert(j);
358         assert(j->installed);
359
360         if (j->in_run_queue) {
361                 LIST_REMOVE(Job, run_queue, j->manager->run_queue, j);
362                 j->in_run_queue = false;
363         }
364
365         if (j->state != JOB_WAITING)
366                 return 0;
367
368         if (!job_is_runnable(j))
369                 return -EAGAIN;
370
371         j->state = JOB_RUNNING;
372         job_add_to_dbus_queue(j);
373
374         switch (j->type) {
375
376                 case JOB_START:
377                         r = unit_start(j->unit);
378                         if (r == -EBADR)
379                                 r = 0;
380                         break;
381
382                 case JOB_VERIFY_ACTIVE: {
383                         UnitActiveState t = unit_active_state(j->unit);
384                         if (UNIT_IS_ACTIVE_OR_RELOADING(t))
385                                 r = -EALREADY;
386                         else if (t == UNIT_ACTIVATING)
387                                 r = -EAGAIN;
388                         else
389                                 r = -ENOEXEC;
390                         break;
391                 }
392
393                 case JOB_STOP:
394                         r = unit_stop(j->unit);
395                         break;
396
397                 case JOB_RELOAD:
398                         r = unit_reload(j->unit);
399                         break;
400
401                 case JOB_RELOAD_OR_START:
402                         if (unit_active_state(j->unit) == UNIT_ACTIVE)
403                                 r = unit_reload(j->unit);
404                         else
405                                 r = unit_start(j->unit);
406                         break;
407
408                 case JOB_RESTART: {
409                         UnitActiveState t = unit_active_state(j->unit);
410                         if (t == UNIT_INACTIVE || t == UNIT_MAINTENANCE || t == UNIT_ACTIVATING) {
411                                 j->type = JOB_START;
412                                 r = unit_start(j->unit);
413                         } else
414                                 r = unit_stop(j->unit);
415                         break;
416                 }
417
418                 case JOB_TRY_RESTART: {
419                         UnitActiveState t = unit_active_state(j->unit);
420                         if (t == UNIT_INACTIVE || t == UNIT_MAINTENANCE || t == UNIT_DEACTIVATING)
421                                 r = -ENOEXEC;
422                         else if (t == UNIT_ACTIVATING) {
423                                 j->type = JOB_START;
424                                 r = unit_start(j->unit);
425                         } else
426                                 r = unit_stop(j->unit);
427                         break;
428                 }
429
430                 default:
431                         assert_not_reached("Unknown job type");
432         }
433
434         if (r == -EALREADY)
435                 r = job_finish_and_invalidate(j, true);
436         else if (r == -EAGAIN) {
437                 j->state = JOB_WAITING;
438                 return -EAGAIN;
439         } else if (r < 0)
440                 r = job_finish_and_invalidate(j, false);
441
442         return r;
443 }
444
445 int job_finish_and_invalidate(Job *j, bool success) {
446         Unit *u;
447         Unit *other;
448         JobType t;
449         Iterator i;
450
451         assert(j);
452         assert(j->installed);
453
454         job_add_to_dbus_queue(j);
455
456         /* Patch restart jobs so that they become normal start jobs */
457         if (success && (j->type == JOB_RESTART || j->type == JOB_TRY_RESTART)) {
458
459                 log_debug("Converting job %s/%s -> %s/%s",
460                           j->unit->meta.id, job_type_to_string(j->type),
461                           j->unit->meta.id, job_type_to_string(JOB_START));
462
463                 j->state = JOB_WAITING;
464                 j->type = JOB_START;
465
466                 job_add_to_run_queue(j);
467                 return 0;
468         }
469
470         log_debug("Job %s/%s finished, success=%s", j->unit->meta.id, job_type_to_string(j->type), yes_no(success));
471
472         j->failed = !success;
473         u = j->unit;
474         t = j->type;
475         job_free(j);
476
477         if (!success)
478                 unit_status_printf(u, "Starting %s " ANSI_HIGHLIGHT_ON "failed" ANSI_HIGHLIGHT_OFF ".\n", unit_description(u));
479
480         /* Fail depending jobs on failure */
481         if (!success) {
482
483                 if (t == JOB_START ||
484                     t == JOB_VERIFY_ACTIVE ||
485                     t == JOB_RELOAD_OR_START) {
486
487                         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY], i)
488                                 if (!other->meta.ignore_dependency_failure &&
489                                     other->meta.job &&
490                                     (other->meta.job->type == JOB_START ||
491                                      other->meta.job->type == JOB_VERIFY_ACTIVE ||
492                                      other->meta.job->type == JOB_RELOAD_OR_START))
493                                         job_finish_and_invalidate(other->meta.job, false);
494
495                         SET_FOREACH(other, u->meta.dependencies[UNIT_REQUIRED_BY_OVERRIDABLE], i)
496                                 if (!other->meta.ignore_dependency_failure &&
497                                     other->meta.job &&
498                                     !other->meta.job->override &&
499                                     (other->meta.job->type == JOB_START ||
500                                      other->meta.job->type == JOB_VERIFY_ACTIVE ||
501                                      other->meta.job->type == JOB_RELOAD_OR_START))
502                                         job_finish_and_invalidate(other->meta.job, false);
503
504                 } else if (t == JOB_STOP) {
505
506                         SET_FOREACH(other, u->meta.dependencies[UNIT_CONFLICTS], i)
507                                 if (!other->meta.ignore_dependency_failure &&
508                                     other->meta.job &&
509                                     (other->meta.job->type == JOB_START ||
510                                      other->meta.job->type == JOB_VERIFY_ACTIVE ||
511                                      other->meta.job->type == JOB_RELOAD_OR_START))
512                                         job_finish_and_invalidate(other->meta.job, false);
513
514                         SET_FOREACH(other, u->meta.dependencies[UNIT_CONFLICTED_BY], i)
515                                 if (!other->meta.ignore_dependency_failure &&
516                                     other->meta.job &&
517                                     (other->meta.job->type == JOB_START ||
518                                      other->meta.job->type == JOB_VERIFY_ACTIVE ||
519                                      other->meta.job->type == JOB_RELOAD_OR_START))
520                                         job_finish_and_invalidate(other->meta.job, false);
521                 }
522         }
523
524         /* Try to start the next jobs that can be started */
525         SET_FOREACH(other, u->meta.dependencies[UNIT_AFTER], i)
526                 if (other->meta.job)
527                         job_add_to_run_queue(other->meta.job);
528         SET_FOREACH(other, u->meta.dependencies[UNIT_BEFORE], i)
529                 if (other->meta.job)
530                         job_add_to_run_queue(other->meta.job);
531
532         return 0;
533 }
534
535 int job_start_timer(Job *j) {
536         struct itimerspec its;
537         struct epoll_event ev;
538         int fd, r;
539         assert(j);
540
541         if (j->unit->meta.job_timeout <= 0 ||
542             j->timer_watch.type == WATCH_JOB_TIMER)
543                 return 0;
544
545         assert(j->timer_watch.type == WATCH_INVALID);
546
547         if ((fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK|TFD_CLOEXEC)) < 0) {
548                 r = -errno;
549                 goto fail;
550         }
551
552         zero(its);
553         timespec_store(&its.it_value, j->unit->meta.job_timeout);
554
555         if (timerfd_settime(fd, 0, &its, NULL) < 0) {
556                 r = -errno;
557                 goto fail;
558         }
559
560         zero(ev);
561         ev.data.ptr = &j->timer_watch;
562         ev.events = EPOLLIN;
563
564         if (epoll_ctl(j->manager->epoll_fd, EPOLL_CTL_ADD, fd, &ev) < 0) {
565                 r = -errno;
566                 goto fail;
567         }
568
569         j->timer_watch.type = WATCH_JOB_TIMER;
570         j->timer_watch.fd = fd;
571         j->timer_watch.data.job = j;
572
573         return 0;
574
575 fail:
576         if (fd >= 0)
577                 close_nointr_nofail(fd);
578
579         return r;
580 }
581
582 void job_add_to_run_queue(Job *j) {
583         assert(j);
584         assert(j->installed);
585
586         if (j->in_run_queue)
587                 return;
588
589         LIST_PREPEND(Job, run_queue, j->manager->run_queue, j);
590         j->in_run_queue = true;
591 }
592
593 void job_add_to_dbus_queue(Job *j) {
594         assert(j);
595         assert(j->installed);
596
597         if (j->in_dbus_queue)
598                 return;
599
600         /* We don't check if anybody is subscribed here, since this
601          * job might just have been created and not yet assigned to a
602          * connection/client. */
603
604         LIST_PREPEND(Job, dbus_queue, j->manager->dbus_job_queue, j);
605         j->in_dbus_queue = true;
606 }
607
608 char *job_dbus_path(Job *j) {
609         char *p;
610
611         assert(j);
612
613         if (asprintf(&p, "/org/freedesktop/systemd1/job/%lu", (unsigned long) j->id) < 0)
614                 return NULL;
615
616         return p;
617 }
618
619 void job_timer_event(Job *j, uint64_t n_elapsed, Watch *w) {
620         assert(j);
621         assert(w == &j->timer_watch);
622
623         log_warning("Job %s/%s timed out.", j->unit->meta.id, job_type_to_string(j->type));
624         job_finish_and_invalidate(j, false);
625 }
626
627 static const char* const job_state_table[_JOB_STATE_MAX] = {
628         [JOB_WAITING] = "waiting",
629         [JOB_RUNNING] = "running"
630 };
631
632 DEFINE_STRING_TABLE_LOOKUP(job_state, JobState);
633
634 static const char* const job_type_table[_JOB_TYPE_MAX] = {
635         [JOB_START] = "start",
636         [JOB_VERIFY_ACTIVE] = "verify-active",
637         [JOB_STOP] = "stop",
638         [JOB_RELOAD] = "reload",
639         [JOB_RELOAD_OR_START] = "reload-or-start",
640         [JOB_RESTART] = "restart",
641         [JOB_TRY_RESTART] = "try-restart",
642 };
643
644 DEFINE_STRING_TABLE_LOOKUP(job_type, JobType);
645
646 static const char* const job_mode_table[_JOB_MODE_MAX] = {
647         [JOB_FAIL] = "fail",
648         [JOB_REPLACE] = "replace",
649         [JOB_ISOLATE] = "isolate"
650 };
651
652 DEFINE_STRING_TABLE_LOOKUP(job_mode, JobMode);