daemon/app_supervisor.h

   1 /* -*- Mode: C ; c-basic-offset: 2 -*- */
   2 /*
   3  * LADI Session Handler (ladish)
   4  *
   5  * Copyright (C) 2009, 2010, 2011, 2012, 2013 Nedko Arnaudov <nedko@arnaudov.name>
   6  *
   7  **************************************************************************
   8  * This file contains interface to app supervisor object
   9  **************************************************************************
  10  *
  11  * LADI Session Handler is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * LADI Session Handler is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with LADI Session Handler. If not, see <http://www.gnu.org/licenses/>
  23  * or write to the Free Software Foundation, Inc.,
  24  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  25  */
  26 /** @file app_supervisor.h */
  27
  28 #ifndef APP_SUPERVISOR_H__712E6589_DCB1_4CE9_9812_4F250D55E8A2__INCLUDED
  29 #define APP_SUPERVISOR_H__712E6589_DCB1_4CE9_9812_4F250D55E8A2__INCLUDED
  30
  31 #include "common.h"
  32
  33 #define LADISH_APP_STATE_STOPPED    0 /**< @brief app is stopped (not running) */
  34 #define LADISH_APP_STATE_STARTED    1 /**< @brief app is running and not stopping */
  35 #define LADISH_APP_STATE_STOPPING   2 /**< @brief app is stopping */
  36 #define LADISH_APP_STATE_KILL       3 /**< @brief app is being force killed */
  37
  38 #define MAX_LEVEL_CHARCOUNT 12 /**< @brief max size of level string, includes terminating nul char */
  39
  40 /**
  41  * App supervisor object handle (pointer to opaque data)
  42  */
  43 typedef struct ladish_app_supervisor_tag { int unused; /**< fake */ } * ladish_app_supervisor_handle;
  44
  45 /**
  46  * App object handle (pointer to opaque data)
  47  *
  48  * The app objects are owned by the app supervisor objects (there is not refcounting)
  49  */
  50 typedef struct ladish_app_tag { int unused; /**< fake */ } * ladish_app_handle;
  51
  52 /**
  53  * Type of function that is called when app is renamed
  54  *
  55  * @param[in] context User defined context that was supplied to ladish_app_supervisor_create()
  56  * @param[in] uuid uuid of the app
  57  * @param[in] old_name Old name of the app
  58  * @param[in] new_name New name of the app
  59  */
  60 typedef void (* ladish_app_supervisor_on_app_renamed_callback)(
  61   void * context,
  62   const uuid_t uuid,
  63   const char * old_name,
  64   const char * new_app_name);
  65
  66 /**
  67  * Type of function that is called during app enumeration
  68  *
  69  * @param[in] context User defined context that was supplied to ladish_app_supervisor_enum()
  70  * @param[in] name Name of the app
  71  * @param[in] running Whether the app is currently running
  72  * @param[in] command Commandline that is used to start the app
  73  * @param[in] terminal Whether the app is started in terminal
  74  * @param[in] level The level that app was started in
  75  * @param[in] pid PID of the app; Zero if app is not started
  76  * @param[in] uuid uuid of the app
  77  *
  78  * @retval true Continue iteration
  79  * @retval false Stop iteration
  80  */
  81 typedef bool (* ladish_app_supervisor_enum_callback)(
  82   void * context,
  83   const char * name,
  84   bool running,
  85   const char * command,
  86   bool terminal,
  87   const char * level,
  88   pid_t pid,
  89   const uuid_t uuid);
  90
  91 /**
  92  * Type of function that is called when save is complete
  93  *
  94  * @param[in] context User defined context that was supplied to ladish_app_supervisor_save()
  95  * @param[in] success Whether save was successfull or not
  96  */
  97 typedef void (* ladish_save_complete_callback)(void * context, bool success);
  98
  99 /**
 100  * Check whether app level string is valid.
 101  *
 102  * @param [in] level app level string
 103  * @param [out] len_ptr When not NULL, the pointed variable will receive length of the level string, excluding terminating nul char.
 104  *
 105  * @return whether level string is valid
 106  */
 107 bool
 108 ladish_check_app_level_validity(
 109   const char * level,
 110   size_t * len_ptr);
 111 /**
 112  * Create app supervisor object
 113  *
 114  * @param[out] supervisor_handle_ptr Pointer to variable that will receive supervisor handle
 115  * @param[in] opath Unique D-Bus object path for supervisor being created
 116  * @param[in] name Name of the supervisor
 117  * @param[in] context User defined context to be supplied when the callback suppiled through the @c on_app_renamed parameter is called
 118  * @param[in] on_app_renamed Callback to call when app is renamed
 119  *
 120  * @return success status
 121  */
 122 bool
 123 ladish_app_supervisor_create(
 124   ladish_app_supervisor_handle * supervisor_handle_ptr,
 125   const char * opath,
 126   const char * name,
 127   void * context,
 128   ladish_app_supervisor_on_app_renamed_callback on_app_renamed);
 129
 130 /**
 131  * Destroy app supervisor object
 132  *
 133  * @param[in] supervisor_handle supervisor object handle
 134  */
 135 void
 136 ladish_app_supervisor_destroy(
 137   ladish_app_supervisor_handle supervisor_handle);
 138
 139 /**
 140  * Set the directory where apps will be started. If never called, apps will be started in the root directory ("/")
 141  *
 142  * @param[in] supervisor_handle supervisor object handle
 143  * @param[in] dir directory where apps will be started
 144  *
 145  * @return success status
 146  */
 147 bool
 148 ladish_app_supervisor_set_directory(
 149   ladish_app_supervisor_handle supervisor_handle,
 150   const char * dir);
 151
 152 /**
 153  * Set/reset the project name
 154  *
 155  * @param[in] supervisor_handle supervisor object handle
 156  * @param[in] project_name project name. NULL means that there is no project name.
 157  *
 158  * @return success status
 159  */
 160 bool
 161 ladish_app_supervisor_set_project_name(
 162   ladish_app_supervisor_handle supervisor_handle,
 163   const char * project_name);
 164
 165 /**
 166  * Mark that app has quit
 167  *
 168  * This function is called to mark that app has quit. Must not be called from signal handler because app supervisor object is not thread safe.
 169  *
 170  * @param[in] supervisor_handle supervisor object handle
 171  * @param[in] pid pid of the app whose termination was detected
 172  * @param[in] exit_status process exit status as returned by waitpid()
 173  *
 174  * @retval true Success
 175  * @retval false Unknown pid
 176  */
 177 bool
 178 ladish_app_supervisor_child_exit(
 179   ladish_app_supervisor_handle supervisor_handle,
 180   pid_t pid,
 181   int exit_status);
 182
 183 /**
 184  * Iterate apps that are owned by supervisor
 185  *
 186  * @param[in] supervisor_handle supervisor object handle
 187  * @param[in] context User defined context to be supplied when the callback suppiled through the @c callback parameter is called
 188  * @param[in] callback Callback to call for each app
 189  *
 190  * @retval true All apps iterated
 191  * @retval false Iteration stopped because callback returned false
 192  */
 193 bool
 194 ladish_app_supervisor_enum(
 195   ladish_app_supervisor_handle supervisor_handle,
 196   void * context,
 197   ladish_app_supervisor_enum_callback callback);
 198
 199 /**
 200  * Remove stopped apps; For running apps, initiate stop and
 201  * mark them as zombies thus causing app autoremove
 202  * once it quits.
 203  *
 204  * @param[in] supervisor_handle supervisor object handle
 205  *
 206  * @return Whether there were no running apps
 207  */
 208 bool
 209 ladish_app_supervisor_clear(
 210   ladish_app_supervisor_handle supervisor_handle);
 211
 212 /**
 213  * Initiate save for apps running at level higher than 0
 214  *
 215  * @param[in] supervisor_handle supervisor object handle
 216  * @param[in] context User defined context to be supplied when callback supplied throuth @c callback parameter is called
 217  * @param[in] callback Callback to call when save is complete
 218  */
 219 void
 220 ladish_app_supervisor_save(
 221   ladish_app_supervisor_handle supervisor_handle,
 222   void * context,
 223   ladish_save_complete_callback callback);
 224
 225 /**
 226  * Add app. Apps are added in stopped state
 227  *
 228  * @param[in] supervisor_handle supervisor object handle
 229  * @param[in] name Name of the app
 230  * @param[in] uuid Optional uuid of the app. If NULL, new uuid will be generated.
 231  * @param[in] autorun whether to start the app when ladish_app_supervisor_autorun() is called
 232  * @param[in] command Commandline that is used to start the app
 233  * @param[in] terminal Whether the app is started in terminal
 234  * @param[in] level The level that app was started in
 235  *
 236  * @return app handle on success; NULL on failure; the app handle is owned by the app supervisor object
 237  */
 238 ladish_app_handle
 239 ladish_app_supervisor_add(
 240   ladish_app_supervisor_handle supervisor_handle,
 241   const char * name,
 242   uuid_t uuid,
 243   bool autorun,
 244   const char * command,
 245   bool terminal,
 246   const char * level);
 247
 248 /**
 249  * Initiate stop of all apps owned by this supervisor
 250  *
 251  * @param[in] supervisor_handle supervisor object handle
 252  */
 253 void
 254 ladish_app_supervisor_stop(
 255   ladish_app_supervisor_handle supervisor_handle);
 256
 257 /**
 258  * Start all apps that were added with autorun enabled
 259  *
 260  * @param[in] supervisor_handle supervisor object handle
 261  */
 262 void
 263 ladish_app_supervisor_autorun(
 264   ladish_app_supervisor_handle supervisor_handle);
 265
 266 /**
 267  * Get name of the supervisor
 268  *
 269  * TODO: This should be probably removed in favour of ladish_app_supervisor_get_opath(); it is used for debuging purposes only
 270  *
 271  * @param[in] supervisor_handle supervisor object handle
 272  *
 273  * @retval app name; the buffer is owned by the app supervisor object
 274  */
 275 const char * ladish_app_supervisor_get_name(ladish_app_supervisor_handle supervisor_handle);
 276
 277 /**
 278  * Get number of apps that are currently running
 279  *
 280  * @param[in] supervisor_handle supervisor object handle
 281  *
 282  * @return Number of apps that are currently running
 283  */
 284 unsigned int ladish_app_supervisor_get_running_app_count(ladish_app_supervisor_handle supervisor_handle);
 285
 286 /**
 287  * Check whether there are apps (running or not)
 288  *
 289  * @param[in] supervisor_handle supervisor object handle
 290  *
 291  * @return whether there are apps
 292  */
 293 bool ladish_app_supervisor_has_apps(ladish_app_supervisor_handle supervisor_handle);
 294
 295 /**
 296  * Dump to log the contents of the app supervisor
 297  *
 298  * @param[in] supervisor_handle supervisor object handle
 299  */
 300 void ladish_app_supervisor_dump(ladish_app_supervisor_handle supervisor_handle);
 301
 302 /**
 303  * Find app by name
 304  *
 305  * @param[in] supervisor_handle supervisor object handle
 306  * @param[in] name name of the app to search for
 307  *
 308  * @return app handle on if found; NULL if app is not found; the app handle is owned by the app supervisor object
 309  */
 310 ladish_app_handle ladish_app_supervisor_find_app_by_name(ladish_app_supervisor_handle supervisor_handle, const char * name);
 311
 312 /**
 313  * Find app by id (as exposed through the D-Bus interface)
 314  *
 315  * @param[in] supervisor_handle supervisor object handle
 316  * @param[in] id id of the app
 317  *
 318  * @return app handle on success; NULL if app is not found; the app handle is owned by the app supervisor object
 319  */
 320 ladish_app_handle ladish_app_supervisor_find_app_by_id(ladish_app_supervisor_handle supervisor_handle, uint64_t id);
 321
 322 /**
 323  * Search app by process id
 324  *
 325  * @param[in] supervisor_handle supervisor object handle
 326  * @param[in] pid pid of the app to search for
 327  *
 328  * @return app handle on if found; NULL if app is not found; the app handle is owned by the app supervisor object
 329  */
 330 ladish_app_handle
 331 ladish_app_supervisor_find_app_by_pid(
 332   ladish_app_supervisor_handle supervisor_handle,
 333   pid_t pid);
 334
 335 /**
 336  * Search app by uuid
 337  *
 338  * @param[in] supervisor_handle supervisor object handle
 339  * @param[in] uuid uuid of the app to search for
 340  *
 341  * @return app handle on if found; NULL if app is not found; the app handle is owned by the app supervisor object
 342  */
 343 ladish_app_handle
 344 ladish_app_supervisor_find_app_by_uuid(
 345   ladish_app_supervisor_handle supervisor_handle,
 346   const uuid_t uuid);
 347
 348 /**
 349  * The the D-Bus object path for the supervisor.
 350  *
 351  * @param[in] supervisor_handle supervisor object handle
 352  *
 353  * @retval supervisor name; the buffer is owned by the app supervisor object
 354  */
 355 const char * ladish_app_supervisor_get_opath(ladish_app_supervisor_handle supervisor_handle);
 356
 357 /**
 358  * Start an app. The app must be in stopped state.
 359  *
 360  * @param[in] supervisor_handle supervisor object handle
 361  * @param[in] app_handle Handle of app to start
 362  *
 363  * @return success status
 364  */
 365 bool ladish_app_supervisor_start_app(ladish_app_supervisor_handle supervisor_handle, ladish_app_handle app_handle);
 366
 367 /**
 368  * Remove an app. The app must be in stopped state.
 369  *
 370  * @param[in] supervisor_handle supervisor object handle
 371  * @param[in] app_handle Handle of app to remove
 372  */
 373 void ladish_app_supervisor_remove_app(ladish_app_supervisor_handle supervisor_handle, ladish_app_handle app_handle);
 374
 375 /**
 376  * Get commandline for an app.
 377  *
 378  * @param[in] app_handle app object handle
 379  *
 380  * @retval app commandline; the buffer is owned by the app supervisor object
 381  */
 382 const char * ladish_app_get_commandline(ladish_app_handle app_handle);
 383
 384 /**
 385  * Get app state
 386  *
 387  * @param[in] app_handle app object handle
 388  *
 389  * @return app state
 390  * @retval LADISH_APP_STATE_STOPPED app is stopped (not running)
 391  * @retval LADISH_APP_STATE_STARTED app is running and not stopping or being killed
 392  * @retval LADISH_APP_STATE_STOPPING app is stopping
 393  * @retval LADISH_APP_STATE_KILL app is being force killed
 394  */
 395 unsigned int ladish_app_get_state(ladish_app_handle app_handle);
 396
 397 /**
 398  * Check whether app is currently running
 399  *
 400  * @param[in] app_handle app object handle
 401  *
 402  * @retval true App is running
 403  * @retval false App is not running
 404  */
 405 bool ladish_app_is_running(ladish_app_handle app_handle);
 406
 407 /**
 408  * Get app name
 409  *
 410  * @param[in] app_handle app object handle
 411  *
 412  * @retval app name; the buffer is owned by the app supervisor
 413  */
 414 const char * ladish_app_get_name(ladish_app_handle app_handle);
 415
 416 /**
 417  * Get app uuid
 418  *
 419  * @param[in] app_handle app object handle
 420  * @param[out] uuid pointer to uuid_t storage where the app uuid will be store
 421  *
 422  */
 423 void ladish_app_get_uuid(ladish_app_handle app_handle, uuid_t uuid);
 424
 425 /**
 426  * Tell app to stop. The app must be in started state.
 427  *
 428  * @param[in] app_handle Handle of app to stop
 429  */
 430 void ladish_app_stop(ladish_app_handle app_handle);
 431
 432 /**
 433  * Force kill an app. The app must be in started state.
 434  *
 435  * @param[in] app_handle Handle of app to kill
 436  */
 437 void ladish_app_kill(ladish_app_handle app_handle);
 438
 439 /**
 440  * Initiate restore of app internal state. The app must be in started state.
 441  *
 442  * @param[in] app_handle Handle of app
 443  */
 444 void ladish_app_restore(ladish_app_handle app_handle);
 445
 446 /**
 447  * Associate pid with app.
 448  *
 449  * @param[in] app_handle Handle of app
 450  * @param[in] pid PID to associate with the app
 451  */
 452 void ladish_app_add_pid(ladish_app_handle app_handle, pid_t pid);
 453
 454 /**
 455  * Deassociate pid with app.
 456  *
 457  * @param[in] app_handle Handle of app
 458  * @param[in] pid PID to deassociate with the app
 459  */
 460 void ladish_app_del_pid(ladish_app_handle app_handle, pid_t pid);
 461
 462 /**
 463  * Set the D-Bus unique name for the app.
 464  *
 465  * @param[in] app_handle Handle of app
 466  * @param[in] name D-Bus unique name
 467  *
 468  * @return success status
 469  */
 470 bool ladish_app_set_dbus_name(ladish_app_handle app_handle, const char * name);
 471
 472 /**
 473  * D-Bus interface descriptor for the app supervisor interface. The call context must be a ::ladish_app_supervisor_handle
 474  */
 475 extern const struct cdbus_interface_descriptor g_iface_app_supervisor;
 476
 477 #endif /* #ifndef APP_SUPERVISOR_H__712E6589_DCB1_4CE9_9812_4F250D55E8A2__INCLUDED */