[源码分析][源码阅读]数据库代码阅读笔记_5

源代码链接地址


今天来看的源码文件是位于路径 src/include/ossUtil.hpp  头文件

/*******************************************************************************
   Copyright (C) 2013 SequoiaDB Software Inc.

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License, version 3,
   as published by the Free Software Foundation.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
   GNU Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program. If not, see <http://www.gnu.org/license/>.
*******************************************************************************/
#ifndef OSSUTIL_HPP__
#define OSSUTIL_HPP__
#include "core.hpp"
#include <boost/thread/thread.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/thread/xtime.hpp>
#if defined _WINDOWS
#include <TlHelp32.h>
#endif

#if defined _WINDOWS
/*
ossSleepmicros 该方法是用来让系统睡眠传入的时间的。
精准度达到纳秒级别； 如果操作系统是 windows 的话，
则会调用 boost 中的时间库函数
将传入的代表时间的数值 s(默认单位为微秒) 除以 10^6
得到的是以秒为单位的计数数值，将其赋值为 boost::xtime xt
用以计数 秒 的变量 xt.sec
同时将传入的数值 s 与 10^6 去余操作，得到的数值便是以纳秒
计数的时间，将其赋值到 boost::xtime xt ; 变量的
xt.nsec 字段上面
---------
然后在对 xt.nsec 进行进一步的细化计算，如果该数值 >= 10^6
那么将其每次 减去数值 10^6 然后对 xt.sec 进行加 1 进位
-----------------
最后调用 boost::thread::sleep 方法将创建好的时间计数结构体
xt (boost::xtime 类型) 传入，便是当前运行该方法的线程(进程)
将要睡眠的时间
*/

inline void ossSleepmicros ( unsigned int s )
{
   boost::xtime xt ;
   boost::xtime_get ( &xt, boost::TIME_UTC_ ) ;
   xt.sec += (int)(s/1000000) ;
   xt.nsec += (int)((s%1000000)*1000) ;
   if ( xt.nsec >= 1000000000 )
   {
      xt.nsec -= 1000000000 ;
      xt.sec ++ ;
   }
   boost::thread::sleep(xt) ;
}
#else
/*
 下面的这个方法是用在 linux/unix 操作系统中，对当前正在运行的
进程(线程)执行睡眠操作的方法，其计数精度为纳秒级别
  在该方法中，使用的计数数据结构为 struct timespec  ;
它的结构体定义代码如下：
// time.h

struct timespec
{
    time_t tv_sec ; // second
    long   tv_nsec ; // nano-second
} ;

方法 nanosleep 的函数原型定义如下：
int naosleep ( const struct timespec *req , struct timespec *rem ) ;

其中 传入的是指向 struct timespec 的指针；
 参数一 为需要当前线程睡眠的时间，
如果，当前的线程(进程) 的状态是可以被其他信号中断的，那么在 req 所指定的时间
到来之前该线程就会醒来 ；

在这种情况下，如果参数传入的数值不为 NULL，而同样的是一个 struct timespec 指针，
那么 nanosleep 将会把剩余的时间（秒+纳秒）按照 struct timespec 赋值给通过
值-地址 方式传入的参数 rem （remain - time）变量中，

这样调用该函数的使用者，可以通过参数1 来设定需要休眠的时间，而通过参数 2 来获知
按照规定的休眠的时间还剩余的时间

使用方法见下面的链接
*/
inline void ossSleepmicros ( unsigned int s )
{
   struct timespec t ;
   t.tv_sec = (time_t) (s/1000000) ;
   t.tv_nsec = 1000 * (s % 1000000 ) ;
   while ( nanosleep ( &t, &t )==-1 && errno==EINTR ) ;
}
#endif
/*
下面的方法也是用于为当前运行该方法的线程(进程) 来设定需要睡眠的时间的，
不过,传入的时间计数单位是 毫秒(milliseconds)
*/
inline void ossSleepmillis ( unsigned int s )
{
   ossSleepmicros ( s * 1000 ) ;
}

/*
    下面定义的方法是用来获取当前正在运行的线程(进程) 的ID号码
    以及它的父线程(进程)的 ID号码，
    windows 下面获取父线程（进程）有些麻烦，
    linux/unix 下面只需要一个方法即可
*/
#if defined _WINDOWS
typedef DWORD     OSSPID ;
typedef DWORD     OSSTID ;
#else
typedef pid_t     OSSPID ;
typedef pthread_t OSSTID ;
#endif
inline OSSPID ossGetParentProcessID ()
{
#if defined _WINDOWS
   OSSPID pid = -1 ;
   OSSPID ppid = -1 ;
   HANDLE hSnapshot = 0 ;
   PROCESSENTRY32 pe = {0} ;
   pe.dwSize = sizeof(PROCESSENTRY32) ;
   hSnapshot = CreateToolhelp32Snapshot ( TH32CS_SNAPPROCESS, 0 ) ;
   if ( hSnapshot == 0 )
       goto error ;
   pid = GetCurrentProcessId () ;
   if ( Process32First ( hSnapshot, &pe ) )
   {
     do
     {
         if ( pe.th32ProcessID == pid )
         {
               ppid = pe.th32ParentProcessID ;
               goto done ;
         }
     } while ( Process32Next ( hSnapshot, &pe ) ) ;
   }
done:
   return ppid ;
error :
   goto done ;
#else
   return getppid () ;
#endif
}

inline OSSPID ossGetCurrentProcessID ()
{
#if defined _WINDOWS
   return GetCurrentProcessId () ;
#else
   return getpid () ;
#endif
}

inline OSSTID ossGetCurrentThreadID ()
{
#if defined _WINDOWS
   return GetCurrentThreadId () ;
#else
   return syscall(SYS_gettid) ;
#endif
}

#endif

---

struct timeval 数据结构声明代码及即使用方法举例

struct timespec 数据结构声明代码及使用方法举例