64d4012746771941379030df9a880be2d5951d1f
[whenjobs.git] / 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       ~proc_get_job
82       ~proc_set_variables
83       ~proc_get_job_names
84       ~proc_test_variables
85       ~proc_ping_daemon
86       ~proc_whisper_variables
87       (Rpc_server.Unix addr)
88       Rpc.Tcp (* not TCP, this is the same as SOCK_STREAM *)
89       Rpc.Socket
90       esys
91   );
92
93   (* Handle SIGCHLD to clean up jobs. *)
94   Sys.set_signal Sys.sigchld (Sys.Signal_handle handle_sigchld);
95
96   (* Initialize the variables. *)
97   state := Whenstate.set_variable !state "JOBSERIAL" (T_int zero_big_int)
98
99 and proc_reload_file () =
100   if !debug then Syslog.notice "remote call: reload_file";
101
102   try reload_files (); `ok
103   with Failure err -> `error err
104
105 and proc_set_variable (name, value) =
106   if !debug then Syslog.notice "remote call: set_variable %s" name;
107
108   try
109     check_valid_variable_name name;
110
111     let value = variable_of_rpc value in
112     state := Whenstate.set_variable !state name value;
113
114     (* Which jobs need to be re-evaluated? *)
115     let jobs = Whenstate.get_dependencies !state [name] in
116     let jobnames, state' = reevaluate_whenjobs !state jobs in
117     let state' = run_whenjobs state' jobnames in
118     state := state';
119
120     `ok
121   with
122     Failure msg -> `error msg
123
124 and proc_get_variable name =
125   if !debug then Syslog.notice "remote call: get_variable %s" name;
126
127   rpc_of_variable (Whenstate.get_variable !state name)
128
129 and proc_get_variable_names () =
130   if !debug then Syslog.notice "remote call: get_variable_names";
131
132   let vars = Whenstate.get_variable_names !state in
133
134   (* Return variable names as a sorted array. *)
135   let vars = Array.of_list vars in
136   Array.sort compare vars;
137   vars
138
139 and proc_exit_daemon () =
140   if !debug then Syslog.notice "remote call: exit_daemon";
141
142   match !server with
143   | None ->
144     `error "exit_daemon: no server handle"
145   | Some s ->
146     Rpc_server.stop_server ~graceful:true s;
147     server := None;
148     `ok
149
150 and proc_get_jobs () =
151   let running = Array.of_list (IntMap.values !runningmap) in
152   Array.map (
153     fun (job, dir, serial, start_time) ->
154       { Whenproto_aux.job_name = job.job_name;
155         job_serial = string_of_big_int serial;
156         job_tmpdir = dir; job_start_time = Int64.of_float start_time }
157   ) running
158
159 and proc_cancel_job serial =
160   try
161     let serial = big_int_of_string serial in
162     let pid = BigIntMap.find serial !serialmap in
163     kill pid 15;
164     `ok
165   with
166   | Not_found -> `error "job not found"
167   | exn -> `error (Printexc.to_string exn)
168
169 and proc_start_job jobname =
170   try
171     let job = Whenstate.get_job !state jobname in
172     let state' = run_job !state job in
173     state := state';
174     `ok
175   with
176   | Not_found -> `error "job not found"
177   | exn -> `error (Printexc.to_string exn)
178
179 and proc_get_job serial =
180   try
181     let serial = big_int_of_string serial in
182     let pid = BigIntMap.find serial !serialmap in
183     let job, dir, serial, start_time = IntMap.find pid !runningmap in
184     { Whenproto_aux.job_name = job.job_name;
185       job_serial = string_of_big_int serial;
186       job_tmpdir = dir; job_start_time = Int64.of_float start_time }
187   with
188   | Not_found -> failwith "job not found"
189   | exn -> failwith (Printexc.to_string exn)
190
191 and proc_set_variables vars =
192   try
193     let vars = Array.map (
194       fun { Whenproto_aux.sv_name = name; sv_value = value } ->
195         name, variable_of_rpc value
196     ) vars in
197     let vars = Array.to_list vars in
198
199     if !debug then
200       Syslog.notice "remote call: set_variables (%s)"
201         (String.concat " "
202            (List.map (
203              fun (name, value) ->
204                sprintf "%s=%s" name (string_of_variable value)
205             ) vars));
206
207     List.iter (fun (name, _) -> check_valid_variable_name name) vars;
208
209     (* Update all the variables atomically. *)
210     let s = List.fold_left (
211       fun s (name, value) -> Whenstate.set_variable s name value
212     ) !state vars in
213     state := s;
214
215     (* Which jobs need to be re-evaluated? *)
216     let jobs = Whenstate.get_dependencies !state (List.map fst vars) in
217     let jobnames, state' = reevaluate_whenjobs !state jobs in
218     let state' = run_whenjobs state' jobnames in
219     state := state';
220
221     `ok
222   with
223     Failure msg -> `error msg
224
225 and proc_get_job_names () =
226   Array.of_list (Whenstate.get_job_names !state)
227
228 and proc_test_variables vars =
229   (* This is the same as proc_set_variables, except that it doesn't
230    * update the state, it just returns the jobs that *would* run if
231    * these variables were set to these values.
232    *)
233   let vars = Array.map (
234     fun { Whenproto_aux.sv_name = name; sv_value = value } ->
235       name, variable_of_rpc value
236   ) vars in
237   let vars = Array.to_list vars in
238
239   if !debug then
240     Syslog.notice "remote call: test_variables (%s)"
241       (String.concat " "
242          (List.map (
243            fun (name, value) ->
244              sprintf "%s=%s" name (string_of_variable value)
245           ) vars));
246
247   List.iter (fun (name, _) -> check_valid_variable_name name) vars;
248
249   (* Update all the variables atomically. *)
250   let state = List.fold_left (
251     fun s (name, value) -> Whenstate.set_variable s name value
252   ) !state vars in
253
254   (* Which jobs WOULD be re-evaluated? *)
255   let jobs = Whenstate.get_dependencies state (List.map fst vars) in
256   let jobnames, _ = reevaluate_whenjobs state jobs in
257
258   (* Return the names. *)
259   Array.of_list jobnames
260
261 and proc_ping_daemon () = `ok
262
263 and proc_whisper_variables vars =
264   try
265     let vars = Array.map (
266       fun { Whenproto_aux.sv_name = name; sv_value = value } ->
267         name, variable_of_rpc value
268     ) vars in
269     let vars = Array.to_list vars in
270
271     if !debug then
272       Syslog.notice "remote call: whisper_variables (%s)"
273         (String.concat " "
274            (List.map (
275              fun (name, value) ->
276                sprintf "%s=%s" name (string_of_variable value)
277             ) vars));
278
279     List.iter (fun (name, _) -> check_valid_variable_name name) vars;
280
281     (* Update all the variables atomically. *)
282     let s = List.fold_left (
283       fun s (name, value) -> Whenstate.set_variable s name value
284     ) !state vars in
285     state := s;
286
287     (* .. but don't reevaluate or run jobs. *)
288
289     `ok
290   with
291     Failure msg -> `error msg
292
293 (* Reload the jobs file(s). *)
294 and reload_files () =
295   (* Get the highest numbered dir/jobs__*.cmo (bytecode) or
296    * dir/jobs__*.cmxs (native code) file and load it.  Delete
297    * lower-numbered (== older) files.
298    *)
299   let filename =
300     let suffix, slen =
301       if not Dynlink.is_native then ".cmo", 4 else ".cmxs", 5 in
302     let dir = !jobsdir in
303     let files = Array.to_list (Sys.readdir dir) in
304     let times = filter_map (
305       fun file ->
306         if not (string_startswith file "jobs__") ||
307           not (string_endswith file suffix) then
308           None
309         else (
310           let len = String.length file in
311           let t = String.sub file 6 (len-slen-6) in
312           try Some (int_of_string t) with Failure "int_of_string" -> None
313         )
314     ) files in
315     let times = List.rev (List.sort compare times) in
316     match times with
317     | [] -> None
318     | x::xs ->
319       (* Unlink the older files. *)
320       List.iter (
321         fun t ->
322           try unlink (dir // sprintf "jobs__%d%s" t suffix)
323           with Unix_error _ -> ()
324       ) xs;
325       (* Return the newest (highest numbered) file. *)
326       Some (dir // sprintf "jobs__%d%s" x suffix) in
327
328   (* As we are reloading the file, we want to create a new state
329    * that has no jobs, but has all the variables from the previous
330    * state.
331    *)
332   let s = Whenstate.copy_variables !state Whenstate.empty in
333   Whenfile.init s;
334
335   let s =
336     match filename with
337     | None ->
338       (* no jobs file, return the same state *)
339       Syslog.notice "no jobs file found";
340       s
341     | Some filename ->
342       try
343         Dynlink.loadfile filename;
344         let s = Whenfile.get_state () in
345         Syslog.notice "loaded %d job(s)" (Whenstate.nr_jobs s);
346         s
347       with
348       | Dynlink.Error err ->
349         let err = Dynlink.error_message err in
350         Syslog.error "error loading jobs: %s" err;
351         failwith err
352       | exn ->
353         failwith (Printexc.to_string exn) in
354
355   let s = Whenstate.copy_prev_state !state s in
356   state := s;
357
358   (* Re-evaluate all when jobs. *)
359   let jobs = Whenstate.get_whenjobs !state in
360   let jobnames, state' = reevaluate_whenjobs ~onload:true !state jobs in
361   let state' = run_whenjobs state' jobnames in
362   state := state';
363
364   (* Schedule the next every job to run. *)
365   schedule_next_everyjob ()
366
367 (* Re-evaluate each when-statement job, in a loop until we reach
368  * a fixpoint.  Return the list of job names that should run and
369  * the updated state.
370  *)
371 and reevaluate_whenjobs ?onload state jobs =
372   let rec loop (set, state) jobs =
373     let set', state' =
374       List.fold_left (
375         fun (set, state) job ->
376           let r, state' =
377             try Whenstate.evaluate_whenjob ?onload state job
378             with Invalid_argument err | Failure err ->
379               Syslog.error "error evaluating job %s (at %s): %s"
380                 job.job_name (Camlp4.PreCast.Ast.Loc.to_string job.job_loc) err;
381               false, state in
382
383           if !debug then
384             Syslog.notice "evaluate %s -> %b\n" job.job_name r;
385
386           (if r then StringSet.add job.job_name set else set), state'
387       ) (set, state) jobs in
388     (* reached a fixpoint? *)
389     if StringSet.compare set set' <> 0 then
390       loop (set', state') jobs
391     else
392       (set', state')
393   in
394   let set, state = loop (StringSet.empty, state) jobs in
395   let jobnames = StringSet.elements set in
396
397   (* Ensure the jobs always run in predictable (name) order. *)
398   let jobnames = List.sort compare_jobnames jobnames in
399   jobnames, state
400
401 and run_whenjobs state jobnames =
402   (* Run the jobs. *)
403   let jobs = List.map (Whenstate.get_job state) jobnames in
404   List.fold_left run_job state jobs
405
406 (* Schedule the next every-statement job to run, if there is one.  We
407  * look at the every jobs, work out the time that each must run at,
408  * pick the job(s) which must run soonest, and schedule a timer to run
409  * them.  When the timer fires, it runs those jobs, then calls this
410  * function again.
411  *)
412 and schedule_next_everyjob () =
413   let t = time () in
414
415   (* Get only everyjobs. *)
416   let jobs = Whenstate.get_everyjobs !state in
417   let jobs = List.map (
418     function
419     | { job_cond = Every_job period } as job -> (job, period)
420     | { job_cond = When_job _ } -> assert false
421   ) jobs in
422
423   (* Map everyjob to next time it must run. *)
424   let jobs = List.map (
425     fun (job, period) ->
426       let t' = next_periodexpr t period in
427       assert (t' > t); (* serious bug in next_periodexpr if false *)
428       job, t'
429   ) jobs in
430
431   (* Sort, soonest first. *)
432   let jobs = List.sort (fun (_,a) (_,b) -> compare a b) jobs in
433
434   if !debug then (
435     List.iter (
436       fun (job, t) ->
437         Syslog.notice "%s: next scheduled run at %s"
438           job.job_name (string_of_time_t t)
439     ) jobs
440   );
441
442   (* Pick the job(s) which run soonest. *)
443   let rec pick = function
444     | [] -> 0., []
445     | [j, t] -> t, [j]
446     | (j1, t) :: (j2, t') :: _ when t < t' -> t, [j1]
447     | (j1, t) :: (((j2, t') :: _) as rest) -> t, (j1 :: snd (pick rest))
448   in
449   let t, jobs = pick jobs in
450
451   if t > 0. then (
452     if jobs <> [] then (
453       (* Ensure the jobs always run in predictable (name) order. *)
454       let jobs =
455         List.sort (fun {job_name = a} {job_name = b} -> compare_jobnames a b)
456           jobs in
457
458       if !debug then
459         Syslog.notice "scheduling job(s) %s to run at %s"
460           (String.concat ", " (List.map (fun { job_name = name } -> name) jobs))
461           (string_of_time_t t);
462
463       (* Schedule them to run at time t. *)
464       let g = new_timer_group () in
465       let t_diff = t -. Unix.time () in
466       let t_diff = if t_diff < 0. then 0. else t_diff in
467       let run_jobs () =
468         delete_timer_group ();          (* Delete the timer. *)
469         let state' = List.fold_left run_job !state jobs in
470         state := state';
471         schedule_next_everyjob ()
472       in
473       Unixqueue.weak_once esys g t_diff run_jobs;
474     )
475   )
476
477 and new_timer_group () =
478   delete_timer_group ();
479   let g = Unixqueue.new_group esys in
480   timer_group := Some g;
481   g
482
483 and delete_timer_group () =
484   match !timer_group with
485   | None -> ()
486   | Some g ->
487     Unixqueue.clear esys g;
488     timer_group := None
489
490 and run_job state job =
491   (* Increment JOBSERIAL. *)
492   let serial, state =
493     match Whenstate.get_variable state "JOBSERIAL" with
494     | T_int serial ->
495       let serial = succ_big_int serial in
496       let state' = Whenstate.set_variable state "JOBSERIAL" (T_int serial) in
497       serial, state'
498     | _ -> assert false in
499
500   (* Call the pre-condition script.  Note this may decide not to run
501    * the job by returning false.
502    *)
503   let pre_condition () =
504     match job.job_pre with
505     | None -> true
506     | Some pre ->
507       let rs = ref [] in
508       IntMap.iter (
509         fun pid (job, _, serial, start_time) ->
510           let r = { pirun_job_name = job.job_name;
511                     pirun_serial = serial;
512                     pirun_start_time = start_time;
513                     pirun_pid = pid } in
514           rs := r :: !rs
515       ) !runningmap;
516       let preinfo = {
517         pi_job_name = job.job_name;
518         pi_serial = serial;
519         pi_variables = Whenstate.get_variables state;
520         pi_running = !rs;
521       } in
522       pre preinfo
523   in
524   if pre_condition () then (
525     Syslog.notice "running %s (JOBSERIAL=%s)"
526       job.job_name (string_of_big_int serial);
527
528     (* Create a temporary directory.  The current directory of the job
529      * will be in this directory.  The directory is removed when the
530      * child process exits.
531      *)
532     let dir = tmpdir () in
533
534     let pid = fork () in
535     if pid = 0 then ( (* child process running the job *)
536       chdir dir;
537
538       (* Set environment variables corresponding to each variable. *)
539       List.iter
540         (fun (name, value) -> putenv name (string_of_variable value))
541         (Whenstate.get_variables state);
542
543       (* Set the $JOBNAME environment variable. *)
544       putenv "JOBNAME" job.job_name;
545
546       (* Create a temporary file containing the shell script fragment. *)
547       let script = dir // "script.sh" in
548       let chan = open_out script in
549       fprintf chan "set -e\n"; (* So that jobs exit on error. *)
550       output_string chan job.job_script.sh_script;
551       close_out chan;
552       chmod script 0o700;
553
554       let shell = try getenv "SHELL" with Not_found -> "/bin/sh" in
555
556       (* Set output to file. *)
557       let output = dir // "output.txt" in
558       let fd = openfile output [O_WRONLY; O_CREAT; O_TRUNC; O_NOCTTY] 0o600 in
559       dup2 fd stdout;
560       dup2 fd stderr;
561       close fd;
562
563       (* Execute the shell script. *)
564       (try execvp shell [| shell; "-c"; script |];
565        with Unix_error (err, fn, _) ->
566          Syslog.error "%s failed: %s: %s" fn script (error_message err)
567       );
568       _exit 1
569     );
570
571     (* Remember this PID, the job and the temporary directory, so we
572      * can clean up when the child exits.
573      *)
574     runningmap := IntMap.add pid (job, dir, serial, time ()) !runningmap;
575     serialmap := BigIntMap.add serial pid !serialmap;
576
577     state
578   )
579   else (
580     Syslog.notice "not running %s (JOBSERIAL=%s) because pre() condition returned false"
581       job.job_name (string_of_big_int serial);
582
583     state
584   )
585
586 and tmpdir () =
587   let chan = open_in "/dev/urandom" in
588   let data = String.create 16 in
589   really_input chan data 0 (String.length data);
590   close_in chan;
591   let data = Digest.to_hex (Digest.string data) in
592   let dir = Filename.temp_dir_name // sprintf "whenjobs%s" data in
593   mkdir dir 0o700;
594   dir
595
596 (* This is called when a job (child process) exits. *)
597 and handle_sigchld _ =
598   try
599     let pid, status = waitpid [WNOHANG] 0 in
600     if pid > 0 then (
601       (* Look up the PID in the running jobs map. *)
602       let job, dir, serial, time = IntMap.find pid !runningmap in
603       runningmap := IntMap.remove pid !runningmap;
604       serialmap := BigIntMap.remove serial !serialmap;
605       post_job job dir serial time status
606     )
607   with Unix_error _ | Not_found -> ()
608
609 and post_job job dir serial time status =
610   (* If there is a post function, run it. *)
611   (match job.job_post with
612   | None -> ()
613   | Some post ->
614     let code =
615       match status with
616       | WEXITED c -> c
617       | WSIGNALED s | WSTOPPED s -> 1 in
618     let result = {
619       res_job_name = job.job_name;
620       res_serial = serial;
621       res_code = code;
622       res_tmpdir = dir;
623       res_output = dir // "output.txt";
624       res_start_time = time
625     } in
626     try post result
627     with
628     | Failure msg ->
629       Syslog.error "job %s post function failed: %s" job.job_name msg
630     | exn ->
631       Syslog.error "job %s post function exception: %s"
632         job.job_name (Printexc.to_string exn)
633   );
634
635   (* This should be safe because the path cannot contain shell metachars. *)
636   let cmd = sprintf "rm -rf '%s'" dir in
637   ignore (Sys.command cmd)
638
639 (* Intelligent comparison of job names. *)
640 and compare_jobnames name1 name2 =
641   try
642     let len1 = String.length name1
643     and len2 = String.length name2 in
644     if len1 > 4 && len2 > 4 &&
645       String.sub name1 0 4 = "job$" && String.sub name2 0 4 = "job$"
646     then (
647       let i1 = int_of_string (String.sub name1 4 (len1-4)) in
648       let i2 = int_of_string (String.sub name2 4 (len2-4)) in
649       compare i1 i2
650     )
651     else raise Not_found
652   with _ ->
653     compare name1 name2
654
655 let main_loop () =
656   Unixqueue.run esys