Skip to content

Latest commit

 

History

History
391 lines (229 loc) · 19.2 KB

lab2-doc.md

File metadata and controls

391 lines (229 loc) · 19.2 KB

实验二指导文档

在本实验中,学生需要实现存储系统中的索引管理器,它主要由IxManager类、IxIndexHandle类、IxNodeHandle类、IxScan类组成。本实验将索引的底层数据结构选取为B+树。

  • IxManager类提供了创建/打开/关闭/删除索引文件的接口,其内部实现调用了实验一实现的DiskManagerBufferPoolManager类的接口。

  • IxIndexHandle类用于实现B+树的基本功能,且支持并发。每个IxIndexHandle对应一个索引文件,当IxManager执行打开文件操作时,便会创建一个指向IxIndexHandle的指针。

  • IxNodeHandle类用于实现B+树的单个结点的基本功能,方便IxIndexHandle类进行调用。

  • IxScan类用于遍历叶子结点。

其中,学生只要实现IxIndexHandleIxNodeHandle中的接口。已提供其他类的完整源码。

B+树的结构如图:

B+树的结构

注意:

(1)本系统设计的B+树索引不支持重复键,即唯一索引(索引列不包含重复的值)。

(2)结点能容纳的键值对数量小于最大值,大于等于最小值。这相当于留出了一个多余的空位,方便B+树进行插入和删除操作。

