polar-runtime-service-thread.h

/* Internal API: runtime service thread for polar-objc.
   Copyright (C) 2022-2025 Michael Malicoat <[email protected]>
 
   This file is part of polar-objc.
 
   polar-objc is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either version 3, or (at your option) any later version.
 
   polar-objc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
   details.
 
   You should have received a copy of the GNU General Public License along with this program; see the file LICENSE.  If
   not, see <http://www.gnu.org/licenses/>.
*/
#ifndef POLAR_RUNTIME_SERVICE_THREAD_H
#define POLAR_RUNTIME_SERVICE_THREAD_H
 
/* Client threads request the services of the runtime service thread by passing a message with a subject that indicates
   the desired service and the desired operation. This is all handled transparently for client threads by the various
   runtime service interfaces provided in "source/polar-internals/runtime-service/interfaces".
 
   The service desired of the runtime service thread is indicated using one of the enumerated values below.  The desired
   operation will be one of the values enumerated in the corresponding service inteface file.
 
   When compiling in debug mode, there are some assertions in place to validate that the service identifier and
   operation identifier are within the defined ranges. If you are adding a service or operation, it is advisable to test
   the addition in debug mode first.
*/
 
// These are the services offered by the runtime service thread
enum
{
  POLAR_ID_SERVICE_NONE = 0,
 
  POLAR_ID_SERVICE_DISPATCH,        // Dispatch array management
  POLAR_ID_SERVICE_MEMORY_DISPOSAL, // Threaded memory disposal
  POLAR_ID_SERVICE_MODULE,          // Compiled module management
  POLAR_ID_SERVICE_SELECTOR,        // Selector registration and management
  POLAR_ID_SERVICE_THREAD_SYNC,     // @synchronized() support
  POLAR_ID_SERVICE_TYPE_REGISTRY,   // Class and Protocol registration
  POLAR_ID_SERVICE_TYPE_WORK,       // Class and Protocol manipulation
 
  // Sentinel value
  POLAR_ID_SERVICE_LAST
};
 
#define POLAR_ID_SERVICE_FIRST ( POLAR_ID_SERVICE_NONE + 1 )
 
#define POLAR_MASK_REQUEST_SERVICE 0xFF00
#define POLAR_MASK_REQUEST_OPERATION 0xFF
#define POLAR_SHIFT_SERVICE_REQUEST 8
 
#define POLAR_SERVICE_DISPATCH ( polar_array_runtime_services[POLAR_ID_SERVICE_DISPATCH] )
#define POLAR_SERVICE_MEMORY_DISPOSAL ( polar_array_runtime_services[POLAR_ID_SERVICE_MEMORY_DISPOSAL] )
#define POLAR_SERVICE_MODULE ( polar_array_runtime_services[POLAR_ID_SERVICE_MODULE] )
#define POLAR_SERVICE_SELECTOR ( polar_array_runtime_services[POLAR_ID_SERVICE_SELECTOR] )
#define POLAR_SERVICE_THREAD_SYNC ( polar_array_runtime_services[POLAR_ID_SERVICE_THREAD_SYNC] )
#define POLAR_SERVICE_TYPE_REGISTRY ( polar_array_runtime_services[POLAR_ID_SERVICE_TYPE_REGISTRY] )
#define POLAR_SERVICE_TYPE_WORK ( polar_array_runtime_services[POLAR_ID_SERVICE_TYPE_WORK] )
 
/* Array of runtime service singleton objects; initialized in the context of the runtime service thread and constant
   thereafter.
*/
extern polar_runtime_service *polar_array_runtime_services[ POLAR_ID_SERVICE_LAST ];
 
// These variables are all initialized in polar_runtime_service_thread_init()
extern thrd_t polar_id_main_thread; // Platform ID of the main thread
extern thrd_t polar_id_rts_thread;  // Platform ID of the runtime service thread
extern polar_thread_message_queue *polar_inbox_rts_thread; // Message queue for the runtime service thread
 
// Called by polar_init()
POLAR_FUNCTION_INTERNAL intptr_t
polar_runtime_service_thread_init( void );
 
// Called by polar_finalize()
POLAR_FUNCTION_INTERNAL void
polar_runtime_service_thread_finalize( void );
 
#endif //POLAR_RUNTIME_SERVICE_THREAD_H