Nginx ソースコード調査における nginx 電流制限モジュールの詳細な説明

typedef列挙型{
 NGX_HTTP_POST_READ_PHASE = 0, // 現在、realip モジュールのみがハンドラを登録します (nginx がプロキシ サーバーとして使用されている場合に便利です。バックエンドはこれを使用してクライアントの元の IP を取得します)
 
 NGX_HTTP_SERVER_REWRITE_PHASE、//URLを書き換えるためにサーバブロックで書き換えディレクティブが設定されている
 
 NGX_HTTP_FIND_CONFIG_PHASE、//一致する場所を検索します。ハンドラーはカスタマイズできません。
 NGX_HTTP_REWRITE_PHASE、// URLを書き換えるために、ロケーションブロックにrewriteディレクティブが設定されている
 NGX_HTTP_POST_REWRITE_PHASE、// URL の書き換えが発生したかどうかを確認します。発生した場合は、FIND_CONFIG フェーズに戻ります。ハンドラーはカスタマイズできません。
 
 NGX_HTTP_PREACCESS_PHASE、//アクセス制御。現在の制限モジュールは、このステージにハンドラーを登録します。NGX_HTTP_ACCESS_PHASE、//アクセス権制御。NGX_HTTP_POST_ACCESS_PHASE、//アクセス権制御ステージに応じて、それに応じて処理します。ハンドラーはカスタマイズできません。
 
 NGX_HTTP_TRY_FILES_PHASE、//このフェーズは try_files ディレクティブが設定されている場合にのみ発生します。ハンドラーはカスタマイズできません。
 NGX_HTTP_CONTENT_PHASE、//コンテンツ生成フェーズ、クライアントに応答を返す NGX_HTTP_LOG_PHASE //ログ レコード} ngx_http_phases;

typedef構造体{
 ngx_int_t (*事前設定)(ngx_conf_t *cf);
 ngx_int_t (*postconfiguration)(ngx_conf_t *cf); //このメソッドは、対応するステージにハンドラーを登録します void *(*create_main_conf)(ngx_conf_t *cf); //http ブロック内のメイン構成 char *(*init_main_conf)(ngx_conf_t *cf, void *conf);
 
 void *(*create_srv_conf)(ngx_conf_t *cf); //サーバー構成 char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf);
 
 void *(*create_loc_conf)(ngx_conf_t *cf); //場所の設定 char *(*merge_loc_conf)(ngx_conf_t *cf, void *prev, void *conf);
} ngx_http_module_t;

静的 ngx_int_t ngx_http_limit_req_init(ngx_conf_t *cf)
{
 h = ngx_array_push(&cmcf->phases[NGX_HTTP_PREACCESS_PHASE].handlers);
 
 *h = ngx_http_limit_req_handler; // ngx_http_limit_req_module モジュールの現在の制限方法。nginx が HTTP リクエストを処理するときに、このメソッドを呼び出して、リクエストを続行するか拒否するかを決定します。 return NGX_OK;
}

静的 ngx_int_t ngx_epoll_add_event(ngx_event_t *ev、ngx_int_t イベント、ngx_uint_t フラグ);

構造体ngx_event_s {
 
 ngx_event_handler_pt handler; //関数ポインタ: イベント処理関数 ngx_rbtree_node_t timer; //タイムアウトタイマー、赤黒木に格納されます (ノードのキーはイベントのタイムアウトです)
 
 unsigned timedout:1; //イベントがタイムアウトしたかどうかを記録します};

ngx_msec_t ngx_event_find_timer(void)
{
 ノード = ngx_rbtree_min(ルート、センチネル);
 タイマー = (ngx_msec_int_t) (node->key - ngx_current_msec);
 
 (ngx_msec_t) を返します (タイマー > 0 ? タイマー: 0);
}

ngx_event_expire_timers は void です。
{
 のために （ ;; ） {
  ノード = ngx_rbtree_min(ルート、センチネル);
 
  if ((ngx_msec_int_t) (node->key - ngx_current_msec) <= 0) { //現在のイベントがタイムアウトしました ev = (ngx_event_t *) ((char *) node - offsetof(ngx_event_t, timer));
 
   ev->タイムアウト = 1;
 
   ev->ハンドラ(ev);
 
   続く;
  }
 
  壊す;
 }
}

//各設定ディレクティブには主に2つのフィールドが含まれます: 名前、解析設定処理メソッド static ngx_command_t ngx_http_limit_req_commands[] = {
 
 //一般的な使用法: limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;
 //$binary_remote_addr はリモート クライアントの IP を表します。
 //zone はストレージ スペースを構成します (各クライアントのアクセス レートを記録するためにスペースを割り当てる必要があり、タイムアウト スペース制限は lru アルゴリズムを使用して排除されます。このスペースは共有メモリに割り当てられ、すべてのワーカー プロセスからアクセスできることに注意してください)
 //rate はレート制限を示します。この場合は 1qps です。
 { ngx_string("limit_req_zone"),
  ngx_http_limit_req_zone、
  },
 
 //使用法: limit_req zone=one burst=5 nodelay;
 //ゾーンは使用する共有スペースを指定します//このレートを超えるリクエストは直接破棄されますか?バースト設定はバースト トラフィックを処理するために使用されます。キューに入れられるリクエストの最大数を示します。クライアントのリクエスト レートが現在の制限を超えると、リクエストはキューに入れられます。バーストを超えるリクエストのみが直接拒否されます。
 //nodelay は burst と一緒に使用する必要があります。この時点で、キューに入れられたリクエストが最初に処理されます。そうでない場合、これらのリクエストが制限されたレートで処理され続けると、サーバーが処理を完了するまでにクライアントがタイムアウトする可能性があります { ngx_string("limit_req"),
  ngx_http_limit_req、
  },
 
 // リクエストが制限されている場合のログ記録レベル。使用法: limit_req_log_level info | notice | warn | error;
 { ngx_string("limit_req_log_level"),
  ngx_conf_set_enum_slot、
  },
 
 // リクエストが制限されている場合、クライアントに返されるステータス コード。使用法: limit_req_status 503
 { ngx_string("limit_req_status"),
  ngx_conf_set_num_slot、
 },
};

