(file) Return to ModuleController.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/ModuleController.h between version 1.16 and 1.47

version 1.16, 2002/04/01 19:25:43 version 1.47, 2006/07/25 19:02:37
Line 1 
Line 1 
 //%////-*-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
Line 22 
Line 31 
 // //
 // 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)
   //              David Dillard, VERITAS Software Corp.
   //                  (david.dillard@veritas.com)
 // //
 //%///////////////////////////////////////////////////////////////////////////// //%/////////////////////////////////////////////////////////////////////////////
  
Line 30 
Line 41 
 #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 <Pegasus/Common/List.h>
  
  
 PEGASUS_NAMESPACE_BEGIN PEGASUS_NAMESPACE_BEGIN
Line 46 
Line 60 
 class ModuleController; class ModuleController;
  
  
 class PEGASUS_COMMON_LINKAGE pegasus_module : pegasus_authorization_handle  class PEGASUS_COMMON_LINKAGE pegasus_module : public Linkable
 { {
    private:    private:
       class module_rep       class module_rep
Line 59 
Line 73 
                        void (*async_callback)(Uint32, Message *, void *),                        void (*async_callback)(Uint32, Message *, void *),
                        void (*shutdown_notify)(Uint32 code, void *));                        void (*shutdown_notify)(Uint32 code, void *));
  
             ~module_rep(void) ;          ~module_rep();
  
           void reference()
           {
               _reference_count++;
           }
  
             Boolean operator == (const module_rep *rep) const          void dereference()
             { if (rep == this ) return true; return false; }          {
               _reference_count--;
           }
  
             Boolean operator == (const module_rep &rep) const          Uint32 reference_count() const
             { if (rep == *this) return true; return false; }          {
               return _reference_count.get();
           }
  
             Boolean operator == (void *rep) const          const String& get_name() const throw()
             { if ( (void *)this == rep ) return true; return false; }          {
               return _name;
           }
  
             void reference(void) { _reference_count++; }          void *get_module_address() const
             void dereference(void) { _reference_count--; }          {
             Uint32 reference_count(void)  { return _reference_count.value(); }              return _module_address;
             const String & get_name(void) const { return _name; }          }
             void *get_module_address(void) const { return _module_address; }  
  
             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 lock(void) { _thread_safety.lock(pegasus_thread_self()); }  
             void unlock(void) { _thread_safety.unlock(); }          void lock()
          private:  
             module_rep(void);  
             module_rep(const module_rep & );  
             module_rep& operator= (const module_rep & rep)  
             {  
                if( this != &rep )  
                {                {
                   _reference_count++;              _thread_safety.lock(pegasus_thread_self());
                }  
                return *this;  
             }             }
  
             module_rep *operator=(const module_rep *rep)          void unlock()
             {             {
                if( this != rep)              _thread_safety.unlock();
                {  
                   _reference_count++;  
                }  
                return this;  
             }             }
  
       private:
           module_rep();
           module_rep(const module_rep&);
           module_rep & operator=(const module_rep & rep);
  
             Mutex _thread_safety;             Mutex _thread_safety;
           // Don't make this an AutoPtr. Refer to bug 3502
             ModuleController *_controller;             ModuleController *_controller;
             String _name;             String _name;
             AtomicInt _reference_count;             AtomicInt _reference_count;
