version 1.11, 2002/03/28 22:56:24
|
version 1.52, 2008/08/14 17:44:27
|
|
|
//%////-*-c++-*-//////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
|
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
|
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation, The Open Group. |
|
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Day (mdday@us.ibm.com) <<< Wed Mar 13 20:49:40 2002 mdd >>> |
|
// |
|
// Modified By: |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_Module_Controller_h |
#ifndef Pegasus_ModuleController_h |
#define Pegasus_Module_Controller_h |
#define Pegasus_ModuleController_h |
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
|
#include <Pegasus/Common/Linkage.h> |
|
#include <Pegasus/Common/Constants.h> |
|
#include <Pegasus/Common/List.h> |
#include <Pegasus/Common/Message.h> | #include <Pegasus/Common/Message.h> |
#include <Pegasus/Common/Exception.h> |
|
#include <Pegasus/Common/IPC.h> |
|
#include <Pegasus/Common/Thread.h> |
|
#include <Pegasus/Common/AsyncOpNode.h> |
|
#include <Pegasus/Common/Cimom.h> |
|
#include <Pegasus/Common/CimomMessage.h> |
|
#include <Pegasus/Common/MessageQueueService.h> | #include <Pegasus/Common/MessageQueueService.h> |
|
#include <Pegasus/Common/AsyncOpNode.h> |
|
#include <Pegasus/Common/AutoPtr.h> |
| |
#ifndef min |
|
#define min(a, b) ((a) < (b) ? (a) : (b) ) |
|
#endif |
|
|
|
#include <bitset> |
|
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
class ModuleController; |
class PEGASUS_COMMON_LINKAGE RegisteredModuleHandle : public Linkable |
|
|
|
|
class PEGASUS_COMMON_LINKAGE pegasus_module |
|
{ |
|
private: |
|
class PEGASUS_COMMON_LINKAGE module_rep |
|
{ | { |
public: | public: |
module_rep(ModuleController *controller, |
RegisteredModuleHandle( |
const String & name, | const String & name, |
void *module_address, | void *module_address, |
Message * (*receive_message)(Message *, void *), | Message * (*receive_message)(Message *, void *), |
void (*async_callback)(Uint32, Message *, void *), |
void (*async_callback)(Uint32, Message *, void *)); |
void (*shutdown_notify)(Uint32 code, void *)); |
|
|
|
~module_rep(void) ; |
|
|
|
| |
Boolean operator == (const module_rep *rep) const |
virtual ~RegisteredModuleHandle(); |
{ if (rep == this ) return true; return false; } |
|
| |
Boolean operator == (const module_rep &rep) const |
const String& get_name() const; |
{ if (rep == *this) return true; return false; } |
|
| |
Boolean operator == (void *rep) const |
private: |
{ if ( (void *)this == rep ) return true; return false; } |
|
|
|
void reference(void) { _reference_count++; } |
|
void dereference(void) { _reference_count--; } |
|
Uint32 reference_count(void) { return _reference_count.value(); } |
|
const String & get_name(void) const { return _name; } |
|
void *get_module_address(void) const { return _module_address; } |
|
|
|
Message * module_receive_message(Message *msg); |
|
| |
void _send_async_callback(Uint32 msg_handle, Message *msg); |
RegisteredModuleHandle(); |
|
RegisteredModuleHandle(const RegisteredModuleHandle&); |
|
RegisteredModuleHandle& operator=(const RegisteredModuleHandle&); |
| |
void _send_shutdown_notify(void); |
Message* _receive_message(Message* msg); |
void lock(void) { _thread_safety.lock(pegasus_thread_self()); } |
void _send_async_callback(Uint32 msg_handle, Message* msg, void* parm); |
void unlock(void) { _thread_safety.unlock(); } |
|
private: |
|
module_rep(void); |
|
module_rep(const module_rep & ); |
|
module_rep& operator= (const module_rep & ); |
|
| |
Mutex _thread_safety; |
|
ModuleController *_controller; |
|
String _name; | String _name; |
AtomicInt _reference_count; |
|
AtomicInt _shutting_down; |
|
|
|
void *_module_address; | void *_module_address; |
Message * (*_receive_message)(Message *, void *); |
Message* (*_module_receive_message)(Message *, void *); |
void (*_async_callback)(Uint32, Message *, void *); | void (*_async_callback)(Uint32, Message *, void *); |
void (*_shutdown_notify)(Uint32 code, void *); |
|
|
|
static Message * default_receive_message(Message *msg, void *inst) |
|
{ throw NotImplemented("Module Receive");} |
|
|
|
static void default_async_callback(Uint32 handle, Message *msg, void *inst) |
|
{ throw NotImplemented("Module Async Receive"); } |
|
|
|
static void default_shutdown_notify(Uint32 code, void *inst) |
|
{ return; } |
|
|
|
static Message * closed_receive_message(Message *msg, void *inst) |
|
{ throw ModuleClosed();} |
|
|
|
static void closed_async_callback(Uint32 handle, Message *msg, void *inst) |
|
{ throw ModuleClosed(); } |
|
| |
friend class ModuleController; | friend class ModuleController; |
}; | }; |
| |
public: |
|
|
|
pegasus_module(ModuleController *controller, |
|
const String &id, |
|
void *module_address, |
|
Message * (*receive_message)(Message *, void *), |
|
void (*async_callback)(Uint32, Message *, void *), |
|
void (*shutdown_notify)(Uint32 code, void *)) ; |
|
|
|
~pegasus_module(void); |
|
|
|
pegasus_module & operator= (const pegasus_module & mod); |
|
Boolean operator == (const pegasus_module *mod) const; |
|
Boolean operator == (const pegasus_module & mod) const ; |
|
Boolean operator == (const String & mod) const; |
|
Boolean operator == (const void *mod) const; |
|
|
|
const String & get_name(void) const; |
|
|
|
// introspection interface |
|
Boolean query_interface(const String & class_id, void **object_ptr) const; |
|
|
|
private: |
|
|
|
module_rep *_rep; |
|
pegasus_module(void); |
|
pegasus_module(const pegasus_module & mod); |
|
Boolean _rcv_msg(Message *) ; |
|
Message * _receive_message(Message *msg); |
|
void _send_async_callback(Uint32 msg_handle, Message *msg) ; |
|
void _send_shutdown_notify(void); |
|
Boolean _shutdown(void); |
|
|
|
void reference(void) { _rep->reference(); } |
|
void dereference(void) { _rep->dereference(); } |
|
friend class ModuleController; |
|
}; |
|
|
|
| |
class PEGASUS_COMMON_LINKAGE ModuleController : public MessageQueueService | class PEGASUS_COMMON_LINKAGE ModuleController : public MessageQueueService |
{ | { |
|
|
|
|
public: | public: |
typedef MessageQueueService Base; | typedef MessageQueueService Base; |
| |
enum |
class callback_handle |
{ |
|
GET_CLIENT_HANDLE, |
|
REGISTER_MODULE, |
|
DEREGISTER_MODULE, |
|
FIND_SERVICE, |
|
FIND_MODULE_IN_SERVICE, |
|
GET_MODULE_REFERENCE, |
|
MODULE_SEND_WAIT, |
|
MODULE_SEND_WAIT_MODULE, |
|
MODULE_SEND_ASYNC, |
|
MODULE_SEND_ASYNC_MODULE, |
|
BLOCKING_THREAD_EXEC, |
|
ASYNC_THREAD_EXEC, |
|
NUMBER_OPERATIONS |
|
} ; |
|
private: |
|
class PEGASUS_COMMON_LINKAGE client_handle |
|
{ | { |
public: | public: |
client_handle(void) |
callback_handle(RegisteredModuleHandle* module, void* parm) |
: _allowed_operations(0), |
: _module(module), _parm(parm) |
_allowed_destinations(0), |
|
_allowed_sources(0), |
|
_identity(NULL) |
|
{ | { |
} | } |
| |
~client_handle(void); |
~callback_handle() |
|
|
private: |
|
friend class ModuleController; |
|
client_handle(Uint32 operations, |
|
Uint32 destinations, |
|
Uint32 sources, |
|
void *identity) |
|
: _allowed_operations(operations), |
|
_allowed_destinations(destinations), |
|
_allowed_sources(sources), |
|
_identity(identity) |
|
{ | { |
|
if (_module->get_name() == String(PEGASUS_MODULENAME_TEMP)) |
|
_module.reset(); |
} | } |
| |
bitset<NUMBER_OPERATIONS> _allowed_operations; |
AutoPtr<RegisteredModuleHandle> _module; |
bitset<128> _allowed_destinations; |
void* _parm; |
bitset<128> _allowed_sources; |
|
void *_identity; |
|
|
|
Boolean allowed(Uint32 operation, |
|
Uint32 destination, |
|
Uint32 source, |
|
void *identity) |
|
{ |
|
return true; |
|
} |
|
}; | }; |
| |
public: | public: |
|
|
|
|
ModuleController(const char *name); | ModuleController(const char *name); |
ModuleController(const char *name, |
|
Sint16 min_threads, |
|
Sint16 max_threads, |
|
struct timeval & create_thread, |
|
struct timeval & destroy_thread, |
|
struct timeval & deadlock); |
|
|
|
|
|
~ModuleController(void); |
|
|
|
static ModuleController & get_client_handle(const String & controller_name, |
|
void **handle); |
|
| |
|
~ModuleController(); |
| |
// module api | // module api |
static ModuleController & register_module(const String & controller_name, |
// @exception AlreadyExistsException |
|
// @exception IncompatibleTypesException |
|
static ModuleController& register_module( |
|
const String & controller_name, |
const String & module_name, | const String & module_name, |
void *module_address, | void *module_address, |
Message * (*receive_message)(Message *, void *), | Message * (*receive_message)(Message *, void *), |
void (*async_callback)(Uint32, Message *, void *), | void (*async_callback)(Uint32, Message *, void *), |
void (*shutdown_notify)(Uint32, void *), |
RegisteredModuleHandle** instance = 0); |
pegasus_module **instance = NULL) |
|
throw(AlreadyExists, IncompatibleTypes); |
// @exception Permission |
|
Boolean deregister_module(const String& module_name); |
| |
Boolean deregister_module(const String & module_name) |
// @exception Permission |
throw(Permission); |
Uint32 find_service( |
|
const RegisteredModuleHandle& handle, |
|
const String& name); |
|
|
|
// @exception Permission |
|
// @exception IPCException |
|
Uint32 find_module_in_service( |
|
const RegisteredModuleHandle& handle, |
|
const String& module_name); |
| |
Uint32 find_service(pegasus_module & handle, const String & name) throw(Permission); |
// send a message to another service |
|
// @exception Permission |
|
// @exception IPCException |
|
AsyncReply* ModuleSendWait( |
|
const RegisteredModuleHandle& handle, |
|
Uint32 destination_q, |
|
AsyncRequest* request); |
|
|
|
// send a message to another module via another service |
|
// @exception Permission |
|
// @exception Deadlock |
|
// @exception IPCException |
|
AsyncReply* ModuleSendWait( |
|
const RegisteredModuleHandle& handle, |
|
Uint32 destination_q, |
|
const String& destination_module, |
|
AsyncRequest* message); |
|
|
|
// send an async message to another service |
|
// @exception Permission |
|
// @exception Deadlock |
|
// @exception IPCException |
|
Boolean ModuleSendAsync( |
|
const RegisteredModuleHandle& handle, |
|
Uint32 msg_handle, |
|
Uint32 destination_q, |
|
AsyncRequest* message, |
|
void* callback_parm); |
|
|
|
// send an async message to another module via another service |
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ModuleSendAsync( |
|
const RegisteredModuleHandle& handle, |
|
Uint32 msg_handle, |
|
Uint32 destination_q, |
|
const String& destination_module, |
|
AsyncRequest* message, |
|
void* callback_parm); |
|
|
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ModuleSendForget( |
|
const RegisteredModuleHandle& handle, |
|
Uint32 destination_q, |
|
AsyncRequest* message); |
| |
Uint32 find_module_in_service(pegasus_module & handle, |
// @exception Permission |
const String & module_name) |
// @exception IPCException |
throw(Permission, IPCException); |
Boolean ModuleSendForget( |
|
const RegisteredModuleHandle & handle, |
|
Uint32 destination_q, |
|
const String & destination_module, |
|
AsyncRequest* message); |
| |
|
Boolean verify_handle(RegisteredModuleHandle *); |
| |
pegasus_module * get_module_reference(pegasus_module & my_handle, |
static ModuleController* getModuleController(); |
const String & module_name) |
|
throw(Permission); |
|
| |
// send a message to another service | // send a message to another service |
AsyncReply *ModuleSendWait(pegasus_module & handle, |
// @exception Permission |
|
// @exception IPCException |
|
AsyncReply* ClientSendWait( |
Uint32 destination_q, | Uint32 destination_q, |
AsyncRequest *request) throw(Permission, IPCException); |
AsyncRequest* request); |
| |
// send a message to another module via another service | // send a message to another module via another service |
AsyncReply *ModuleSendWait(pegasus_module & handle, |
// @exception Permission |
|
// @exception Deadlock |
|
// @exception IPCException |
|
AsyncReply* ClientSendWait( |
Uint32 destination_q, | Uint32 destination_q, |
String & destination_module, | String & destination_module, |
AsyncRequest *message) throw(Permission, Deadlock, IPCException); |
AsyncRequest* message); |
| |
// send an async message to another service | // send an async message to another service |
Boolean ModuleSendAsync(pegasus_module & handle, |
// @exception Permission |
|
// @exception IPCException |
|
Boolean ClientSendAsync( |
Uint32 msg_handle, | Uint32 msg_handle, |
Uint32 destination_q, | Uint32 destination_q, |
AsyncRequest *message) throw(Permission, IPCException); |
AsyncRequest* message, |
|
void (*async_callback)(Uint32, Message *, void *), |
|
void* callback_parm); |
| |
// send an async message to another module via another service | // send an async message to another module via another service |
Boolean ModuleSendAsync(pegasus_module & handle, |
// @exception Permission |
|
// @exception IPCException |
|
Boolean ClientSendAsync( |
Uint32 msg_handle, | Uint32 msg_handle, |
Uint32 destination_q, | Uint32 destination_q, |
String & destination_module, |
const String& destination_module, |
AsyncRequest *message) throw(Permission, IPCException); |
AsyncRequest* message, |
|
void (*async_callback)(Uint32, Message *, void *), |
|
void* callback_parm); |
|
|
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ClientSendForget( |
|
Uint32 destination_q, |
|
AsyncRequest* message); |
|
|
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ClientSendForget( |
|
Uint32 destination_q, |
|
const String& destination_module, |
|
AsyncRequest* message); |
| |
void blocking_thread_exec(pegasus_module & handle, |
|
PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), |
|
void *parm) throw(Permission, Deadlock, IPCException); |
|
void async_thread_exec(pegasus_module & handle, |
|
PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), |
|
void *parm) throw(Permission, Deadlock, IPCException); |
|
Boolean verify_handle(pegasus_module *); |
|
protected: | protected: |
// ATTN-RK-P2-20010322: These methods are pure virtual in superclass | // ATTN-RK-P2-20010322: These methods are pure virtual in superclass |
virtual void handleEnqueue(void) {} |
virtual void handleEnqueue() {} |
virtual void handleEnqueue(Message *) {} | virtual void handleEnqueue(Message *) {} |
virtual void _handle_async_request(AsyncRequest *rq); | virtual void _handle_async_request(AsyncRequest *rq); |
virtual void _handle_async_callback(AsyncOpNode *op); | virtual void _handle_async_callback(AsyncOpNode *op); |
| |
private: | private: |
static void _async_handleEnqueue(AsyncOpNode *h, MessageQueue *q, void *parm); |
class _module_lock |
DQueue<pegasus_module> _modules; |
{ |
ThreadPool _thread_pool; |
public: |
}; |
_module_lock(List<RegisteredModuleHandle, Mutex> * list) |
|
:_list(list) |
|
{ |
|
_list->lock(); |
|
} |
| |
|
~_module_lock() |
|
{ |
|
_list->unlock(); |
|
} |
| |
|
private: |
|
_module_lock(); |
|
List<RegisteredModuleHandle, Mutex> * _list; |
|
}; |
| |
| |
|
static void _async_handleEnqueue( |
|
AsyncOpNode* h, |
|
MessageQueue* q, |
|
void* parm); |
|
|
|
List<RegisteredModuleHandle, Mutex> _modules; |
|
AsyncReply *_send_wait(Uint32, AsyncRequest *); |
|
AsyncReply *_send_wait(Uint32, const String &, AsyncRequest *); |
| |
|
// @exception IPCException |
|
Boolean _send_forget(Uint32, AsyncRequest *); |
| |
|
// @exception IPCException |
|
Boolean _send_forget(Uint32, const String &, AsyncRequest *); |
|
}; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
|
#endif // Pegasus_ModuleController_h |
#endif // Pegasus_Module_Controller_H |
|