Dev/utvpn/utvpn-unix-v101-7101-public/src/Cedar/Layer3.h

   1 // SoftEther UT-VPN SourceCode\r
   2 // \r
   3 // Copyright (C) 2004-2010 SoftEther Corporation.\r
   4 // Copyright (C) 2004-2010 University of Tsukuba, Japan.\r
   5 // Copyright (C) 2003-2010 Daiyuu Nobori.\r
   6 // All Rights Reserved.\r
   7 // \r
   8 // http://utvpn.tsukuba.ac.jp/\r
   9 // \r
  10 // This program is free software; you can redistribute it and/or\r
  11 // modify it under the terms of the GNU General Public License\r
  12 // version 2 as published by the Free Software Foundation.\r
  13 // \r
  14 // This program is distributed in the hope that it will be useful,\r
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
  17 // GNU General Public License for more details.\r
  18 // \r
  19 // You should have received a copy of the GNU General Public License version 2\r
  20 // along with this program; if not, write to the Free Software\r
  21 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
  22 // \r
  23 // このファイルは GPL バージョン 2 ライセンスで公開されています。\r
  24 // 誰でもこのファイルの内容を複製、改変したり、改変したバージョンを再配布\r
  25 // することができます。ただし、原著作物を改変した場合は、原著作物の著作権表示\r
  26 // を除去することはできません。改変した著作物を配布する場合は、改変実施者の\r
  27 // 著作権表示を原著作物の著作権表示に付随して記載するようにしてください。\r
  28 // \r
  29 // この SoftEther UT-VPN オープンソース・プロジェクトは、日本国の\r
  30 // ソフトイーサ株式会社 (SoftEther Corporation, http://www.softether.co.jp/ )\r
  31 // および筑波大学 (University of Tsukuba, http://www.tsukuba.ac.jp/ ) によって\r
  32 // ホストされています。\r
  33 // 本プログラムの配布者は、本プログラムを、業としての利用以外のため、\r
  34 // および、試験または研究のために利用が行われることを想定して配布\r
  35 // しています。\r
  36 // SoftEther UT-VPN プロジェクトの Web サイトは http://utvpn.tsukuba.ac.jp/ に\r
  37 // あります。\r
  38 // 本ソフトウェアの不具合の修正、機能改良、セキュリティホールの修復などのコード\r
  39 // の改変を行った場合で、その成果物を SoftEther UT-VPN プロジェクトに提出して\r
  40 // いただける場合は、 http://utvpn.tsukuba.ac.jp/ までソースコードを送付して\r
  41 // ください。SoftEther UT-VPN プロジェクトの本体リリースまたはブランチリリース\r
  42 // に組み込みさせていただきます。\r
  43 // \r
  44 // GPL に基づいて原著作物が提供される本ソフトウェアの改良版を配布、販売する\r
  45 // 場合は、そのソースコードを GPL に基づいて誰にでも開示する義務が生じます。\r
  46 // \r
  47 // 本ソフトウェアに関連する著作権、特許権、商標権はソフトイーサ株式会社\r
  48 // (SoftEther Corporation) およびその他の著作権保持者が保有しています。\r
  49 // ソフトイーサ株式会社等はこれらの権利を放棄していません。本ソフトウェアの\r
  50 // 二次著作物を配布、販売する場合は、これらの権利を侵害しないようにご注意\r
  51 // ください。\r
  52 // \r
  53 // お願い: どのような通信ソフトウェアにも通常は必ず未発見の\r
  54 // セキュリティホールが潜んでいます。本ソースコードをご覧いただいた結果、\r
  55 // UT-VPN にセキュリティホールを発見された場合は、当該セキュリティホールの\r
  56 // 情報を不特定多数に開示される前に、必ず、ソフトイーサ株式会社\r
  57 // および脆弱性情報の届出を受け付ける公的機関まで通報いただき、\r
  58 // 公益保護にご協力いただきますようお願い申し上げます。\r
  59 // \r
  60 // ソフトイーサ株式会社は、当該セキュリティホールについて迅速に対処を\r
  61 // 行い、UT-VPN および UT-VPN に関連するソフトウェアのユーザー・顧客\r
  62 // を保護するための努力を行います。\r
  63 // \r
  64 // ソフトイーサへの届出先: http://www.softether.co.jp/jp/contact/\r
  65 // 日本国内の脆弱性情報届出受付公的機関:\r
  66 //         独立行政法人 情報処理推進機構\r
  67 //         http://www.ipa.go.jp/security/vuln/report/\r
  68 // \r
  69 // 上記各事項について不明な点は、ソフトイーサ株式会社までご連絡ください。\r
  70 // 連絡先: http://www.softether.co.jp/jp/contact/\r
  71 \r
  72 // -----------------------------------------------\r
  73 // [ChangeLog]\r
  74 // 2010.05.20\r
  75 //  新規リリース by SoftEther\r
  76 // -----------------------------------------------\r
  77 \r
  78 // Layer3.h\r
  79 // Layer3.c のヘッダ\r
  80 \r
  81 #ifndef LAYER3_H\r
  82 #define LAYER3_H\r
  83 \r
  84 // 定数\r
  85 #define L3_USERNAME                                     "L3SW_"\r
  86 \r
  87 \r
  88 // L3 ARP テーブルエントリ\r
  89 struct L3ARPENTRY\r
  90 {\r
  91         UINT IpAddress;                                 // IP アドレス\r
  92         UCHAR MacAddress[6];                    // MAC アドレス\r
  93         UCHAR Padding[2];\r
  94         UINT64 Expire;                                  // 有効期限\r
  95 };\r
  96 \r
  97 // L3 ARP 解決待ちリストエントリ\r
  98 struct L3ARPWAIT\r
  99 {\r
 100         UINT IpAddress;                                 // IP アドレス\r
 101         UINT64 LastSentTime;                    // 最後に ARP を送信した時刻\r
 102         UINT64 Expire;                                  // 有効期限\r
 103 };\r
 104 \r
 105 // L3 IP パケットテーブル\r
 106 struct L3PACKET\r
 107 {\r
 108         PKT *Packet;                                    // パケットデータ本体\r
 109         UINT64 Expire;                                  // 有効期限\r
 110         UINT NextHopIp;                                 // ローカル配信宛先 IP アドレス\r
 111 };\r
 112 \r
 113 // L3 ルーティングテーブル定義\r
 114 struct L3TABLE\r
 115 {\r
 116         UINT NetworkAddress;                    // ネットワークアドレス\r
 117         UINT SubnetMask;                                // サブネットマスク\r
 118         UINT GatewayAddress;                    // ゲートウェイアドレス\r
 119         UINT Metric;                                    // メトリック\r
 120 };\r
 121 \r
 122 // L3 インターフェイス定義\r
 123 struct L3IF\r
 124 {\r
 125         L3SW *Switch;                                   // Layer-3 スイッチ\r
 126         char HubName[MAX_HUBNAME_LEN + 1];      // 仮想 HUB 名\r
 127         UINT IpAddress;                                 // IP アドレス\r
 128         UINT SubnetMask;                                // サブネットマスク\r
 129 \r
 130         HUB *Hub;                                               // 仮想 HUB\r
 131         SESSION *Session;                               // セッション\r
 132         LIST *ArpTable;                                 // ARP テーブル\r
 133         LIST *ArpWaitTable;                             // ARP 待機テーブル\r
 134         QUEUE *IpPacketQueue;                   // IP パケットキュー (他のインターフェイスからの受信用)\r
 135         LIST *IpWaitList;                               // IP 待機リスト\r
 136         QUEUE *SendQueue;                               // 送信キュー\r
 137         UCHAR MacAddress[6];                    // MAC アドレス\r
 138         UCHAR Padding[2];\r
 139         UINT64 LastDeleteOldArpTable;   // 古い ARP テーブルを清掃した時刻\r
 140         LIST *CancelList;                               // キャンセルリスト\r
 141         UINT64 LastBeaconSent;                  // 最後にビーコンを送信した時刻\r
 142 };\r
 143 \r
 144 // L3 スイッチ定義\r
 145 struct L3SW\r
 146 {\r
 147         char Name[MAX_HUBNAME_LEN + 1]; // 名前\r
 148         LOCK *lock;                                             // ロック\r
 149         REF *ref;                                               // 参照カウンタ\r
 150         CEDAR *Cedar;                                   // Cedar\r
 151         bool Active;                                    // 動作中フラグ\r
 152         bool Online;                                    // オンラインフラグ\r
 153         volatile bool Halt;                             // 停止フラグ\r
 154         LIST *IfList;                                   // インターフェイスリスト\r
 155         LIST *TableList;                                // ルーティングテーブルリスト\r
 156         THREAD *Thread;                                 // スレッド\r
 157 };\r
 158 \r
 159 \r
 160 \r
 161 // 関数プロトタイプ\r
 162 int CmpL3Sw(void *p1, void *p2);\r
 163 int CmpL3ArpEntry(void *p1, void *p2);\r
 164 int CmpL3ArpWaitTable(void *p1, void *p2);\r
 165 int CmpL3Table(void *p1, void *p2);\r
 166 int CmpL3If(void *p1, void *p2);\r
 167 void InitCedarLayer3(CEDAR *c);\r
 168 void FreeCedarLayer3(CEDAR *c);\r
 169 L3SW *NewL3Sw(CEDAR *c, char *name);\r
 170 void ReleaseL3Sw(L3SW *s);\r
 171 void CleanupL3Sw(L3SW *s);\r
 172 bool L3AddIf(L3SW *s, char *hubname, UINT ip, UINT subnet);\r
 173 bool L3DelIf(L3SW *s, char *hubname);\r
 174 bool L3AddTable(L3SW *s, L3TABLE *tbl);\r
 175 bool L3DelTable(L3SW *s, L3TABLE *tbl);\r
 176 L3IF *L3SearchIf(L3SW *s, char *hubname);\r
 177 L3SW *L3GetSw(CEDAR *c, char *name);\r
 178 L3SW *L3AddSw(CEDAR *c, char *name);\r
 179 bool L3DelSw(CEDAR *c, char *name);\r
 180 void L3FreeAllSw(CEDAR *c);\r
 181 void L3SwStart(L3SW *s);\r
 182 void L3SwStop(L3SW *s);\r
 183 void L3SwThread(THREAD *t, void *param);\r
 184 void L3Test(SERVER *s);\r
 185 void L3InitAllInterfaces(L3SW *s);\r
 186 void L3FreeAllInterfaces(L3SW *s);\r
 187 void L3IfThread(THREAD *t, void *param);\r
 188 void L3InitInterface(L3IF *f);\r
 189 void L3FreeInterface(L3IF *f);\r
 190 L3IF *L3GetNextIf(L3SW *s, UINT ip, UINT *next_hop);\r
 191 L3TABLE *L3GetBestRoute(L3SW *s, UINT ip);\r
 192 UINT L3GetNextPacket(L3IF *f, void **data);\r
 193 void L3Polling(L3IF *f);\r
 194 void L3PollingBeacon(L3IF *f);\r
 195 void L3DeleteOldArpTable(L3IF *f);\r
 196 void L3DeleteOldIpWaitList(L3IF *f);\r
 197 void L3PollingArpWaitTable(L3IF *f);\r
 198 void L3SendL2Now(L3IF *f, UCHAR *dest_mac, UCHAR *src_mac, USHORT protocol, void *data, UINT size);\r
 199 void L3SendArpRequestNow(L3IF *f, UINT dest_ip);\r
 200 void L3SendArpResponseNow(L3IF *f, UCHAR *dest_mac, UINT dest_ip, UINT src_ip);\r
 201 void L3GenerateMacAddress(L3IF *f);\r
 202 L3ARPENTRY *L3SearchArpTable(L3IF *f, UINT ip);\r
 203 void L3SendIpNow(L3IF *f, L3ARPENTRY *a, L3PACKET *p);\r
 204 void L3SendIp(L3IF *f, L3PACKET *p);\r
 205 void L3RecvArp(L3IF *f, PKT *p);\r
 206 void L3RecvArpRequest(L3IF *f, PKT *p);\r
 207 void L3RecvArpResponse(L3IF *f, PKT *p);\r
 208 void L3KnownArp(L3IF *f, UINT ip, UCHAR *mac);\r
 209 void L3SendArp(L3IF *f, UINT ip);\r
 210 void L3InsertArpTable(L3IF *f, UINT ip, UCHAR *mac);\r
 211 void L3SendWaitingIp(L3IF *f, UCHAR *mac, UINT ip, L3ARPENTRY *a);\r
 212 void L3PutPacket(L3IF *f, void *data, UINT size); \r
 213 void L3RecvL2(L3IF *f, PKT *p);\r
 214 void L3StoreIpPacketToIf(L3IF *src_if, L3IF *dst_if, L3PACKET *p);\r
 215 void L3RecvIp(L3IF *f, PKT *p, bool self);\r
 216 void L3PollingIpQueue(L3IF *f);\r
 217 \r
 218 \r
 219 #endif  // LAYER3_H\r
 220 \r
 221 \r
 222 \r