Gperf詳解

一、Gperf簡介

Gperf是一款代碼生成工具，用於生成key-value對的散列表並以C或C++的形式輸出。它使用了一種名為「字典樹」（trie-tree）的數據結構，並在其基礎上進行了優化和改進。採用gperf可以快速生成高效的哈希表。

相比於其他哈希算法，gperf的散列表具有更快的查找速度以及更低的衝突率。在處理大規模數據時，gperf具有優越的性能表現。同時，通過使用gperf的工具，我們可以生成一份清晰且易於閱讀的C/C++代碼，並且還能夠自定義哈希函數。

二、Gperf工具結構

Gperf的工具結構非常簡單，我們可以先手動創建一份包含key-value對的輸入文件，然後使用gperf工具進行處理，生成源代碼文件。

下面以一個簡單的例子來展示gperf工具的使用：

%{
#include <stdio.h>
#include <stdlib.h>
%}

struct keyword {
    char *name;
    int type;
};

%%
if      { return IF; }
else    { return ELSE; }
for     { return FOR; }
while   { return WHILE; }
return  { return RETURN; }
// 前面定義了關鍵詞，下面開始定義一些常量或者一些有特殊意義的符號
"+"       { return ADD; }
"-"       { return SUB; }
"*"       { return MUL; }
"/"       { return DIV; }
"="       { return ASSIGN; }
"("       { return LPARE; }
")"       { return RPARE; }
";"       { return SEMICOLON; }
":"       { return COLON; }
","       { return COMMA; }
.{Text}   { return ID; }
\n        { return 0; }
%%

int main(void) {
    yylex();
    return 0;
}

int yywrap(void) {
    return 1;
}

int yylex(void) {
    int c = getchar();
    if (c == EOF) {
        return 0;
    }
    if (c >= 'a' && c = 'a' && c type);
        } else {
            printf("%d ", ID);
        }
    } else {
        printf("%c ", c);
    }
    return yylex();
}

char *strdup(const char *);

#define NHASH  9997
#define MULTIPLIER  31

struct keyword *lookup(char *s) {
    static struct keyword keywords[] = {
        {"if", IF},
        {"else", ELSE},
        {"for", FOR},
        {"while", WHILE},
        {"return", RETURN},
        {0, 0}
    };
    struct keyword *p;
    char *t;
    unsigned int h = 0;

    for (t = s; *t; t++) {
        h = MULTIPLIER * h + *t;
    }

    h %= NHASH;

    for (p = &keywords[h]; p->name; p++) {
        if (!strcmp(p->name, s)) {
            return p;
        }
    }

    p->name = strdup(s);
    p->type = ID;
    return p;
}

char *strdup(const char *s) {
    char *p;
    p = (char *) malloc(strlen(s) + 1);
    if (p != NULL) {
        strcpy(p, s);
    }
    return p;
}

在上述代碼中，我們定義了一個簡單的語法分析器，它可以對包含關鍵詞、運算符和標識符等符號的輸入文件進行分析，並按照一定規則輸出結果。這裡我們引入了gperf工具，使用下面的命令處理上述輸入文件：

gperf -L ANSI-C -t -E --enum yykey -k "*" -N keyword input.gperf

根據上述命令生成的代碼中，會包含一個叫做lookup()的函數，它返回輸入值對應的數據結構。下面是生成的C代碼：

struct keyword { char *name; int type; };

#define TOTAL_KEYWORDS 5
#define MIN_WORD_LENGTH 2
#define MAX_WORD_LENGTH 6
#define MIN_HASH_VALUE 2
#define MAX_HASH_VALUE 11
/* maximum key range = 10, duplicates = 0 */
#ifdef __GNUC__
__inline
#else
#ifdef __cplusplus
inline
#endif
#endif
static unsigned int
hash (register const char *str, register unsigned int len)
{
  static unsigned short asso_values[] =
    {
      1, 0, 0, 0, 0, 0, 1, 1, 0, 1, 0
    };
  return len + asso_values[(unsigned char)str[0]];
}