静的 ngx_http_variable_t ngx_http_core_variables[] = {
 
 { ngx_string("http_host"), NULL, ngx_http_variable_header,
  offsetof(ngx_http_request_t, headers_in.host), 0, 0 },
 
 { ngx_string("http_user_agent"), NULL, ngx_http_variable_header,
  offsetof(ngx_http_request_t, headers_in.user_agent), 0, 0 },
 …………
}

typedef構造体{
 ngx_http_limit_req_shctx_t *sh;
 ngx_slab_pool_t *shpool; //メモリプール ngx_uint_t rate; //現在の制限速度（ストレージ用にqpsを1000倍したもの）
 ngx_int_t index; //変数インデックス（nginxは一連の変数を提供しますが、現在の制限変数インデックスはユーザーが設定します）
 ngx_str_t var; //現在の制限変数名 ngx_http_limit_req_node_t *node;
} ngx_http_limit_req_ctx_t;
 
//同時に、共有ストレージスペース struct ngx_shm_zone_s {
 void *data; //data は ngx_http_limit_req_ctx_t 構造体を指します ngx_shm_t shm; //共有スペース ngx_shm_zone_init_pt init; //初期化メソッド関数ポインター void *tag; //ngx_http_limit_req_module 構造体を指します };

typedef構造体{
 ngx_shm_zone_t *shm_zone; //共有ストレージスペース ngx_uint_t burst; //キューサイズ ngx_uint_t nodelay; //キューにリクエストがある場合に緊急に処理するかどうか、バーストで使用される (設定されている場合、キューに入れられたリクエストは緊急に処理されます。そうでない場合は、現在の制限速度に従って処理されます)
} ngx_http_limit_req_limit_t; 

