Darwin中OSRef和OSHashTable类的使用

//哈希表被设计成模版类的形式

#include "../WinNTSupport/Win32header.h"


#include <iostream>
using namespace std;
#include <string>




#include <OSCond.h>
#include <OSRef.h>
#include "getopt.h"
#include "FilePrefsSource.h"


#include "RunServer.h"
#include "QTSServer.h"
#include "QTSSExpirationDate.h"
#include "GenerateXMLPrefs.h"




// #include "OSHashTable.h"
#include "MyAssert.h"
typedef OSHashTable<OSRef, OSRefKey> OSRefHashTable;
typedef OSHashTableIter<OSRef,OSRefKey> OSRefHashTableIter;
int main(int argc, char * argv[]) 
{
  OSRefHashTable fTable(1000);
for (int i=0; i< 5 ;i ++)
{
  char *buf = new char[100];
memset(buf,0,100);
  sprintf(buf,"%d%d%d%d",i,i,i,i);
StrPtrLen ptr(buf);

OSRef *fRef = new OSRef;
fRef->Set(ptr,NULL);
OSRefKey key(fRef->GetString());
OSRef* duplicateRef = fTable.Map(&key);
if (duplicateRef != NULL)
{
continue;
}
fTable.Add(fRef);
}


OSRefHashTableIter tableIter(&fTable);
OSRef *pTemp = NULL;
while((pTemp = tableIter.GetCurrent()) != NULL)
{
char *pbuf  = pTemp->GetString()->GetAsCString();
cout << pbuf <<"   index:"<<tableIter.GetCurIndex()<< endl;
tableIter.Next();
}


return 0;
}

template<class T, class K>
class OSHashTable {
public:
   OSHashTable( UInt32 size ) //构造函数
    {
       fHashTable = new ( T*[size] );//初始化大小
       Assert( fHashTable );
       memset( fHashTable, 0, sizeof(T*) * size );//设置初始值
       fSize = size;
        /*下面的代码决定用哪种方式为哈希表的键值计算索引；
如果哈希表的大小不是2的幂，只好采用对fSize求余的方法；
否则可以直接用掩码的方式，这种方式相对速度更快*/      
 fMask = fSize - 1;
        if((fMask & fSize) != 0)//判断是不是2的幂，确定使用何种哈希函数（ComputeIndex）
           fMask = 0;
       fNumEntries = 0;
    }
   ~OSHashTable() //析构
    {
       delete [] fHashTable;
    }
    voidAdd( T* entry ) { //加入元素，有标记代码可以看出，此处解决冲突的方式采用了链地址法
       Assert( entry->fNextHashEntry == NULL );
        Kkey( entry );
       UInt32 theIndex = ComputeIndex( key.GetHashKey() );
        entry->fNextHashEntry = fHashTable[theIndex ];
       fHashTable[ theIndex ] = entry;
       fNumEntries++;
    }
    voidRemove( T* entry )//移除元素
    {
        Kkey( entry );
       UInt32 theIndex = ComputeIndex( key.GetHashKey() );
        T*elem = fHashTable[ theIndex ];
        T*last = NULL;
       while (elem && elem != entry) {
           last = elem;
           elem = elem->fNextHashEntry;
        }
   
        if( elem ) // sometimes remove is called 2x ( swap, then un register )
        {
           Assert(elem);
           if (last)
               last->fNextHashEntry = elem->fNextHashEntry;
           else
                fHashTable[ theIndex ] =elem->fNextHashEntry;
           elem->fNextHashEntry = NULL;
           fNumEntries--;
        }
    }
    T* Map(K* key ) //查找对象
    {
       UInt32 theIndex = ComputeIndex( key->GetHashKey() );
        T*elem = fHashTable[ theIndex ];
       while (elem) {
           K elemKey( elem );
           if (elemKey == *key)
               break;
           elem = elem->fNextHashEntry;
        }
       return elem;
    }
    UInt64GetNumEntries() { return fNumEntries; }
   
