]>
git.proxmox.com Git - pve-common.git/blob - src/PVE/RESTEnvironment.pm
1 package PVE
::RESTEnvironment
;
3 # NOTE: you can/should provide your own specialice class, and
4 # use this a bas class (as example see PVE::RPCEnvironment).
6 # we use this singleton class to pass RPC related environment values
10 use POSIX
qw(:sys_wait_h EINTR);
15 use PVE
::Exception
qw(raise raise_perm_exc);
24 # save $SIG{CHLD} handler implementation.
25 # simply set $SIG{CHLD} = $worker_reaper;
26 # and register forked processes with &$register_worker(pid)
27 # Note: using $SIG{CHLD} = 'IGNORE' or $SIG{CHLD} = sub { wait (); } or ...
28 # has serious side effects, because perls built in system() and open()
29 # functions can't get the correct exit status of a child. So we cant use
30 # that (also see perlipc)
35 my $log_task_result = sub {
36 my ($upid, $user, $status) = @_;
40 my $msg = 'successful';
43 my $ec = $status >> 8;
44 my $ic = $status & 255;
45 $msg = $ec ?
"failed ($ec)" : "interrupted ($ic)";
49 my $tlist = $rest_env->active_workers($upid);
50 eval { $rest_env->broadcast_tasklist($tlist); };
51 syslog
('err', $@) if $@;
54 foreach my $t (@$tlist) {
55 if ($t->{upid
} eq $upid) {
60 if ($task && $task->{status
}) {
61 $msg = $task->{status
};
64 $rest_env->log_cluster_msg($pri, $user, "end task $upid $msg");
67 my $worker_reaper = sub {
69 foreach my $pid (keys %$WORKER_PIDS) {
70 my $waitpid = waitpid ($pid, WNOHANG
);
71 if (defined($waitpid) && ($waitpid == $pid)) {
72 my $info = $WORKER_PIDS->{$pid};
73 if ($info && $info->{upid
} && $info->{user
}) {
74 &$log_task_result($info->{upid
}, $info->{user
}, $?);
76 delete ($WORKER_PIDS->{$pid});
81 my $register_worker = sub {
82 my ($pid, $user, $upid) = @_;
86 # do not register if already finished
87 my $waitpid = waitpid ($pid, WNOHANG
);
88 if (defined($waitpid) && ($waitpid == $pid)) {
89 delete ($WORKER_PIDS->{$pid});
93 $WORKER_PIDS->{$pid} = {
99 # initialize environment - must be called once at program startup
101 my ($class, $type, %params) = @_;
103 $class = ref($class) || $class;
105 die "already initialized" if $rest_env;
107 die "unknown environment type"
108 if !$type || $type !~ m/^(cli|pub|priv|ha)$/;
110 $SIG{CHLD
} = $worker_reaper;
113 # cli ... command started fron command line
114 # pub ... access from public server (apache)
115 # priv ... access from private server (pvedaemon)
116 # ha ... access from HA resource manager agent (rgmanager)
118 my $self = { type
=> $type };
122 foreach my $p (keys %params) {
123 if ($p eq 'atfork') {
124 $self->{$p} = $params{$p};
126 die "unknown option '$p'";
132 my ($sysname, $nodename) = POSIX
::uname
();
134 $nodename =~ s/\..*$//; # strip domain part, if any
136 $self->{nodename
} = $nodename;
141 # convenience function for command line tools
142 sub setup_default_cli_env
{
143 my ($class, $username) = @_;
145 $class = ref($class) || $class;
147 $username //= 'root@pam';
149 PVE
::INotify
::inotify_init
();
151 my $rpcenv = $class->init('cli');
152 $rpcenv->init_request();
153 $rpcenv->set_language($ENV{LANG
});
154 $rpcenv->set_user($username);
156 die "please run as root\n"
157 if ($username eq 'root@pam') && ($> != 0);
163 die "REST environment not initialized" if !$rest_env;
169 my ($self, $ip) = @_;
171 $self->{client_ip
} = $ip;
177 return $self->{client_ip
};
180 sub set_result_attrib
{
181 my ($self, $key, $value) = @_;
183 $self->{result_attributes
}->{$key} = $value;
186 sub get_result_attrib
{
187 my ($self, $key) = @_;
189 return $self->{result_attributes
}->{$key};
193 my ($self, $lang) = @_;
195 # fixme: initialize I18N
197 $self->{language
} = $lang;
203 return $self->{language
};
207 my ($self, $user) = @_;
209 $self->{user
} = $user;
213 my ($self, $noerr) = @_;
215 return $self->{user
} if defined($self->{user
}) || $noerr;
217 die "user name not set\n";
226 # read/update list of active workers
227 # we move all finished tasks to the archive index,
228 # but keep aktive and most recent task in the active file.
229 # $nocheck ... consider $new_upid still running (avoid that
230 # we try to read the reult to early.
232 my ($self, $new_upid, $nocheck) = @_;
234 my $lkfn = "/var/log/pve/tasks/.active.lock";
240 my $tasklist = PVE
::INotify
::read_file
('active');
244 my $thash = {}; # only list task once
246 my $check_task = sub {
247 my ($task, $running) = @_;
249 if ($running || PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
})) {
255 delete $task->{pstart
};
258 foreach my $task (@$tasklist) {
259 my $upid = $task->{upid
};
260 next if $thash->{$upid};
261 $thash->{$upid} = $task;
265 if ($new_upid && !(my $task = $thash->{$new_upid})) {
266 $task = PVE
::Tools
::upid_decode
($new_upid);
267 $task->{upid
} = $new_upid;
268 $thash->{$new_upid} = $task;
269 &$check_task($task, $nocheck);
273 @ta = sort { $b->{starttime
} <=> $a->{starttime
} } @ta;
275 my $save = defined($new_upid);
277 foreach my $task (@ta) {
278 next if $task->{endtime
};
279 $task->{endtime
} = time();
280 $task->{status
} = PVE
::Tools
::upid_read_status
($task->{upid
});
286 foreach my $task (@ta) {
287 if (!$task->{saved
}) {
288 $archive .= sprintf("%s %08X %s\n", $task->{upid
}, $task->{endtime
}, $task->{status
});
297 my $filename = "/var/log/pve/tasks/index";
299 my $fh = IO
::File-
>new($filename, '>>', 0644) ||
300 die "unable to open file '$filename' - $!\n";
301 PVE
::Tools
::safe_print
($filename, $fh, $archive);
304 die "unable to close file '$filename' - $!\n";
309 foreach my $task (@arlist) { # mark as not saved
313 my $maxsize = 50000; # about 1000 entries
314 if ($size > $maxsize) {
315 rename($filename, "$filename.1");
319 # we try to reduce the amount of data
320 # list all running tasks and task and a few others
321 # try to limit to 25 tasks
322 my $max = 25 - scalar(@$tlist);
323 foreach my $task (@ta) {
329 PVE
::INotify
::write_file
('active', $tlist) if $save;
334 my $res = PVE
::Tools
::lock_file
($lkfn, $timeout, $code);
340 my $kill_process_group = sub {
341 my ($pid, $pstart) = @_;
343 # send kill to process group (negative pid)
346 # always send signal to all pgrp members
347 kill(15, $kpid); # send TERM signal
349 # give max 5 seconds to shut down
350 for (my $i = 0; $i < 5; $i++) {
351 return if !PVE
::ProcFSTools
::check_process_running
($pid, $pstart);
360 my ($self, $upid, $killit) = @_;
362 my $task = PVE
::Tools
::upid_decode
($upid);
364 my $running = PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
});
366 return 0 if !$running;
369 &$kill_process_group($task->{pid
});
376 # acts almost as tee: writes an output both to STDOUT and a task log,
377 # we differ as we're worker aware and look also at the childs control pipe,
378 # so we know if the function could be executed successfully or not.
379 my $tee_worker = sub {
380 my ($childfd, $ctrlfd, $taskfh, $cpid) = @_;
384 local $SIG{INT
} = local $SIG{QUIT
} = local $SIG{TERM
} = sub {
385 # always send signal to all pgrp members
387 if ($int_count < 3) {
388 kill(15, $kpid); # send TERM signal
390 kill(9, $kpid); # send KILL signal
394 local $SIG{PIPE
} = sub { die "broken pipe\n"; };
396 my $select = new IO
::Select
;
397 my $fh = IO
::Handle-
>new_from_fd($childfd, 'r');
402 while ($select->count) {
403 my @handles = $select->can_read(1);
404 if (scalar(@handles)) {
405 my $count = sysread ($handles[0], $readbuf, 4096);
406 if (!defined ($count)) {
408 die "sync pipe read error: $err\n";
410 last if $count == 0; # eof
415 print $taskfh $readbuf;
418 # some commands daemonize without closing stdout
419 last if !PVE
::ProcFSTools
::check_process_running
($cpid);
423 # get status (error or OK)
424 POSIX
::read($ctrlfd, $readbuf, 4096);
425 if ($readbuf =~ m/^TASK OK\n?$/) {
426 # skip printing to stdout
427 print $taskfh $readbuf;
428 } elsif ($readbuf =~ m/^TASK ERROR: (.*)\n?$/) {
430 print $taskfh "\n$readbuf"; # ensure start on new line for webUI
432 die "got unexpected control message: $readbuf\n";
438 POSIX
::close($childfd);
439 POSIX
::close($ctrlfd);
443 print STDERR
"$err\n";
444 print $taskfh "TASK ERROR: $err\n";
448 # start long running workers
449 # STDIN is redirected to /dev/null
450 # STDOUT,STDERR are redirected to the filename returned by upid_decode
451 # NOTE: we simulate running in foreground if ($self->{type} eq 'cli')
453 my ($self, $dtype, $id, $user, $function, $background) = @_;
455 $dtype = 'unknown' if !defined ($dtype);
456 $id = '' if !defined ($id);
458 $user = 'root@pve' if !defined ($user);
460 my $sync = ($self->{type
} eq 'cli' && !$background) ?
1 : 0;
465 local $SIG{TERM
} = 'IGNORE';
467 my $starttime = time ();
469 my @psync = POSIX
::pipe();
470 my @csync = POSIX
::pipe();
471 my @ctrlfd = POSIX
::pipe() if $sync;
473 my $node = $self->{nodename
};
476 die "unable to fork worker - $!" if !defined($cpid);
478 my $workerpuid = $cpid ?
$cpid : $$;
480 my $pstart = PVE
::ProcFSTools
::read_proc_starttime
($workerpuid) ||
481 die "unable to read process start time";
483 my $upid = PVE
::Tools
::upid_encode
({
484 node
=> $node, pid
=> $workerpuid, pstart
=> $pstart,
485 starttime
=> $starttime, type
=> $dtype, id
=> $id, user
=> $user });
489 if (!$cpid) { # child
494 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub { die "received interrupt\n"; };
496 $SIG{CHLD
} = $SIG{PIPE
} = 'DEFAULT';
498 # set sess/process group - we want to be able to kill the
499 # whole process group
502 POSIX
::close ($psync[0]);
503 POSIX
::close ($ctrlfd[0]) if $sync;
504 POSIX
::close ($csync[1]);
506 $outfh = $sync ?
$psync[1] : undef;
507 my $resfh = $sync ?
$ctrlfd[1] : undef;
510 PVE
::INotify
::inotify_close
();
512 if (my $atfork = $self->{atfork
}) {
516 # same algorythm as used inside SA
518 my $fd = fileno (STDIN
);
522 POSIX
::close(0) if $fd != 0;
524 die "unable to redirect STDIN - $!"
525 if !open(STDIN
, "</dev/null");
527 $outfh = PVE
::Tools
::upid_open
($upid);
528 $resfh = fileno($outfh);
533 $fd = fileno(STDOUT
);
535 POSIX
::close (1) if $fd != 1;
537 die "unable to redirect STDOUT - $!"
538 if !open(STDOUT
, ">&", $outfh);
540 STDOUT-
>autoflush (1);
542 # redirect STDERR to STDOUT
543 $fd = fileno (STDERR
);
545 POSIX
::close(2) if $fd != 2;
547 die "unable to redirect STDERR - $!"
548 if !open(STDERR
, ">&1");
550 STDERR-
>autoflush(1);
553 my $msg = "ERROR: $err";
554 POSIX
::write($psync[1], $msg, length ($msg));
555 POSIX
::close($psync[1]);
560 # sync with parent (signal that we are ready)
561 POSIX
::write($psync[1], $upid, length ($upid));
562 POSIX
::close($psync[1]) if !$sync; # don't need output pipe if async
566 # sync with parent (wait until parent is ready)
567 POSIX
::read($csync[0], $readbuf, 4096);
568 die "parent setup error\n" if $readbuf ne 'OK';
570 if ($self->{type
} eq 'ha') {
571 print "task started by HA resource agent\n";
580 my $msg = "TASK ERROR: $err\n";
581 POSIX
::write($resfh, $msg, length($msg));
582 POSIX
::close($resfh) if $sync;
585 my $msg = "TASK OK\n";
586 POSIX
::write($resfh, $msg, length($msg));
587 POSIX
::close($resfh) if $sync;
595 POSIX
::close ($psync[1]);
596 POSIX
::close ($ctrlfd[1]) if $sync;
597 POSIX
::close ($csync[0]);
600 # sync with child (wait until child starts)
601 POSIX
::read($psync[0], $readbuf, 4096);
604 POSIX
::close($psync[0]);
605 &$register_worker($cpid, $user, $upid);
611 die "got no worker upid - start worker failed\n" if !$readbuf;
613 if ($readbuf =~ m/^ERROR:\s*(.+)$/m) {
614 die "starting worker failed: $1\n";
617 if ($readbuf ne $upid) {
618 die "got strange worker upid ('$readbuf' != '$upid') - start worker failed\n";
622 $outfh = PVE
::Tools
::upid_open
($upid);
629 POSIX
::write($csync[1], $msg, length ($msg));
630 POSIX
::close($csync[1]);
633 POSIX
::close($csync[1]);
634 kill(-9, $cpid); # make sure it gets killed
638 $self->log_cluster_msg('info', $user, "starting task $upid");
640 my $tlist = $self->active_workers($upid, $sync);
641 eval { $self->broadcast_tasklist($tlist); };
642 syslog
('err', $@) if $@;
648 $tee_worker->($psync[0], $ctrlfd[0], $outfh, $cpid);
650 &$kill_process_group($cpid, $pstart); # make sure it gets killed
656 &$log_task_result($upid, $user, $res);
659 return wantarray ?
($upid, $res) : $upid;
664 sub log_cluster_msg
{
665 my ($self, $pri, $user, $msg) = @_;
667 syslog
($pri, "%s", $msg);
669 # PVE::Cluster::log_msg($pri, $user, $msg);
672 sub broadcast_tasklist
{
673 my ($self, $tlist) = @_;
675 # PVE::Cluster::broadcast_tasklist($tlist);
678 sub check_api2_permissions
{
679 my ($self, $perm, $username, $param) = @_;
681 return 1 if !$username && $perm->{user
} eq 'world';
683 raise_perm_exc
("user != null") if !$username;
685 return 1 if $username eq 'root@pam';
687 raise_perm_exc
('user != root@pam') if !$perm;
689 return 1 if $perm->{user
} && $perm->{user
} eq 'all';
691 ##return $self->exec_api2_perm_check($perm->{check}, $username, $param)
697 # init_request - should be called before each REST/CLI request
699 my ($self, %params) = @_;
701 $self->{result_attributes
} = {}
703 # if you nedd more, implement in subclass