daemon/daemon.ml

   1 (* whenjobs
   2  * Copyright (C) 2012 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *)
  18
  19 open Whenutils
  20 open Whenexpr
  21
  22 open Big_int
  23 open Unix
  24 open Printf
  25
  26 (* See [exit.c]. *)
  27 external _exit : int -> 'a = "whenjobs__exit"
  28
  29 (* $HOME/.whenjobs *)
  30 let jobsdir = ref ""
  31
  32 (* The state. *)
  33 let state = ref Whenstate.empty
  34
  35 (* Jobs that are running: a map of PID -> (job, tmpdir, serial, start_time).
  36  * Note that the job may no longer exist *OR* it may have been renamed,
  37  * eg. if the jobs file was reloaded.
  38  *)
  39 let runningmap = ref IntMap.empty
  40
  41 (* Serial numbers of running jobs.  Map of serial -> PID (in runningmap). *)
  42 let serialmap = ref BigIntMap.empty
  43
  44 (* Was debugging requested on the command line? *)
  45 let debug = ref false
  46
  47 (* The server. *)
  48 let server = ref None
  49
  50 let esys = Unixqueue.standard_event_system ()
  51
  52 (* The timer.  It's convenient to have this as a global variable
  53  * because (a) there should only be one timer (which fires when the
  54  * soonest every-job becomes ready), and (b) it's complicated to track
  55  * that timer and avoid it getting double-scheduled (eg.  when we
  56  * reload the jobs file) without having a global variable.
  57  *)
  58 let timer_group = ref None
  59
  60 let rec init j d =
  61   jobsdir := j;
  62   debug := d;
  63
  64   Whenlock.create_lock !jobsdir;
  65
  66   (* Remove old socket if it exists. *)
  67   let addr = sprintf "%s/socket" !jobsdir in
  68   (try unlink addr with Unix_error _ -> ());
  69
  70   (* Create the Unix domain socket server. *)
  71   server := Some (
  72     Whenproto_srv.When.V1.create_server
  73       ~proc_reload_file
  74       ~proc_set_variable
  75       ~proc_get_variable
  76       ~proc_get_variable_names
  77       ~proc_exit_daemon
  78       ~proc_get_jobs
  79       ~proc_cancel_job
  80       ~proc_start_job
  81       (Rpc_server.Unix addr)
  82       Rpc.Tcp (* not TCP, this is the same as SOCK_STREAM *)
  83       Rpc.Socket
  84       esys
  85   );
  86
  87   (* Handle SIGCHLD to clean up jobs. *)
  88   Sys.set_signal Sys.sigchld (Sys.Signal_handle handle_sigchld);
  89
  90   (* Initialize the variables. *)
  91   state := Whenstate.set_variable !state "JOBSERIAL" (T_int zero_big_int)
  92
  93 and proc_reload_file () =
  94   if !debug then Syslog.notice "remote call: reload_file";
  95
  96   try reload_file (); `ok
  97   with Failure err -> `error err
  98
  99 and proc_set_variable (name, value) =
 100   if !debug then Syslog.notice "remote call: set_variable %s" name;
 101
 102   try
 103     check_valid_variable_name name;
 104
 105     let value = variable_of_rpc value in
 106     state := Whenstate.set_variable !state name value;
 107
 108     (* Which jobs need to be re-evaluated? *)
 109     let jobs = Whenstate.get_dependencies !state name in
 110     reevaluate_whenjobs jobs;
 111
 112     `ok
 113   with
 114     Failure msg -> `error msg
 115
 116 and proc_get_variable name =
 117   if !debug then Syslog.notice "remote call: get_variable %s" name;
 118
 119   rpc_of_variable (Whenstate.get_variable !state name)
 120
 121 and proc_get_variable_names () =
 122   if !debug then Syslog.notice "remote call: get_variable_names";
 123
 124   let vars = Whenstate.get_variable_names !state in
 125
 126   (* Return variable names as a sorted array. *)
 127   let vars = Array.of_list vars in
 128   Array.sort compare vars;
 129   vars
 130
 131 and proc_exit_daemon () =
 132   if !debug then Syslog.notice "remote call: exit_daemon";
 133
 134   match !server with
 135   | None ->
 136     `error "exit_daemon: no server handle"
 137   | Some s ->
 138     Rpc_server.stop_server ~graceful:true s;
 139     server := None;
 140     `ok
 141
 142 and proc_get_jobs () =
 143   let running = Array.of_list (IntMap.values !runningmap) in
 144   Array.map (
 145     fun (job, dir, serial, start_time) ->
 146       { Whenproto_aux.job_name = job.job_name;
 147         job_serial = string_of_big_int serial;
 148         job_tmpdir = dir; job_start_time = Int64.of_float start_time }
 149   ) running
 150
 151 and proc_cancel_job serial =
 152   try
 153     let serial = big_int_of_string serial in
 154     let pid = BigIntMap.find serial !serialmap in
 155     kill pid 15;
 156     `ok
 157   with
 158   | Not_found -> `error "job not found"
 159   | exn -> `error (Printexc.to_string exn)
 160
 161 and proc_start_job jobname =
 162   try
 163     let job = Whenstate.get_job !state jobname in
 164     run_job job;
 165     `ok
 166   with
 167   | Not_found -> `error "job not found"
 168   | exn -> `error (Printexc.to_string exn)
 169
 170 (* Reload the jobs file. *)
 171 and reload_file () =
 172   let file = sprintf "%s/jobs.cmo" !jobsdir in
 173
 174   (* As we are reloading the file, we want to create a new state
 175    * that has no jobs, but has all the variables from the previous
 176    * state.
 177    *)
 178   let s = Whenstate.copy_variables !state Whenstate.empty in
 179   Whenfile.init s;
 180
 181   let s =
 182     try
 183       Dynlink.loadfile file;
 184       let s = Whenfile.get_state () in
 185       Syslog.notice "loaded %d job(s) from %s" (Whenstate.nr_jobs s) file;
 186       s
 187     with
 188     | Dynlink.Error err ->
 189       let err = Dynlink.error_message err in
 190       Syslog.error "error loading jobs: %s" err;
 191       failwith err
 192     | exn ->
 193       failwith (Printexc.to_string exn) in
 194
 195   let s = Whenstate.copy_prev_state !state s in
 196   state := s;
 197
 198   (* Re-evaluate all when jobs. *)
 199   reevaluate_whenjobs ~onload:true (Whenstate.get_whenjobs !state);
 200
 201   (* Schedule the next every job to run. *)
 202   schedule_next_everyjob ()
 203
 204 (* Re-evaluate each when-statement job, in a loop until we reach
 205  * a fixpoint.  Run those that need to be run.
 206  *)
 207 and reevaluate_whenjobs ?onload jobs =
 208   let rec loop set jobs =
 209     let set' =
 210       List.fold_left (
 211         fun set job ->
 212           let r, state' =
 213             try Whenstate.evaluate_whenjob ?onload !state job
 214             with Invalid_argument err | Failure err ->
 215               Syslog.error "error evaluating job %s (at %s): %s"
 216                 job.job_name (Camlp4.PreCast.Ast.Loc.to_string job.job_loc) err;
 217               false, !state in
 218
 219           state := state';
 220
 221           if !debug then
 222             Syslog.notice "evaluate %s -> %b\n" job.job_name r;
 223
 224           if r then StringSet.add job.job_name set else set
 225       ) set jobs in
 226     if StringSet.compare set set' <> 0 then
 227       loop set' jobs
 228     else
 229       set'
 230   in
 231   let set = loop StringSet.empty jobs in
 232   let jobnames = StringSet.elements set in
 233
 234   (* Ensure the jobs always run in predictable (name) order. *)
 235   let jobnames = List.sort compare_jobnames jobnames in
 236
 237   (* Run the jobs. *)
 238   List.iter run_job (List.map (Whenstate.get_job !state) jobnames)
 239
 240 (* Schedule the next every-statement job to run, if there is one.  We
 241  * look at the every jobs, work out the time that each must run at,
 242  * pick the job(s) which must run soonest, and schedule a timer to run
 243  * them.  When the timer fires, it runs those jobs, then calls this
 244  * function again.
 245  *)
 246 and schedule_next_everyjob () =
 247   let t = time () in
 248
 249   (* Get only everyjobs. *)
 250   let jobs = Whenstate.get_everyjobs !state in
 251   let jobs = List.map (
 252     function
 253     | { job_cond = Every_job period } as job -> (job, period)
 254     | { job_cond = When_job _ } -> assert false
 255   ) jobs in
 256
 257   (* Map everyjob to next time it must run. *)
 258   let jobs = List.map (
 259     fun (job, period) ->
 260       let t' = next_periodexpr t period in
 261       assert (t' > t); (* serious bug in next_periodexpr if false *)
 262       job, t'
 263   ) jobs in
 264
 265   (* Sort, soonest first. *)
 266   let jobs = List.sort (fun (_,a) (_,b) -> compare a b) jobs in
 267
 268   if !debug then (
 269     List.iter (
 270       fun (job, t) ->
 271         Syslog.notice "%s: next scheduled run at %s"
 272           job.job_name (string_of_time_t t)
 273     ) jobs
 274   );
 275
 276   (* Pick the job(s) which run soonest. *)
 277   let rec pick = function
 278     | [] -> 0., []
 279     | [j, t] -> t, [j]
 280     | (j1, t) :: (j2, t') :: _ when t < t' -> t, [j1]
 281     | (j1, t) :: (((j2, t') :: _) as rest) -> t, (j1 :: snd (pick rest))
 282   in
 283   let t, jobs = pick jobs in
 284
 285   if t > 0. then (
 286     if jobs <> [] then (
 287       (* Ensure the jobs always run in predictable (name) order. *)
 288       let jobs =
 289         List.sort (fun {job_name = a} {job_name = b} -> compare_jobnames a b)
 290           jobs in
 291
 292       if !debug then
 293         Syslog.notice "scheduling job(s) %s to run at %s"
 294           (String.concat ", " (List.map (fun { job_name = name } -> name) jobs))
 295           (string_of_time_t t);
 296
 297       (* Schedule them to run at time t. *)
 298       let g = new_timer_group () in
 299       let t_diff = t -. Unix.time () in
 300       let t_diff = if t_diff < 0. then 0. else t_diff in
 301       let run_jobs () =
 302         delete_timer_group ();          (* Delete the timer. *)
 303         List.iter run_job jobs;
 304         schedule_next_everyjob ()
 305       in
 306       Unixqueue.weak_once esys g t_diff run_jobs;
 307     )
 308   )
 309
 310 and new_timer_group () =
 311   delete_timer_group ();
 312   let g = Unixqueue.new_group esys in
 313   timer_group := Some g;
 314   g
 315
 316 and delete_timer_group () =
 317   match !timer_group with
 318   | None -> ()
 319   | Some g ->
 320     Unixqueue.clear esys g;
 321     timer_group := None
 322
 323 and run_job job =
 324   (* Increment JOBSERIAL. *)
 325   let serial =
 326     match Whenstate.get_variable !state "JOBSERIAL" with
 327     | T_int serial ->
 328       let serial = succ_big_int serial in
 329       state := Whenstate.set_variable !state "JOBSERIAL" (T_int serial);
 330       serial
 331     | _ -> assert false in
 332
 333   (* Call the pre-condition script.  Note this may decide not to run
 334    * the job by returning false.
 335    *)
 336   let pre_condition () =
 337     match job.job_pre with
 338     | None -> true
 339     | Some pre ->
 340       let rs = ref [] in
 341       IntMap.iter (
 342         fun pid (job, _, serial, start_time) ->
 343           let r = { pirun_job_name = job.job_name;
 344                     pirun_serial = serial;
 345                     pirun_start_time = start_time;
 346                     pirun_pid = pid } in
 347           rs := r :: !rs
 348       ) !runningmap;
 349       let preinfo = {
 350         pi_job_name = job.job_name;
 351         pi_serial = serial;
 352         pi_variables = Whenstate.get_variables !state;
 353         pi_running = !rs;
 354       } in
 355       pre preinfo
 356   in
 357   if pre_condition () then (
 358     Syslog.notice "running %s (JOBSERIAL=%s)"
 359       job.job_name (string_of_big_int serial);
 360
 361     (* Create a temporary directory.  The current directory of the job
 362      * will be in this directory.  The directory is removed when the
 363      * child process exits.
 364      *)
 365     let dir = tmpdir () in
 366
 367     let pid = fork () in
 368     if pid = 0 then ( (* child process running the job *)
 369       chdir dir;
 370
 371       (* Set environment variables corresponding to each variable. *)
 372       List.iter
 373         (fun (name, value) -> putenv name (string_of_variable value))
 374         (Whenstate.get_variables !state);
 375
 376       (* Set the $JOBNAME environment variable. *)
 377       putenv "JOBNAME" job.job_name;
 378
 379       (* Create a temporary file containing the shell script fragment. *)
 380       let script = dir // "script.sh" in
 381       let chan = open_out script in
 382       fprintf chan "set -e\n"; (* So that jobs exit on error. *)
 383       output_string chan job.job_script.sh_script;
 384       close_out chan;
 385       chmod script 0o700;
 386
 387       let shell = try getenv "SHELL" with Not_found -> "/bin/sh" in
 388
 389       (* Set output to file. *)
 390       let output = dir // "output.txt" in
 391       let fd = openfile output [O_WRONLY; O_CREAT; O_TRUNC; O_NOCTTY] 0o600 in
 392       dup2 fd stdout;
 393       dup2 fd stderr;
 394       close fd;
 395
 396       (* Execute the shell script. *)
 397       (try execvp shell [| shell; "-c"; script |];
 398        with Unix_error (err, fn, _) ->
 399          Syslog.error "%s failed: %s: %s" fn script (error_message err)
 400       );
 401       _exit 1
 402     );
 403
 404     (* Remember this PID, the job and the temporary directory, so we
 405      * can clean up when the child exits.
 406      *)
 407     runningmap := IntMap.add pid (job, dir, serial, time ()) !runningmap;
 408     serialmap := BigIntMap.add serial pid !serialmap
 409   )
 410   else (
 411     Syslog.notice "not running %s (JOBSERIAL=%s) because pre() condition returned false"
 412       job.job_name (string_of_big_int serial);
 413   )
 414
 415 and tmpdir () =
 416   let chan = open_in "/dev/urandom" in
 417   let data = String.create 16 in
 418   really_input chan data 0 (String.length data);
 419   close_in chan;
 420   let data = Digest.to_hex (Digest.string data) in
 421   let dir = Filename.temp_dir_name // sprintf "whenjobs%s" data in
 422   mkdir dir 0o700;
 423   dir
 424
 425 (* This is called when a job (child process) exits. *)
 426 and handle_sigchld _ =
 427   try
 428     let pid, status = waitpid [WNOHANG] 0 in
 429     if pid > 0 then (
 430       (* Look up the PID in the running jobs map. *)
 431       let job, dir, serial, time = IntMap.find pid !runningmap in
 432       runningmap := IntMap.remove pid !runningmap;
 433       serialmap := BigIntMap.remove serial !serialmap;
 434       post_job job dir serial time status
 435     )
 436   with Unix_error _ | Not_found -> ()
 437
 438 and post_job job dir serial time status =
 439   (* If there is a post function, run it. *)
 440   (match job.job_post with
 441   | None -> ()
 442   | Some post ->
 443     let code =
 444       match status with
 445       | WEXITED c -> c
 446       | WSIGNALED s | WSTOPPED s -> 1 in
 447     let result = {
 448       res_job_name = job.job_name;
 449       res_serial = serial;
 450       res_code = code;
 451       res_tmpdir = dir;
 452       res_output = dir // "output.txt";
 453       res_start_time = time
 454     } in
 455     try post result
 456     with
 457     | Failure msg ->
 458       Syslog.error "job %s post function failed: %s" job.job_name msg
 459     | exn ->
 460       Syslog.error "job %s post function exception: %s"
 461         job.job_name (Printexc.to_string exn)
 462   );
 463
 464   (* This should be safe because the path cannot contain shell metachars. *)
 465   let cmd = sprintf "rm -rf '%s'" dir in
 466   ignore (Sys.command cmd)
 467
 468 (* Intelligent comparison of job names. *)
 469 and compare_jobnames name1 name2 =
 470   try
 471     let len1 = String.length name1
 472     and len2 = String.length name2 in
 473     if len1 > 4 && len2 > 4 &&
 474       String.sub name1 0 4 = "job$" && String.sub name2 0 4 = "job$"
 475     then (
 476       let i1 = int_of_string (String.sub name1 4 (len1-4)) in
 477       let i2 = int_of_string (String.sub name2 4 (len2-4)) in
 478       compare i1 i2
 479     )
 480     else raise Not_found
 481   with _ ->
 482     compare name1 name2
 483
 484 let main_loop () =
 485   Unixqueue.run esys