//レコード構造 typedef struct {
 u_char 色;
 u_char ダミー;
 u_short len; //データ長 ngx_queue_t queue; 
 ngx_msec_t last; //最終アクセス時間 ngx_uint_t extra; //現在処理が残っているリクエスト数（nginxはこれを使用してトークンバケットの現在の制限アルゴリズムを実装します）
 ngx_uint_t count; //そのようなレコード要求の合計数 u_char data[1]; //データ内容（最初にキー（ハッシュ値）で検索し、次にデータ内容が等しいかどうかを比較します）
} ngx_http_limit_req_node_t;
 
//赤黒木ノード、キーはユーザーが設定した現在の制限変数のハッシュ値です。
構造体ngx_rbtree_node_s {
 ngx_rbtree_key_t キー;
 ngx_rbtree_node_t *左;
 ngx_rbtree_node_t *右;
 ngx_rbtree_node_t *親;
 u_char 色;
 u_char データ;
};
 
 
typedef構造体{
 ngx_rbtree_t rbtree; //赤黒木 ngx_rbtree_node_t sentinel; //NIL ノード ngx_queue_t queue; //LRU キュー } ngx_http_limit_req_shctx_t;
 
//キューには前と次のポインターのみが含まれます struct ngx_queue_s {
 ngx_queue_t *前;
 ngx_queue_t *次へ;
};

ngx_http_limit_req_ctx_t *ctx;
ngx_queue_t *q;
 
q = ngx_queue_last(&ctx->sh->queue);
 
lr = ngx_queue_data(q, ngx_http_limit_req_node_t, queue);//このメソッドは、ngx_queue_t から ngx_http_limit_req_node_t 構造体の最初のアドレスを取得し、次のように実装されます。
 
#define ngx_queue_data(q, type, link) (type *) ((u_char *) q - offsetof(type, link)) //キューフィールドのアドレスから構造体内のオフセットを引いたものが構造体の最初のアドレスになります

size = offsetof(ngx_rbtree_node_t, color) // 新しいレコードにメモリを割り当て、必要なスペースを計算します size + offsetof(ngx_http_limit_req_node_t, data)
  + 長さ;
 
ノード = ngx_slab_alloc_locked(ctx->shpool, サイズ);
 
ノード->キー = ハッシュ;
 
lr = (ngx_http_limit_req_node_t *) &node->color; //color は u_char 型ですが、なぜ強制的に ngx_http_limit_req_node_t ポインタ型に変換できるのでしょうか?
 
lr->len = (u_char)len;
lr->過剰 = 0;
 
ngx_memcpy(lr->data, データ, len);
 
ngx_rbtree_insert(&ctx->sh->rbtree, ノード);
 
ngx_queue_insert_head(&ctx->sh->queue, &lr->queue);

