1
0

gamemode.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  1. /*
  2. Copyright (c) 2017-2019, Feral Interactive
  3. All rights reserved.
  4. Redistribution and use in source and binary forms, with or without
  5. modification, are permitted provided that the following conditions are met:
  6. * Redistributions of source code must retain the above copyright notice,
  7. this list of conditions and the following disclaimer.
  8. * Redistributions in binary form must reproduce the above copyright
  9. notice, this list of conditions and the following disclaimer in the
  10. documentation and/or other materials provided with the distribution.
  11. * Neither the name of Feral Interactive nor the names of its contributors
  12. may be used to endorse or promote products derived from this software
  13. without specific prior written permission.
  14. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  15. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17. ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  18. LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19. CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20. SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21. INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22. CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23. ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24. POSSIBILITY OF SUCH DAMAGE.
  25. */
  26. #pragma once
  27. #include <stdbool.h>
  28. #include <sys/types.h>
  29. #define INVALID_PROCFD -1
  30. typedef int procfd_t;
  31. /**
  32. * Opaque types
  33. */
  34. typedef struct GameModeContext GameModeContext;
  35. typedef struct GameModeConfig GameModeConfig;
  36. typedef struct GameModeClient GameModeClient;
  37. /**
  38. * GameModeClient related functions
  39. */
  40. /**
  41. * Decrement the usage count of client.
  42. */
  43. void game_mode_client_unref(GameModeClient *client);
  44. /**
  45. * Increment the usage count of client.
  46. */
  47. void game_mode_client_ref(GameModeClient *client);
  48. /**
  49. * The process identifier of the client.
  50. */
  51. pid_t game_mode_client_get_pid(GameModeClient *client);
  52. /**
  53. * The path to the executable of client.
  54. */
  55. const char *game_mode_client_get_executable(GameModeClient *client);
  56. /**
  57. * Return the singleton instance
  58. */
  59. GameModeContext *game_mode_context_instance(void);
  60. /**
  61. * Initialise the GameModeContext
  62. *
  63. * This is performed in a thread-safe fashion.
  64. */
  65. void game_mode_context_init(GameModeContext *self);
  66. /**
  67. * Destroy the previously initialised GameModeContext.
  68. *
  69. * This is performed in a thread safe fashion.
  70. */
  71. void game_mode_context_destroy(GameModeContext *self);
  72. /**
  73. * Query the number of currently registered clients.
  74. *
  75. * @returns The number of clients. A number > 0 means that gamemode is active.
  76. */
  77. int game_mode_context_num_clients(GameModeContext *self);
  78. /**
  79. * List the currently active clients.
  80. * @param out holds the number of active clients.
  81. *
  82. * @returns A array of pid_t or NULL if there are no active clients.
  83. */
  84. pid_t *game_mode_context_list_clients(GameModeContext *self, unsigned int *count);
  85. /**
  86. * Lookup up information about a client via the pid;
  87. *
  88. * @returns A pointer to a GameModeClient struct or NULL in case no client
  89. * with the corresponding id could be found. Adds a reference to
  90. * GameModeClient that needs to be released.
  91. */
  92. GameModeClient *game_mode_context_lookup_client(GameModeContext *self, pid_t client);
  93. /**
  94. * Register a new game client with the context
  95. *
  96. * @param pid Process ID for the remote client
  97. * @param requester Process ID for the remote requestor
  98. * @returns 0 if the request was accepted and the client could be registered
  99. * -1 if the request was accepted but the client could not be registered
  100. * -2 if the request was rejected
  101. */
  102. int game_mode_context_register(GameModeContext *self, pid_t pid, pid_t requester);
  103. /**
  104. * Unregister an existing remote game client from the context
  105. *
  106. * @param pid Process ID for the remote client
  107. * @param requester Process ID for the remote requestor
  108. * @returns 0 if the request was accepted and the client existed
  109. * -1 if the request was accepted but the client did not exist
  110. * -2 if the request was rejected
  111. */
  112. int game_mode_context_unregister(GameModeContext *self, pid_t pid, pid_t requester);
  113. /**
  114. * Query the current status of gamemode
  115. *
  116. * @param pid Process ID for the remote client
  117. * @returns Positive if gamemode is active
  118. * 1 if gamemode is active but the client is not registered
  119. * 2 if gamemode is active and the client is registered
  120. * -2 if this requester was rejected
  121. */
  122. int game_mode_context_query_status(GameModeContext *self, pid_t pid, pid_t requester);
  123. /**
  124. * Query the config of a gamemode context
  125. *
  126. * @param context A gamemode context
  127. * @returns Configuration from the gamemode context
  128. */
  129. GameModeConfig *game_mode_config_from_context(const GameModeContext *context);
  130. /*
  131. * Reload the current configuration
  132. */
  133. int game_mode_reload_config(GameModeContext *context);
  134. /** gamemode-ioprio.c
  135. * Provides internal API functions specific to adjusting process
  136. * IO priorities.
  137. */
  138. int game_mode_get_ioprio(const pid_t client);
  139. void game_mode_apply_ioprio(const GameModeContext *self, const pid_t client, int expected);
  140. /** gamemode-sched.c
  141. * Provides internal API functions specific to adjusting process
  142. * scheduling.
  143. */
  144. int game_mode_get_renice(const pid_t client);
  145. void game_mode_apply_renice(const GameModeContext *self, const pid_t client, int expected);
  146. void game_mode_apply_scheduling(const GameModeContext *self, const pid_t client);
  147. /** gamemode-wine.c
  148. * Provides internal API functions specific to handling wine
  149. * prefixes.
  150. */
  151. char *game_mode_resolve_wine_preloader(const char *exe, const pid_t pid);
  152. /** gamemode-tests.c
  153. * Provides a test suite to verify gamemode behaviour
  154. */
  155. int game_mode_run_client_tests(void);
  156. /** gamemode-gpu.c
  157. * Provides internal APU functions to apply optimisations to gpus
  158. */
  159. typedef struct GameModeGPUInfo GameModeGPUInfo;
  160. int game_mode_initialise_gpu(GameModeConfig *config, GameModeGPUInfo **info);
  161. void game_mode_free_gpu(GameModeGPUInfo **info);
  162. int game_mode_apply_gpu(const GameModeGPUInfo *info);
  163. int game_mode_get_gpu(GameModeGPUInfo *info);
  164. /** gamemode-dbus.c
  165. * Provides an API interface for using dbus
  166. */
  167. void game_mode_context_loop(GameModeContext *context) __attribute__((noreturn));
  168. int game_mode_inhibit_screensaver(bool inhibit);
  169. void game_mode_client_registered(pid_t);
  170. void game_mode_client_unregistered(pid_t);