Line 118 
Line 134 
             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");
           }
  
             static void default_shutdown_notify(Uint32 code, void *inst)             static void default_shutdown_notify(Uint32 code, void *inst)
             { return; }          {
               // Intentionally left blank
           }
  
             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();
           }
  
             friend class ModuleController;             friend class ModuleController;
       };       };
  
    public:    public:
       typedef pegasus_authorization_handle Base;  
   
       pegasus_module(ModuleController *controller,       pegasus_module(ModuleController *controller,
                      const String &id,                      const String &id,
                      void *module_address,                      void *module_address,
Line 145 
Line 171 
                      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);
   
       virtual Boolean authorized(Uint32 operation);  
       virtual Boolean authorized(void);  
   
       pegasus_module & operator= (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();
       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;  
  
       const String & get_name(void) const;      const String & get_name() 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()
       {
       }
   
       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();
       Boolean _shutdown(void);      Boolean _shutdown();
       bitset<32> _allowed_operations;  
       void reference()
       {
           _rep->reference();
       }
   
       void dereference()
       {
           _rep->dereference();
       }
  
       void reference(void) { _rep->reference(); }  
       void dereference(void)  { _rep->dereference(); }  
       friend class ModuleController;       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;
  
       static const Uint32 GET_CLIENT_HANDLE;      class callback_handle
       static const Uint32 REGISTER_MODULE;  
       static const Uint32 DEREGISTER_MODULE;  
       static const Uint32 FIND_SERVICE;  
       static const Uint32 FIND_MODULE_IN_SERVICE;  
       static const Uint32 GET_MODULE_REFERENCE;  
       static const Uint32 MODULE_SEND_WAIT;  
       static const Uint32 MODULE_SEND_WAIT_MODULE;  
       static const Uint32 MODULE_SEND_ASYNC;  
       static const Uint32 MODULE_SEND_ASYNC_MODULE;  
       static const Uint32 BLOCKING_THREAD_EXEC;  
       static const Uint32 ASYNC_THREAD_EXEC;  
       static const Uint32 CLIENT_SEND_WAIT;  
       static const Uint32 CLIENT_SEND_WAIT_MODULE;  
       static const Uint32 CLIENT_SEND_ASYNC;  
       static const Uint32 CLIENT_SEND_ASYNC_MODULE;  
       static const Uint32 CLIENT_BLOCKING_THREAD_EXEC;  
       static const Uint32 CLIENT_ASYNC_THREAD_EXEC;  
   
   
    private:  
       class client_handle : pegasus_authorization_handle  
       {       {
          public:          public:
             typedef pegasus_authorization_handle Base;          callback_handle(pegasus_module * module, void *parm)
              : _module(module), _parm(parm)
             client_handle(void)  
                :Base(new pegasus_internal_identity(peg_credential_types::SERVICE)),  
                 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)  
             {             {
   
             }             }
  
             client_handle(pegasus_base_identity *id)          ~callback_handle()
                :Base(id)  
             {  
                if( id && (id->get_base_id_type() == peg_identity_types::INTERNAL ))  
                {                {
                   if (id->get_base_cred_type() == peg_credential_types::SERVICE )              if( _module->get_name() == String(PEGASUS_MODULENAME_TEMP) )
                      allowed_operations = ModuleController::CLIENT_SEND_WAIT |                  // delete _module;
                                           ModuleController::CLIENT_SEND_WAIT_MODULE |                  _module.reset();
                                           ModuleController::CLIENT_SEND_ASYNC |  
                                           ModuleController::CLIENT_SEND_ASYNC_MODULE |  
                                           ModuleController::CLIENT_BLOCKING_THREAD_EXEC |  
                                           ModuleController::CLIENT_ASYNC_THREAD_EXEC;  
                   else  
                      allowed_operations = 0;  
                }                }
  
             }          AutoPtr<pegasus_module> _module;//PEP101
             ~client_handle(void);          void *_parm;
             virtual Boolean authorized(Uint32 operation);  
             virtual Boolean authorized(void);  
   
          private:  
             bitset<64> allowed_operations;  
       };       };
  
    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);  
   
   
       ~ModuleController(void);  
   
       static ModuleController & get_client_handle(const String & controller_name,  
                                                   void **handle);  
  
       ~ModuleController();
  
       // module api       // module api
       // @exception AlreadyExistsException
       // @exception IncompatibleTypesException
       static ModuleController & register_module(const String & controller_name,       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 *),                                                 void (*shutdown_notify)(Uint32, void *),
                                                 pegasus_module **instance = NULL)                      pegasus_module **instance = NULL);
          throw(AlreadyExists, IncompatibleTypes);  
  
       Boolean deregister_module(const String & module_name)      // @exception Permission
          throw(Permission);      Boolean deregister_module(const String & module_name);
  
       Uint32 find_service(pegasus_module & handle, const String & name) throw(Permission);      // @exception Permission
       Uint32 find_service(const pegasus_module & handle, const String & name);
  
       Uint32 find_module_in_service(pegasus_module & handle,      // @exception Permission
                                     const String & module_name)      // @exception IPCException
          throw(Permission, IPCException);      Uint32 find_module_in_service(const pegasus_module & handle,
                       const String & module_name);
   
       // @exception Permission
       pegasus_module * get_module_reference(const pegasus_module & my_handle,
                       const String & module_name);
  
       // send a message to another service
       // @exception Permission
       // @exception IPCException
       AsyncReply *ModuleSendWait(const pegasus_module & handle,
                       Uint32 destination_q,
                       AsyncRequest *request);
  
       pegasus_module * get_module_reference(pegasus_module & my_handle,      // send a message to another module via another service
                                             const String & module_name)      // @exception Permission
          throw(Permission);      // @exception DeadLock
       // @exception IPCException
       AsyncReply *ModuleSendWait(const pegasus_module & handle,
                       Uint32 destination_q,
                       const String & destination_module,
                       AsyncRequest *message);
  
       // send a message to another service      // send an async message to another service
       AsyncReply *ModuleSendWait(pegasus_module & handle,      // @exception Permission
       // @exception DeadLock
       // @exception IPCException
       Boolean ModuleSendAsync(const pegasus_module & 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 pegasus_module & handle,
                       Uint32 msg_handle,
                       Uint32 destination_q,
                       const String & destination_module,
                       AsyncRequest *message,
                       void *callback_parm);
   
       // @exception Permission
       // @exception IPCException
       Boolean ModuleSendForget(const pegasus_module & handle,
                       Uint32 destination_q,
                       AsyncRequest *message);
   
       // @exception Permission
       // @exception IPCException
       Boolean ModuleSendForget(const pegasus_module & handle,
                               Uint32 destination_q,                               Uint32 destination_q,
                               AsyncRequest *request) throw(Permission, IPCException);                      const String & destination_module,
                       AsyncRequest *message);
   
       // @exception Permission
       // @exception Deadlock
       // @exception IPCException
       void blocking_thread_exec(const pegasus_module & handle,
                       PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
                       void *parm);
   
       // @exception Permission
       // @exception Deadlock
       // @exception IPCException
       void async_thread_exec(const pegasus_module & handle,
                       PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
                       void *parm);
   
       Boolean verify_handle(pegasus_module *);
   
       static ModuleController* getModuleController();
   
       // send a message to another service
       // @exception Permission
       // @exception IPCException
       AsyncReply *ClientSendWait(
                       Uint32 destination_q, 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,      // @exception Permission
       // @exception Deadlock
       // @exception IPCException
       void client_blocking_thread_exec(
                                 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);
       void async_thread_exec(pegasus_module & handle,  
       // @exception Permission
       // @exception Deadlock
       // @exception IPCException
       void client_async_thread_exec(
                              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);
  
       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<pegasus_module, RecursiveMutex> * list)
              :_list(list)
           {
              _list->lock();
           }
   
           ~_module_lock()
           {
              _list->unlock();
           }
   
       private:
           _module_lock();
           List<pegasus_module, RecursiveMutex> * _list;
 }; };
  
  
  
       static void _async_handleEnqueue(AsyncOpNode *h, MessageQueue *q, void *parm);
       List<pegasus_module, RecursiveMutex> _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 *);
  
       void _blocking_thread_exec(
                   PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
                   void *parm);
  
 PEGASUS_NAMESPACE_END      void _async_thread_exec(
                   PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
                   void *parm);
   };
  
   PEGASUS_NAMESPACE_END
  
 #endif // Pegasus_Module_Controller_H #endif // Pegasus_Module_Controller_H


Legend:
Removed from v.1.16  
changed lines
  Added in v.1.47

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2