source3/include/rpc_svcctl.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup
   4    Copyright (C) Andrew Tridgell              1992-1997,
   5    Copyright (C) Gerald (Jerry) Carter        2005
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #ifndef _RPC_SVCCTL_H /* _RPC_SVCCTL_H */
  23 #define _RPC_SVCCTL_H
  24
  25
  26 /* svcctl pipe */
  27
  28 #define SVCCTL_CLOSE_SERVICE                    0x00
  29 #define SVCCTL_CONTROL_SERVICE                  0x01
  30 #define SVCCTL_QUERY_STATUS                     0x06
  31 #define SVCCTL_ENUM_DEPENDENT_SERVICES_W        0x0d
  32 #define SVCCTL_ENUM_SERVICES_STATUS_W           0x0e
  33 #define SVCCTL_OPEN_SCMANAGER_W                 0x0f
  34 #define SVCCTL_OPEN_SERVICE_W                   0x10
  35 #define SVCCTL_QUERY_SERVICE_CONFIG_W           0x11
  36 #define SVCCTL_START_SERVICE_W                  0x13
  37 #define SVCCTL_GET_DISPLAY_NAME                 0x14
  38 #define SVCCTL_QUERY_SERVICE_CONFIG2_W          0x27
  39 #define SVCCTL_QUERY_SERVICE_STATUSEX_W         0x28
  40
  41 /* ANSI versions not implemented currently
  42 #define SVCCTL_ENUM_SERVICES_STATUS_A           0x0e
  43 #define SVCCTL_OPEN_SCMANAGER_A                 0x1b
  44 */
  45
  46 /* SERVER_STATUS - type */
  47
  48 #define SVCCTL_TYPE_WIN32               0x00000030
  49 #define SVCCTL_TYPE_DRIVER              0x0000000f
  50
  51 /* SERVER_STATUS - state */
  52 #define SVCCTL_STATE_ACTIVE             0x00000001
  53 #define SVCCTL_STATE_INACTIVE           0x00000002
  54 #define SVCCTL_STATE_ALL                ( SVCCTL_STATE_ACTIVE | SVCCTL_STATE_INACTIVE )
  55
  56 /* SERVER_STATUS - CurrentState */
  57
  58 #define SVCCTL_STOPPED                  0x00000001
  59 #define SVCCTL_START_PENDING            0x00000002
  60 #define SVCCTL_STOP_PENDING             0x00000003
  61 #define SVCCTL_RUNNING                  0x00000004
  62 #define SVCCTL_CONTINUE_PENDING         0x00000005
  63 #define SVCCTL_PAUSE_PENDING            0x00000006
  64 #define SVCCTL_PAUSED                   0x00000007
  65
  66 /* SERVER_STATUS - ControlAccepted */
  67
  68 #define SVCCTL_ACCEPT_STOP                      0x00000001
  69 #define SVCCTL_ACCEPT_PAUSE_CONTINUE            0x00000002
  70 #define SVCCTL_ACCEPT_SHUTDOWN                  0x00000004
  71 #define SVCCTL_ACCEPT_PARAMCHANGE               0x00000008
  72 #define SVCCTL_ACCEPT_NETBINDCHANGE             0x00000010
  73 #define SVCCTL_ACCEPT_HARDWAREPROFILECHANGE     0x00000020
  74 #define SVCCTL_ACCEPT_POWEREVENT                0x00000040
  75
  76 /* SERVER_STATUS - ControlAccepted */
  77 #define SVCCTL_SVC_ERROR_IGNORE                 0x00000000
  78 #define SVCCTL_SVC_ERROR_NORMAL                 0x00000001
  79 #define SVCCTL_SVC_ERROR_CRITICAL               0x00000002
  80 #define SVCCTL_SVC_ERROR_SEVERE                 0x00000003
  81
  82 /* QueryServiceConfig2 options */
  83 #define SERVICE_CONFIG_DESCRIPTION              0x00000001
  84 #define SERVICE_CONFIG_FAILURE_ACTIONS          0x00000002
  85
  86
  87 /* Service Config - values for ServiceType field*/
  88
  89 #define SVCCTL_KERNEL_DRVR                         0x00000001  /* doubtful we'll have these */
  90 #define SVCCTL_FILE_SYSTEM_DRVR                    0x00000002
  91 #define SVCCTL_WIN32_OWN_PROC                      0x00000010
  92 #define SVCCTL_WIN32_SHARED_PROC                   0x00000020
  93 #define SVCCTL_WIN32_INTERACTIVE                   0x00000100
  94
  95 /* Service Config - values for StartType field */
  96 #define SVCCTL_BOOT_START                          0x00000000
  97 #define SVCCTL_SYSTEM_START                        0x00000001
  98 #define SVCCTL_AUTO_START                          0x00000002
  99 #define SVCCTL_DEMAND_START                        0x00000003
 100 #define SVCCTL_DISABLED                            0x00000004
 101
 102 /* Service Controls */
 103
 104 #define SVCCTL_CONTROL_STOP                     0x00000001
 105 #define SVCCTL_CONTROL_PAUSE                    0x00000002
 106 #define SVCCTL_CONTROL_CONTINUE                 0x00000003
 107 #define SVCCTL_CONTROL_SHUTDOWN                 0x00000004
 108
 109 #define SVC_HANDLE_IS_SCM                       0x0000001
 110 #define SVC_HANDLE_IS_SERVICE                   0x0000002
 111
 112 #define SVC_STATUS_PROCESS_INFO                 0x00000001
 113
 114 #define SVCCTL_SCRIPT_DIR  "/svcctl/"
 115
 116 /* utility structures for RPCs */
 117
 118 typedef struct {
 119         uint32 type;
 120         uint32 state;
 121         uint32 controls_accepted;
 122         uint32 win32_exit_code;
 123         uint32 service_exit_code;
 124         uint32 check_point;
 125         uint32 wait_hint;
 126 } SERVICE_STATUS;
 127
 128 typedef struct {
 129         uint32 type;
 130         uint32 state;
 131         uint32 controls_accepted;
 132         uint32 win32_exit_code;
 133         uint32 service_exit_code;
 134         uint32 check_point;
 135         uint32 wait_hint;
 136         uint32 process_id;
 137         uint32 service_flags;
 138 } SERVICE_STATUS_PROCESS;
 139
 140
 141 typedef struct {
 142         UNISTR servicename;
 143         UNISTR displayname;
 144         SERVICE_STATUS status;
 145 } ENUM_SERVICES_STATUS;
 146
 147 typedef struct {
 148         uint32 service_type;
 149         uint32 start_type;
 150         uint32 error_control;
 151         UNISTR2 *executablepath;
 152         UNISTR2 *loadordergroup;
 153         uint32 tag_id;
 154         UNISTR2 *dependencies;
 155         UNISTR2 *startname;
 156         UNISTR2 *displayname;
 157 } SERVICE_CONFIG;
 158
 159 typedef struct {
 160         UNISTR2 *description;
 161 } SERVICE_DESCRIPTION;
 162
 163 typedef struct {
 164         uint32 type;
 165         uint32 delay;
 166 } SC_ACTION;
 167
 168 typedef struct {
 169         uint32 reset_period;
 170         UNISTR2 *rebootmsg;
 171         UNISTR2 *command;
 172         uint32  nActions;
 173         SC_ACTION *saActions;
 174         UNISTR2 *description;
 175 } SERVICE_FAILURE_ACTIONS;
 176
 177
 178 typedef struct SCM_info_struct {
 179         uint32  type;                    /* should be SVC_HANDLE_IS_SCM */
 180         pstring target_server_name;      /* name of the server on which the operation is taking place */
 181         pstring target_db_name;          /* name of the database that we're opening */
 182 } SCM_info;
 183
 184 typedef struct Service_info_struct {
 185         uint32  type;           /* should be SVC_HANDLE_IS_SERVICE */
 186         pstring servicename;    /* the name of the service */
 187         pstring servicetype;    /* internal or external */
 188         pstring filename;       /* what file name we can find this in,
 189                                    as well as the "index" for what the
 190                                    service name is */
 191         pstring provides;
 192         pstring dependencies;
 193         pstring shouldstart;
 194         pstring shouldstop;
 195         pstring requiredstart;
 196         pstring requiredstop;
 197         pstring shortdescription;
 198         pstring description;
 199 } Service_info;
 200
 201 /*
 202  * dispatch table of functions to handle the =ServiceControl API
 203  */
 204
 205 typedef struct {
 206         /* functions for enumerating subkeys and values */
 207         WERROR  (*stop_service)( void );
 208         WERROR  (*start_service) ( void );
 209         WERROR  (*service_status)( SERVICE_STATUS *status );
 210 } SERVICE_CONTROL_OPS;
 211
 212 /* structure to store the service handle information  */
 213
 214 typedef struct _ServiceInfo {
 215         uint8                   type;
 216         char                    *name;
 217         uint32                  access_granted;
 218         SERVICE_CONTROL_OPS     *ops;
 219 } SERVICE_INFO;
 220
 221
 222 /* rpc structures */
 223
 224 /**************************/
 225
 226 typedef struct {
 227         POLICY_HND handle;
 228 } SVCCTL_Q_CLOSE_SERVICE;
 229
 230 typedef struct {
 231         POLICY_HND handle;
 232         WERROR status;
 233 } SVCCTL_R_CLOSE_SERVICE;
 234
 235 /**************************/
 236
 237 typedef struct {
 238         UNISTR2 *servername;
 239         UNISTR2 *database;
 240         uint32 access;
 241 } SVCCTL_Q_OPEN_SCMANAGER;
 242
 243 typedef struct {
 244         POLICY_HND handle;
 245         WERROR status;
 246 } SVCCTL_R_OPEN_SCMANAGER;
 247
 248 /**************************/
 249
 250 typedef struct {
 251         POLICY_HND handle;
 252         UNISTR2 servicename;
 253         uint32  display_name_len;
 254 } SVCCTL_Q_GET_DISPLAY_NAME;
 255
 256 typedef struct {
 257         UNISTR2 displayname;
 258         uint32 display_name_len;
 259         WERROR status;
 260 } SVCCTL_R_GET_DISPLAY_NAME;
 261
 262 /**************************/
 263
 264 typedef struct {
 265         POLICY_HND handle;
 266         UNISTR2 servicename;
 267         uint32 access;
 268 } SVCCTL_Q_OPEN_SERVICE;
 269
 270 typedef struct {
 271         POLICY_HND handle;
 272         WERROR status;
 273 } SVCCTL_R_OPEN_SERVICE;
 274
 275 /**************************/
 276
 277 typedef struct {
 278         POLICY_HND handle;
 279         uint32 parmcount;
 280         UNISTR4_ARRAY *parameters;
 281 } SVCCTL_Q_START_SERVICE;
 282
 283 typedef struct {
 284         WERROR status;
 285 } SVCCTL_R_START_SERVICE;
 286
 287 /**************************/
 288
 289 typedef struct {
 290         POLICY_HND handle;
 291         uint32 control;
 292 } SVCCTL_Q_CONTROL_SERVICE;
 293
 294 typedef struct {
 295         SERVICE_STATUS svc_status;
 296         WERROR status;
 297 } SVCCTL_R_CONTROL_SERVICE;
 298
 299 /**************************/
 300
 301 typedef struct {
 302         POLICY_HND handle;
 303 } SVCCTL_Q_QUERY_STATUS;
 304
 305 typedef struct {
 306         SERVICE_STATUS svc_status;
 307         WERROR status;
 308 } SVCCTL_R_QUERY_STATUS;
 309
 310 /**************************/
 311
 312 typedef struct {
 313         POLICY_HND handle;
 314         uint32 type;
 315         uint32 state;
 316         uint32 buffer_size;
 317         uint32 *resume;
 318 } SVCCTL_Q_ENUM_SERVICES_STATUS;
 319
 320 typedef struct {
 321         RPC_BUFFER buffer;
 322         uint32 needed;
 323         uint32 returned;
 324         uint32 *resume;
 325         WERROR status;
 326 } SVCCTL_R_ENUM_SERVICES_STATUS;
 327
 328 /**************************/
 329
 330 typedef struct {
 331         POLICY_HND handle;
 332         uint32 state;
 333         uint32 buffer_size;
 334 } SVCCTL_Q_ENUM_DEPENDENT_SERVICES;
 335
 336 typedef struct {
 337         RPC_BUFFER buffer;
 338         uint32 needed;
 339         uint32 returned;
 340         WERROR status;
 341 } SVCCTL_R_ENUM_DEPENDENT_SERVICES;
 342
 343 /**************************/
 344
 345 typedef struct {
 346         POLICY_HND handle;
 347         uint32 buffer_size;
 348 } SVCCTL_Q_QUERY_SERVICE_CONFIG;
 349
 350 typedef struct {
 351         SERVICE_CONFIG config;
 352         uint32 needed;
 353         WERROR status;
 354 } SVCCTL_R_QUERY_SERVICE_CONFIG;
 355
 356 typedef struct {
 357         POLICY_HND handle;
 358         uint32 info_level;
 359         uint32 buffer_size;
 360 } SVCCTL_Q_QUERY_SERVICE_CONFIG2;
 361
 362 typedef struct {
 363         UNISTR2 *description;
 364         uint32 returned;
 365         uint32 needed;
 366         uint32 offset;
 367         WERROR status;
 368 } SVCCTL_R_QUERY_SERVICE_CONFIG2;
 369
 370 typedef struct {
 371         POLICY_HND handle;
 372         uint32 info_level;
 373         uint32 buffer_size;
 374 } SVCCTL_Q_QUERY_SERVICE_STATUSEX;
 375
 376 typedef struct {
 377         RPC_BUFFER buffer;
 378         uint32 returned;
 379         uint32 needed;
 380         WERROR status;
 381 } SVCCTL_R_QUERY_SERVICE_STATUSEX;
 382
 383 #endif /* _RPC_SVCCTL_H */
 384