C语言的sleep、usleep、nanosleep等休眠函数的了解与用法

昨天晚上，无聊中捣鼓「死循环」小代码的时候，想用休眠函数来慢慢显示输出结果，免得输出结果闪得太快，看都看不清。

但是，使用 sleep 函数的话，最短的休眠时间段是一秒钟，要想看到比较大的输出结果的话，要等好久，于是就查了一下有没有休眠时间段更小的函数。很容易地就找到了两个，一个是 usleep ，一个是 nanosleep 函数。

因为是第一次使用，尤其是 nanosleep 函数的第一个参数是一个没见过的结构体数据类型，所以花了一点点时间去学习和探索背后的细节，当然了，对于俺目前的水平而言，也只是了解了函数本身层面的浅显的细节而已。

捣鼓下来，觉得内容也不少，而且还是挺有用的，就整理了一下，组合成文章，发布在这里，也方便自己以后的回顾学习。

引子

一个无聊的死循环小代码：

#include <stdio.h>

int main(int argc, char const *argv[])
{
	for (char c = 0; c < 128; c++) {
                printf("cool\n");
	}
	return 0;
}

以及运行过程展示版：

#include <stdio.h>
#include <time.h>
#include <stdlib.h>
#include <unistd.h>

int main(int argc, char const *argv[])
{
	struct timespec n_sleep;
	n_sleep.tv_sec = 0; //secondes, integer part sleep duration
	n_sleep.tv_nsec = 5e8L; //nanoseconds, decimal part sleep duration

	char c;
	for (c = 0; c < 128; c++) {
		printf("char of c :%c\n", c);
		printf("ASCII num of c :%d\n", c);
		sleep(1); // 1 s
        usleep(900000); // 0.9 s 
		nanosleep(&n_sleep, NULL); // 0 + 0.5 s
	}
	return 0;
}

另外，推荐一下 clang 这款编译器，

它的（1）错误、（2）警告提示非常直观、准确、体贴。
比如，上面的死循环代码，编译之后，它就贴心地显示了一个警告：

result of comparison of constant 128 with expression of type 'char' is always true
      [-Wtautological-constant-out-of-range-compare]
              for (c = 0; c < 128; c++) {
                        ~ ^ ~~~

强烈推荐啊！！！
当然，如果还是喜欢或者必须使用 gcc 的话，建议可以将 clang 作为一个辅助选项。

（一） sleep 函数

头文件 unistd.h

头文件 unistd.h 中的原文如下：

/* Make the process sleep for SECONDS seconds, or until a signal arrives
   and is not ignored.  The function returns the number of seconds less
   than SECONDS which it actually slept (thus zero if it slept the full time).
   If a signal handler does a `longjmp' or modifies the handling of the
   SIGALRM signal while inside `sleep' call, the handling of the SIGALRM
   signal afterwards is undefined.  There is no return value to indicate
   error, but if `sleep' returns SECONDS, it probably didn't work.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern unsigned int sleep (unsigned int __seconds);

通过debug的方式，进入 sleep 函数本体内部，可以反向查找到 sleep 函数所在的具体文件是 /glibc-2.23/sysdeps/posix/sleep.c 。

（根据gcc版本的不同，上面的库函数版本号 glibc-2.23 有所不同。）

源文件 sleep.c

sleep 函数的原型代码如下：

#include <time.h>
#include <unistd.h>
#include <errno.h>
#include <sys/param.h>

/* Make the process sleep for SECONDS seconds, or until a signal arrives
   and is not ignored.  The function returns the number of seconds less
   than SECONDS which it actually slept (zero if it slept the full time).
   If a signal handler does a `longjmp' or modifies the handling of the
   SIGALRM signal while inside `sleep' call, the handling of the SIGALRM
   signal afterwards is undefined.  There is no return value to indicate
   error, but if `sleep' returns SECONDS, it probably didn't work.  */
unsigned int __sleep(unsigned int seconds)
{
	int save_errno = errno;

	const unsigned int max =
		(unsigned int)(((unsigned long int)(~((time_t)0))) >> 1);
	struct timespec ts = { 0, 0 };
	do {
		if (sizeof(ts.tv_sec) <= sizeof(seconds)) {
			/* Since SECONDS is unsigned assigning the value to .tv_sec can
             overflow it.  In this case we have to wait in steps.  */
			ts.tv_sec += MIN(seconds, max);
			seconds -= (unsigned int)ts.tv_sec;
		} else {
			ts.tv_sec = (time_t)seconds;
			seconds = 0;
		}

		if (__nanosleep(&ts, &ts) < 0)
			/* We were interrupted.
           Return the number of (whole) seconds we have not yet slept.  */
			return seconds + ts.tv_sec;
	} while (seconds > 0);

	__set_errno(save_errno);

	return 0;
}
weak_alias(__sleep, sleep)

sleep 函数的用法

简单地说， sleep 函数实现的功能是让程序休眠若干秒钟，时间的最小刻度是「秒」。

extern unsigned int sleep (unsigned int __seconds);

sleep 函数的返回值，

（1）如果 sleep 函数顺利执行了的话，返回值是实际休眠的时间数，
（2）如果实际休眠的时间和设定的休眠时间一致的话，返回值是0,
（3）不会返回表示错误信息的值，但是如果返回的值与设定的休眠时间的值一样的话，很可能 sleep 函数其实并没有执行，
（4）返回值类型是 unsigned int 型，也就是说，是一个非负数。

sleep 函数的参数，

（1）参数的类型是 unsigned int 型，也就是说，是一个非负数，
（2）参数的时间单位是秒。

所以， sleep 函数，使进程/process 休眠的最短时间段，是一秒钟。

（二） usleep 函数

头文件 unistd.h

头文件 unistd.h 中的原文如下：

/* Sleep USECONDS microseconds, or until a signal arrives that is not blocked
   or ignored.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern int usleep (__useconds_t __useconds);

查找上面的 sleep.c 文件的时候，在 find 命令的结果中看到了 usleep.c 文件和 sleep.c 文件位于同一个文件夹：
/glibc-2.23/sysdeps/posix/sleep.c 。

（根据gcc版本的不同，上面的库函数版本号 glibc-2.23 有所不同。）

源文件 usleep.c

usleep 函数的原型代码如下：

#include <time.h>
#include <unistd.h>

int
usleep (useconds_t useconds)
{
  struct timespec ts = { .tv_sec = (long int) (useconds / 1000000),
			 .tv_nsec = (long int) (useconds % 1000000) * 1000ul };

  /* Note the usleep() is a cancellation point.  But since we call
     nanosleep() which itself is a cancellation point we do not have
     to do anything here.  */
  return __nanosleep (&ts, NULL);
}

