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
;
24 rotate_task_log_archive
,
26 tools
::systemd
::time
::{
33 use proxmox_backup
::api2
::types
::Authid
;
34 use proxmox_backup
::configdir
;
35 use proxmox_backup
::buildcfg
;
36 use proxmox_backup
::server
;
37 use proxmox_backup
::auth_helpers
::*;
38 use proxmox_backup
::tools
::{
47 PROXMOX_BACKUP_TCP_KEEPALIVE_TIME
,
51 use proxmox_backup
::api2
::pull
::do_sync_job
;
52 use proxmox_backup
::server
::do_verification_job
;
53 use proxmox_backup
::server
::do_prune_job
;
55 fn main() -> Result
<(), Error
> {
56 proxmox_backup
::tools
::setup_safe_path_env();
58 let backup_uid
= proxmox_backup
::backup
::backup_user()?
.uid
;
59 let backup_gid
= proxmox_backup
::backup
::backup_group()?
.gid
;
60 let running_uid
= nix
::unistd
::Uid
::effective();
61 let running_gid
= nix
::unistd
::Gid
::effective();
63 if running_uid
!= backup_uid
|| running_gid
!= backup_gid
{
64 bail
!("proxy not running as backup user or group (got uid {} gid {})", running_uid
, running_gid
);
67 proxmox_backup
::tools
::runtime
::main(run())
70 async
fn run() -> Result
<(), Error
> {
71 if let Err(err
) = syslog
::init(
72 syslog
::Facility
::LOG_DAEMON
,
73 log
::LevelFilter
::Info
,
74 Some("proxmox-backup-proxy")) {
75 bail
!("unable to inititialize syslog - {}", err
);
78 let _
= public_auth_key(); // load with lazy_static
79 let _
= csrf_secret(); // load with lazy_static
81 let mut config
= ApiConfig
::new(
82 buildcfg
::JS_DIR
, &proxmox_backup
::api2
::ROUTER
, RpcEnvironmentType
::PUBLIC
)?
;
84 config
.add_alias("novnc", "/usr/share/novnc-pve");
85 config
.add_alias("extjs", "/usr/share/javascript/extjs");
86 config
.add_alias("fontawesome", "/usr/share/fonts-font-awesome");
87 config
.add_alias("xtermjs", "/usr/share/pve-xtermjs");
88 config
.add_alias("locale", "/usr/share/pbs-i18n");
89 config
.add_alias("widgettoolkit", "/usr/share/javascript/proxmox-widget-toolkit");
90 config
.add_alias("css", "/usr/share/javascript/proxmox-backup/css");
91 config
.add_alias("docs", "/usr/share/doc/proxmox-backup/html");
93 let mut indexpath
= PathBuf
::from(buildcfg
::JS_DIR
);
94 indexpath
.push("index.hbs");
95 config
.register_template("index", &indexpath
)?
;
96 config
.register_template("console", "/usr/share/pve-xtermjs/index.html.hbs")?
;
98 let mut commando_sock
= server
::CommandoSocket
::new(server
::our_ctrl_sock());
100 config
.enable_file_log(buildcfg
::API_ACCESS_LOG_FN
, &mut commando_sock
)?
;
102 let rest_server
= RestServer
::new(config
);
104 //openssl req -x509 -newkey rsa:4096 -keyout /etc/proxmox-backup/proxy.key -out /etc/proxmox-backup/proxy.pem -nodes
105 let key_path
= configdir
!("/proxy.key");
106 let cert_path
= configdir
!("/proxy.pem");
108 let mut acceptor
= SslAcceptor
::mozilla_intermediate_v5(SslMethod
::tls()).unwrap();
109 acceptor
.set_private_key_file(key_path
, SslFiletype
::PEM
)
110 .map_err(|err
| format_err
!("unable to read proxy key {} - {}", key_path
, err
))?
;
111 acceptor
.set_certificate_chain_file(cert_path
)
112 .map_err(|err
| format_err
!("unable to read proxy cert {} - {}", cert_path
, err
))?
;
113 acceptor
.check_private_key().unwrap();
115 let acceptor
= Arc
::new(acceptor
.build());
117 let server
= daemon
::create_daemon(
118 ([0,0,0,0,0,0,0,0], 8007).into(),
120 let connections
= proxmox_backup
::tools
::async_io
::StaticIncoming
::from(listener
)
121 .map_err(Error
::from
)
122 .try_filter_map(move |(sock
, _addr
)| {
123 let acceptor
= Arc
::clone(&acceptor
);
125 sock
.set_nodelay(true).unwrap();
127 let _
= set_tcp_keepalive(sock
.as_raw_fd(), PROXMOX_BACKUP_TCP_KEEPALIVE_TIME
);
129 Ok(tokio_openssl
::accept(&acceptor
, sock
)
131 .ok() // handshake errors aren't be fatal, so return None to filter
135 let connections
= proxmox_backup
::tools
::async_io
::HyperAccept(connections
);
138 .and_then(|_
| hyper
::Server
::builder(connections
)
140 .with_graceful_shutdown(server
::shutdown_future())
141 .map_err(Error
::from
)
143 .map_err(|err
| eprintln
!("server error: {}", err
))
149 server
::write_pid(buildcfg
::PROXMOX_BACKUP_PROXY_PID_FN
)?
;
150 daemon
::systemd_notify(daemon
::SystemdNotify
::Ready
)?
;
152 let init_result
: Result
<(), Error
> = try_block
!({
153 server
::register_task_control_commands(&mut commando_sock
)?
;
154 commando_sock
.spawn()?
;
155 server
::server_state_init()?
;
159 if let Err(err
) = init_result
{
160 bail
!("unable to start daemon - {}", err
);
163 start_task_scheduler();
164 start_stat_generator();
167 log
::info
!("server shutting down, waiting for active workers to complete");
168 proxmox_backup
::server
::last_worker_future().await?
;
169 log
::info
!("done - exit server");
174 fn start_stat_generator() {
175 let abort_future
= server
::shutdown_future();
176 let future
= Box
::pin(run_stat_generator());
177 let task
= futures
::future
::select(future
, abort_future
);
178 tokio
::spawn(task
.map(|_
| ()));
181 fn start_task_scheduler() {
182 let abort_future
= server
::shutdown_future();
183 let future
= Box
::pin(run_task_scheduler());
184 let task
= futures
::future
::select(future
, abort_future
);
185 tokio
::spawn(task
.map(|_
| ()));
188 use std
::time
::{SystemTime, Instant, Duration, UNIX_EPOCH}
;
190 fn next_minute() -> Result
<Instant
, Error
> {
191 let now
= SystemTime
::now();
192 let epoch_now
= now
.duration_since(UNIX_EPOCH
)?
;
193 let epoch_next
= Duration
::from_secs((epoch_now
.as_secs()/60 + 1)*60);
194 Ok(Instant
::now() + epoch_next
- epoch_now
)
197 async
fn run_task_scheduler() {
199 let mut count
: usize = 0;
204 let delay_target
= match next_minute() { // try to run very minute
207 eprintln
!("task scheduler: compute next minute failed - {}", err
);
208 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(Instant
::now() + Duration
::from_secs(60))).await
;
213 if count
> 2 { // wait 1..2 minutes before starting
214 match schedule_tasks().catch_unwind().await
{
216 match panic
.downcast
::<&str>() {
218 eprintln
!("task scheduler panic: {}", msg
);
221 eprintln
!("task scheduler panic - unknown type");
226 eprintln
!("task scheduler failed - {:?}", err
);
232 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(delay_target
)).await
;
236 async
fn schedule_tasks() -> Result
<(), Error
> {
238 schedule_datastore_garbage_collection().await
;
239 schedule_datastore_prune().await
;
240 schedule_datastore_sync_jobs().await
;
241 schedule_datastore_verify_jobs().await
;
242 schedule_task_log_rotate().await
;
247 async
fn schedule_datastore_garbage_collection() {
249 use proxmox_backup
::config
::{
256 let config
= match datastore
::config() {
258 eprintln
!("unable to read datastore config - {}", err
);
261 Ok((config
, _digest
)) => config
,
264 for (store
, (_
, store_config
)) in config
.sections
{
265 let datastore
= match DataStore
::lookup_datastore(&store
) {
266 Ok(datastore
) => datastore
,
268 eprintln
!("lookup_datastore failed - {}", err
);
273 let store_config
: DataStoreConfig
= match serde_json
::from_value(store_config
) {
276 eprintln
!("datastore config from_value failed - {}", err
);
281 let event_str
= match store_config
.gc_schedule
{
282 Some(event_str
) => event_str
,
286 let event
= match parse_calendar_event(&event_str
) {
289 eprintln
!("unable to parse schedule '{}' - {}", event_str
, err
);
294 if datastore
.garbage_collection_running() { continue; }
296 let worker_type
= "garbage_collection";
298 let stat
= datastore
.last_gc_status();
299 let last
= if let Some(upid_str
) = stat
.upid
{
300 match upid_str
.parse
::<UPID
>() {
301 Ok(upid
) => upid
.starttime
,
303 eprintln
!("unable to parse upid '{}' - {}", upid_str
, err
);
308 match jobstate
::last_run_time(worker_type
, &store
) {
311 eprintln
!("could not get last run time of {} {}: {}", worker_type
, store
, err
);
317 let next
= match compute_next_event(&event
, last
, false) {
318 Ok(Some(next
)) => next
,
319 Ok(None
) => continue,
321 eprintln
!("compute_next_event for '{}' failed - {}", event_str
, err
);
326 let now
= proxmox
::tools
::time
::epoch_i64();
328 if next
> now { continue; }
330 let job
= match Job
::new(worker_type
, &store
) {
332 Err(_
) => continue, // could not get lock
335 let auth_id
= Authid
::backup_auth_id();
337 if let Err(err
) = crate::server
::do_garbage_collection_job(job
, datastore
, auth_id
, Some(event_str
)) {
338 eprintln
!("unable to start garbage collection job on datastore {} - {}", store
, err
);
343 async
fn schedule_datastore_prune() {
345 use proxmox_backup
::{
355 let config
= match datastore
::config() {
357 eprintln
!("unable to read datastore config - {}", err
);
360 Ok((config
, _digest
)) => config
,
363 for (store
, (_
, store_config
)) in config
.sections
{
365 let store_config
: DataStoreConfig
= match serde_json
::from_value(store_config
) {
368 eprintln
!("datastore '{}' config from_value failed - {}", store
, err
);
373 let event_str
= match store_config
.prune_schedule
{
374 Some(event_str
) => event_str
,
378 let prune_options
= PruneOptions
{
379 keep_last
: store_config
.keep_last
,
380 keep_hourly
: store_config
.keep_hourly
,
381 keep_daily
: store_config
.keep_daily
,
382 keep_weekly
: store_config
.keep_weekly
,
383 keep_monthly
: store_config
.keep_monthly
,
384 keep_yearly
: store_config
.keep_yearly
,
387 if !prune_options
.keeps_something() { // no prune settings - keep all
391 let worker_type
= "prune";
392 if check_schedule(worker_type
, &event_str
, &store
) {
393 let job
= match Job
::new(worker_type
, &store
) {
395 Err(_
) => continue, // could not get lock
398 let auth_id
= Authid
::backup_auth_id().clone();
399 if let Err(err
) = do_prune_job(job
, prune_options
, store
.clone(), &auth_id
, Some(event_str
)) {
400 eprintln
!("unable to start datastore prune job {} - {}", &store
, err
);
406 async
fn schedule_datastore_sync_jobs() {
408 use proxmox_backup
::config
::sync
::{
413 let config
= match sync
::config() {
415 eprintln
!("unable to read sync job config - {}", err
);
418 Ok((config
, _digest
)) => config
,
421 for (job_id
, (_
, job_config
)) in config
.sections
{
422 let job_config
: SyncJobConfig
= match serde_json
::from_value(job_config
) {
425 eprintln
!("sync job config from_value failed - {}", err
);
430 let event_str
= match job_config
.schedule
{
431 Some(ref event_str
) => event_str
.clone(),
435 let worker_type
= "syncjob";
436 if check_schedule(worker_type
, &event_str
, &job_id
) {
437 let job
= match Job
::new(worker_type
, &job_id
) {
439 Err(_
) => continue, // could not get lock
442 let auth_id
= Authid
::backup_auth_id().clone();
443 if let Err(err
) = do_sync_job(job
, job_config
, &auth_id
, Some(event_str
)) {
444 eprintln
!("unable to start datastore sync job {} - {}", &job_id
, err
);
450 async
fn schedule_datastore_verify_jobs() {
452 use proxmox_backup
::config
::verify
::{
454 VerificationJobConfig
,
457 let config
= match verify
::config() {
459 eprintln
!("unable to read verification job config - {}", err
);
462 Ok((config
, _digest
)) => config
,
464 for (job_id
, (_
, job_config
)) in config
.sections
{
465 let job_config
: VerificationJobConfig
= match serde_json
::from_value(job_config
) {
468 eprintln
!("verification job config from_value failed - {}", err
);
472 let event_str
= match job_config
.schedule
{
473 Some(ref event_str
) => event_str
.clone(),
477 let worker_type
= "verificationjob";
478 let auth_id
= Authid
::backup_auth_id().clone();
479 if check_schedule(worker_type
, &event_str
, &job_id
) {
480 let job
= match Job
::new(&worker_type
, &job_id
) {
482 Err(_
) => continue, // could not get lock
484 if let Err(err
) = do_verification_job(job
, job_config
, &auth_id
, Some(event_str
)) {
485 eprintln
!("unable to start datastore verification job {} - {}", &job_id
, err
);
491 async
fn schedule_task_log_rotate() {
493 let worker_type
= "logrotate";
494 let job_id
= "access-log_and_task-archive";
496 // schedule daily at 00:00 like normal logrotate
497 let schedule
= "00:00";
499 if !check_schedule(worker_type
, schedule
, job_id
) {
500 // if we never ran the rotation, schedule instantly
501 match jobstate
::JobState
::load(worker_type
, job_id
) {
502 Ok(state
) => match state
{
503 jobstate
::JobState
::Created { .. }
=> {}
,
510 let mut job
= match Job
::new(worker_type
, job_id
) {
512 Err(_
) => return, // could not get lock
515 if let Err(err
) = WorkerTask
::new_thread(
518 Authid
::backup_auth_id().clone(),
521 job
.start(&worker
.upid().to_string())?
;
522 worker
.log(format
!("starting task log rotation"));
524 let result
= try_block
!({
525 let max_size
= 512 * 1024 - 1; // an entry has ~ 100b, so > 5000 entries/file
526 let max_files
= 20; // times twenty files gives > 100000 task entries
527 let has_rotated
= rotate_task_log_archive(max_size
, true, Some(max_files
))?
;
529 worker
.log(format
!("task log archive was rotated"));
531 worker
.log(format
!("task log archive was not rotated"));
534 let max_size
= 32 * 1024 * 1024 - 1;
536 let mut logrotate
= LogRotate
::new(buildcfg
::API_ACCESS_LOG_FN
, true)
537 .ok_or_else(|| format_err
!("could not get API access log file names"))?
;
539 let has_rotated
= logrotate
.rotate(max_size
, None
, Some(max_files
))?
;
541 println
!("rotated access log, telling daemons to re-open log file");
542 proxmox_backup
::tools
::runtime
::block_on(command_reopen_logfiles())?
;
544 worker
.log(format
!("API access log was rotated"));
546 worker
.log(format
!("API access log was not rotated"));
552 let status
= worker
.create_state(&result
);
554 if let Err(err
) = job
.finish(status
) {
555 eprintln
!("could not finish job state for {}: {}", worker_type
, err
);
561 eprintln
!("unable to start task log rotation: {}", err
);
566 async
fn command_reopen_logfiles() -> Result
<(), Error
> {
567 // only care about the most recent daemon instance for each, proxy & api, as other older ones
568 // should not respond to new requests anyway, but only finish their current one and then exit.
569 let sock
= server
::our_ctrl_sock();
570 server
::send_command(sock
, serde_json
::json
!({
571 "command": "api-access-log-reopen",
574 let pid
= server
::read_pid(buildcfg
::PROXMOX_BACKUP_API_PID_FN
)?
;
575 let sock
= server
::ctrl_sock_from_pid(pid
);
576 server
::send_command(sock
, serde_json
::json
!({
577 "command": "api-access-log-reopen",
582 async
fn run_stat_generator() {
587 let save
= if count
>= 6 { count = 0; true }
else { false }
;
589 let delay_target
= Instant
::now() + Duration
::from_secs(10);
591 generate_host_stats(save
).await
;
593 tokio
::time
::delay_until(tokio
::time
::Instant
::from_std(delay_target
)).await
;
599 fn rrd_update_gauge(name
: &str, value
: f64, save
: bool
) {
600 use proxmox_backup
::rrd
;
601 if let Err(err
) = rrd
::update_value(name
, value
, rrd
::DST
::Gauge
, save
) {
602 eprintln
!("rrd::update_value '{}' failed - {}", name
, err
);
606 fn rrd_update_derive(name
: &str, value
: f64, save
: bool
) {
607 use proxmox_backup
::rrd
;
608 if let Err(err
) = rrd
::update_value(name
, value
, rrd
::DST
::Derive
, save
) {
609 eprintln
!("rrd::update_value '{}' failed - {}", name
, err
);
613 async
fn generate_host_stats(save
: bool
) {
614 use proxmox
::sys
::linux
::procfs
::{
615 read_meminfo
, read_proc_stat
, read_proc_net_dev
, read_loadavg
};
616 use proxmox_backup
::config
::datastore
;
619 proxmox_backup
::tools
::runtime
::block_in_place(move || {
621 match read_proc_stat() {
623 rrd_update_gauge("host/cpu", stat
.cpu
, save
);
624 rrd_update_gauge("host/iowait", stat
.iowait_percent
, save
);
627 eprintln
!("read_proc_stat failed - {}", err
);
631 match read_meminfo() {
633 rrd_update_gauge("host/memtotal", meminfo
.memtotal
as f64, save
);
634 rrd_update_gauge("host/memused", meminfo
.memused
as f64, save
);
635 rrd_update_gauge("host/swaptotal", meminfo
.swaptotal
as f64, save
);
636 rrd_update_gauge("host/swapused", meminfo
.swapused
as f64, save
);
639 eprintln
!("read_meminfo failed - {}", err
);
643 match read_proc_net_dev() {
645 use proxmox_backup
::config
::network
::is_physical_nic
;
649 if !is_physical_nic(&item
.device
) { continue; }
650 netin
+= item
.receive
;
653 rrd_update_derive("host/netin", netin
as f64, save
);
654 rrd_update_derive("host/netout", netout
as f64, save
);
657 eprintln
!("read_prox_net_dev failed - {}", err
);
661 match read_loadavg() {
663 rrd_update_gauge("host/loadavg", loadavg
.0 as f64, save
);
666 eprintln
!("read_loadavg failed - {}", err
);
670 let disk_manager
= DiskManage
::new();
672 gather_disk_stats(disk_manager
.clone(), Path
::new("/"), "host", save
);
674 match datastore
::config() {
676 let datastore_list
: Vec
<datastore
::DataStoreConfig
> =
677 config
.convert_to_typed_array("datastore").unwrap_or(Vec
::new());
679 for config
in datastore_list
{
681 let rrd_prefix
= format
!("datastore/{}", config
.name
);
682 let path
= std
::path
::Path
::new(&config
.path
);
683 gather_disk_stats(disk_manager
.clone(), path
, &rrd_prefix
, save
);
687 eprintln
!("read datastore config failed - {}", err
);
694 fn check_schedule(worker_type
: &str, event_str
: &str, id
: &str) -> bool
{
695 let event
= match parse_calendar_event(event_str
) {
698 eprintln
!("unable to parse schedule '{}' - {}", event_str
, err
);
703 let last
= match jobstate
::last_run_time(worker_type
, &id
) {
706 eprintln
!("could not get last run time of {} {}: {}", worker_type
, id
, err
);
711 let next
= match compute_next_event(&event
, last
, false) {
712 Ok(Some(next
)) => next
,
713 Ok(None
) => return false,
715 eprintln
!("compute_next_event for '{}' failed - {}", event_str
, err
);
720 let now
= proxmox
::tools
::time
::epoch_i64();
724 fn gather_disk_stats(disk_manager
: Arc
<DiskManage
>, path
: &Path
, rrd_prefix
: &str, save
: bool
) {
726 match proxmox_backup
::tools
::disks
::disk_usage(path
) {
728 let rrd_key
= format
!("{}/total", rrd_prefix
);
729 rrd_update_gauge(&rrd_key
, status
.total
as f64, save
);
730 let rrd_key
= format
!("{}/used", rrd_prefix
);
731 rrd_update_gauge(&rrd_key
, status
.used
as f64, save
);
734 eprintln
!("read disk_usage on {:?} failed - {}", path
, err
);
738 match disk_manager
.find_mounted_device(path
) {
740 Ok(Some((fs_type
, device
, source
))) => {
741 let mut device_stat
= None
;
742 match fs_type
.as_str() {
744 if let Some(pool
) = source
{
745 match zfs_pool_stats(&pool
) {
746 Ok(stat
) => device_stat
= stat
,
747 Err(err
) => eprintln
!("zfs_pool_stats({:?}) failed - {}", pool
, err
),
752 if let Ok(disk
) = disk_manager
.clone().disk_by_dev_num(device
.into_dev_t()) {
753 match disk
.read_stat() {
754 Ok(stat
) => device_stat
= stat
,
755 Err(err
) => eprintln
!("disk.read_stat {:?} failed - {}", path
, err
),
760 if let Some(stat
) = device_stat
{
761 let rrd_key
= format
!("{}/read_ios", rrd_prefix
);
762 rrd_update_derive(&rrd_key
, stat
.read_ios
as f64, save
);
763 let rrd_key
= format
!("{}/read_bytes", rrd_prefix
);
764 rrd_update_derive(&rrd_key
, (stat
.read_sectors
*512) as f64, save
);
766 let rrd_key
= format
!("{}/write_ios", rrd_prefix
);
767 rrd_update_derive(&rrd_key
, stat
.write_ios
as f64, save
);
768 let rrd_key
= format
!("{}/write_bytes", rrd_prefix
);
769 rrd_update_derive(&rrd_key
, (stat
.write_sectors
*512) as f64, save
);
771 let rrd_key
= format
!("{}/io_ticks", rrd_prefix
);
772 rrd_update_derive(&rrd_key
, (stat
.io_ticks
as f64)/1000.0, save
);
776 eprintln
!("find_mounted_device failed - {}", err
);