python源码剖析—— 初识 PyIntObject 对象

1. 初识 PyIntObject 对象

[intobject.h]
typedef struct {
	PyObject_HEAD
    long ob_ival;
} PyIntObject

首先，PyIntObject是一个不可变（immutable）对象。其次，Python内部也大量的使用整数对象，我们在自己的代码中也会有大量的创建销毁整型对象的操作，因此单独的维护整形对象并对其申请内存和释放内存是不现实的。Python给出的解决方案是将整形对象通过一定的结构连接在一起的整数对象系统：整数对象池，一个整形对象的缓冲池机制。

Python的实现中，对某些可能频繁执行的代码，都会提供函数和宏两个版本。**宏版本节省了一次函数调用的开销但是牺牲了类型安全。**对于PyIntObject的操作，像前面说的，定义在该类型对象的函数指针中。特别注意的是，tp_as_number指针存放的是int_as_number结构体的地址，在 python2.5 中，该结构体包含了39个PyNumberMethods要求的函数指针，但是不是每个指针都有定义，部分为NULL。

另一个有趣的元信息是对象的文档，这个元信息维护在int_doc域中，文档无缝集成在语言的实现中，这一点是Python相对其他语言的一大特点。

2. PyIntObject 对象的创建和维护

2.1 对象创建的三种途径

1. PyInt_FromString
2. PyInt_FromLong
3. PyInt_FromUnicode

其中，后两种方法实际上是先转换成浮点数,然后再调用PyInt_FromFloat，这实际上是 Adaptor Pattern 的思想：对核心函数进行接口转换。

2.2 小整数对象

想一想 C 语言中的 for 循环,就可以了解这些小整数会有多么频繁的使用场合。在 Python 中,所有的对象都是存活在系统堆上。这样的操作不仅大大降低了运行效率,而且会在系统堆上造成内存碎片。

所以解决方法就是对小整数使用对象池技术，正是因为使用缓冲池，PyIntObject才是不可变对象。想一下这是为什么？

**原因在于：对象池中的每一个对象可以被安全的共享。**那么，多小才算小整数？默认的范围是-5到256，这个值不可以动态修改，要想修改只能修改源代码然后重新编译。

2.3 大整数对象

对于大整数对象，是一次申请一块内存，这块内存用PyIntBlock结构体管理，该结构体中中有一个PyIntObject数组（会链表形式维护）来供大整数对象使用，还有一个用于形成链表的指向下一个block的指针。如果这一整块内存都祸祸光了（默认一个block可以存放82个int对象），就再申请一个PyIntBlock，然后用一个单向链表维护所有的PyIntBlock，这个链表就是大整数对象缓冲池两个重要变量其中之一：block_list指针。

另一个是干啥的稍微一想就能想到：这个 block 链表维护的是一整块block，是block级别的，我要使用的是PyIntObject，每次使用的话总不能进到block去遍历数组去找到一个还没使用的PyIntObject吧，所以下一个大整数缓冲池至关重要的变量就是free_list指针，这个指向一个链表，链表中的所有元素是PyIntObject。注意这两个链表的元素不是一个级别。虚拟机刚启动时，两个指针均为空。

需要注意的是PyIntObject中没有预先定义的供链表使用的next指针，这里借用了ob_type作为链表指针，因为我们知道在这个链表中拿到的对象都是用于实例化 int 对象的。

2.4 添加和删除

插图配源码，效果一顶俩。

[intobject.c]
PyObject* PyInt_FromLong(long ival)
{
	register PyIntObject *v;
#if NSMALLNEGINTS + NSMALLPOSINTS > 0
	//尝试使用小整数池
	if (-NSMALLNEGINTS <= ival && ival < NSMALLPOSINTS) {
		v = small_ints[ival + NSMALLNEGINTS];
		Py_INCREF(v);
		return (PyObject *) v;
	}
#endif
	// 如果必要，申请block
	if (free_list == NULL) {
		if ((free_list = fill_free_list()) == NULL)
			return NULL;
	}
	// 初始化
	v = free_list;
	free_list = (PyIntObject *)v->ob_type;
	PyObject_INIT(v, &PyInt_Type);
	v->ob_ival = ival;
	return (PyObject *) v;
}