名称 usleep 的第一个字母 u 代表的是时间单位微秒的第一个字母。
虽然实际上是希腊字母的 μ ，但英语键盘里不方便敲出这个字母，所以就用了样子相似的英文字母 u 。
时间单位微秒的英文单词是 microsecond ，是由词根 micro 和 second 组合而成的单词。
微秒是 10的负6次方秒。

另外，还有一个以字母 m 开头的时间单位的英文单词 millisecond ,意思是毫秒，也就是千分之一秒。
注意，区分 micro 和 milli ，一个是微，一个是毫。

usleep 函数的用法

简单地说， usleep 函数实现的功能是让程序休眠若干「微秒」，时间的最小刻度是「微秒」，10的负6次方秒。

/* Sleep USECONDS microseconds, or until a signal arrives that is not blocked
   or ignored.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern int usleep (__useconds_t __useconds);

usleep 函数的返回值

网上查到的是：成功返回0，出错返回-1。

usleep 函数的参数

（1）参数的类型是 __useconds_t ，这个类型的定义要查找好几个文件才找得到，
（2）首先是找到了头文件 types.h ，具体路径是 /glibc/include/sys/types.h ，可惜这里面没有明确、具体的定义，
（3）然后还得找到头文件 typesizes.h ，具体路径是 ==/glibc/sysdeps/mach/hurd/bits/typesizes.h ==，这里终于有了，
（4）第一个宏， #define __USECONDS_T_TYPE __U32_TYPE ，在 typesizes.h 文件里，
（5）第二个宏， #define __U32_TYPE unsigned int ，在 types.h 文件里，
（6）真是折腾啊！这下总算知道 __useconds_t 就是 unsigned int 类型了，也就是非负整数。
（7）参数的时间单位是微秒。

所以， usleep 函数，使进程/process 休眠的最短时间段，是一微秒。

（三） nanosleep 函数

头文件 time.h

这个 time.h 头文件的路径是 /glibc/time/time.h 。
在C语言自带的库目录里面，有好几个不同目录下的 time.h 文件，只有这个才是定义了 nanosleep 函数的。
也不知道，编译器在预处理阶段去获取的 time.h 到底是哪个？或者说，全部都获取过来了？

头文件 time.h 中的原文如下：

/* Pause execution for a number of nanoseconds.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern int nanosleep (const struct timespec *__requested_time,
		      struct timespec *__remaining);

函数名称的 nano 是纳米、纳秒等计量单位的开头字母，一纳秒是10的负9次方秒，是10的负6次方毫秒，是10的负3次方微秒。

源文件 nanosleep.c

下面是这个路径 /glibc/posix/nanosleep.c 的文件内容。

在C语言自带的函数库中搜索 nanosleep ，出来的结果同样有好几个，暂时分不清到底是哪个，先采用了这个。

nanosleep 函数的原型代码如下：

#include <errno.h>
#include <time.h>


/* Pause execution for a number of nanoseconds.  */
int
__nanosleep (const struct timespec *requested_time,
	     struct timespec *remaining)
{
  __set_errno (ENOSYS);
  return -1;
}
stub_warning (nanosleep)