    UInt32GetTableSize() { return fSize; }
    T*GetTableEntry( int i ) { return fHashTable[i]; }
 
private:
    T**fHashTable;
    UInt32fSize;
    UInt32fMask;
    UInt64fNumEntries;
    UInt32 ComputeIndex(UInt32 hashKey )
   {
       if (fMask)
            return( hashKey & fMask );//掩码方式
       else
            return( hashKey % fSize );// 除留取余法
   }
};
//实现了一个hash表迭代器的功能
template<class T, class K>
class OSHashTableIter {
public:
   OSHashTableIter( OSHashTable<T,K>* table )
    {
       fHashTable = table;
       First();
    }
    voidFirst()
    {
        for(fIndex = 0; fIndex < fHashTable->GetTableSize(); fIndex++) {
           fCurrent = fHashTable->GetTableEntry( fIndex );
           if (fCurrent)
               break;
        }
    }
    voidNext()
    {
       fCurrent = fCurrent->fNextHashEntry;
        if(!fCurrent) {
           for (fIndex = fIndex + 1; fIndex < fHashTable->GetTableSize();fIndex++) {
                fCurrent =fHashTable->GetTableEntry( fIndex );
               if (fCurrent)
                    break;
           }
        }
    }
    Bool16IsDone()
    {
       return( fCurrent == NULL );
    }
    T*GetCurrent() { return fCurrent; }
   
private:
   OSHashTable<T,K>* fHashTable;
    T*fCurrent;
    UInt32fIndex;

[html]  view plain  copy

1. class OSRefKey;  
2. class OSRefTableUtils  
3. {  
4.    private:  
5.        static UInt32  HashString(StrPtrLen* inString);     
6.        friend class OSRef;  
7.        friend class OSRefKey;  
8. };  
9. class OSRef  
10. {  
11.     public:  
12.        OSRef() :   fObjectP(NULL),fRefCount(0), fNextHashEntry(NULL)  
13.            {      
14.            }  
15.        OSRef(const StrPtrLen &inString, void* inObjectP)  
16.                                 : fRefCount(0),fNextHashEntry(NULL)  
17.                                     {   Set(inString, inObjectP); }  
18.        ~OSRef() {}  
19.         void Set(const StrPtrLen& inString,void* inObjectP)  
20.            {       
21.                fString = inString; fObjectP = inObjectP;  
22.                fHashValue = OSRefTableUtils::HashString(&fString);  
23.            }  
24.        void**  GetObjectPtr()  { return &fObjectP; }  
25.        void*   GetObject()     { return fObjectP; }  
26.        UInt32  GetRefCount()   { return fRefCount; }  
27.        StrPtrLen *GetString()  { return&fString; }  
28.    private:  
29.        //value  
30.        void*   fObjectP;  
31.        //key  
32.        StrPtrLen   fString;  
33.        //refcounting  
34.         UInt32  fRefCount;  
35. #if DEBUG  
36.        Bool16  fInATable;  
37.        Bool16  fSwapCalled;  
38. #endif  
39.        OSCond  fCond;//to block threadswaiting for this ref.  
40.        UInt32              fHashValue;  
41.        OSRef*             fNextHashEntry;  
42.         friend class OSRefKey;  
43.        friend class OSHashTable<OSRef, OSRefKey>;  
44.        friend class OSHashTableIter<OSRef, OSRefKey>;  
45.        friend class OSRefTable;  
46. };  
47. class OSRefKey  
48. {  
49. public:  
50.    //CONSTRUCTOR / DESTRUCTOR:  
51.    OSRefKey(StrPtrLen* inStringP)  
52.        :   fStringP(inStringP)  
53.          {fHashValue = OSRefTableUtils::HashString(inStringP); }  
54.    ~OSRefKey() {}  
55.    //ACCESSORS:  
56.    StrPtrLen*  GetString()         { return fStringP; }  
57. private:  
58.    //PRIVATE ACCESSORS:     
59.    SInt32      GetHashKey()        { return fHashValue; }  
60.     //thesefunctions are only used by the hash table itself. This constructor  
61.     //willbreak the "Set" functions.  
62.    OSRefKey(OSRef *elem) : fStringP(&elem->fString),  
63.                            fHashValue(elem->fHashValue) {}                    
64.     friendint operator ==(const OSRefKey &key1, const OSRefKey &key2)  
65.     {  
66.         if(key1.fStringP->Equal(*key2.fStringP))  
67.            return true;  
68.        return false;  
69.     }  
70.     //data:  
71.    StrPtrLen *fStringP;  
72.    UInt32  fHashValue;  
73.     friendclass OSHashTable<OSRef, OSRefKey>;  
74. };  
75. typedef OSHashTable<OSRef, OSRefKey>OSRefHashTable;  
76. typedef OSHashTableIter<OSRef, OSRefKey>OSRefHashTableIter;  
77. class OSRefTable  
78. {  
79.     public:  
80.        enum  
81.         {  
82.            kDefaultTableSize = 1193 //UInt32  
83.         };  
84.        //tableSize doesn't indicate the max number of Refs that can be added  
85.        //(it's unlimited), but is rather just how big to make the hash table  
86.        OSRefTable(UInt32 tableSize = kDefaultTableSize) : fTable(tableSize),fMutex() {}  
87.        ~OSRefTable() {}  
88.        //Allows access to the mutex in case you need to lock the table down  
89.        //between operations  
90.        OSMutex*    GetMutex()      { return &fMutex; }  
91.        OSRefHashTable* GetHashTable() { return &fTable;   
92.        //Registers a Ref in the table. Once the Ref is in, clients may resolve  
93.        //the ref by using its string ID. You must setup the Ref before passingit  
94.        //in here, ie., setup the string and object pointers  
95.        //This function will succeed unless the string identifier is not unique,  
96.        //in which case it will return QTSS_DupName  
97.         //This function is atomic wrt this reftable.  
98.        OS_Error        Register(OSRef*ref);  
99.         //RegisterOrResolve  
100.         //If the ID of the input ref is unique, this function is equivalent to  
101.         //Register, and returns NULL.  
102.         // If there is a duplicate ID already inthe map, this funcion  
103.         //leave it, resolves it, and returns it.  
104.        OSRef*             RegisterOrResolve(OSRef* inRef);  
105.        //This function may block. You can only remove a Ref from the table  
106.        //when the refCount drops to the level specified. If several threadshave  
107.        //the ref currently, the calling thread will wait until the otherthreads  
108.        //stop using the ref (by calling Release, below)  
109.        //This function is atomic wrt this ref table.  
110.        void        UnRegister(OSRef* ref,UInt32 refCount = 0);  
111.         //Same as UnRegister, but guarenteed not to block. Will return  
112.         //true if ref was sucessfully unregistered, false otherwise  
113.        Bool16      TryUnRegister(OSRef*ref, UInt32 refCount = 0);  
114.        //Resolve. This function uses the provided key string to identify andgrab  
115.        //the Ref keyed by that string. Once the Ref is resolved, it is safe touse  
116.        //(it cannot be removed from the Ref table) until you call Release.Because  
117.        //of that, you MUST call release in a timely manner, and be aware ofpotential  
118.        //deadlocks because you now own a resource being contended over.  
119.        //This function is atomic wrt this ref table.  
120.        OSRef*     Resolve(StrPtrLen*  inString);  
121.        //Release. Release a Ref, and drops its refCount. After calling this,the  
122.        //Ref is no longer safe to use, as it may be removed from the ref table.  
123.         void       Release(OSRef*  inRef);  
124.         //Swap. This atomically removes any existing Ref in the table with the new  
125.         //ref's ID, and replaces it with this new Ref. If there is no matching Ref  
126.         //already in the table, this function does nothing.  
127.         //  
128.         //Be aware that this creates a situation where clients may have a Ref resolved  
129.         //that is no longer in the table. The old Ref must STILL be UnRegisterednormally.  
130.         //Once Swap completes sucessfully, clients that call resolve on the ID will get  
131.         //the new OSRef object.  
132.        void        Swap(OSRef* newRef);  
133.        UInt32      GetNumRefsInTable() {UInt64 result =  fTable.GetNumEntries();Assert(result < kUInt32_Max); return (UInt32) result; }  
134.    private:  
135.        //all this object needs to do its job is an atomic hashtable  
136.        OSRefHashTable  fTable;  
137.        OSMutex         fMutex;  
138. };  
139. class OSRefReleaser  
140. {  
141.     public:  
142.        OSRefReleaser(OSRefTable* inTable, OSRef* inRef) : fOSRefTable(inTable),fOSRef(inRef) {}  
143.        ~OSRefReleaser() { fOSRefTable->Release(fOSRef); }  
144.        OSRef*          GetRef() { returnfOSRef; }  
145.    private:  
146.        OSRefTable*     fOSRefTable;  
147.        OSRef*          fOSRef;  
148. };  
149.    

};

 

引用表头文件定义，详细的代码请参考源码，此处只结合实例讲解几个主要的函数

//结合实例说明常用的方法

服务器网络模型中有个很重要的类EventContext, EventContext.h中包含EventContext类和EventThread类的定义

每一个EventContext类中都有一个引用对象，如下图

在每次执行RequestEvent函数时，就会执行以下代码（EventContext.cpp182行）

if (!compare_and_store(8192, WM_USER,&sUniqueID))

