qdevices/process-list.h

   1 /*
   2  * Copyright (c) 2015-2017 Red Hat, Inc.
   3  *
   4  * All rights reserved.
   5  *
   6  * Author: Jan Friesse (jfriesse@redhat.com)
   7  *
   8  * This software licensed under BSD license, the text of which follows:
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are met:
  12  *
  13  * - Redistributions of source code must retain the above copyright notice,
  14  *   this list of conditions and the following disclaimer.
  15  * - Redistributions in binary form must reproduce the above copyright notice,
  16  *   this list of conditions and the following disclaimer in the documentation
  17  *   and/or other materials provided with the distribution.
  18  * - Neither the name of the Red Hat, Inc. nor the names of its
  19  *   contributors may be used to endorse or promote products derived from this
  20  *   software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32  * THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef _PROCESS_LIST_H_
  36 #define _PROCESS_LIST_H_
  37
  38 #include <signal.h>
  39 #include <sys/queue.h>
  40
  41 #include "dynar.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 enum process_list_entry_state {
  48         PROCESS_LIST_ENTRY_STATE_INITIALIZED,
  49         PROCESS_LIST_ENTRY_STATE_RUNNING,
  50         PROCESS_LIST_ENTRY_STATE_FINISHED,
  51         PROCESS_LIST_ENTRY_STATE_SIGTERM_SENT,
  52         PROCESS_LIST_ENTRY_STATE_SIGKILL_SENT,
  53 };
  54
  55 enum process_list_notify_reason {
  56         PROCESS_LIST_NOTIFY_REASON_EXECUTED,
  57         PROCESS_LIST_NOTIFY_REASON_FINISHED,
  58 };
  59
  60 struct process_list_entry {
  61         char *name;
  62         enum process_list_entry_state state;
  63         char **exec_argv;
  64         size_t exec_argc;
  65         pid_t pid;
  66         int exit_status;
  67
  68         TAILQ_ENTRY(process_list_entry) entries;
  69 };
  70
  71 typedef void (*process_list_notify_fn_t) (enum process_list_notify_reason reason,
  72     const struct process_list_entry *entry, void *user_data);
  73
  74 struct process_list {
  75         int use_execvp;
  76         size_t max_list_entries;
  77         size_t allocated_list_entries;
  78         process_list_notify_fn_t notify_fn;
  79         void *notify_fn_user_data;
  80
  81         TAILQ_HEAD(, process_list_entry) active_list;
  82         TAILQ_HEAD(, process_list_entry) to_kill_list;
  83 };
  84
  85
  86 extern void                              process_list_init(struct process_list *plist,
  87     size_t max_list_entries, int use_execvp, process_list_notify_fn_t notify_fn,
  88     void *notify_fn_user_data);
  89
  90 extern struct process_list_entry        *process_list_add(struct process_list *plist,
  91     const char *name, const char *command);
  92
  93 extern void                              process_list_free(struct process_list *plist);
  94
  95 extern int                               process_list_exec_initialized(struct process_list *plist);
  96
  97 extern int                               process_list_waitpid(struct process_list *plist);
  98
  99 extern size_t                            process_list_get_no_running(struct process_list *plist);
 100
 101 extern int                               process_list_get_summary_result(struct process_list *plist);
 102
 103 extern int                               process_list_get_summary_result_short(
 104     struct process_list *plist);
 105
 106 extern void                              process_list_move_active_entries_to_kill_list(
 107     struct process_list *plist);
 108
 109 extern int                               process_list_process_kill_list(struct process_list *plist);
 110
 111 extern size_t                            process_list_get_kill_list_items(struct process_list *plist);
 112
 113 extern int                               process_list_killall(struct process_list *plist,
 114     uint32_t timeout);
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif
 119
 120 #endif /* _PROCESS_LIST_H_ */