programs/services/services.h

   1 /*
   2  * Services.exe - include file
   3  *
   4  * Copyright 2007 Google (Mikolaj Zalewski)
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef WINE_PROGRAMS_UTILS_H_
  22 #define WINE_PROGRAMS_UTILS_H_
  23
  24 #include "wine/list.h"
  25
  26 struct scmdatabase
  27 {
  28     HKEY root_key;
  29     LONG service_start_lock;
  30     struct list processes;
  31     struct list services;
  32     CRITICAL_SECTION cs;
  33 };
  34
  35 struct process_entry
  36 {
  37     struct list entry;
  38     struct scmdatabase *db;
  39     LONG ref_count;
  40     HANDLE process;
  41     HANDLE control_mutex;
  42     HANDLE control_pipe;
  43     HANDLE overlapped_event;
  44     HANDLE status_changed_event;
  45 };
  46
  47 struct service_entry
  48 {
  49     struct list entry;
  50     struct scmdatabase *db;
  51     LONG ref_count;                    /* number of references - if goes to zero and the service is deleted the structure will be freed */
  52     LPWSTR name;
  53     SERVICE_STATUS_PROCESS status;
  54     QUERY_SERVICE_CONFIGW config;
  55     DWORD preshutdown_timeout;
  56     LPWSTR description;
  57     LPWSTR dependOnServices;
  58     LPWSTR dependOnGroups;
  59     struct process_entry *process;
  60     BOOL force_shutdown;
  61     BOOL marked_for_delete;
  62     BOOL is_wow64;
  63 };
  64
  65 extern struct scmdatabase *active_database;
  66
  67 /* SCM database functions */
  68
  69 struct service_entry *scmdatabase_find_service(struct scmdatabase *db, LPCWSTR name);
  70 struct service_entry *scmdatabase_find_service_by_displayname(struct scmdatabase *db, LPCWSTR name);
  71 DWORD scmdatabase_add_service(struct scmdatabase *db, struct service_entry *entry);
  72
  73 DWORD scmdatabase_lock_startup(struct scmdatabase *db);
  74 void scmdatabase_unlock_startup(struct scmdatabase *db);
  75
  76 void scmdatabase_lock(struct scmdatabase *db);
  77 void scmdatabase_unlock(struct scmdatabase *db);
  78
  79 /* Service functions */
  80
  81 DWORD service_create(LPCWSTR name, struct service_entry **entry);
  82 BOOL validate_service_name(LPCWSTR name);
  83 BOOL validate_service_config(struct service_entry *entry);
  84 DWORD save_service_config(struct service_entry *entry);
  85 void free_service_entry(struct service_entry *entry);
  86 void release_service(struct service_entry *service);
  87 void service_lock(struct service_entry *service);
  88 void service_unlock(struct service_entry *service);
  89 DWORD service_start(struct service_entry *service, DWORD service_argc, LPCWSTR *service_argv);
  90 void service_terminate(struct service_entry *service);
  91
  92 /* Process functions */
  93
  94 struct process_entry *grab_process(struct process_entry *process);
  95 void release_process(struct process_entry *process);
  96 BOOL process_send_command(struct process_entry *process, const void *data, DWORD size, DWORD *result);
  97 void process_terminate(struct process_entry *process);
  98
  99 extern HANDLE g_hStartedEvent;
 100
 101 extern DWORD service_pipe_timeout;
 102 extern DWORD service_kill_timeout;
 103
 104 DWORD RPC_Init(void);
 105 DWORD events_loop(void);
 106
 107 /* from utils.c */
 108 LPWSTR strdupW(LPCWSTR str);
 109
 110 BOOL check_multisz(LPCWSTR lpMultiSz, DWORD cbSize);
 111
 112 DWORD load_reg_string(HKEY hKey, LPCWSTR szValue, BOOL bExpand, LPWSTR *output);
 113 DWORD load_reg_multisz(HKEY hKey, LPCWSTR szValue, BOOL bAllowSingle, LPWSTR *output);
 114 DWORD load_reg_dword(HKEY hKey, LPCWSTR szValue, DWORD *output);
 115
 116 static inline LPCWSTR get_display_name(struct service_entry *service)
 117 {
 118     return service->config.lpDisplayName ? service->config.lpDisplayName : service->name;
 119 }
 120
 121 static inline BOOL is_marked_for_delete(struct service_entry *service)
 122 {
 123     return service->marked_for_delete;
 124 }
 125
 126 static inline DWORD mark_for_delete(struct service_entry *service)
 127 {
 128     service->marked_for_delete = TRUE;
 129     return ERROR_SUCCESS;
 130 }
 131
 132 #endif /*WINE_PROGRAMS_UTILS_H_*/