version 1.13, 2002/03/29 17:36:41
|
version 1.38, 2004/10/17 20:39:17
|
|
|
//%////-*-c++-*-//////////////////////////////////////////////////////////////// |
//%2004//////////////////////////////////////////////////////////////////////// |
// | // |
// 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. |
// | // |
// 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 >>> | // Author: Mike Day (mdday@us.ibm.com) <<< Wed Mar 13 20:49:40 2002 mdd >>> |
// | // |
// Modified By: |
// Modified By: Amit K Arora, IBM (amita@in.ibm.com) |
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
|
|
#define Pegasus_Module_Controller_h | #define Pegasus_Module_Controller_h |
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
|
#include <Pegasus/Common/Constants.h> |
#include <Pegasus/Common/Message.h> | #include <Pegasus/Common/Message.h> |
#include <Pegasus/Common/Exception.h> |
#include <Pegasus/Common/InternalException.h> |
#include <Pegasus/Common/IPC.h> | #include <Pegasus/Common/IPC.h> |
#include <Pegasus/Common/Thread.h> | #include <Pegasus/Common/Thread.h> |
#include <Pegasus/Common/AsyncOpNode.h> | #include <Pegasus/Common/AsyncOpNode.h> |
#include <Pegasus/Common/Cimom.h> | #include <Pegasus/Common/Cimom.h> |
#include <Pegasus/Common/CimomMessage.h> | #include <Pegasus/Common/CimomMessage.h> |
#include <Pegasus/Common/MessageQueueService.h> | #include <Pegasus/Common/MessageQueueService.h> |
|
#include <Pegasus/Common/peg_authorization.h> |
|
#include <Pegasus/Common/Linkage.h> |
|
#include <Pegasus/Common/AutoPtr.h> |
| |
#include <bitset> |
|
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
|
|
class PEGASUS_COMMON_LINKAGE pegasus_module | class PEGASUS_COMMON_LINKAGE pegasus_module |
{ | { |
private: | private: |
class PEGASUS_COMMON_LINKAGE module_rep |
class module_rep : public pegasus_auth_handle |
{ | { |
public: | public: |
|
typedef pegasus_auth_handle Base; |
|
|
module_rep(ModuleController *controller, | module_rep(ModuleController *controller, |
const String & name, | const String & name, |
void *module_address, | void *module_address, |
|
|
| |
~module_rep(void) ; | ~module_rep(void) ; |
| |
|
|
Boolean operator == (const module_rep *rep) const | Boolean operator == (const module_rep *rep) const |
{ if (rep == this ) return true; return false; } | { if (rep == this ) return true; return false; } |
| |
|
|
| |
Message * module_receive_message(Message *msg); | Message * module_receive_message(Message *msg); |
| |
void _send_async_callback(Uint32 msg_handle, Message *msg); |
void _send_async_callback(Uint32 msg_handle, Message *msg, void *parm); |
| |
void _send_shutdown_notify(void); | void _send_shutdown_notify(void); |
void lock(void) { _thread_safety.lock(pegasus_thread_self()); } | void lock(void) { _thread_safety.lock(pegasus_thread_self()); } |
void unlock(void) { _thread_safety.unlock(); } | void unlock(void) { _thread_safety.unlock(); } |
|
|
|
Boolean authorized(void) ; |
|
Boolean authorized(Uint32); |
|
Boolean authorized(Uint32, Uint32); |
|
|
private: | private: |
module_rep(void); | module_rep(void); |
module_rep(const module_rep & ); | module_rep(const module_rep & ); |
module_rep& operator= (const module_rep & ); |
module_rep & operator= (const module_rep & rep); |
|
|
| |
Mutex _thread_safety; | Mutex _thread_safety; |
ModuleController *_controller; |
AutoPtr<ModuleController> _controller;//PEP101 |
String _name; | String _name; |
AtomicInt _reference_count; | AtomicInt _reference_count; |
AtomicInt _shutting_down; | AtomicInt _shutting_down; |
|
|
void (*_shutdown_notify)(Uint32 code, void *); | void (*_shutdown_notify)(Uint32 code, void *); |
| |
static Message * default_receive_message(Message *msg, void *inst) | static Message * default_receive_message(Message *msg, void *inst) |
{ throw NotImplemented("Module Receive");} |
{ throw NotImplemented("Module Receive"); return 0; } |
| |
static void default_async_callback(Uint32 handle, Message *msg, void *inst) | static void default_async_callback(Uint32 handle, Message *msg, void *inst) |
{ throw NotImplemented("Module Async Receive"); } | { throw NotImplemented("Module Async Receive"); } |
|
|
{ return; } | { return; } |
| |
static Message * closed_receive_message(Message *msg, void *inst) | static Message * closed_receive_message(Message *msg, void *inst) |
{ throw ModuleClosed();} |
{ throw ModuleClosed(); return 0; } |
| |
static void closed_async_callback(Uint32 handle, Message *msg, void *inst) | static void closed_async_callback(Uint32 handle, Message *msg, void *inst) |
{ throw ModuleClosed(); } | { throw ModuleClosed(); } |
|
|
}; | }; |
| |
public: | public: |
|
|
pegasus_module(ModuleController *controller, | pegasus_module(ModuleController *controller, |
const String &id, | const String &id, |
void *module_address, | void *module_address, |
|
|
void (*async_callback)(Uint32, Message *, void *), | void (*async_callback)(Uint32, Message *, void *), |
void (*shutdown_notify)(Uint32 code, void *)) ; | void (*shutdown_notify)(Uint32 code, void *)) ; |
| |
~pegasus_module(void); |
pegasus_module(const pegasus_module & mod); |
|
|
pegasus_module & operator= (const pegasus_module & mod); | pegasus_module & operator= (const pegasus_module & mod); |
Boolean operator == (const pegasus_module *mod) const; |
|
|
virtual ~pegasus_module(void); |
|
|
|
virtual Boolean authorized(Uint32 operation); |
|
virtual Boolean authorized(void); |
|
|
Boolean operator == (const pegasus_module & mod) const ; | Boolean operator == (const pegasus_module & mod) const ; |
Boolean operator == (const String & mod) const; | Boolean operator == (const String & mod) const; |
Boolean operator == (const void *mod) const; | Boolean operator == (const void *mod) const; |
|
|
// introspection interface | // introspection interface |
Boolean query_interface(const String & class_id, void **object_ptr) const; | Boolean query_interface(const String & class_id, void **object_ptr) const; |
| |
|
|
private: | private: |
| |
module_rep *_rep; |
AutoPtr<module_rep> _rep;//PEP101 |
pegasus_module(void); |
|
pegasus_module(const pegasus_module & mod); |
pegasus_module(void) |
|
{ |
|
} |
|
|
Boolean _rcv_msg(Message *) ; | Boolean _rcv_msg(Message *) ; |
Message * _receive_message(Message *msg); | Message * _receive_message(Message *msg); |
void _send_async_callback(Uint32 msg_handle, Message *msg) ; |
void _send_async_callback(Uint32 msg_handle, Message *msg, void *) ; |
void _send_shutdown_notify(void); | void _send_shutdown_notify(void); |
Boolean _shutdown(void); | Boolean _shutdown(void); |
|
PEGASUS_STD(bitset<32>) _allowed_operations; |
| |
void reference(void) { _rep->reference(); } | void reference(void) { _rep->reference(); } |
void dereference(void) { _rep->dereference(); } | void dereference(void) { _rep->dereference(); } |
|
|
public: | public: |
typedef MessageQueueService Base; | typedef MessageQueueService Base; |
| |
enum |
static const Uint32 GET_CLIENT_HANDLE; |
{ |
static const Uint32 REGISTER_MODULE; |
GET_CLIENT_HANDLE, |
static const Uint32 DEREGISTER_MODULE; |
REGISTER_MODULE, |
static const Uint32 FIND_SERVICE; |
DEREGISTER_MODULE, |
static const Uint32 FIND_MODULE_IN_SERVICE; |
FIND_SERVICE, |
static const Uint32 GET_MODULE_REFERENCE; |
FIND_MODULE_IN_SERVICE, |
static const Uint32 MODULE_SEND_WAIT; |
GET_MODULE_REFERENCE, |
static const Uint32 MODULE_SEND_WAIT_MODULE; |
MODULE_SEND_WAIT, |
static const Uint32 MODULE_SEND_ASYNC; |
MODULE_SEND_WAIT_MODULE, |
static const Uint32 MODULE_SEND_ASYNC_MODULE; |
MODULE_SEND_ASYNC, |
static const Uint32 BLOCKING_THREAD_EXEC; |
MODULE_SEND_ASYNC_MODULE, |
static const Uint32 ASYNC_THREAD_EXEC; |
BLOCKING_THREAD_EXEC, |
static const Uint32 CLIENT_SEND_WAIT; |
ASYNC_THREAD_EXEC, |
static const Uint32 CLIENT_SEND_WAIT_MODULE; |
NUMBER_OPERATIONS |
static const Uint32 CLIENT_SEND_ASYNC; |
} ; |
static const Uint32 CLIENT_SEND_ASYNC_MODULE; |
private: |
static const Uint32 CLIENT_BLOCKING_THREAD_EXEC; |
class PEGASUS_COMMON_LINKAGE client_handle |
static const Uint32 CLIENT_ASYNC_THREAD_EXEC; |
|
static const Uint32 CLIENT_SEND_FORGET; |
|
static const Uint32 CLIENT_SEND_FORGET_MODULE; |
|
static const Uint32 MODULE_SEND_FORGET; |
|
static const Uint32 MODULE_SEND_FORGET_MODULE; |
|
|
|
// ATTN-DME-P2-20020406 Removed private declaration. client_handle is |
|
// currently used in Pegasus/Provider/CIMOMHandle.cpp |
|
|
|
// private: |
|
class client_handle : public pegasus_auth_handle |
{ | { |
public: | public: |
client_handle(void) |
typedef pegasus_auth_handle Base; |
: _allowed_operations(0), |
|
_allowed_destinations(0), |
client_handle(const pegasus_identity & id) |
_allowed_sources(0), |
:Base(id) , |
_identity(NULL) |
allowed_operations( GET_CLIENT_HANDLE | |
|
FIND_SERVICE | |
|
FIND_MODULE_IN_SERVICE | |
|
GET_MODULE_REFERENCE | |
|
CLIENT_SEND_WAIT | |
|
CLIENT_SEND_WAIT_MODULE | |
|
CLIENT_SEND_ASYNC | |
|
CLIENT_SEND_ASYNC_MODULE | |
|
CLIENT_BLOCKING_THREAD_EXEC | |
|
CLIENT_ASYNC_THREAD_EXEC), |
|
reference_count(1) |
{ | { |
} | } |
| |
~client_handle(void); |
~client_handle(void) |
|
{ |
|
} |
| |
|
client_handle & operator=(const client_handle & handle) |
|
{ |
|
if(this == &handle) |
|
return *this; |
|
reference_count++; |
|
return *this; |
|
} |
|
|
|
|
|
virtual Boolean authorized(Uint32, Uint32); |
|
virtual Boolean authorized(Uint32 operation); |
|
virtual Boolean authorized(void); |
|
PEGASUS_STD(bitset<32>) allowed_operations; |
|
AtomicInt reference_count; |
|
|
|
}; |
|
|
|
class callback_handle |
|
{ |
|
public: |
|
static void * operator new(size_t ); |
|
static void operator delete(void *, size_t); |
private: | private: |
friend class ModuleController; |
static callback_handle *_head; |
client_handle(Uint32 operations, |
static const int BLOCK_SIZE; |
Uint32 destinations, |
static Mutex _alloc_mut; |
Uint32 sources, |
|
void *identity) |
public: |
: _allowed_operations(operations), |
callback_handle(pegasus_module * module, void *parm) |
_allowed_destinations(destinations), |
: _module(module), _parm(parm) |
_allowed_sources(sources), |
|
_identity(identity) |
|
{ | { |
} | } |
| |
bitset<NUMBER_OPERATIONS> _allowed_operations; |
~callback_handle() |
bitset<128> _allowed_destinations; |
|
bitset<128> _allowed_sources; |
|
void *_identity; |
|
|
|
Boolean allowed(Uint32 operation, |
|
Uint32 destination, |
|
Uint32 source, |
|
void *identity) |
|
{ | { |
return true; |
if( _module->get_name() == String(PEGASUS_MODULENAME_TEMP) ) |
|
// delete _module; |
|
_module.reset(); |
} | } |
|
|
|
AutoPtr<pegasus_module> _module;//PEP101 |
|
void *_parm; |
}; | }; |
| |
|
|
public: | public: |
| |
| |
ModuleController(const char *name); | ModuleController(const char *name); |
ModuleController(const char *name, |
/* ModuleController(const char *name, */ |
Sint16 min_threads, |
/* Sint16 min_threads, */ |
Sint16 max_threads, |
/* Sint16 max_threads, */ |
struct timeval & create_thread, |
/* struct timeval & create_thread, */ |
struct timeval & destroy_thread, |
/* struct timeval & destroy_thread, */ |
struct timeval & deadlock); |
/* struct timeval & deadlock); */ |
| |
| |
~ModuleController(void); | ~ModuleController(void); |
| |
static ModuleController & get_client_handle(const String & controller_name, |
|
void **handle); |
|
| |
| |
// module api | // module api |
|
|
void (*async_callback)(Uint32, Message *, void *), | void (*async_callback)(Uint32, Message *, void *), |
void (*shutdown_notify)(Uint32, void *), | void (*shutdown_notify)(Uint32, void *), |
pegasus_module **instance = NULL) | pegasus_module **instance = NULL) |
throw(AlreadyExists, IncompatibleTypes); |
|
|
throw(AlreadyExistsException, IncompatibleTypesException); |
| |
Boolean deregister_module(const String & module_name) | Boolean deregister_module(const String & module_name) |
throw(Permission); | throw(Permission); |
| |
Uint32 find_service(pegasus_module & handle, const String & name) throw(Permission); |
Uint32 find_service(const pegasus_module & handle, const String & name) throw(Permission); |
| |
Uint32 find_module_in_service(pegasus_module & handle, |
Uint32 find_module_in_service(const pegasus_module & handle, |
const String & module_name) | const String & module_name) |
throw(Permission, IPCException); | throw(Permission, IPCException); |
| |
| |
pegasus_module * get_module_reference(pegasus_module & my_handle, |
pegasus_module * get_module_reference(const pegasus_module & my_handle, |
const String & module_name) | const String & module_name) |
throw(Permission); | throw(Permission); |
| |
// send a message to another service | // send a message to another service |
AsyncReply *ModuleSendWait(pegasus_module & handle, |
AsyncReply *ModuleSendWait(const pegasus_module & handle, |
Uint32 destination_q, | Uint32 destination_q, |
AsyncRequest *request) throw(Permission, IPCException); | AsyncRequest *request) throw(Permission, IPCException); |
| |
// send a message to another module via another service | // send a message to another module via another service |
AsyncReply *ModuleSendWait(pegasus_module & handle, |
AsyncReply *ModuleSendWait(const pegasus_module & handle, |
Uint32 destination_q, | Uint32 destination_q, |
String & destination_module, |
const String & destination_module, |
AsyncRequest *message) throw(Permission, Deadlock, IPCException); | AsyncRequest *message) throw(Permission, Deadlock, IPCException); |
| |
// send an async message to another service | // send an async message to another service |
Boolean ModuleSendAsync(pegasus_module & handle, |
Boolean ModuleSendAsync(const pegasus_module & handle, |
Uint32 msg_handle, | Uint32 msg_handle, |
Uint32 destination_q, | Uint32 destination_q, |
AsyncRequest *message) throw(Permission, IPCException); |
AsyncRequest *message, |
|
void *callback_parm) throw(Permission, IPCException); |
| |
// 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, |
Boolean ModuleSendAsync(const pegasus_module & handle, |
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 *callback_parm) throw(Permission, IPCException); |
|
|
|
Boolean ModuleSendForget(const pegasus_module & handle, |
|
Uint32 destination_q, |
|
AsyncRequest *message) |
|
throw(Permission, IPCException); |
| |
void blocking_thread_exec(pegasus_module & handle, |
Boolean ModuleSendForget(const pegasus_module & handle, |
|
Uint32 destination_q, |
|
const String & destination_module, |
|
AsyncRequest *message) |
|
throw(Permission, IPCException); |
|
|
|
void blocking_thread_exec(const pegasus_module & handle, |
PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), | PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), |
void *parm) throw(Permission, Deadlock, IPCException); | void *parm) throw(Permission, Deadlock, IPCException); |
void async_thread_exec(pegasus_module & handle, |
void async_thread_exec(const pegasus_module & handle, |
PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), | PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), |
void *parm) throw(Permission, Deadlock, IPCException); | void *parm) throw(Permission, Deadlock, IPCException); |
|
|
Boolean verify_handle(pegasus_module *); | Boolean verify_handle(pegasus_module *); |
|
|
|
static ModuleController & get_client_handle(const pegasus_identity & id, |
|
client_handle **handle) |
|
throw(IncompatibleTypesException); |
|
|
|
static ModuleController & get_client_handle(const char *controller, |
|
const pegasus_identity & id, |
|
client_handle **handle) |
|
throw(IncompatibleTypesException); |
|
|
|
|
|
void return_client_handle(client_handle *handle); |
|
|
|
// send a message to another service |
|
AsyncReply *ClientSendWait(const client_handle & handle, |
|
Uint32 destination_q, |
|
AsyncRequest *request) |
|
throw(Permission, IPCException); |
|
|
|
// send a message to another module via another service |
|
AsyncReply *ClientSendWait(const client_handle & handle, |
|
Uint32 destination_q, |
|
String & destination_module, |
|
AsyncRequest *message) |
|
throw(Permission, Deadlock, IPCException); |
|
|
|
// send an async message to another service |
|
Boolean ClientSendAsync(const client_handle & handle, |
|
Uint32 msg_handle, |
|
Uint32 destination_q, |
|
AsyncRequest *message, |
|
void (*async_callback)(Uint32, Message *, void *) , |
|
void *callback_parm) |
|
throw(Permission, IPCException); |
|
|
|
// send an async message to another module via another service |
|
Boolean ClientSendAsync(const client_handle & handle, |
|
Uint32 msg_handle, |
|
Uint32 destination_q, |
|
const String & destination_module, |
|
AsyncRequest *message, |
|
void (*async_callback)(Uint32, Message *, void *), |
|
void *callback_parm ) |
|
throw(Permission, IPCException); |
|
|
|
Boolean ClientSendForget(const client_handle & handle, |
|
Uint32 destination_q, |
|
AsyncRequest *message) |
|
throw(Permission, IPCException); |
|
|
|
Boolean ClientSendForget(const client_handle & handle, |
|
Uint32 destination_q, |
|
const String & destination_module, |
|
AsyncRequest *message) |
|
throw(Permission, IPCException); |
|
|
|
void client_blocking_thread_exec(const client_handle & handle, |
|
PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), |
|
void *parm) |
|
throw(Permission, Deadlock, IPCException); |
|
void client_async_thread_exec(const client_handle & handle, |
|
PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), |
|
void *parm) |
|
throw(Permission, Deadlock, IPCException); |
|
|
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(void) {} |
|
|
virtual void _handle_async_callback(AsyncOpNode *op); | virtual void _handle_async_callback(AsyncOpNode *op); |
| |
private: | private: |
|
|
|
|
|
class _module_lock |
|
{ |
|
public: |
|
_module_lock(DQueue<pegasus_module> * list) |
|
:_list(list) |
|
{ |
|
_list->lock(); |
|
|
|
} |
|
~_module_lock(void) |
|
{ |
|
_list->unlock(); |
|
} |
|
|
|
|
|
private: |
|
_module_lock(); |
|
DQueue<pegasus_module> * _list; |
|
}; |
|
|
|
|
|
|
static void _async_handleEnqueue(AsyncOpNode *h, MessageQueue *q, void *parm); | static void _async_handleEnqueue(AsyncOpNode *h, MessageQueue *q, void *parm); |
DQueue<pegasus_module> _modules; | DQueue<pegasus_module> _modules; |
ThreadPool _thread_pool; |
pegasus_module _internal_module; |
|
AsyncReply *_send_wait(Uint32, AsyncRequest *); |
|
AsyncReply *_send_wait(Uint32, const String &, AsyncRequest *); |
|
Boolean _send_forget(Uint32, AsyncRequest *) throw(IPCException); |
|
Boolean _send_forget(Uint32, const String &, AsyncRequest *) throw(IPCException); |
|
|
|
void _blocking_thread_exec( |
|
PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), |
|
void *parm) ; |
|
void _async_thread_exec( |
|
PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *), |
|
void *parm) ; |
}; | }; |
| |
| |
|
|
| |
| |
| |
|
|
|
|
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
| |