[intobject.c]
static PyIntObject* fill_free_list(void)
{
	PyIntObject *p, *q;
    // malloc空间
	p = (PyIntObject *) PyMem_MALLOC(sizeof(PyIntBlock));
	if (p == NULL)
		return (PyIntObject *) PyErr_NoMemory();
    // 链接block_list
	((PyIntBlock *)p)->next = block_list;
	block_list = (PyIntBlock *)p;
    // （自后向前）链接free_list
	p = &((PyIntBlock *)p)->objects[0];
	q = p + N_INTOBJECTS;
	while (--q > p)
		q->ob_type = (struct _typeobject *)(q-1);
	q->ob_type = NULL;
	return p + N_INTOBJECTS - 1;
}

因此，结合源码，申请PyIntObject的完整流程是：

1. 如果是小整数，直接返回小整数对象，增加引用计数，返回。
2. 如果没有可用空间，申请block，初始化block，把block中的对象数组链接到free_list中。
3. 当必要的空间被申请之后,将会把当前可用的 Block 中的内存空间划出一块,将在这块内存上创建我们需要的 PyIntObject 对象,同时,还会调整完成必要的初始化工作,以及调整 free_list 指针,使其指向下一块还没有被占用的内存。
   
   

注意，新申请的 block 在链表头，这样做的原因是考虑到链表的插入效率。

如果操作系统学得不错，对于管理存储空间比较熟悉，立刻就会发现还有一点没有实现，就是内存的释放与回收。既然free_list管理所有可用的PyIntObject，那么在对象回收的时候，应该将其链接回free_list。

[intobject.c]
static void int_dealloc(PyIntObject *v)
{
	if (PyInt_CheckExact(v)) {
    	// 链到free_list头
		v->ob_type = (struct _typeobject *)free_list;
		free_list = v;
	}
	else
    	// 如果删除的是int派生类的对象，调用其类型对象的方法
        // (可能在free函数中实现一些自定义功能)
		v->ob_type->tp_free((PyObject *)v);
}

这样一来，本来在各个 block 中的隔断的对象数组也会在回收阶段被free_list连接起来。

一个小小的内存问题是，这些 block 在本次执行结束前，不会交还给系统堆。一个PyIntObject对象的大小是12字节，需要89478486个对象就可以消耗1G内存。

2.5 小整数对象池的初始化

从前面为PyIntObject申请空间的源码中可以看到，small_ints就是小整数池，其实一个数组，维护着所有小整数的指针。小整数池的初始化，在Python初始化的时候会自动调用，而其使用的空间也是PyIntBlock中的对象数组。

[intobject.c]
int _PyInt_Init(void)
{
	PyIntObject *v;
	int ival;
	#if NSMALLNEGINTS + NSMALLPOSINTS > 0
	for (ival = -NSMALLNEGINTS; ival < NSMALLPOSINTS; ival++)
	{
		if (!free_list && (free_list = fill_free_list()) == NULL)
			return 0;
		/* PyObject_New is inlined */
		v = free_list;
		free_list = (PyIntObject *)v->ob_type;
		PyObject_INIT(v, &PyInt_Type);
		v->ob_ival = ival;
		small_ints[ival + NSMALLNEGINTS] = v;
}
#endif
return 1;
}

综上所述，Python 中的PyIntObject构成了一个整数系统，其下有两个“部门”，一个是静态对象池，一个是动态缓冲池，两个池的管理使用两个不同级别的指针block_list和free_list来统一管理，内存使用的基本单元是PyIntObject。

Hack PyIntObject

（略略略）

---

参考：

1. Python源码剖析（陈孺）