           fUniqueID = (PointerSizedInt)atomic_add(&sUniqueID, 1);      //获取一个唯一标识  

fRef.Set(fUniqueIDStr, this);//对引用对象赋值

void Set(const StrPtrLen&inString, void* inObjectP)

            {

                fString = inString; fObjectP =inObjectP;

                fHashValue =OSRefTableUtils::HashString(&fString);

            }

fString作为索引，fObjectP保存对象，fHashValue根据索引计算出一个hash值

fEventThread->fRefTable.Register(&fRef);//把这个引用对象加入到EventThread中的引用表中（其实就是hash表），fRefTable是OSRefTable类的实例，而类中操作的表是OSRefHashTable类型（typedef OSHashTable<OSRef, OSRefKey>OSRefHashTable;）

OS_ErrorOSRefTable::Register(OSRef* inRef)

{

       if (inRef == NULL)

        return EPERM;

   OSMutexLocker locker(&fMutex);

   if (inRef->fString.Ptr == NULL || inRef->fString.Len == 0)

   {         return EPERM;

   }

   // Check for a duplicate. In this function, if there is a duplicate,

   // return an error, don't resolve the duplicate

   OSRefKey key(&inRef->fString);

   OSRef* duplicateRef = fTable.Map(&key);//查找有没有重复的，没有则加入到hash表中

   if (duplicateRef != NULL)

        return EPERM;

       

   // There is no duplicate, so add this ref into the table

   fTable.Add(inRef);

   return OS_NoErr;

}

::memset( &fEventReq, '\0',sizeof(fEventReq));//下面的代码其实就是把socket加入到select监视中，由于本文主要讲解下引用表相关类的使用，所以此处不再详细描述