(3)在上图中,value的数量比key的数量多一个,而为了体现”键值对“的概念,实际上应该将key和value的数量设为相等。为了做到这一点,在每个内部结点的第一个值前面额外加上第一个键,这样就能让键和值的数量保持一致,即具有 k+1 个键的内部结点能索引 k+1 个子树。这个键(内部结点的第一个键)存储的key设置为其第一个孩子结点的第一个key,当结点分裂或合并时,可能需要更新其信息;同样地,在每个叶子结点的第一个值前面也额外加上第一个键,它存储当前结点中插入的最小key。(每个结点的第一个key,存储的都是以该结点为根结点的子树中的所有key的最小值

辅助函数说明

本实验提供一些已经实现好的辅助函数,学生无需实现,可以阅读其实现,并调用其功能。

(1)IxNodeHandle类的辅助函数:

class IxNodeHandle {
    // 辅助函数(本实验提供,无需实现)
    char *get_key(int key_idx) const;
    Rid *get_rid(int rid_idx) const;
}
  • char *get_key(int key_idx) const;

​ 得到键数组中指定位置的地址。

  • Rid *get_rid(int rid_idx) const;

​ 得到值数组中指定位置的地址。

(2)IxIndexHandle类辅助函数:

class IxIndexHandle {
    // 辅助函数(本实验提供,无需实现)
    IxNodeHandle *FetchNode(int page_no) const;
    IxNodeHandle *CreateNode();
    void maintain_parent(IxNodeHandle *node);
    void maintain_child(IxNodeHandle *node, int child_idx);
    void erase_leaf(IxNodeHandle *leaf);
    void release_node_handle(IxNodeHandle &node);
}
  • IxNodeHandle *FetchNode(int page_no) const;

​ 用于获取指定页面对应的IxNodeHandle

  • IxNodeHandle *CreateNode();

​ 用于创建一个IxNodeHandle

  • void maintain_parent(IxNodeHandle *node);

    用于从node开始更新其父节点的第一个key,一直向上更新直到根节点。

  • void maintain_child(IxNodeHandle *node, int child_idx);

    用于将node的第child_idx个孩子结点的父结点指针置为node

  • void erase_leaf(IxNodeHandle *leaf);

    用于删除leaf之前,更新其前驱结点和后继结点的prev_leafnext_leaf指针。

  • void release_node_handle(IxNodeHandle &node);

    用于删除node之后,更新索引头记录的页面个数信息。

(3)int ix_compare(const char *a, const char *b, ColType type, int col_len);

​ 用于比较两个key的大小,key所占长度为col_len。key的类型支持 int * / float * / char *(即字段支持的类型)。

任务1 B+树的查找

(1)结点内的查找

class IxNodeHandle {
    // 结点内的查找
    int lower_bound(const char *target) const;
    int upper_bound(const char *target) const;
    bool LeafLookup(const char *key, Rid **value);
    page_id_t InternalLookup(const char *key);
}

为了实现整个B+树的查找,首先需要实现B+树单个结点内部的查找。

学生需要实现以下函数:

  • int lower_bound(const char *target) const;

    用于在当前结点中查找第一个大于或等于target的key的位置。

  • int upper_bound(const char *target) const;

    用于在当前结点中查找第一个大于target的key的位置。

提示:获得key需要调用get_key()函数;在比较key大小时需要调用ix_compare()函数;B+树中每个结点的键数组是有序的,可用二分查找。

  • bool LeafLookup(const char *key, Rid **value);

​ 用于叶子结点根据key来查找该结点中的键值对。值value作为传出参数,函数返回是否查找成功。

​ 提示:可以调用lower_bound()get_rid()函数。

  • page_id_t InternalLookup(const char *key);

​ 用于内部结点根据key来查找该key所在的孩子结点(子树)。

​ 值value为Rid类型,对于内部结点,其Rid中的page_no表示指向的孩子结点的页面编号。而内部结点每个key右边的value指向的孩子结点中的键均大于等于该key,每个key左边的value指向的孩子结点中的键均小于该key。根据这一特性,思考如何找到key所在的孩子结点。

​ 提示:可以调用upper_bound()get_rid()函数。

(2)B+树的查找

class IxIndexHandle {
    // B+树的查找
    IxNodeHandle *FindLeafPage(const char *key, Operation operation, Transaction *transaction);
    bool GetValue(const char *key, std::vector<Rid> *result, Transaction *transaction);
}

学生需要实现以下函数:

  • IxNodeHandle *FindLeafPage(const char *key, Operation operation, Transaction *transaction);

​ 用于查找指定键所在的叶子结点。

​ 从根结点开始,不断向下查找孩子结点,直到找到包含该key的叶子结点。

operation表示上层调用此函数时进行的是何种操作(因为查找/插入/删除均需要查找叶子结点)。

​ 提示:可以调用FetchNode()InternalLookup()函数。

  • bool GetValue(const char *key, std::vector<Rid> *result, Transaction *transaction);

    用于查找指定键在叶子结点中的对应的值result

    提示:可以调用FindLeafPage()LeafLookup()函数。

任务2 B+树的插入

(1)结点内的插入

class IxNodeHandle {
    // 结点内的插入
    void insert_pairs(int pos, const char *key, const Rid *rid, int n);
    int Insert(const char *key, const Rid &value);
}

学生需要实现以下函数:

  • void insert_pairs(int pos, const char *key, const Rid *rid, int n);

​ 用于在结点中的指定位置插入多个键值对。

​ 该函数插入指定n个单位长度的键值对数组(key,rid)到结点中的指定位置pos。其中key为键数组的首地址,其每个单位长度为file_hdr->col_lenrid为值数组的首地址,其每个单位长度为sizeof(Rid)。这里内部存储结构是键数组和值数组连续存储,即键数组的后面存储了值数组。

​ 对于该操作的内部实现逻辑,可以先将数组中原来从第pos位开始到其后n位的数据移到末尾,再将要插入的数组移到pos位之后。注意键数组和值数组的数据都要移动。

​ 提示:需要调用get_key() / get_rid()函数得到 键/值 数组中指定位置的地址;可以调用memcpy()memmove()进行数据移动。

  • int Insert(const char *key, const Rid &value);

​ 用于在结点中插入单个键值对。函数返回插入后的键值对数量。

​ 注意:重复的key不插入;插入后需要保持键数组仍然有序。

​ 提示:可以调用lower_bound()insert_pairs()函数。

(2)B+树的插入

class IxIndexHandle {
    // B+树的插入
    bool insert_entry(const char *key, const Rid &value, Transaction *transaction);
    IxNodeHandle *Split(IxNodeHandle *node);
    void InsertIntoParent(IxNodeHandle *old_node, const char *key, IxNodeHandle *new_node, Transaction *transaction);
}

学生需要实现以下函数:

  • void insert_entry(const char *key, const Rid &value);

​ 用于将指定键值对插入到B+树。

​ 首先找到要插入的叶结点,然后将键值对插入到该叶结点。如果该结点插入后已满,即size==max_size,就需要分裂成两个结点,分裂后还需要将新结点相关信息插入到父结点,不断向上递归插入直到当前结点在插入后未满或到达根结点。

​ 提示:需要调用FindLeafPage()Insert()Split()InsertIntoParent()

  • IxNodeHandle *Split(IxNodeHandle *node);

​ 用于分裂结点。函数返回分裂产生的新结点。

​ 具体做法是,将原结点的键值对平均分配,其左半部分不变,右半部分移动到分裂产生的新结点中。新结点在原结点的右边。

​ 注意:如果分裂的结点是叶结点,要更新叶结点的后继指针。如果分裂的结点是内部结点,要更新其孩子结点的父指针。

  • void InsertIntoParent(IxNodeHandle *old_node, const char *key, IxNodeHandle *new_node, Transaction *transaction);

​ 用于结点分裂后,更新父结点中的键值对。

​ 将new_node的第一个key插入到父结点,其位置在 父结点指向old_node的孩子指针value 之后。如果父结点插入后size==maxsize,则必须继续分裂父结点,然后在该父结点的父结点再插入,即需要递归。不断地分裂和向上插入,直到父结点被插入后未满,或者一直向上插入到了根结点,才会停止递归;如果一直向上插入到了根结点,会产生一个新的根结点,它的左孩子是分裂前的原结点,右孩子是分裂后产生的新结点。

​ 提示:需要调用Split()InsertIntoParent(),进行递归。

B+树插入的整体流程如下图:

B+树插入流程

任务3 B+树的删除

(1)结点内的删除

class IxNodeHandle {
    // 结点内的删除
    void erase_pair(int pos);
    int Remove(const char *key);
}

学生需要实现以下函数:

  • void erase_pair(int pos);

    用于在结点中的指定位置删除单个键值对。

    提示:可以调用memmove()函数。

  • int Remove(const char *key);

​ 用于在结点中删除指定key的键值对。函数返回删除后的键值对数量。

​ 提示:可以调用lower_bound()erase_pair()函数。

(2)B+树的删除

class IxIndexHandle {
    // B+树的删除
    void delete_entry(const char *key, Transaction *transaction);
    bool CoalesceOrRedistribute(IxNodeHandle *node, Transaction *transaction);
    bool Coalesce(IxNodeHandle **neighbor_node, IxNodeHandle **node, IxNodeHandle **parent, int index, Transaction *transaction);
    void Redistribute(IxNodeHandle *neighbor_node, IxNodeHandle *node, IxNodeHandle *parent, int index);
    bool AdjustRoot(IxNodeHandle *old_root_node);
}

学生需要实现以下函数:

  • void delete_entry(const char *key, Transaction *transaction);

​ 用于删除B+树中含有指定key的键值对。

​ 首先找到要删除的叶结点,直接删除对应键值对。如果删除后该结点小于半满,则需要合并(Coalesce)或重分配(Redistribute)。

​ 提示:需要调用FindLeafPage()Remove()CoalesceOrRedistribute()

  • bool CoalesceOrRedistribute(IxNodeHandle *node, Transaction *transaction);

    用于处理合并和重分配的逻辑。函数返回是否有结点被删除(无论是node还是它的兄弟结点被删除)。传出参数root_is_latched记录根结点是否被上锁,该参数将在任务3使用,在本任务2中不使用。

​ 首先需要得到node的兄弟结点(尽量找前驱结点),然后根据键值对总和能否支撑两个结点决定是合并还是重分配。如果node是根结点,则需要特殊处理(AdjustRoot)。

​ 提示:需要调用Coalesce()Redistribute()AdjustRoot()

  • bool Coalesce(IxNodeHandle **neighbor_node, IxNodeHandle **node, IxNodeHandle **parent, int index, Transaction *transaction);

​ 将node向前合并到其前驱neighbor_node。函数返回node的父结点parent否需要被删除。

​ 将node中的键值对全部移动到neighbor_node,移动时注意更新孩子结点的父指针。由于合并操作实质上删除了结点node,所以还要删除父结点中的对应键值对,然后继续递归,进入父结点进行合并或重分配。如果是叶结点被删除要更新其后继指针。

​ 参数indexnodeparent中的rid_idx,其表示neighbor_node是否为node的前驱结点。需要保证neighbor_nodenode的前驱,如果不是,则交换位置。

​ 提示:需要调用insert_pairs()erase_pair()maintain_child()release_node_handle()。以及CoalesceOrRedistribute()进行继续递归。

  • void Redistribute(IxNodeHandle *neighbor_node, IxNodeHandle *node, IxNodeHandle *parent, int index);

​ 重新分配node和兄弟结点neighbor_node的键值对。参数index表示node在parent中的rid_idx,其决定neighbor_node是否为node的前驱结点。

node是之前被删除过的结点,所以要移动其兄弟结点neighbor_node的一个键值对到node。注意这里有多种情况要考虑:根据neighbor_node是在node的前面还是后面,移动的键值对不一样;此外,如果node是内部结点要更新其孩子结点的父指针。

​ 提示:需要调用insert_pairs()erase_pair()maintain_child()

  • bool AdjustRoot(IxNodeHandle *old_root_node);

​ 用于根结点被删除了一个键值对之后的处理。函数返回根结点是否需要被删除。

​ 考虑两种根结点需要被删除的情况:(1)删除了根结点的最后一个键值对,但它仍然有一个孩子。那么可以将其孩子作为新的根结点。(2)删除了整个B+树的最后一个键值对。那么直接更新文件头中记录的根结点为INVALID_PAGE_ID

​ 对于其他情况则无需任何处理,因为根结点无需被删除。

​ 提示:需要调用release_node_handle()

B+树删除的整体流程如下图:

B+树删除流程

任务4 B+树索引并发控制

本任务要求修改IxIndexHandle类的原实现逻辑,让其支持对B+树索引的并发查找、插入、删除操作。

学生可以选择实现并发的粒度,选择下面两种并发粒度的任意一种进行实现即可。

方法一、粗粒度并发(Tree级)

比较简单的粗粒度实现方法是对整个树加锁,即让查找、插入、删除三者操作互斥。

提醒:这种方法的实现类似于 实验一任务1.3 缓冲池管理器的并发实现。

方法二、细粒度并发(Page级)【选做】

请自行学习B+树索引并发算法:蟹行协议(crabbing protocol)

主要需要修改IxIndexHandle类中以下函数的实现逻辑:

(1)FindLeafPage()

​ 此函数十分重要,在B+树的查找/插入/删除操作中均被调用。其基本功能在于根据指定key从根结点向下查找到含有该key的叶结点。

​ 引入并发控制算法,以 蟹行协议(crabbing protocol) 为例,其使用读写锁来控制对树结点(索引页面)的访问和修改,并规定向下遍历树时 获取/释放 锁的机制:每个线程都是以自上而下的方式获取锁,从根结点开始获取锁,然后向下进入孩子结点并获取锁,再选择是否释放父结点的锁。

​ 参数operation表示操作类型。对于查找操作,进入树的每一层结点都是先在当前结点获取读锁,然后释放父结点读锁;对于插入和删除操作,进入树的每一层结点都是先在当前结点获取写锁,如果当前结点“安全”才释放所有祖先节点的写锁。“安全”结点的定义是:结点插入一个键值对后仍然未满(size+1<max_size);或者结点删除一个键值对后仍然超过或等于半满(size-1>=min_size);注意,根结点的min_size=2,其余结点的min_size=max_size/2。

​ 参数transaction表示事务,其中有一个数据结构page_set_用于存储从根结点到当前结点经过的所有祖先结点(索引页面)。实际上,只有插入或删除操作需要记录当前结点的所有祖先结点,然后判断如果当前结点是“安全”的,就遍历transactionpage_set_中存放的所有页面,依次释放这些页面的写锁。

​ 函数返回值修改为std::pair<IxNodeHandle*, bool>,其两部分分别表示找到的叶结点以及根结点是否被锁住。在IxIndexHandle类中设计了一个mutex锁(互斥锁)root_latch_用于对根结点进行上锁。对于读操作(查找),不需要对根结点上锁,因为蟹行协议允许多个线程同时读B+树;但对于写操作(插入/删除),则需要上锁,直到确定根结点不会被修改或者已经将根结点修改完毕,才能释放锁,从而防止本线程写操作未完成而其他线程又进行读的错误。最后用一个bool类型的变量表示根结点是否被上锁。

(2)查找函数GetValue()

​ 与之前实现不同的是,此处经过FindLeafPage()找到的叶结点被加上了读锁,且其祖先结点无任何读锁。最后释放叶结点的读锁即可。

(3)插入函数insert_entry()Split()InsertIntoParent()

删除函数delete_entry()CoalesceOrRedistribute()Coalesce()Redistribute()AdjustRoot()

​ 当要插入或删除某个键值对时,首先获取根结点的写锁, 在其孩子结点上获取写锁。然后判断孩子结点是否“安全”,只有孩子结点安全才能释放它的所有祖先结点的写锁。不断重复这一过程,直到找到叶结点,最后叶结点获取的是写锁。

​ 注意释放结点写锁的时机:对于每一层结点,都是确定其安全之后,才能释放其上层的写锁。

实验计分

本实验满分为100分,测试文件对应的任务点及其分值如下:

任务点 测试文件 分值
任务1和任务2 B+树的查找和插入 src/index/b_plus_tree_insert_test.cpp 30
任务3 B+树的删除 src/index/b_plus_tree_delete_test.cpp 40
任务4 B+树的并发控制 src/index/b_plus_tree_concurrent_test.cpp 30

编译生成可执行文件进行测试:

cd build

make b_plus_tree_insert_test
./bin/b_plus_tree_insert_test

make b_plus_tree_delete_test
./bin/b_plus_tree_delete_test

make b_plus_tree_concurrent_test
./bin/b_plus_tree_concurrent_test

注意:在本实验中的所有测试只调用GetValue()insert_entry()delete_entry()这三个函数。学生可以自行添加和修改辅助函数,但不能修改以上三个函数的声明。