]> git.proxmox.com Git - pve-access-control.git/blame - PVE/RPCEnvironment.pm
PVE/API2/Domains.pm: fix property description
[pve-access-control.git] / PVE / RPCEnvironment.pm
CommitLineData
2c3a6c0a
DM
1package PVE::RPCEnvironment;
2
3use strict;
4use warnings;
8d6e045f 5use POSIX qw(:sys_wait_h EINTR);
b28410fc 6use IO::Handle;
2c3a6c0a 7use IO::File;
b28410fc 8use IO::Select;
2c3a6c0a 9use Fcntl qw(:flock);
37d45deb 10use PVE::Exception qw(raise raise_perm_exc);
2c3a6c0a
DM
11use PVE::SafeSyslog;
12use PVE::Tools;
13use PVE::INotify;
14use PVE::Cluster;
15use PVE::ProcFSTools;
16use PVE::AccessControl;
17
18# we use this singleton class to pass RPC related environment values
19
20my $pve_env;
21
22# save $SIG{CHLD} handler implementation.
23# simply set $SIG{CHLD} = $worker_reaper;
24# and register forked processes with &$register_worker(pid)
25# Note: using $SIG{CHLD} = 'IGNORE' or $SIG{CHLD} = sub { wait (); } or ...
26# has serious side effects, because perls built in system() and open()
27# functions can't get the correct exit status of a child. So we cant use
28# that (also see perlipc)
29
30my $WORKER_PIDS;
7b6dfe82 31my $WORKER_FLAG = 0;
2c3a6c0a
DM
32
33my $log_task_result = sub {
34 my ($upid, $user, $status) = @_;
35
36 my $msg = 'successful';
37 my $pri = 'info';
38 if ($status != 0) {
39 my $ec = $status >> 8;
40 my $ic = $status & 255;
41 $msg = $ec ? "failed ($ec)" : "interrupted ($ic)";
42 $pri = 'err';
43 }
44 my $tlist = active_workers($upid);
45 PVE::Cluster::broadcast_tasklist($tlist);
46 my $task;
47 foreach my $t (@$tlist) {
48 if ($t->{upid} eq $upid) {
49 $task = $t;
50 last;
51 }
52 }
53 if ($task && $task->{status}) {
54 $msg = $task->{status};
55 }
56 PVE::Cluster::log_msg($pri, $user, "end task $upid $msg");
57};
58
59my $worker_reaper = sub {
60 local $!; local $?;
61 foreach my $pid (keys %$WORKER_PIDS) {
62 my $waitpid = waitpid ($pid, WNOHANG);
63 if (defined($waitpid) && ($waitpid == $pid)) {
64 my $info = $WORKER_PIDS->{$pid};
65 if ($info && $info->{upid} && $info->{user}) {
66 &$log_task_result($info->{upid}, $info->{user}, $?);
67 }
68 delete ($WORKER_PIDS->{$pid});
69 }
70 }
71};
72
73my $register_worker = sub {
74 my ($pid, $user, $upid) = @_;
75
76 return if !$pid;
77
78 # do not register if already finished
79 my $waitpid = waitpid ($pid, WNOHANG);
80 if (defined($waitpid) && ($waitpid == $pid)) {
81 delete ($WORKER_PIDS->{$pid});
82 return;
83 }
84
85 $WORKER_PIDS->{$pid} = {
86 user => $user,
87 upid => $upid,
88 };
89};
90
91# ACL cache
92
4bc17477
DM
93my $compile_acl_path = sub {
94 my ($self, $user, $path) = @_;
2c3a6c0a 95
2c3a6c0a
DM
96 my $cfg = $self->{user_cfg};
97
98 return undef if !$cfg->{roles};
99
4bc17477 100 die "internal error" if $user eq 'root@pam';
2c3a6c0a 101
4bc17477
DM
102 my $cache = $self->{aclcache};
103 $cache->{$user} = {} if !$cache->{$user};
104 my $data = $cache->{$user};
2c3a6c0a 105
4bc17477
DM
106 if (!$data->{poolroles}) {
107 $data->{poolroles} = {};
108
39c85db8
DM
109 foreach my $pool (keys %{$cfg->{pools}}) {
110 my $d = $cfg->{pools}->{$pool};
111 my @ra = PVE::AccessControl::roles($cfg, $user, "/pool/$pool"); # pool roles
4bc17477
DM
112 next if !scalar(@ra);
113 foreach my $vmid (keys %{$d->{vms}}) {
114 for my $role (@ra) {
115 $data->{poolroles}->{"/vms/$vmid"}->{$role} = 1;
2c3a6c0a
DM
116 }
117 }
4bc17477
DM
118 foreach my $storeid (keys %{$d->{storage}}) {
119 for my $role (@ra) {
120 $data->{poolroles}->{"/storage/$storeid"}->{$role} = 1;
121 }
122 }
123 }
124 }
125
126 my @ra = PVE::AccessControl::roles($cfg, $user, $path);
127
128 # apply roles inherited from pools
129 # Note: assume we do not want to propagate those privs
130 if ($data->{poolroles}->{$path}) {
131 if (!($ra[0] && $ra[0] eq 'NoAccess')) {
8ade28e6
DM
132 if ($data->{poolroles}->{$path}->{NoAccess}) {
133 @ra = ('NoAccess');
134 } else {
135 foreach my $role (keys %{$data->{poolroles}->{$path}}) {
136 push @ra, $role;
137 }
4bc17477 138 }
2c3a6c0a 139 }
4bc17477 140 }
2c3a6c0a 141
4bc17477
DM
142 $data->{roles}->{$path} = [ @ra ];
143
144 my $privs = {};
145 foreach my $role (@ra) {
146 if (my $privset = $cfg->{roles}->{$role}) {
147 foreach my $p (keys %$privset) {
148 $privs->{$p} = 1;
149 }
150 }
2c3a6c0a 151 }
4bc17477 152 $data->{privs}->{$path} = $privs;
2c3a6c0a 153
4bc17477 154 return $privs;
2c3a6c0a
DM
155};
156
4bc17477
DM
157sub roles {
158 my ($self, $user, $path) = @_;
159
160 if ($user eq 'root@pam') { # root can do anything
161 return ('Administrator');
162 }
163
164 $user = PVE::AccessControl::verify_username($user, 1);
165 return () if !$user;
166
167 my $cache = $self->{aclcache};
168 $cache->{$user} = {} if !$cache->{$user};
169
170 my $acl = $cache->{$user};
171
172 my $roles = $acl->{roles}->{$path};
173 return @$roles if $roles;
174
175 &$compile_acl_path($self, $user, $path);
176 $roles = $acl->{roles}->{$path} || [];
177 return @$roles;
178}
179
2c3a6c0a
DM
180sub permissions {
181 my ($self, $user, $path) = @_;
182
4bc17477
DM
183 if ($user eq 'root@pam') { # root can do anything
184 my $cfg = $self->{user_cfg};
185 return $cfg->{roles}->{'Administrator'};
186 }
187
2c3a6c0a
DM
188 $user = PVE::AccessControl::verify_username($user, 1);
189 return {} if !$user;
190
191 my $cache = $self->{aclcache};
4bc17477 192 $cache->{$user} = {} if !$cache->{$user};
2c3a6c0a
DM
193
194 my $acl = $cache->{$user};
195
4bc17477
DM
196 my $perm = $acl->{privs}->{$path};
197 return $perm if $perm;
2c3a6c0a 198
4bc17477 199 return &$compile_acl_path($self, $user, $path);
2c3a6c0a
DM
200}
201
202sub check {
37d45deb 203 my ($self, $user, $path, $privs, $noerr) = @_;
2c3a6c0a
DM
204
205 my $perm = $self->permissions($user, $path);
206
207 foreach my $priv (@$privs) {
37d45deb
DM
208 PVE::AccessControl::verify_privname($priv);
209 if (!$perm->{$priv}) {
210 return undef if $noerr;
211 raise_perm_exc("$path, $priv");
212 }
2c3a6c0a
DM
213 };
214
215 return 1;
216};
217
37d45deb
DM
218sub check_any {
219 my ($self, $user, $path, $privs, $noerr) = @_;
220
221 my $perm = $self->permissions($user, $path);
efce1d57 222
37d45deb
DM
223 my $found = 0;
224 foreach my $priv (@$privs) {
225 PVE::AccessControl::verify_privname($priv);
226 if ($perm->{$priv}) {
227 $found = 1;
228 last;
229 }
230 };
231
232 return 1 if $found;
233
234 return undef if $noerr;
235
236 raise_perm_exc("$path, " . join("|", @$privs));
237};
238
c4a776a6
DM
239sub check_full {
240 my ($self, $username, $path, $privs, $any, $noerr) = @_;
241 if ($any) {
242 return $self->check_any($username, $path, $privs, $noerr);
243 } else {
244 return $self->check($username, $path, $privs, $noerr);
245 }
246}
247
7070c1ae
DM
248sub check_user_enabled {
249 my ($self, $user, $noerr) = @_;
2c3a6c0a
DM
250
251 my $cfg = $self->{user_cfg};
7070c1ae 252 return PVE::AccessControl::check_user_enabled($cfg, $user, $noerr);
2c3a6c0a
DM
253}
254
37d45deb
DM
255sub check_user_exist {
256 my ($self, $user, $noerr) = @_;
257
258 my $cfg = $self->{user_cfg};
259 return PVE::AccessControl::check_user_exist($cfg, $user, $noerr);
260}
261
a23cec1f
DM
262sub check_pool_exist {
263 my ($self, $pool, $noerr) = @_;
264
265 my $cfg = $self->{user_cfg};
266
267 return 1 if $cfg->{pools}->{$pool};
268
269 return undef if $noerr;
270
271 raise_perm_exc("pool '$pool' does not exist");
272}
273
274sub check_vm_perm {
275 my ($self, $user, $vmid, $pool, $privs, $any, $noerr) = @_;
276
277 my $cfg = $self->{user_cfg};
278
279 if ($pool) {
280 return if $self->check_full($user, "/pool/$pool", $privs, $any, 1);
281 }
282 return $self->check_full($user, "/vms/$vmid", $privs, $any, $noerr);
283};
284
17ecec71 285sub check_volume_access {
fef1bc17
DM
286 my ($self, $user, $storecfg, $vmid, $volid) = @_;
287
288 # test if we have read access to volid
289
3eac4e35
DM
290 my ($sid, $volname) = PVE::Storage::parse_volume_id($volid, 1);
291 if ($sid) {
854f1dce 292 my ($vtype, undef, $ownervm) = PVE::Storage::parse_volname($storecfg, $volid);
fef1bc17
DM
293 if ($vtype eq 'iso' || $vtype eq 'vztmpl') {
294 # we simply allow access
e5ae5487
DM
295 } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) {
296 # we are owner - allow access
297 } elsif ($vtype eq 'backup' && $ownervm) {
298 $self->check($user, "/storage/$sid", ['Datastore.AllocateSpace']);
299 $self->check($user, "/vms/$ownervm", ['VM.Backup']);
300 } else {
fef1bc17
DM
301 # allow if we are Datastore administrator
302 $self->check($user, "/storage/$sid", ['Datastore.Allocate']);
303 }
304 } else {
305 die "Only root can pass arbitrary filesystem paths."
306 if $user ne 'root@pam';
fef1bc17 307 }
5f494227
DM
308
309 return undef;
fef1bc17
DM
310}
311
37d45deb
DM
312sub is_group_member {
313 my ($self, $group, $user) = @_;
314
315 my $cfg = $self->{user_cfg};
316
317 return 0 if !$cfg->{groups}->{$group};
318
319 return defined($cfg->{groups}->{$group}->{users}->{$user});
320}
321
322sub filter_groups {
b9180ed2 323 my ($self, $user, $privs, $any) = @_;
37d45deb
DM
324
325 my $cfg = $self->{user_cfg};
326
327 my $groups = {};
328 foreach my $group (keys %{$cfg->{groups}}) {
b9180ed2 329 my $path = "/access/groups/$group";
c4a776a6
DM
330 if ($self->check_full($user, $path, $privs, $any, 1)) {
331 $groups->{$group} = $cfg->{groups}->{$group};
37d45deb
DM
332 }
333 }
334
335 return $groups;
336}
337
338sub group_member_join {
339 my ($self, $grouplist) = @_;
340
341 my $users = {};
342
343 my $cfg = $self->{user_cfg};
344 foreach my $group (@$grouplist) {
345 my $data = $cfg->{groups}->{$group};
346 next if !$data;
347 foreach my $user (keys %{$data->{users}}) {
348 $users->{$user} = 1;
349 }
350 }
351
352 return $users;
353}
354
e3a3a0d7
DM
355sub check_perm_modify {
356 my ($self, $username, $path, $noerr) = @_;
357
358 return $self->check($username, '/access', [ 'Permissions.Modify' ], $noerr) if !$path;
359
360 my $testperms = [ 'Permissions.Modify' ];
361 if ($path =~ m|^/storage/.+$|) {
362 push @$testperms, 'Datastore.Allocate';
363 } elsif ($path =~ m|^/vms/.+$|) {
364 push @$testperms, 'VM.Allocate';
7a7a517a
DM
365 } elsif ($path =~ m|^/pool/.+$|) {
366 push @$testperms, 'Pool.Allocate';
e3a3a0d7
DM
367 }
368
369 return $self->check_any($username, $path, $testperms, $noerr);
370}
371
f8cc5a5f
DM
372sub exec_api2_perm_check {
373 my ($self, $check, $username, $param, $noerr) = @_;
374
375 # syslog("info", "CHECK " . join(', ', @$check));
376
377 my $ind = 0;
378 my $test = $check->[$ind++];
379 die "no permission test specified" if !$test;
380
381 if ($test eq 'and') {
382 while (my $subcheck = $check->[$ind++]) {
383 $self->exec_api2_perm_check($subcheck, $username, $param);
384 }
385 return 1;
386 } elsif ($test eq 'or') {
387 while (my $subcheck = $check->[$ind++]) {
388 return 1 if $self->exec_api2_perm_check($subcheck, $username, $param, 1);
389 }
390 return 0 if $noerr;
391 raise_perm_exc();
392 } elsif ($test eq 'perm') {
393 my ($t, $tmplpath, $privs, %options) = @$check;
394 my $any = $options{any};
395 die "missing parameters" if !($tmplpath && $privs);
c4a776a6
DM
396 my $require_param = $options{require_param};
397 if ($require_param && !defined($param->{$require_param})) {
398 return 0 if $noerr;
399 raise_perm_exc();
400 }
f8cc5a5f 401 my $path = PVE::Tools::template_replace($tmplpath, $param);
e3a3a0d7 402 $path = PVE::AccessControl::normalize_path($path);
c4a776a6 403 return $self->check_full($username, $path, $privs, $any, $noerr);
f8cc5a5f
DM
404 } elsif ($test eq 'userid-group') {
405 my $userid = $param->{userid};
406 my ($t, $privs, %options) = @$check;
82b63965
DM
407 return 0 if !$options{groups_param} && !$self->check_user_exist($userid, $noerr);
408 if (!$self->check_any($username, "/access/groups", $privs, 1)) {
f8cc5a5f
DM
409 my $groups = $self->filter_groups($username, $privs, 1);
410 if ($options{groups_param}) {
411 my @group_param = PVE::Tools::split_list($param->{groups});
82b63965 412 raise_perm_exc("/access/groups, " . join("|", @$privs)) if !scalar(@group_param);
f8cc5a5f
DM
413 foreach my $pg (@group_param) {
414 raise_perm_exc("/access/groups/$pg, " . join("|", @$privs))
415 if !$groups->{$pg};
416 }
417 } else {
418 my $allowed_users = $self->group_member_join([keys %$groups]);
419 if (!$allowed_users->{$userid}) {
420 return 0 if $noerr;
421 raise_perm_exc();
422 }
423 }
424 }
425 return 1;
426 } elsif ($test eq 'userid-param') {
09d27058 427 my ($userid, undef, $realm) = PVE::AccessControl::verify_username($param->{userid});
f8cc5a5f
DM
428 my ($t, $subtest) = @$check;
429 die "missing parameters" if !$subtest;
430 if ($subtest eq 'self') {
a69bbe2e 431 return 0 if !$self->check_user_exist($userid, $noerr);
1cf154b7 432 return 1 if $username eq $userid;
f8cc5a5f
DM
433 return 0 if $noerr;
434 raise_perm_exc();
82b63965
DM
435 } elsif ($subtest eq 'Realm.AllocateUser') {
436 my $path = "/access/realm/$realm";
437 return $self->check($username, $path, ['Realm.AllocateUser'], $noerr);
f8cc5a5f
DM
438 } else {
439 die "unknown userid-param test";
440 }
82b63965 441 } elsif ($test eq 'perm-modify') {
e3a3a0d7
DM
442 my ($t, $tmplpath) = @$check;
443 my $path = PVE::Tools::template_replace($tmplpath, $param);
444 $path = PVE::AccessControl::normalize_path($path);
445 return $self->check_perm_modify($username, $path, $noerr);
446 } else {
f8cc5a5f
DM
447 die "unknown permission test";
448 }
449};
450
451sub check_api2_permissions {
452 my ($self, $perm, $username, $param) = @_;
453
454 return 1 if !$username && $perm->{user} eq 'world';
455
456 raise_perm_exc("user != null") if !$username;
457
458 return 1 if $username eq 'root@pam';
459
460 raise_perm_exc('user != root@pam') if !$perm;
461
462 return 1 if $perm->{user} && $perm->{user} eq 'all';
463
464 return $self->exec_api2_perm_check($perm->{check}, $username, $param)
465 if $perm->{check};
466
467 raise_perm_exc();
468}
469
2c3a6c0a
DM
470# initialize environment - must be called once at program startup
471sub init {
472 my ($class, $type, %params) = @_;
473
474 $class = ref($class) || $class;
475
476 die "already initialized" if $pve_env;
477
e42eedbc 478 die "unknown environment type" if !$type || $type !~ m/^(cli|pub|priv|ha)$/;
2c3a6c0a
DM
479
480 $SIG{CHLD} = $worker_reaper;
481
482 # environment types
483 # cli ... command started fron command line
484 # pub ... access from public server (apache)
485 # priv ... access from private server (pvedaemon)
e42eedbc 486 # ha ... access from HA resource manager agent (rgmanager)
2c3a6c0a
DM
487
488 my $self = {
489 user_cfg => {},
490 aclcache => {},
491 aclversion => undef,
492 type => $type,
493 };
494
495 bless $self, $class;
496
497 foreach my $p (keys %params) {
498 if ($p eq 'atfork') {
499 $self->{$p} = $params{$p};
500 } else {
501 die "unknown option '$p'";
502 }
503 }
504
505 $pve_env = $self;
506
507 my ($sysname, $nodename) = POSIX::uname();
508
509 $nodename =~ s/\..*$//; # strip domain part, if any
510
511 $self->{nodename} = $nodename;
512
513 return $self;
514};
515
516# get the singleton
517sub get {
518
519 die "not initialized" if !$pve_env;
520
521 return $pve_env;
522}
523
524# init_request - must be called before each RPC request
525sub init_request {
526 my ($self, %params) = @_;
527
528 PVE::Cluster::cfs_update();
529
be6ea723 530 $self->{result_attributes} = {};
272fe9ff 531
2c3a6c0a
DM
532 my $userconfig; # we use this for regression tests
533 foreach my $p (keys %params) {
534 if ($p eq 'userconfig') {
535 $userconfig = $params{$p};
536 } else {
537 die "unknown parameter '$p'";
538 }
539 }
540
541 eval {
542 $self->{aclcache} = {};
543 if ($userconfig) {
544 my $ucdata = PVE::Tools::file_get_contents($userconfig);
545 my $cfg = PVE::AccessControl::parse_user_config($userconfig, $ucdata);
546 $self->{user_cfg} = $cfg;
4bc17477 547 #print Dumper($cfg);
2c3a6c0a
DM
548 } else {
549 my $ucvers = PVE::Cluster::cfs_file_version('user.cfg');
550 if (!$self->{aclcache} || !defined($self->{aclversion}) ||
551 !defined($ucvers) || ($ucvers ne $self->{aclversion})) {
552 $self->{aclversion} = $ucvers;
553 my $cfg = PVE::Cluster::cfs_read_file('user.cfg');
554 $self->{user_cfg} = $cfg;
555 }
556 }
557 };
558 if (my $err = $@) {
559 $self->{user_cfg} = {};
560 die "Unable to load access control list: $err";
561 }
562}
563
564sub set_client_ip {
565 my ($self, $ip) = @_;
566
567 $self->{client_ip} = $ip;
568}
569
570sub get_client_ip {
571 my ($self) = @_;
572
573 return $self->{client_ip};
574}
575
be6ea723
DM
576sub set_result_attrib {
577 my ($self, $key, $value) = @_;
2c3a6c0a 578
be6ea723 579 $self->{result_attributes}->{$key} = $value;
2c3a6c0a
DM
580}
581
be6ea723
DM
582sub get_result_attrib {
583 my ($self, $key) = @_;
272fe9ff 584
be6ea723 585 return $self->{result_attributes}->{$key};
272fe9ff
DM
586}
587
2c3a6c0a
DM
588sub set_language {
589 my ($self, $lang) = @_;
590
591 # fixme: initialize I18N
592
593 $self->{language} = $lang;
594}
595
596sub get_language {
597 my ($self) = @_;
598
599 return $self->{language};
600}
601
602sub set_user {
603 my ($self, $user) = @_;
604
605 # fixme: get ACLs
606
607 $self->{user} = $user;
608}
609
610sub get_user {
611 my ($self) = @_;
612
613 die "user name not set\n" if !$self->{user};
614
615 return $self->{user};
616}
617
7b6dfe82
FG
618sub is_worker {
619 return $WORKER_FLAG;
620}
621
2c3a6c0a
DM
622# read/update list of active workers
623# we move all finished tasks to the archive index,
624# but keep aktive and most recent task in the active file.
5bf71a96
DM
625# $nocheck ... consider $new_upid still running (avoid that
626# we try to read the reult to early.
2c3a6c0a 627sub active_workers {
5bf71a96 628 my ($new_upid, $nocheck) = @_;
2c3a6c0a
DM
629
630 my $lkfn = "/var/log/pve/tasks/.active.lock";
631
632 my $timeout = 10;
633
634 my $code = sub {
635
636 my $tasklist = PVE::INotify::read_file('active');
637
638 my @ta;
639 my $tlist = [];
640 my $thash = {}; # only list task once
641
642 my $check_task = sub {
d33d0735 643 my ($task, $running) = @_;
2c3a6c0a 644
d33d0735 645 if ($running || PVE::ProcFSTools::check_process_running($task->{pid}, $task->{pstart})) {
2c3a6c0a
DM
646 push @$tlist, $task;
647 } else {
648 delete $task->{pid};
649 push @ta, $task;
650 }
651 delete $task->{pstart};
652 };
653
654 foreach my $task (@$tasklist) {
655 my $upid = $task->{upid};
656 next if $thash->{$upid};
657 $thash->{$upid} = $task;
658 &$check_task($task);
659 }
660
661 if ($new_upid && !(my $task = $thash->{$new_upid})) {
662 $task = PVE::Tools::upid_decode($new_upid);
663 $task->{upid} = $new_upid;
664 $thash->{$new_upid} = $task;
d33d0735 665 &$check_task($task, $nocheck);
2c3a6c0a
DM
666 }
667
668
669 @ta = sort { $b->{starttime} cmp $a->{starttime} } @ta;
670
671 my $save = defined($new_upid);
672
673 foreach my $task (@ta) {
674 next if $task->{endtime};
675 $task->{endtime} = time();
676 $task->{status} = PVE::Tools::upid_read_status($task->{upid});
677 $save = 1;
678 }
679
680 my $archive = '';
681 my @arlist = ();
682 foreach my $task (@ta) {
683 if (!$task->{saved}) {
66c62938 684 $archive .= sprintf("%s %08X %s\n", $task->{upid}, $task->{endtime}, $task->{status});
2c3a6c0a
DM
685 $save = 1;
686 push @arlist, $task;
687 $task->{saved} = 1;
688 }
689 }
690
691 if ($archive) {
692 my $size = 0;
693 my $filename = "/var/log/pve/tasks/index";
694 eval {
695 my $fh = IO::File->new($filename, '>>', 0644) ||
696 die "unable to open file '$filename' - $!\n";
697 PVE::Tools::safe_print($filename, $fh, $archive);
698 $size = -s $fh;
699 close($fh) ||
700 die "unable to close file '$filename' - $!\n";
701 };
702 my $err = $@;
703 if ($err) {
704 syslog('err', $err);
705 foreach my $task (@arlist) { # mark as not saved
706 $task->{saved} = 0;
707 }
708 }
709 my $maxsize = 50000; # about 1000 entries
710 if ($size > $maxsize) {
711 rename($filename, "$filename.1");
712 }
713 }
714
715 # we try to reduce the amount of data
716 # list all running tasks and task and a few others
717 # try to limit to 25 tasks
718 my $ctime = time();
719 my $max = 25 - scalar(@$tlist);
720 foreach my $task (@ta) {
721 last if $max <= 0;
722 push @$tlist, $task;
723 $max--;
724 }
725
726 PVE::INotify::write_file('active', $tlist) if $save;
727
728 return $tlist;
729 };
730
731 my $res = PVE::Tools::lock_file($lkfn, $timeout, $code);
732 die $@ if $@;
733
734 return $res;
735}
736
b9e47e57
DM
737my $kill_process_group = sub {
738 my ($pid, $pstart) = @_;
739
740 # send kill to process group (negative pid)
741 my $kpid = -$pid;
742
743 # always send signal to all pgrp members
744 kill(15, $kpid); # send TERM signal
745
746 # give max 5 seconds to shut down
747 for (my $i = 0; $i < 5; $i++) {
748 return if !PVE::ProcFSTools::check_process_running($pid, $pstart);
749 sleep (1);
750 }
751
752 # to be sure
753 kill(9, $kpid);
754};
755
756sub check_worker {
757 my ($upid, $killit) = @_;
758
759 my $task = PVE::Tools::upid_decode($upid);
760
761 my $running = PVE::ProcFSTools::check_process_running($task->{pid}, $task->{pstart});
762
763 return 0 if !$running;
764
765 if ($killit) {
766 &$kill_process_group($task->{pid});
767 return 0;
768 }
769
770 return 1;
771}
772
2c3a6c0a
DM
773# start long running workers
774# STDIN is redirected to /dev/null
775# STDOUT,STDERR are redirected to the filename returned by upid_decode
776# NOTE: we simulate running in foreground if ($self->{type} eq 'cli')
777sub fork_worker {
3036e8b1 778 my ($self, $dtype, $id, $user, $function, $background) = @_;
2c3a6c0a
DM
779
780 $dtype = 'unknown' if !defined ($dtype);
781 $id = '' if !defined ($id);
782
783 $user = 'root@pve' if !defined ($user);
784
3036e8b1 785 my $sync = ($self->{type} eq 'cli' && !$background) ? 1 : 0;
2c3a6c0a
DM
786
787 local $SIG{INT} =
788 local $SIG{QUIT} =
789 local $SIG{PIPE} =
790 local $SIG{TERM} = 'IGNORE';
791
792 my $starttime = time ();
793
794 my @psync = POSIX::pipe();
795 my @csync = POSIX::pipe();
796
797 my $node = $self->{nodename};
798
799 my $cpid = fork();
800 die "unable to fork worker - $!" if !defined($cpid);
801
802 my $workerpuid = $cpid ? $cpid : $$;
803
804 my $pstart = PVE::ProcFSTools::read_proc_starttime($workerpuid) ||
805 die "unable to read process start time";
806
807 my $upid = PVE::Tools::upid_encode ({
808 node => $node, pid => $workerpuid, pstart => $pstart,
809 starttime => $starttime, type => $dtype, id => $id, user => $user });
810
811 my $outfh;
812
813 if (!$cpid) { # child
814
815 $0 = "task $upid";
7b6dfe82 816 $WORKER_FLAG = 1;
2c3a6c0a
DM
817
818 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub { die "received interrupt\n"; };
819
820 $SIG{CHLD} = $SIG{PIPE} = 'DEFAULT';
821
822 # set sess/process group - we want to be able to kill the
823 # whole process group
824 POSIX::setsid();
825
826 POSIX::close ($psync[0]);
827 POSIX::close ($csync[1]);
828
829 $outfh = $sync ? $psync[1] : undef;
830
831 eval {
832 PVE::INotify::inotify_close();
833
834 if (my $atfork = $self->{atfork}) {
835 &$atfork();
836 }
837
838 # same algorythm as used inside SA
839 # STDIN = /dev/null
840 my $fd = fileno (STDIN);
2c3a6c0a 841
5a941ebe
DM
842 if (!$sync) {
843 close STDIN;
844 POSIX::close(0) if $fd != 0;
845
846 die "unable to redirect STDIN - $!"
847 if !open(STDIN, "</dev/null");
848
849 $outfh = PVE::Tools::upid_open($upid);
850 }
2c3a6c0a 851
2c3a6c0a
DM
852
853 # redirect STDOUT
854 $fd = fileno(STDOUT);
855 close STDOUT;
856 POSIX::close (1) if $fd != 1;
857
858 die "unable to redirect STDOUT - $!"
859 if !open(STDOUT, ">&", $outfh);
860
861 STDOUT->autoflush (1);
862
863 # redirect STDERR to STDOUT
864 $fd = fileno (STDERR);
865 close STDERR;
866 POSIX::close(2) if $fd != 2;
867
868 die "unable to redirect STDERR - $!"
869 if !open(STDERR, ">&1");
870
871 STDERR->autoflush(1);
872 };
873 if (my $err = $@) {
874 my $msg = "ERROR: $err";
875 POSIX::write($psync[1], $msg, length ($msg));
876 POSIX::close($psync[1]);
877 POSIX::_exit(1);
b9e47e57 878 kill(-9, $$);
2c3a6c0a
DM
879 }
880
f6f2d51f 881 # sync with parent (signal that we are ready)
2c3a6c0a
DM
882 if ($sync) {
883 print "$upid\n";
884 } else {
885 POSIX::write($psync[1], $upid, length ($upid));
886 POSIX::close($psync[1]);
887 }
888
889 my $readbuf = '';
890 # sync with parent (wait until parent is ready)
891 POSIX::read($csync[0], $readbuf, 4096);
892 die "parent setup error\n" if $readbuf ne 'OK';
893
e42eedbc
DM
894 if ($self->{type} eq 'ha') {
895 print "task started by HA resource agent\n";
896 }
2c3a6c0a
DM
897 eval { &$function($upid); };
898 my $err = $@;
899 if ($err) {
900 chomp $err;
901 $err =~ s/\n/ /mg;
902 syslog('err', $err);
903 print STDERR "TASK ERROR: $err\n";
904 POSIX::_exit(-1);
905 } else {
906 print STDERR "TASK OK\n";
b9e47e57 907 POSIX::_exit(0);
2c3a6c0a 908 }
b9e47e57 909 kill(-9, $$);
2c3a6c0a
DM
910 }
911
912 # parent
913
914 POSIX::close ($psync[1]);
915 POSIX::close ($csync[0]);
916
917 my $readbuf = '';
918 # sync with child (wait until child starts)
919 POSIX::read($psync[0], $readbuf, 4096);
920
921 if (!$sync) {
922 POSIX::close($psync[0]);
923 &$register_worker($cpid, $user, $upid);
924 } else {
925 chomp $readbuf;
926 }
927
928 eval {
929 die "got no worker upid - start worker failed\n" if !$readbuf;
930
931 if ($readbuf =~ m/^ERROR:\s*(.+)$/m) {
932 die "starting worker failed: $1\n";
933 }
934
935 if ($readbuf ne $upid) {
936 die "got strange worker upid ('$readbuf' != '$upid') - start worker failed\n";
937 }
938
939 if ($sync) {
940 $outfh = PVE::Tools::upid_open($upid);
941 }
942 };
943 my $err = $@;
944
945 if (!$err) {
946 my $msg = 'OK';
947 POSIX::write($csync[1], $msg, length ($msg));
948 POSIX::close($csync[1]);
949
950 } else {
951 POSIX::close($csync[1]);
b9e47e57 952 kill(-9, $cpid); # make sure it gets killed
2c3a6c0a
DM
953 die $err;
954 }
955
956 PVE::Cluster::log_msg('info', $user, "starting task $upid");
957
5bf71a96 958 my $tlist = active_workers($upid, $sync);
2c3a6c0a
DM
959 PVE::Cluster::broadcast_tasklist($tlist);
960
961 my $res = 0;
962
963 if ($sync) {
964 my $count;
965 my $outbuf = '';
8d6e045f 966 my $int_count = 0;
2c3a6c0a 967 eval {
8d6e045f 968 local $SIG{INT} = local $SIG{QUIT} = local $SIG{TERM} = sub {
527b2e7a
DM
969 # always send signal to all pgrp members
970 my $kpid = -$cpid;
8d6e045f 971 if ($int_count < 3) {
527b2e7a 972 kill(15, $kpid); # send TERM signal
8d6e045f 973 } else {
527b2e7a 974 kill(9, $kpid); # send KILL signal
8d6e045f
DM
975 }
976 $int_count++;
977 };
2c3a6c0a 978 local $SIG{PIPE} = sub { die "broken pipe\n"; };
b28410fc
DM
979
980 my $select = new IO::Select;
981 my $fh = IO::Handle->new_from_fd($psync[0], 'r');
982 $select->add($fh);
983
984 while ($select->count) {
985 my @handles = $select->can_read(1);
986 if (scalar(@handles)) {
987 my $count = sysread ($handles[0], $readbuf, 4096);
988 if (!defined ($count)) {
989 my $err = $!;
990 die "sync pipe read error: $err\n";
2c3a6c0a 991 }
b28410fc
DM
992 last if $count == 0; # eof
993
994 $outbuf .= $readbuf;
995 while ($outbuf =~ s/^(([^\010\r\n]*)(\r|\n|(\010)+|\r\n))//s) {
996 my $line = $1;
997 my $data = $2;
998 if ($data =~ m/^TASK OK$/) {
999 # skip
1000 } elsif ($data =~ m/^TASK ERROR: (.+)$/) {
1001 print STDERR "$1\n";
1002 } else {
1003 print $line;
1004 }
1005 if ($outfh) {
1006 print $outfh $line;
1007 $outfh->flush();
1008 }
2c3a6c0a 1009 }
b28410fc
DM
1010 } else {
1011 # some commands daemonize without closing stdout
1012 last if !PVE::ProcFSTools::check_process_running($cpid);
2c3a6c0a
DM
1013 }
1014 }
1015 };
1016 my $err = $@;
1017
1018 POSIX::close($psync[0]);
1019
1020 if ($outbuf) { # just to be sure
1021 print $outbuf;
1022 if ($outfh) {
1023 print $outfh $outbuf;
1024 }
1025 }
1026
1027 if ($err) {
1028 $err =~ s/\n/ /mg;
1029 print STDERR "$err\n";
1030 if ($outfh) {
1031 print $outfh "TASK ERROR: $err\n";
1032 }
2c3a6c0a
DM
1033 }
1034
b9e47e57
DM
1035 &$kill_process_group($cpid, $pstart); # make sure it gets killed
1036
2c3a6c0a
DM
1037 close($outfh);
1038
b9e47e57 1039 waitpid($cpid, 0);
2c3a6c0a
DM
1040 $res = $?;
1041 &$log_task_result($upid, $user, $res);
1042 }
1043
1044 return wantarray ? ($upid, $res) : $upid;
1045}
1046
10471;