 fEventReq.er_type = EV_FD;

 fEventReq.er_handle = fFileDesc;

 fEventReq.er_eventbits = theMask;

 fEventReq.er_data = (void*)fUniqueID;

if (select_watchevent(&fEventReq, theMask) !=0)

 

========以上代码描述了构造一个ref，然后加入reftable中的操作

 

在EventThread的线程执行函数Entry中，使用了reftable查找EventContext对象

当select返回一个可操作的socket时，执行了以下代码，

if (theCurrentEvent.er_data != NULL)// theCurrentEvent就是select返回的数据

        {

        

           StrPtrLen idStr((char*)&theCurrentEvent.er_data,sizeof(theCurrentEvent.er_data));

//返回的数据用于构造一个id，这个id其实就是在上一步中得到的唯一标识，如下图

           OSRef* ref = fRefTable.Resolve(&idStr);//根据这个唯一标识获取到引用对象，其实就是通过hash类中map函数去查找对象，然后把引用对象的引用计数+1

           if (ref != NULL)

           {

               EventContext* theContext = (EventContext*)ref->GetObject();

               theContext->ProcessEvent(theCurrentEvent.er_eventbits);

               fRefTable.Release(ref);//把引用对象的引用计数-1，然后设置事件为有信号，确保唤醒等待该资源被释放的对象

           }

        }

以上说明是通过darwin中一个使用实例，为了方面理解引用表和哈希表的使用（OSRef和OSHashTable）