hidden_def (__nanosleep)
weak_alias (__nanosleep, nanosleep)

nanosleep 函数的用法

简单地说， nanosleep 函数实现的功能是让程序休眠若干「纳秒」，时间的最小刻度是「纳秒」，10的负9次方秒。

/* Pause execution for a number of nanoseconds.

   This function is a cancellation point and therefore not marked with
   __THROW.  */
extern int nanosleep (const struct timespec *__requested_time,
		      struct timespec *__remaining);

nanosleep 函数的返回值

网上查到的是：成功返回0，出错返回-1。

这个函数功能是暂停某个进程直到你规定的时间后恢复，参数 req 就是你要暂停的时间，其中 req->tv_sec 是以秒为单位，而 tv_nsec 以纳秒为单位（10的-9次方秒）。

由于调用 nanosleep 是进程进入 TASK_INTERRUPTIBLE ，这种状态是会相应信号而进入 TASK_RUNNING 状态的，这就意味着有可能会没有等到你规定的时间就因为其它信号而唤醒，此时函数返回 -1 ，切换剩余的时间会被记录在 rem 中。

return值: 若进程暂停到参数 *req 所指定的时间，成功则返回0；若有信号中断则返回-1，并且将剩余微秒数记录在 *rem 中。

nanosleep 函数的参数

第一个参数 *__requested_time 的数据类型是 struct timespec ，定义在 time.h 文件中，

具体是定义在 /glibc/time/bits/types/struct_timespec.h 文件中的。
文件内容如下：

#include <bits/types.h>

/* POSIX.1b structure for a time value.  This is like a `struct timeval' but
   has nanoseconds instead of microseconds.  */
struct timespec
{
  __time_t tv_sec;		/* Seconds.  */
  __syscall_slong_t tv_nsec;	/* Nanoseconds.  */
};

对于 struct timespec 数据类型的详细说明如下：

（昨天晚上上网查资料、自行测试的时候，自己写的英文笔记，请忽略语法疏漏～）

in header file of C lib, time.h, declaration as below:
struct timespec; (since C11)

struct timespec {
	time_t tv_sec; // seconds
	long tv_nsec; // nanoseconds
};

Member objects / 结构体成员:
time_t tv_sec whole seconds (valid values are >= 0)
long tv_nsec nanoseconds (valid values are [0, 999999999])
time_t 类型是 long 型，成员 tv_sec 决定休眠持续时间段的整数部分：
member of 「tv_sec」 at the type of 「time_t」,
aka (also know as) 「long」 type,
determines the integer part of sleep duration;
time_t 类型是 long 型，成员 tv_nsec 决定休眠持续时间段的小数部分：
member of 「tv_nsec」 at the type of 「long」,
and in the range of [0, 999999999] or [0,1e9),
that means tv_nsec is forever less than 1 second,
determines the decimal part of sleep duration.
就算赋值给成员 tv_nsec 的数值直接计算下来超过了一秒，成员 tv_nsec 获得的实际的值也是被取余后的结果。
even if a value more than 999999999 ns given to tv_nsec,
actually what tv_nsec will get is a value cut down extra part,
eg. 1e9L or 100000000 will be cut the high bits and leave 0 to tv_nsec.
总而言之，整个的休眠时间段是整数部分的 tv_sec 加上小数部分的 tv_nsec 组成的。
so, the whole sleep duration is tv_sec + tv_nsec,
just as 「integer part + decimal part」 of the whole sleep duration.

所以， nanosleep 函数，使进程/process 休眠的最短时间段，是一纳秒。

注意

unistd.h 是 unix 系统标准头文件，用于系统调用，相当于 win32 中的 windows.h ， unistd.h 定义的函数只能用于 UNIX 环境中，而不能用于 windows 。
所以 sleep 和 usleep 只能用于 Linux / Unix 下，而不能用于 windows 。
nalosleep 和其它时间日期操作函数一样，都是定义在 time.h 中的，所以都适用。
使用 clang 编译c程序文件的时候，提示「警告」说， usleep 和 nanosleep 在 C99 中是非法的。不过因为实际采用的是 C11 标准，所以还是编译通过了，也能正常执行。这里只是 clang 的一个善意的提醒吧。