2 use std
::path
::{Path, PathBuf}
;
3 use std
::os
::unix
::io
::AsRawFd
;
5 use anyhow
::{bail, format_err, Error}
;
8 use openssl
::ssl
::{SslMethod, SslAcceptor, SslFiletype}
;
10 use proxmox
::try_block
;
11 use proxmox
::api
::RpcEnvironmentType
;
23 rotate_task_log_archive
,
25 tools
::systemd
::time
::{
32 use proxmox_backup
::api2
::types
::Authid
;
33 use proxmox_backup
::configdir
;
34 use proxmox_backup
::buildcfg
;
35 use proxmox_backup
::server
;
36 use proxmox_backup
::auth_helpers
::*;
37 use proxmox_backup
::tools
::{
46 PROXMOX_BACKUP_TCP_KEEPALIVE_TIME
,
50 use proxmox_backup
::api2
::pull
::do_sync_job
;
51 use proxmox_backup
::server
::do_verification_job
;
52 use proxmox_backup
::server
::do_prune_job
;
54 fn main() -> Result
<(), Error
> {
55 proxmox_backup
::tools
::setup_safe_path_env();
57 let backup_uid
= proxmox_backup
::backup
::backup_user()?
.uid
;
58 let backup_gid
= proxmox_backup
::backup
::backup_group()?
.gid
;
59 let running_uid
= nix
::unistd
::Uid
::effective();
60 let running_gid
= nix
::unistd
::Gid
::effective();
62 if running_uid
!= backup_uid
|| running_gid
!= backup_gid
{
63 bail
!("proxy not running as backup user or group (got uid {} gid {})", running_uid
, running_gid
);
66 proxmox_backup
::tools
::runtime
::main(run())
69 async
fn run() -> Result
<(), Error
> {
70 if let Err(err
) = syslog
::init(
71 syslog
::Facility
::LOG_DAEMON
,
72 log
::LevelFilter
::Info
,
73 Some("proxmox-backup-proxy")) {
74 bail
!("unable to inititialize syslog - {}", err
);
77 // Note: To debug early connection error use
78 // PROXMOX_DEBUG=1 ./target/release/proxmox-backup-proxy
79 let debug
= std
::env
::var("PROXMOX_DEBUG").is_ok();
81 let _
= public_auth_key(); // load with lazy_static
82 let _
= csrf_secret(); // load with lazy_static
84 let mut config
= ApiConfig
::new(
85 buildcfg
::JS_DIR
, &proxmox_backup
::api2
::ROUTER
, RpcEnvironmentType
::PUBLIC
)?
;
87 config
.add_alias("novnc", "/usr/share/novnc-pve");
88 config
.add_alias("extjs", "/usr/share/javascript/extjs");
89 config
.add_alias("fontawesome", "/usr/share/fonts-font-awesome");
90 config
.add_alias("xtermjs", "/usr/share/pve-xtermjs");
91 config
.add_alias("locale", "/usr/share/pbs-i18n");
92 config
.add_alias("widgettoolkit", "/usr/share/javascript/proxmox-widget-toolkit");
93 config
.add_alias("css", "/usr/share/javascript/proxmox-backup/css");
94 config
.add_alias("docs", "/usr/share/doc/proxmox-backup/html");
96 let mut indexpath
= PathBuf
::from(buildcfg
::JS_DIR
);
97 indexpath
.push("index.hbs");
98 config
.register_template("index", &indexpath
)?
;
99 config
.register_template("console", "/usr/share/pve-xtermjs/index.html.hbs")?
;
101 let mut commando_sock
= server
::CommandoSocket
::new(server
::our_ctrl_sock());
103 config
.enable_file_log(buildcfg
::API_ACCESS_LOG_FN
, &mut commando_sock
)?
;
105 let rest_server
= RestServer
::new(config
);
107 //openssl req -x509 -newkey rsa:4096 -keyout /etc/proxmox-backup/proxy.key -out /etc/proxmox-backup/proxy.pem -nodes
108 let key_path
= configdir
!("/proxy.key");
109 let cert_path
= configdir
!("/proxy.pem");
111 let mut acceptor
= SslAcceptor
::mozilla_intermediate_v5(SslMethod
::tls()).unwrap();
112 acceptor
.set_private_key_file(key_path
, SslFiletype
::PEM
)
113 .map_err(|err
| format_err
!("unable to read proxy key {} - {}", key_path
, err
))?
;
114 acceptor
.set_certificate_chain_file(cert_path
)
115 .map_err(|err
| format_err
!("unable to read proxy cert {} - {}", cert_path
, err
))?
;
116 acceptor
.check_private_key().unwrap();
118 let acceptor
= Arc
::new(acceptor
.build());
120 let server
= daemon
::create_daemon(
121 ([0,0,0,0,0,0,0,0], 8007).into(),
124 let connections
= accept_connections(listener
, acceptor
, debug
);
125 let connections
= hyper
::server
::accept
::from_stream(connections
);
128 .and_then(|_
| hyper
::Server
::builder(connections
)
130 .with_graceful_shutdown(server
::shutdown_future())
131 .map_err(Error
::from
)
133 .map_err(|err
| eprintln
!("server error: {}", err
))
139 server
::write_pid(buildcfg
::PROXMOX_BACKUP_PROXY_PID_FN
)?
;
140 daemon
::systemd_notify(daemon
::SystemdNotify
::Ready
)?
;
142 let init_result
: Result
<(), Error
> = try_block
!({
143 server
::register_task_control_commands(&mut commando_sock
)?
;
144 commando_sock
.spawn()?
;
145 server
::server_state_init()?
;
149 if let Err(err
) = init_result
{
150 bail
!("unable to start daemon - {}", err
);
153 start_task_scheduler();
154 start_stat_generator();
157 log
::info
!("server shutting down, waiting for active workers to complete");
158 proxmox_backup
::server
::last_worker_future().await?
;
159 log
::info
!("done - exit server");
164 fn accept_connections(
165 mut listener
: tokio
::net
::TcpListener
,
166 acceptor
: Arc
<openssl
::ssl
::SslAcceptor
>,
168 ) -> tokio
::sync
::mpsc
::Receiver
<Result
<tokio_openssl
::SslStream
<tokio
::net
::TcpStream
>, Error
>> {
170 const MAX_PENDING_ACCEPTS
: usize = 1024;
172 let (sender
, receiver
) = tokio
::sync
::mpsc
::channel(MAX_PENDING_ACCEPTS
);
174 let accept_counter
= Arc
::new(());
176 tokio
::spawn(async
move {
178 match listener
.accept().await
{
180 eprintln
!("error accepting tcp connection: {}", err
);
182 Ok((sock
, _addr
)) => {
183 sock
.set_nodelay(true).unwrap();
184 let _
= set_tcp_keepalive(sock
.as_raw_fd(), PROXMOX_BACKUP_TCP_KEEPALIVE_TIME
);
185 let acceptor
= Arc
::clone(&acceptor
);
186 let mut sender
= sender
.clone();
188 if Arc
::strong_count(&accept_counter
) > MAX_PENDING_ACCEPTS
{
189 eprintln
!("connection rejected - to many open connections");
193 let accept_counter
= accept_counter
.clone();
194 tokio
::spawn(async
move {
195 let accept_future
= tokio
::time
::timeout(
196 Duration
::new(10, 0), tokio_openssl
::accept(&acceptor
, sock
));
198 let result
= accept_future
.await
;
201 Ok(Ok(connection
)) => {
202 if let Err(_
) = sender
.send(Ok(connection
)).await
{
204 eprintln
!("detect closed connection channel");
210 eprintln
!("https handshake failed - {}", err
);
215 eprintln
!("https handshake timeout");
220 drop(accept_counter
); // decrease reference count
230 fn start_stat_generator() {
231 let abort_future
= server
::shutdown_future();
232 let future
= Box
::pin(run_stat_generator());
233 let task
= futures
::future
::select(future
, abort_future
);
234 tokio
::spawn(task
.map(|_
| ()));
237 fn start_task_scheduler() {
238 let abort_future
= server
::shutdown_future();
239 let future
= Box
::pin(run_task_scheduler());
240 let task
= futures
::future
::select(future
, abort_future
);
241 tokio
::spawn(task
.map(|_
| ()));
244 use std
::time
::{SystemTime, Instant, Duration, UNIX_EPOCH}
;
246 fn next_minute() -> Result
<Instant
, Error
> {
247 let now
= SystemTime
::now();
248 let epoch_now
= now
.duration_since(UNIX_EPOCH
)?
;
249 let epoch_next
= Duration
::from_secs((epoch_now
.as_secs()/60 + 1)*60);
250 Ok(Instant
::now() + epoch_next
- epoch_now
)
253 async
fn run_task_scheduler() {
255 let mut count
: usize = 0;
260 let delay_target
= match next_minute() { // try to run very minute
263 eprintln
!("task scheduler: compute next minute failed - {}", err
);
264 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(Instant
::now() + Duration
::from_secs(60))).await
;
269 if count
> 2 { // wait 1..2 minutes before starting
270 match schedule_tasks().catch_unwind().await
{
272 match panic
.downcast
::<&str>() {
274 eprintln
!("task scheduler panic: {}", msg
);
277 eprintln
!("task scheduler panic - unknown type");
282 eprintln
!("task scheduler failed - {:?}", err
);
288 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(delay_target
)).await
;
292 async
fn schedule_tasks() -> Result
<(), Error
> {
294 schedule_datastore_garbage_collection().await
;
295 schedule_datastore_prune().await
;
296 schedule_datastore_sync_jobs().await
;
297 schedule_datastore_verify_jobs().await
;
298 schedule_task_log_rotate().await
;
303 async
fn schedule_datastore_garbage_collection() {
305 use proxmox_backup
::config
::{
312 let config
= match datastore
::config() {
314 eprintln
!("unable to read datastore config - {}", err
);
317 Ok((config
, _digest
)) => config
,
320 for (store
, (_
, store_config
)) in config
.sections
{
321 let datastore
= match DataStore
::lookup_datastore(&store
) {
322 Ok(datastore
) => datastore
,
324 eprintln
!("lookup_datastore failed - {}", err
);
329 let store_config
: DataStoreConfig
= match serde_json
::from_value(store_config
) {
332 eprintln
!("datastore config from_value failed - {}", err
);
337 let event_str
= match store_config
.gc_schedule
{
338 Some(event_str
) => event_str
,
342 let event
= match parse_calendar_event(&event_str
) {
345 eprintln
!("unable to parse schedule '{}' - {}", event_str
, err
);
350 if datastore
.garbage_collection_running() { continue; }
352 let worker_type
= "garbage_collection";
354 let last
= match jobstate
::last_run_time(worker_type
, &store
) {
357 eprintln
!("could not get last run time of {} {}: {}", worker_type
, store
, err
);
362 let next
= match compute_next_event(&event
, last
, false) {
363 Ok(Some(next
)) => next
,
364 Ok(None
) => continue,
366 eprintln
!("compute_next_event for '{}' failed - {}", event_str
, err
);
371 let now
= proxmox
::tools
::time
::epoch_i64();
373 if next
> now { continue; }
375 let job
= match Job
::new(worker_type
, &store
) {
377 Err(_
) => continue, // could not get lock
380 let auth_id
= Authid
::backup_auth_id();
382 if let Err(err
) = crate::server
::do_garbage_collection_job(job
, datastore
, auth_id
, Some(event_str
), false) {
383 eprintln
!("unable to start garbage collection job on datastore {} - {}", store
, err
);
388 async
fn schedule_datastore_prune() {
390 use proxmox_backup
::{
400 let config
= match datastore
::config() {
402 eprintln
!("unable to read datastore config - {}", err
);
405 Ok((config
, _digest
)) => config
,
408 for (store
, (_
, store_config
)) in config
.sections
{
410 let store_config
: DataStoreConfig
= match serde_json
::from_value(store_config
) {
413 eprintln
!("datastore '{}' config from_value failed - {}", store
, err
);
418 let event_str
= match store_config
.prune_schedule
{
419 Some(event_str
) => event_str
,
423 let prune_options
= PruneOptions
{
424 keep_last
: store_config
.keep_last
,
425 keep_hourly
: store_config
.keep_hourly
,
426 keep_daily
: store_config
.keep_daily
,
427 keep_weekly
: store_config
.keep_weekly
,
428 keep_monthly
: store_config
.keep_monthly
,
429 keep_yearly
: store_config
.keep_yearly
,
432 if !prune_options
.keeps_something() { // no prune settings - keep all
436 let worker_type
= "prune";
437 if check_schedule(worker_type
, &event_str
, &store
) {
438 let job
= match Job
::new(worker_type
, &store
) {
440 Err(_
) => continue, // could not get lock
443 let auth_id
= Authid
::backup_auth_id().clone();
444 if let Err(err
) = do_prune_job(job
, prune_options
, store
.clone(), &auth_id
, Some(event_str
)) {
445 eprintln
!("unable to start datastore prune job {} - {}", &store
, err
);
451 async
fn schedule_datastore_sync_jobs() {
453 use proxmox_backup
::config
::sync
::{
458 let config
= match sync
::config() {
460 eprintln
!("unable to read sync job config - {}", err
);
463 Ok((config
, _digest
)) => config
,
466 for (job_id
, (_
, job_config
)) in config
.sections
{
467 let job_config
: SyncJobConfig
= match serde_json
::from_value(job_config
) {
470 eprintln
!("sync job config from_value failed - {}", err
);
475 let event_str
= match job_config
.schedule
{
476 Some(ref event_str
) => event_str
.clone(),
480 let worker_type
= "syncjob";
481 if check_schedule(worker_type
, &event_str
, &job_id
) {
482 let job
= match Job
::new(worker_type
, &job_id
) {
484 Err(_
) => continue, // could not get lock
487 let auth_id
= Authid
::backup_auth_id().clone();
488 if let Err(err
) = do_sync_job(job
, job_config
, &auth_id
, Some(event_str
)) {
489 eprintln
!("unable to start datastore sync job {} - {}", &job_id
, err
);
495 async
fn schedule_datastore_verify_jobs() {
497 use proxmox_backup
::config
::verify
::{
499 VerificationJobConfig
,
502 let config
= match verify
::config() {
504 eprintln
!("unable to read verification job config - {}", err
);
507 Ok((config
, _digest
)) => config
,
509 for (job_id
, (_
, job_config
)) in config
.sections
{
510 let job_config
: VerificationJobConfig
= match serde_json
::from_value(job_config
) {
513 eprintln
!("verification job config from_value failed - {}", err
);
517 let event_str
= match job_config
.schedule
{
518 Some(ref event_str
) => event_str
.clone(),
522 let worker_type
= "verificationjob";
523 let auth_id
= Authid
::backup_auth_id().clone();
524 if check_schedule(worker_type
, &event_str
, &job_id
) {
525 let job
= match Job
::new(&worker_type
, &job_id
) {
527 Err(_
) => continue, // could not get lock
529 if let Err(err
) = do_verification_job(job
, job_config
, &auth_id
, Some(event_str
)) {
530 eprintln
!("unable to start datastore verification job {} - {}", &job_id
, err
);
536 async
fn schedule_task_log_rotate() {
538 let worker_type
= "logrotate";
539 let job_id
= "access-log_and_task-archive";
541 // schedule daily at 00:00 like normal logrotate
542 let schedule
= "00:00";
544 if !check_schedule(worker_type
, schedule
, job_id
) {
545 // if we never ran the rotation, schedule instantly
546 match jobstate
::JobState
::load(worker_type
, job_id
) {
547 Ok(state
) => match state
{
548 jobstate
::JobState
::Created { .. }
=> {}
,
555 let mut job
= match Job
::new(worker_type
, job_id
) {
557 Err(_
) => return, // could not get lock
560 if let Err(err
) = WorkerTask
::new_thread(
563 Authid
::backup_auth_id().clone(),
566 job
.start(&worker
.upid().to_string())?
;
567 worker
.log(format
!("starting task log rotation"));
569 let result
= try_block
!({
570 let max_size
= 512 * 1024 - 1; // an entry has ~ 100b, so > 5000 entries/file
571 let max_files
= 20; // times twenty files gives > 100000 task entries
572 let has_rotated
= rotate_task_log_archive(max_size
, true, Some(max_files
))?
;
574 worker
.log(format
!("task log archive was rotated"));
576 worker
.log(format
!("task log archive was not rotated"));
579 let max_size
= 32 * 1024 * 1024 - 1;
581 let mut logrotate
= LogRotate
::new(buildcfg
::API_ACCESS_LOG_FN
, true)
582 .ok_or_else(|| format_err
!("could not get API access log file names"))?
;
584 let has_rotated
= logrotate
.rotate(max_size
, None
, Some(max_files
))?
;
586 println
!("rotated access log, telling daemons to re-open log file");
587 proxmox_backup
::tools
::runtime
::block_on(command_reopen_logfiles())?
;
589 worker
.log(format
!("API access log was rotated"));
591 worker
.log(format
!("API access log was not rotated"));
597 let status
= worker
.create_state(&result
);
599 if let Err(err
) = job
.finish(status
) {
600 eprintln
!("could not finish job state for {}: {}", worker_type
, err
);
606 eprintln
!("unable to start task log rotation: {}", err
);
611 async
fn command_reopen_logfiles() -> Result
<(), Error
> {
612 // only care about the most recent daemon instance for each, proxy & api, as other older ones
613 // should not respond to new requests anyway, but only finish their current one and then exit.
614 let sock
= server
::our_ctrl_sock();
615 let f1
= server
::send_command(sock
, serde_json
::json
!({
616 "command": "api-access-log-reopen",
619 let pid
= server
::read_pid(buildcfg
::PROXMOX_BACKUP_API_PID_FN
)?
;
620 let sock
= server
::ctrl_sock_from_pid(pid
);
621 let f2
= server
::send_command(sock
, serde_json
::json
!({
622 "command": "api-access-log-reopen",
625 match futures
::join
!(f1
, f2
) {
626 (Err(e1
), Err(e2
)) => Err(format_err
!("reopen commands failed, proxy: {}; api: {}", e1
, e2
)),
627 (Err(e1
), Ok(_
)) => Err(format_err
!("reopen commands failed, proxy: {}", e1
)),
628 (Ok(_
), Err(e2
)) => Err(format_err
!("reopen commands failed, api: {}", e2
)),
633 async
fn run_stat_generator() {
638 let save
= if count
>= 6 { count = 0; true }
else { false }
;
640 let delay_target
= Instant
::now() + Duration
::from_secs(10);
642 generate_host_stats(save
).await
;
644 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(delay_target
)).await
;
650 fn rrd_update_gauge(name
: &str, value
: f64, save
: bool
) {
651 use proxmox_backup
::rrd
;
652 if let Err(err
) = rrd
::update_value(name
, value
, rrd
::DST
::Gauge
, save
) {
653 eprintln
!("rrd::update_value '{}' failed - {}", name
, err
);
657 fn rrd_update_derive(name
: &str, value
: f64, save
: bool
) {
658 use proxmox_backup
::rrd
;
659 if let Err(err
) = rrd
::update_value(name
, value
, rrd
::DST
::Derive
, save
) {
660 eprintln
!("rrd::update_value '{}' failed - {}", name
, err
);
664 async
fn generate_host_stats(save
: bool
) {
665 use proxmox
::sys
::linux
::procfs
::{
666 read_meminfo
, read_proc_stat
, read_proc_net_dev
, read_loadavg
};
667 use proxmox_backup
::config
::datastore
;
670 proxmox_backup
::tools
::runtime
::block_in_place(move || {
672 match read_proc_stat() {
674 rrd_update_gauge("host/cpu", stat
.cpu
, save
);
675 rrd_update_gauge("host/iowait", stat
.iowait_percent
, save
);
678 eprintln
!("read_proc_stat failed - {}", err
);
682 match read_meminfo() {
684 rrd_update_gauge("host/memtotal", meminfo
.memtotal
as f64, save
);
685 rrd_update_gauge("host/memused", meminfo
.memused
as f64, save
);
686 rrd_update_gauge("host/swaptotal", meminfo
.swaptotal
as f64, save
);
687 rrd_update_gauge("host/swapused", meminfo
.swapused
as f64, save
);
690 eprintln
!("read_meminfo failed - {}", err
);
694 match read_proc_net_dev() {
696 use proxmox_backup
::config
::network
::is_physical_nic
;
700 if !is_physical_nic(&item
.device
) { continue; }
701 netin
+= item
.receive
;
704 rrd_update_derive("host/netin", netin
as f64, save
);
705 rrd_update_derive("host/netout", netout
as f64, save
);
708 eprintln
!("read_prox_net_dev failed - {}", err
);
712 match read_loadavg() {
714 rrd_update_gauge("host/loadavg", loadavg
.0 as f64, save
);
717 eprintln
!("read_loadavg failed - {}", err
);
721 let disk_manager
= DiskManage
::new();
723 gather_disk_stats(disk_manager
.clone(), Path
::new("/"), "host", save
);
725 match datastore
::config() {
727 let datastore_list
: Vec
<datastore
::DataStoreConfig
> =
728 config
.convert_to_typed_array("datastore").unwrap_or(Vec
::new());
730 for config
in datastore_list
{
732 let rrd_prefix
= format
!("datastore/{}", config
.name
);
733 let path
= std
::path
::Path
::new(&config
.path
);
734 gather_disk_stats(disk_manager
.clone(), path
, &rrd_prefix
, save
);
738 eprintln
!("read datastore config failed - {}", err
);
745 fn check_schedule(worker_type
: &str, event_str
: &str, id
: &str) -> bool
{
746 let event
= match parse_calendar_event(event_str
) {
749 eprintln
!("unable to parse schedule '{}' - {}", event_str
, err
);
754 let last
= match jobstate
::last_run_time(worker_type
, &id
) {
757 eprintln
!("could not get last run time of {} {}: {}", worker_type
, id
, err
);
762 let next
= match compute_next_event(&event
, last
, false) {
763 Ok(Some(next
)) => next
,
764 Ok(None
) => return false,
766 eprintln
!("compute_next_event for '{}' failed - {}", event_str
, err
);
771 let now
= proxmox
::tools
::time
::epoch_i64();
775 fn gather_disk_stats(disk_manager
: Arc
<DiskManage
>, path
: &Path
, rrd_prefix
: &str, save
: bool
) {
777 match proxmox_backup
::tools
::disks
::disk_usage(path
) {
779 let rrd_key
= format
!("{}/total", rrd_prefix
);
780 rrd_update_gauge(&rrd_key
, status
.total
as f64, save
);
781 let rrd_key
= format
!("{}/used", rrd_prefix
);
782 rrd_update_gauge(&rrd_key
, status
.used
as f64, save
);
785 eprintln
!("read disk_usage on {:?} failed - {}", path
, err
);
789 match disk_manager
.find_mounted_device(path
) {
791 Ok(Some((fs_type
, device
, source
))) => {
792 let mut device_stat
= None
;
793 match fs_type
.as_str() {
795 if let Some(pool
) = source
{
796 match zfs_pool_stats(&pool
) {
797 Ok(stat
) => device_stat
= stat
,
798 Err(err
) => eprintln
!("zfs_pool_stats({:?}) failed - {}", pool
, err
),
803 if let Ok(disk
) = disk_manager
.clone().disk_by_dev_num(device
.into_dev_t()) {
804 match disk
.read_stat() {
805 Ok(stat
) => device_stat
= stat
,
806 Err(err
) => eprintln
!("disk.read_stat {:?} failed - {}", path
, err
),
811 if let Some(stat
) = device_stat
{
812 let rrd_key
= format
!("{}/read_ios", rrd_prefix
);
813 rrd_update_derive(&rrd_key
, stat
.read_ios
as f64, save
);
814 let rrd_key
= format
!("{}/read_bytes", rrd_prefix
);
815 rrd_update_derive(&rrd_key
, (stat
.read_sectors
*512) as f64, save
);
817 let rrd_key
= format
!("{}/write_ios", rrd_prefix
);
818 rrd_update_derive(&rrd_key
, stat
.write_ios
as f64, save
);
819 let rrd_key
= format
!("{}/write_bytes", rrd_prefix
);
820 rrd_update_derive(&rrd_key
, (stat
.write_sectors
*512) as f64, save
);
822 let rrd_key
= format
!("{}/io_ticks", rrd_prefix
);
823 rrd_update_derive(&rrd_key
, (stat
.io_ticks
as f64)/1000.0, save
);
827 eprintln
!("find_mounted_device failed - {}", err
);