//limit、現在の制限戦略。hash、キーのハッシュ値を記録。data、キーのデータ内容を記録。len、キーのデータ長を記録。ep、保留中のリクエストの数。account、これが最後の現在の制限戦略であるかどうか static ngx_int_t ngx_http_limit_req_limit_t *limit、ngx_uint_t hash、u_char *data、size_t len、ngx_uint_t *ep、ngx_uint_t account)
{
 //指定された境界の赤黒木検索 while (node ​​!= sentinel) {
 
  if (ハッシュ < ノード-> キー) {
   ノード = ノード->左;
   続く;
  }
 
  if (ハッシュ > ノード->キー) {
   ノード = ノード->right;
   続く;
  }
 
  //ハッシュ値が等しいか、データが等しいか比較します lr = (ngx_http_limit_req_node_t *) &node->color;
 
  rc = ngx_memn2cmp(データ、lr->data、len、(size_t) lr->len);
  // (rc == 0) かどうかを調べる {
   ngx_queue_remove(&lr->queue);
   ngx_queue_insert_head(&ctx->sh->queue, &lr->queue); //レコードをLRUキューの先頭に移動します ms = (ngx_msec_int_t) (now - lr->last); //現在の時刻から最後のアクセス時刻を引いた値 extrasecess = lr->excess - ctx->rate * ngx_abs(ms) / 1000 + 1000; //処理対象のリクエスト - 現在の制限レート * 期間 + 1 リクエスト (レート、リクエスト数などは 1000 倍になります)
 
   （超過<0）の場合{
    超過 = 0;
   }
 
   *ep = 過剰;
 
   // 保留中のリクエストの数がバースト（待機キューのサイズ）を超え、リクエストを拒否するために NGX_BUSY が返されます（バーストが設定されていない場合、値は 0 です）
   if ((ngx_uint_t) 超過 > 制限->バースト) {
    NGX_BUSY を返します。
   }
 
   if (account) { //これが現在の最後の制限ポリシーである場合、最終アクセス時刻と保留中のリクエストの数を更新し、NGX_OKを返します。
    lr->excess = 過剰;
    lr->last = 今;
    NGX_OK を返します。
   }
   //訪問回数を増やす lr->count++;
 
   ctx->node = lr;
 
   return NGX_AGAIN; // 最後の電流制限戦略ではないので、NGX_AGAIN を返し、次の電流制限戦略のチェックを続行します}
 
  ノード = (rc < 0) ? ノード->left : ノード->right;
 }
 
 //ノードが見つからない場合は、新しいレコードを作成する必要があります *ep = 0;
 //ストレージスペースサイズの計算方法については、セクション3.2.1のデータ構造を参照してください。size = offsetof(ngx_rbtree_node_t, color)
   + offsetof(ngx_http_limit_req_node_t、データ)
   + 長さ;
 //レコードの削除を試みる (LRU)
 ngx_http_limit_req_expire(ctx, 1);
 
  
 node = ngx_slab_alloc_locked(ctx->shpool, size); //スペースを割り当てる if (node ​​== NULL) { //スペースが不足しているため、割り当てに失敗しました ngx_http_limit_req_expire(ctx, 0); //レコードの強制削除 node = ngx_slab_alloc_locked(ctx->shpool, size); //スペースを割り当てる if (node ​​== NULL) { //割り当てに失敗しました。NGX_ERRORを返します
   NGX_ERROR を返します。
  }
 }
 
 node->key = hash; //値を割り当てる lr = (ngx_http_limit_req_node_t *) &node->color;
 lr->len = (u_char)len;
 lr->過剰 = 0;
 ngx_memcpy(lr->data, データ, len);
 
 ngx_rbtree_insert(&ctx->sh->rbtree, node); //赤黒木とLRUキューにレコードを挿入します ngx_queue_insert_head(&ctx->sh->queue, &lr->queue);
 
 if (account) { //これが現在の最後の制限ポリシーである場合、最終アクセス時刻と保留中のリクエストの数を更新し、NGX_OKを返します。
  lr->last = 今;
  lr->カウント = 0;
  NGX_OK を返します。
 }
 
 lr->last = 0;
 lr->カウント = 1;
 
 ctx->node = lr;
 
 return NGX_AGAIN; // 最後の電流制限戦略ではないので、NGX_AGAIN を返し、次の電流制限戦略のチェックを続行します}

