source: lab.git/Dev/utvpn/utvpn-unix-v101-7101-public/src/Sen/Sen.h @ 072e48b

trunk
Last change on this file since 072e48b was a1bae3e, checked in by mitty <mitty@…>, 12 years ago
  • copy vendor drop to trunk

git-svn-id: https://lab.mitty.jp/svn/lab/trunk@147 7d2118f6-f56c-43e7-95a2-4bb3031d96e7

  • Property mode set to 100644
File size: 11.3 KB
Line 
1// SoftEther UT-VPN SourceCode
2//
3// Copyright (C) 2004-2010 SoftEther Corporation.
4// Copyright (C) 2004-2010 University of Tsukuba.
5// Copyright (C) 2003-2010 Daiyuu Nobori.
6// All Rights Reserved.
7//
8// http://utvpn.tsukuba.ac.jp/
9//
10// This program is free software; you can redistribute it and/or
11// modify it under the terms of the GNU General Public License
12// as published by the Free Software Foundation; either version 2
13// of the License, or (at your option) any later version.
14//
15// This program is distributed in the hope that it will be useful,
16// but WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18// GNU General Public License for more details.
19//
20// You should have received a copy of the GNU General Public License
21// along with this program; if not, write to the Free Software
22// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23//
24// このファイルは GPL バージョン 2 ライセンスで公開されています。
25// 誰でもこのファイルの内容を複製、改変したり、改変したバージョンを再配布
26// することができます。ただし、原著作物を改変した場合は、原著作物の著作権表示
27// を除去することはできません。改変した著作物を配布する場合は、改変実施者の
28// 著作権表示を原著作物の著作権表示に付随して記載するようにしてください。
29//
30// この SoftEther UT-VPN オープンソース・プロジェクトは、
31// ソフトイーサ株式会社 (SoftEther Corporation, http://www.softether.co.jp/ )
32// および筑波大学 (University of Tsukuba, http://www.tsukuba.ac.jp/ ) によって
33// ホストされています。
34// SoftEther UT-VPN プロジェクトの Web サイトは http://utvpn.tsukuba.ac.jp/ に
35// あります。
36// 本ソフトウェアの不具合の修正、機能改良、セキュリティホールの修復などのコード
37// の改変を行った場合で、その成果物を SoftEther UT-VPN プロジェクトに提出して
38// いただける場合は、 http://utvpn.tsukuba.ac.jp/ までソースコードを送付して
39// ください。SoftEther UT-VPN プロジェクトの本体リリースまたはブランチリリース
40// に組み込みさせていただきます。
41//
42// 本ソフトウェアを本オープンソース・プロジェクトの運営主体以外が改変した場合、
43// それを複製、配布、販売することは GPL ライセンスに基づいて可能ですが、
44// その場合、"SoftEther UT-VPN" の名前を勝手に騙り使用することはできません。
45// 事前にソフトイーサ株式会社に許諾を求めるか、または、別の名称として
46// ソフトウェアを配布、販売してください。
47//
48// GPL に基づいて原著作物が提供される本ソフトウェアの改良版を配布、販売する
49// 場合は、そのソースコードを GPL に基づいて誰にでも開示する義務が生じます。
50//
51// 本ソフトウェアに関連する著作権、特許権、商標権はソフトイーサ株式会社
52// (SoftEther Corporation) およびその他の著作権保持者が保有しています。
53// ソフトイーサ株式会社はこれらの権利を放棄していません。本ソフトウェアの
54// 二次著作物を配布、販売する場合は、これらの権利を侵害しないようにご注意
55// ください。
56//
57// 不明な点は、ソフトイーサ株式会社までご連絡ください。
58// 連絡先: http://www.softether.co.jp/jp/contact/
59
60// -----------------------------------------------
61// [ChangeLog]
62// 2010.05.20
63//  新規リリース by SoftEther
64// -----------------------------------------------
65
66/*
67**   File Name: Sen.h
68** Description: Sen.c のヘッダ
69*/
70
71#ifndef SEN_H
72#define SEN_H
73
74
75// 識別文字列 (NDIS)
76#define NDIS_SEN_HARDWARE_ID                "VPN Client Adapter - %s"
77#define NDIS_SEN_DEVICE_NAME                "\\Device\\SEN_%s_DEVICE"
78#define NDIS_SEN_DEVICE_NAME_WIN32          "\\DosDevices\\SEN_%s_DEVICE"
79#define NDIS_SEN_DEVICE_FILE_NAME           "\\\\.\\SEN_SENADAPTER_%s_DEVICE"
80#define NDIS_SEN_EVENT_NAME                 "\\BaseNamedObjects\\SEN_EVENT_%s"
81#define NDIS_SEN_EVENT_NAME_WIN32           "Global\\SEN_EVENT_SENADAPTER_%s"
82
83// 定数
84#define SEN_MAX_PACKET_SIZE         1560
85#define SEN_MAX_PACKET_SIZE_ANNOUNCE    1514
86#define SEN_MIN_PACKET_SIZE         14
87#define SEN_PACKET_HEADER_SIZE      14
88#define SEN_MAX_FRAME_SIZE          (SEN_MAX_PACKET_SIZE - SEN_MIN_PACKET_SIZE)
89#define SEN_MAX_SPEED_DEFAULT       1000000
90#define SEN_MAC_ADDRESS_SIZE        6
91#define SEN_MAX_MULTICASE           32
92
93
94// IOCTL 定数
95#define SEN_IOCTL_SET_EVENT         CTL_CODE(0x8000, 0, METHOD_BUFFERED, FILE_ANY_ACCESS)
96#define SEN_IOCTL_PUT_PACKET        CTL_CODE(0x8000, 1, METHOD_BUFFERED, FILE_ANY_ACCESS)
97#define SEN_IOCTL_GET_PACKET        CTL_CODE(0x8000, 2, METHOD_BUFFERED, FILE_ANY_ACCESS)
98
99
100// パケットデータ交換関係
101#define SEN_MAX_PACKET_EXCHANGE     256         // 一度に交換できるパケット数
102#define SEN_MAX_PACKET_QUEUED       4096        // キューに入れることができるパケット数
103#define SEN_EX_SIZEOF_NUM_PACKET    4           // パケット数データ (UINT)
104#define SEN_EX_SIZEOF_LENGTH_PACKET 4           // パケットデータの長さデータ (UINT)
105#define SEN_EX_SIZEOF_LEFT_FLAG     4           // まだパケットが残っていることを示すフラグ
106#define SEN_EX_SIZEOF_ONE_PACKET    1600        // 1 つのパケットデータが占有するデータ領域
107#define SEN_EXCHANGE_BUFFER_SIZE    (SEN_EX_SIZEOF_NUM_PACKET + SEN_EX_SIZEOF_LEFT_FLAG +   \
108    (SEN_EX_SIZEOF_LENGTH_PACKET + SEN_EX_SIZEOF_ONE_PACKET) * (SEN_MAX_PACKET_EXCHANGE + 1))
109#define SEN_NUM_PACKET(buf)         (*((UINT *)((UCHAR *)buf + 0)))
110#define SEN_SIZE_OF_PACKET(buf, i)  (*((UINT *)((UCHAR *)buf + SEN_EX_SIZEOF_NUM_PACKET + \
111                                    (i * (SEN_EX_SIZEOF_LENGTH_PACKET + SEN_EX_SIZEOF_ONE_PACKET)))))
112#define SEN_ADDR_OF_PACKET(buf, i)  (((UINT *)((UCHAR *)buf + SEN_EX_SIZEOF_NUM_PACKET + \
113                                    SEN_EX_SIZEOF_LENGTH_PACKET +   \
114                                    (i * (SEN_EX_SIZEOF_LENGTH_PACKET + SEN_EX_SIZEOF_ONE_PACKET)))))
115#define SEN_LEFT_FLAG(buf)          SEN_SIZE_OF_PACKET(buf, SEN_MAX_PACKET_EXCHANGE)
116
117
118
119// デバイスドライバとしてコンパイルする際に必要な定義
120#ifdef  SEN_DEVICE_DRIVER
121
122// OS 判定
123#ifdef  WIN32
124#define OS_WIN32    // Microsoft Windows
125#else
126#define OS_UNIX     // UNIX / Linux
127#endif
128
129
130// 型宣言
131#ifndef WINDOWS_H_INCLUDED
132#ifndef WIN9X
133typedef unsigned long       BOOL;
134#endif  // WIN9X
135#define TRUE                1
136#define FALSE               0
137#endif
138typedef unsigned long       bool;
139#define true                1
140#define false               0
141typedef unsigned long long  UINT64;
142typedef signed long long    INT64;
143typedef unsigned short      WORD;
144typedef unsigned short      USHORT;
145typedef signed short        SHORT;
146typedef unsigned char       BYTE;
147typedef unsigned char       UCHAR;
148typedef signed char         CHAR;
149typedef unsigned long       DWORD;
150#define INFINITE            0xFFFFFFFF
151
152#define LESS(a, max_value)  ((a) < (max_value) ? (a) : (max_value))
153#define MORE(a, min_value)  ((a) > (min_value) ? (a) : (min_value))
154#define INNER(a, b, c)      (((b) <= (c) && (a) >= (b) && (a) <= (c)) || ((b) >= (c) && (a) >= (c) && (a) <= (b)))
155#define OUTER(a, b, c)      (!INNER((a), (b), (c)))
156#define MAKESURE(a, b, c)       (((b) <= (c)) ? (MORE(LESS((a), (c)), (b))) : (MORE(LESS((a), (b)), (c))))
157#define MIN(a, b)           ((a) >= (b) ? (b) : (a))
158#define MAX(a, b)           ((a) >= (b) ? (a) : (b))
159
160#ifdef  OS_WIN32
161// NDIS 5.0 関係
162#include "NDIS5.h"
163#endif  // OS_WIN32
164
165// ロック
166typedef struct _SEN_LOCK
167{
168#ifdef  OS_WIN32
169    NDIS_SPIN_LOCK spin_lock;
170#endif
171} SEN_LOCK;
172
173// イベント
174typedef struct _SEN_EVENT
175{
176#ifdef  OS_WIN32
177#ifndef WIN9X
178    KEVENT *event;
179    HANDLE event_handle;
180#else   // WIN9X
181    DWORD win32_event;
182#endif  // WIN9X
183#endif
184} SEN_EVENT;
185
186// パケットキュー
187typedef struct _SEN_QUEUE
188{
189    struct _SEN_QUEUE *Next;
190    UINT Size;
191    void *Buf;
192} SEN_QUEUE;
193
194// ステータス
195typedef struct _SEN_STATUS
196{
197    UINT NumPacketSend;
198    UINT NumPacketRecv;
199    UINT NumPacketSendError;
200    UINT NumPacketRecvError;
201    UINT NumPacketRecvNoBuffer;
202} SEN_STATUS;
203
204// NDIS パケットバッファ
205typedef struct _PACKET_BUFFER
206{
207    void *Buf;                          // バッファ
208    NDIS_PACKET *NdisPacket;            // NDIS パケット
209    NDIS_BUFFER *NdisBuffer;            // NDIS パケットバッファ
210    NDIS_HANDLE PacketPool;             // パケットプール
211    NDIS_HANDLE BufferPool;             // バッファプール
212} PACKET_BUFFER;
213
214// コンテキスト
215typedef struct _SEN_CTX
216{
217    SEN_EVENT *Event;                   // パケット受信通知イベント
218    BOOL Opened;                        // Open されているか否かのフラグ
219    BOOL Inited;                        // 初期化フラグ
220    BOOL Initing;                       // 起動中フラグ
221    volatile BOOL Halting;              // 停止中フラグ
222    BYTE MacAddress[6];                 // MAC アドレス
223    BYTE padding[2];                    // padding
224    SEN_QUEUE *PacketQueue;             // 送信パケットキュー
225    SEN_QUEUE *Tail;                    // 送信パケットキューの末尾
226    UINT NumPacketQueue;                // パケットキュー数
227    SEN_LOCK *PacketQueueLock;          // 送信パケットキュー用ロック
228    SEN_STATUS Status;                  // ステータス
229    BOOL Connected, ConnectedOld;       // ケーブル接続状態
230    BOOL ConnectedForce;                // 接続状態強制通知
231#ifdef  OS_WIN32
232    NDIS_HANDLE NdisWrapper;            // NDIS ラッパーハンドル
233    NDIS_HANDLE NdisControl;            // NDIS コントロールハンドル
234    NDIS_HANDLE NdisMiniport;           // NDIS ミニポートハンドル
235    NDIS_HANDLE NdisContext;            // NDIS コンテキストハンドル
236    NDIS_HANDLE NdisConfig;             // NDIS Config ハンドル
237    DEVICE_OBJECT *NdisControlDevice;   // NDIS コントロールデバイス
238    PDRIVER_DISPATCH DispatchTable[IRP_MJ_MAXIMUM_FUNCTION];
239    PACKET_BUFFER *PacketBuffer[SEN_MAX_PACKET_EXCHANGE];       // NDIS パケットバッファ
240    NDIS_PACKET *PacketBufferArray[SEN_MAX_PACKET_EXCHANGE];    // NDIS パケットバッファ配列
241    NDIS_HARDWARE_STATUS HardwareStatus;    // ハードウェア状態
242    char HardwareID[MAX_SIZE];          // ハードウェア ID
243    char HardwareID_Raw[MAX_SIZE];      // 元のハードウェア ID
244    char HardwarePrintableID[MAX_SIZE]; // ハードウェア ID (表示用)
245#endif
246} SEN_CTX;
247
248extern SEN_CTX *ctx;
249
250
251// Sen.c ルーチン
252void SenNewStatus(SEN_STATUS *s);
253void SenFreeStatus(SEN_STATUS *s);
254BOOL SenInit();
255void SenShutdown();
256void SenInitPacketQueue();
257void SenFreePacketQueue();
258void SenClearPacketQueue();
259void SenLockPacketQueue();
260void SenUnlockPacketQueue();
261SEN_QUEUE *SenGetNextQueue();
262void SenFreeQueue(SEN_QUEUE *q);
263void SenInsertQueue(void *buf, UINT size);
264UINT SenGetNumQueue();
265void SenStartAdapter();
266void SenStopAdapter();
267void SenRead(void *buf);
268void SenWrite(void *buf);
269
270// 共通ルーチン (プラットフォーム依存)
271void *SenMalloc(UINT size);
272void *SenZeroMalloc(UINT size);
273void SenFree(void *p);
274void SenCopy(void *dst, void *src, UINT size);
275void SenZero(void *dst, UINT size);
276SEN_LOCK *SenNewLock();
277void SenLock(SEN_LOCK *lock);
278void SenUnlock(SEN_LOCK *lock);
279void SenFreeLock(SEN_LOCK *lock);
280SEN_EVENT *SenNewEvent(char *name);
281SEN_EVENT *SenCreateWin9xEvent(DWORD h);
282void SenFreeEvent(SEN_EVENT *event);
283void SenSet(SEN_EVENT *event);
284void SenReset(SEN_EVENT *event);
285BOOL SenIsKernelAddress(void *addr);
286
287#endif  // SEN_DEVICE_DRIVER
288
289
290#endif  // SEN_H
291
292
293
Note: See TracBrowser for help on using the repository browser.