Differences between revisions 3 and 7 (spanning 4 versions)
⇤ ← Revision 3 as of 2014-07-01 04:38:09 →
Size: 2493
Editor: HungTa
Comment:
← Revision 7 as of 2014-07-01 07:29:33 → ⇥
Size: 2287
Editor: HungTa
Comment:
Deletions are marked like this. Additions are marked like this.
Line 11: Line 11:
According to GNU weak attribute declaration, we can declare initialization functions as the weak linked functions. Therefore, their definitions can be omitted (in case they're not used), or replaced by different libraries (in case they're used). The linker will fill in NULL for undefined weak symbols.
Line 12: Line 13:
== Header ==
#include <clThreadPool.hxx>
== APIs ==		 === Header ===
#include <clGlobals.hxx>
=== APIs ===
Line 20: Line 21:
  // Definition of user task
  typedef void (*CallbackT) (void* invocation);
  typedef uint32_t (*UserCallbackT) (void* invocation);		   extern void utilsInitialize() __attribute__((weak));
  extern void logInitialize() __attribute__((weak));
  // TODO: other initialization functions declaration here
Line 24: Line 25:
  class Poolable: public Wakeable   enum
Line 26: Line 27:
  public:
    struct timespec m_startTime;
    struct timespec m_endTime;
    uint32_t m_executionTimeLimit;
    bool deleteWhenComplete; /** Flag that indicates this object should be deleted when it is finished running */

    Poolable(uint_t timeLimit=30000); /** by default allow a 30 second execution time */
    virtual void wake(int amt,void* cookie=NULL); /** Implement this virtual function to do the job */
    virtual ~Poolable();		     RPC=1,
    CKPT=2,
    IOC=4,
    UTILS=8,
    OSAL=16,
    LOG=32
Line 37: Line 35:
  class ThreadPool
    {
  protected:
    void createTask();
    void startNewTask();
    void taskEntry();

  protected:
    short m_minThread;
    short m_maxThread;
    short m_numIdleTasks;
    short m_flags;
    Mutex m_mutex;
    Wakeable preIdleFn;
    void* m_preIdleCookie;
    Wakeable onDeckFn;
    void* m_onDeckCookie;
    ThreadCondition m_cond;
    uint32_t m_pendingJobs;

  public:
    ThreadPool(uint_t minThreads, uint_t maxThreads); /* Initialize pool */

    /** Starts the thread pool running */
    void start();
    /** Stops the thread pool. All currently running threads complete their job and then exit */
    void stop();		   void safplusInitialize(uint16_t svc)
  {
    if(svc&LOG)
      if(logInitialize) logInitialize();
    if(svc&UTILS)
      if(utilsInitialize) utilsInitialize();
    // TODO: other ones here
  }
Line 65: Line 44:
    /** Adds a job into the thread pool. Poolable is NOT COPIED; do not delete or let it fall out of scope.
        A Poolable object is more sophisticated than a Wakeable; it measures how long it was run for, can track
        whether it should be deleted, and will ASSERT if it is running for longer than a configured limit (deadlock detector)
     */
    void run(Poolable* p,void* arg);

    /** Adds a job into the thread pool. Wakeable is NOT COPIED; do not delete or let it fall out of scope */
    void run(Wakeable* p,void* arg);

    ~ThreadPool(); /* Finalize pool */
    
  };
Line 80: Line 47:

=== Method 2: configuring the app with options ===
The idea is based on SAFplus 6. An app can be configured with options named svcs as 'log', 'utils', 'ioc'... or 'all' and pass it to an environment variable. Then, following its value, the preface.mk will define accordingly:
==== Makefile ====
include preface.mk

{{{#!highlight bash
$DSVCS:=
ifeq ($(SVCS),log)
       $DSVCS += -DLOG
ifeq ($(SVCS),utils)
       $DSVCS += -DUTILS
#...
LINK_EXE = g++ $DSVCS -g -O0 -fPIC $(LINK_FLAGS) -o
}}}

==== Header ====
#include <clGlobals.hxx>
==== APIs ====

{{{#!highlight cpp

namespace SAFplus
{

  enum
  {
    RPC=1,
    CKPT=2,
    IOC=4,
    UTILS=8,
    OSAL=16,
    LOG=32
  };

  void safplusInitialize(uint16_t svc)
  {
    if(svc&LOG)
#ifdef LOG
      logInitialize();
#endif
    if(svc&UTILS)
#ifdef UTILS
      utilsInitialize();
#endif
    // TODO: other ones here
  }
    
}

}}}

SAFplus initialization

SAFplus provides library initialization infrastructure: log, utils, osal, timer... They're the basic libraries that most applications should use. However, not all of them would be used. Furthermore, it's necessary to be able to explicitly link individual libraries for highly embedded users.

Implementation

SAFplus initialization can be implemented in 2 methods:

According to GNU weak attribute declaration, we can declare initialization functions as the weak linked functions. Therefore, their definitions can be omitted (in case they're not used), or replaced by different libraries (in case they're used). The linker will fill in NULL for undefined weak symbols.

#include <clGlobals.hxx>

APIs

   1 namespace SAFplus
   2 {
   3   extern void utilsInitialize() __attribute__((weak));
   4   extern void logInitialize() __attribute__((weak));
   5   // TODO: other initialization functions declaration here
   6 
   7   enum
   8   {
   9     RPC=1,
  10     CKPT=2,
  11     IOC=4,
  12     UTILS=8,
  13     OSAL=16,
  14     LOG=32
  15   };
  16 
  17   void safplusInitialize(uint16_t svc)
  18   {
  19     if(svc&LOG)
  20       if(logInitialize) logInitialize();
  21     if(svc&UTILS)
  22       if(utilsInitialize) utilsInitialize();
  23     // TODO: other ones here
  24   }
  25     
  26 }

Method 2: configuring the app with options

The idea is based on SAFplus 6. An app can be configured with options named svcs as 'log', 'utils', 'ioc'... or 'all' and pass it to an environment variable. Then, following its value, the preface.mk will define accordingly:

Makefile

include preface.mk 

   1 $DSVCS:=
   2 ifeq ($(SVCS),log)
   3        $DSVCS += -DLOG
   4 ifeq ($(SVCS),utils)
   5        $DSVCS += -DUTILS
   6 #...
   7 LINK_EXE    = g++ $DSVCS -g -O0 -fPIC $(LINK_FLAGS) -o

Header

#include <clGlobals.hxx>

APIs

   1 namespace SAFplus
   2 {
   3 
   4   enum
   5   {
   6     RPC=1,
   7     CKPT=2,
   8     IOC=4,
   9     UTILS=8,
  10     OSAL=16,
  11     LOG=32
  12   };
  13 
  14   void safplusInitialize(uint16_t svc)
  15   {
  16     if(svc&LOG)
  17 #ifdef LOG
  18       logInitialize();
  19 #endif
  20     if(svc&UTILS)
  21 #ifdef UTILS
  22       utilsInitialize();
  23 #endif
  24     // TODO: other ones here
  25   }
  26     
  27 }

SAFplus: SAFplus-initialization (last edited 2014-07-22 14:00:44 by AndrewStone)