静的 void ngx_http_limit_req_expire(ngx_http_limit_req_ctx_t *ctx, ngx_uint_t n)
{
 // 最大 3 つのレコードを削除します while (n < 3) {
  // 末尾ノード q = ngx_queue_last(&ctx->sh->queue);
  //レコードを取得 lr = ngx_queue_data(q, ngx_http_limit_req_node_t, queue);
   
  //注: n が 0 の場合、if コード ブロックに入ることができないため、末尾のノードが削除されます。n が 0 でない場合は、if コード ブロックに入り、削除できるかどうかを確認します。if (n++ != 0) {
 
   ms = (ngx_msec_int_t) (現在 - lr->last);
   ms = ngx_abs(ms);
   // 短時間でアクセスされたため削除できず、直接戻ります if (ms < 60000) {
    戻る;
   }
    
   // 削除できない保留中のリクエストがあります。直接返します。excess = lr->excess - ctx->rate * ms / 1000;
   （超過＞0）の場合{
    戻る;
   }
  }
 
  // ngx_queue_remove(q) を削除します。
 
  ノード = (ngx_rbtree_node_t *)
     ((u_char *) lr - offsetof(ngx_rbtree_node_t, color));
 
  ngx_rbtree_delete(&ctx->sh->rbtree、ノード);
 
  ngx_slab_free_locked(ctx->shpool、ノード);
 }
}

//現在のリクエストが処理されるまでに待機する必要がある時間を計算します。delay = ngx_http_limit_req_account(limits, n, &excess, &limit);

//読み取り可能なイベントを追加します if (ngx_handle_read_event(r->connection->read, 0) != NGX_OK) {
 NGX_HTTP_INTERNAL_SERVER_ERROR を返します。
}

r->read_event_handler = ngx_http_test_reading;
r->write_event_handler = ngx_http_limit_req_delay; //書き込み可能なイベント処理関数 ngx_add_timer(r->connection->write, delay); //書き込み可能なイベント追加タイマー（タイムアウト前にクライアントに戻ることはできません）

if (limits[n].nodelay) { //nodelayが設定されている場合、リクエストは遅延されず、遅延は0になります
 続く;
}
 
遅延 = 超過 * 1000 / ctx->rate;
 
（遅延＞最大遅延）の場合{
 max_delay = 遅延;
 *ep = 過剰;
 *制限 = &limits[n];
}

静的 void ngx_http_limit_req_delay(ngx_http_request_t *r)
{
 
 wev = r->接続->書き込み;
 
 if (!wev->timedout) { //タイムアウトなし、処理なし if (ngx_handle_write_event(wev, 0) != NGX_OK) {
   ngx_http_finalize_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR);
  }
 
  戻る;
 }
 
 wev->タイムアウト = 0;
 
 r->read_event_handler = ngx_http_block_reading;
 r->write_event_handler = ngx_http_core_run_phases;
 
 ngx_http_core_run_phases(r); //タイムアウト、HTTPリクエストの処理を続行}

http{
 limit_req_zone $binary_remote_addr ゾーン=テスト:10m レート=1r/s;
 
 サーバー{
  聞く 80;
  server_name ローカルホスト;
  位置 / {
   limit_req ゾーン=テスト;
   ルートhtml;
   インデックス index.html index.htm;
  }
}

http{
 limit_req_zone $binary_remote_addr ゾーン=テスト:10m レート=1r/s;
 
 サーバー{
  聞く 80;
  server_name ローカルホスト;
  位置 / {
   limit_req ゾーン=テストバースト=5;
   ルートhtml;
   インデックス index.html index.htm;
  }
}

    最小 平均[+/- 標準偏差] 中央値 最大値
接続: 41 44 1.7 44 46
処理: 46 1566 1916.6 1093 5084
待機中: 46 1565 1916.7 1092 5084
合計: 87 1609 1916.2 1135 5128

http{
 limit_req_zone $binary_remote_addr ゾーン=テスト:10m レート=1r/s;
 
 サーバー{
  聞く 80;
  server_name ローカルホスト;
  位置 / {
   limit_req ゾーン=テスト バースト=5 ノードレイ;
   ルートhtml;
   インデックス index.html index.htm;
  }
}

    最小 平均[+/- 標準偏差] 中央値 最大値
接続: 42 43 0.5 43 43
処理: 43 46 2.4 47 49
待機中: 42 45 2.5 46 49
合計: 85 88 2.8 90 92