struct keyword *
in_word_set (register const char *str, register unsigned int len)
{
  static struct keyword wordlist[] =
    {
      {"for",          1},
      {"else",         2},
      {"while",        3},
      {"if",           4},
      {"return",       5},
      {""}, {""},
      {"",0}
    };

  if (len = MIN_WORD_LENGTH)
    {
      register int key = hash (str, len);

      if (key = MIN_HASH_VALUE)
        {
          register const char *s = wordlist[key].name;

          if (*str == *s && !strcmp (str + 1, s + 1))
            return &wordlist[key];
        }
    }
  return 0;
}

這段代碼實現了一個哈希表，並提供了一個快速查找的函數in_word_set()。我們可以使用這個函數來查找輸入的key是否在哈希表中，並返回對應的value值。

三、gperf性能分析

3.1 gperftools內存分析

gperftools是一套開源的性能分析工具集，其中包括了一些常用的工具，例如CPU性能分析、內存分析、堆棧跟蹤等等。其中，內存分析工具heapcheck可以用於檢查程序在運行時的內存分配情況，減少內存泄漏和內存溢出等問題。下面我們以一個簡單的例子來演示heapcheck的使用方法：

#include <stdio.h>
#include <stdlib.h>
#include <gperftools/heap-checker.h>

void * LeakyFunction(int leakCount) {
  void **memory = (void **) malloc(sizeof(void *) * leakCount);
  for (int i = 0; i < leakCount; i++) {
    memory[i] = (void *) malloc(1024 * 1024);
  }
  return memory;
}

int main(int argc, char *argv[]) {
  int leakCount = 100;
  HeapLeakChecker checker("basic");
  void *memory = LeakyFunction(leakCount);
  checker.ExpectLeaks(leakCount);
  free(memory);
  checker.NoLeaks();
  return 0;
}

通過將gperftools的頭文件包含在代碼中，並在主函數中添加HeapLeakChecker的實例，我們可以對這個程序進行內存分配的檢查。上述例子中，我們定義了一個函數LeakyFunction()，它會分配100個1MB大小的內存塊。通過HeapLeakChecker的ExpectLeaks()可以檢查我們期望的內存泄漏數目，並通過NoLeaks()方法來檢查程序是否發生了內存泄漏。

3.2 gperformance性能分析

gperftools還包含另一個稱為gperformance的性能分析工具，它是一款延遲分析工具，可以對函數調用的延遲進行採樣和統計。使用gperformance需要先對代碼進行編譯，然後在啟動時加入–gperf-start、–gperf-stop等參數。下面我們以一個簡單的例子來演示gperformance的使用方法：

#include <gperftools/profiler.h>
#include <stdlib.h>
#include <unistd.h>

void InnerFunction()
{
  usleep(100);
}

void OutterFunction()
{
  usleep(200);
  InnerFunction();
}

int main(int argc, char **argv)
{
  ProfilerStart("/tmp/prof-example.profile");
  for (int i = 0; i < 100000; i++) {
    OutterFunction();
  }
  ProfilerStop();
  return 0;
}

在上述代碼中，我們在開始時調用了ProfilerStart()函數，並指定了統計結果輸出到的文件名，然後循環調用了100000次OutterFunction()，每次調用時OutterFunction都會調用InnerFunction()。程序運行結束後，gperformance會自動生成一個性能報告，並在報告中展示各個函數的耗時佔比。

四、Gperf特點及應用場景

Gperf具有以下四個特點：

1、性能優秀：使用gperf生成的哈希表具有更快的查找速度以及更低的衝突率。

2、代碼簡潔：gperf可以生成一份清晰且易於閱讀的C/C++代碼，並且還能夠自定義哈希函數。

3、易於使用：使用gperf可以快速生成高效的哈希表。

4、可靠性高：gperf已經經過了廣泛的測試和驗證，在處理大規模數據時具有優越的性能表現。

gperf主要應用於大規模數據的快速查找、編譯器的語法分析、關鍵詞查找等場景。例如，我們可以在編譯器中使用gperf來生成一份自定義的語法分析表，從而提高編譯器的語法檢查效率。