source: lab.git/Dev/utvpn/utvpn-unix-v101-7101-public/src/Cedar/Logging.h @ 86521dd

trunk
Last change on this file since 86521dd 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: 9.9 KB
Line 
1// SoftEther UT-VPN SourceCode
2//
3// Copyright (C) 2004-2010 SoftEther Corporation.
4// Copyright (C) 2004-2010 University of Tsukuba, Japan.
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// version 2 as published by the Free Software Foundation.
13//
14// This program is distributed in the hope that it will be useful,
15// but WITHOUT ANY WARRANTY; without even the implied warranty of
16// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17// GNU General Public License for more details.
18//
19// You should have received a copy of the GNU General Public License version 2
20// along with this program; if not, write to the Free Software
21// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22//
23// このファイルは GPL バージョン 2 ライセンスで公開されています。
24// 誰でもこのファイルの内容を複製、改変したり、改変したバージョンを再配布
25// することができます。ただし、原著作物を改変した場合は、原著作物の著作権表示
26// を除去することはできません。改変した著作物を配布する場合は、改変実施者の
27// 著作権表示を原著作物の著作権表示に付随して記載するようにしてください。
28//
29// この SoftEther UT-VPN オープンソース・プロジェクトは、日本国の
30// ソフトイーサ株式会社 (SoftEther Corporation, http://www.softether.co.jp/ )
31// および筑波大学 (University of Tsukuba, http://www.tsukuba.ac.jp/ ) によって
32// ホストされています。
33// 本プログラムの配布者は、本プログラムを、業としての利用以外のため、
34// および、試験または研究のために利用が行われることを想定して配布
35// しています。
36// SoftEther UT-VPN プロジェクトの Web サイトは http://utvpn.tsukuba.ac.jp/ に
37// あります。
38// 本ソフトウェアの不具合の修正、機能改良、セキュリティホールの修復などのコード
39// の改変を行った場合で、その成果物を SoftEther UT-VPN プロジェクトに提出して
40// いただける場合は、 http://utvpn.tsukuba.ac.jp/ までソースコードを送付して
41// ください。SoftEther UT-VPN プロジェクトの本体リリースまたはブランチリリース
42// に組み込みさせていただきます。
43//
44// GPL に基づいて原著作物が提供される本ソフトウェアの改良版を配布、販売する
45// 場合は、そのソースコードを GPL に基づいて誰にでも開示する義務が生じます。
46//
47// 本ソフトウェアに関連する著作権、特許権、商標権はソフトイーサ株式会社
48// (SoftEther Corporation) およびその他の著作権保持者が保有しています。
49// ソフトイーサ株式会社等はこれらの権利を放棄していません。本ソフトウェアの
50// 二次著作物を配布、販売する場合は、これらの権利を侵害しないようにご注意
51// ください。
52//
53// お願い: どのような通信ソフトウェアにも通常は必ず未発見の
54// セキュリティホールが潜んでいます。本ソースコードをご覧いただいた結果、
55// UT-VPN にセキュリティホールを発見された場合は、当該セキュリティホールの
56// 情報を不特定多数に開示される前に、必ず、ソフトイーサ株式会社
57// および脆弱性情報の届出を受け付ける公的機関まで通報いただき、
58// 公益保護にご協力いただきますようお願い申し上げます。
59//
60// ソフトイーサ株式会社は、当該セキュリティホールについて迅速に対処を
61// 行い、UT-VPN および UT-VPN に関連するソフトウェアのユーザー・顧客
62// を保護するための努力を行います。
63//
64// ソフトイーサへの届出先: http://www.softether.co.jp/jp/contact/
65// 日本国内の脆弱性情報届出受付公的機関:
66//         独立行政法人 情報処理推進機構
67//         http://www.ipa.go.jp/security/vuln/report/
68//
69// 上記各事項について不明な点は、ソフトイーサ株式会社までご連絡ください。
70// 連絡先: http://www.softether.co.jp/jp/contact/
71
72// -----------------------------------------------
73// [ChangeLog]
74// 2010.05.20
75//  新規リリース by SoftEther
76// -----------------------------------------------
77
78// Logging.h
79// Logging.c のヘッダ
80
81#ifndef LOGGING_H
82#define LOGGING_H
83
84
85#define MAX_LOG_SIZE                        1073741823ULL
86
87typedef char *(RECORD_PARSE_PROC)(RECORD *rec);
88
89// パケットログ構造体
90struct PACKET_LOG
91{
92    CEDAR *Cedar;
93    struct PKT *Packet;
94    char *SrcSessionName;
95    char *DestSessionName;
96    bool PurePacket;                        // クローンしていないパケット
97    bool PurePacketNoPayload;               // クローンしていないパケット (ペイロード無し)
98    SESSION *SrcSession;
99    bool NoLog;                             // ログを書かない
100};
101
102// HUB のログ保存オプション
103struct HUB_LOG
104{
105    bool SaveSecurityLog;                   // セキュリティログの保存
106    UINT SecurityLogSwitchType;             // セキュリティログの切り替え種類
107    bool SavePacketLog;                     // パケットログの保存
108    UINT PacketLogSwitchType;               // パケットログの切り替え種類
109    UINT PacketLogConfig[NUM_PACKET_LOG];   // パケットログ設定
110};
111
112// レコード
113struct RECORD
114{
115    UINT64 Tick;                            // 時刻
116    RECORD_PARSE_PROC *ParseProc;           // パース用プロシージャ
117    void *Data;                             // データ
118};
119
120// LOG オブジェクト
121struct LOG
122{
123    LOCK *lock;                             // ロック
124    THREAD *Thread;                         // スレッド
125    char *DirName;                          // 保存先ディレクトリ名
126    char *Prefix;                           // ファイル名
127    UINT SwitchType;                        // ログファイルの切り替え種類
128    QUEUE *RecordQueue;                     // レコードキュー
129    volatile bool Halt;                     // 停止フラグ
130    EVENT *Event;                           // ログ用イベント
131    EVENT *FlushEvent;                      // フラッシュ完了イベント
132    bool CacheFlag;
133    UINT64 LastTick;
134    UINT LastSwitchType;
135    char LastStr[MAX_SIZE];
136    UINT64 CurrentFilePointer;              // 現在のファイルポインタ
137    UINT64 MaxLogFileSize;                  // 最大ログファイルサイズ
138    UINT CurrentLogNumber;                  // 現在のログファイル番号
139    bool log_number_incremented;
140};
141
142// ERASER オブジェクト
143struct ERASER
144{
145    LOG *Log;                               // ロガー
146    UINT64 MinFreeSpace;                    // ファイルの削除を開始するディスク空き容量
147    char *DirName;                          // ディレクトリ名
148    volatile bool Halt;                     // 停止フラグ
149    THREAD *Thread;                         // スレッド
150    bool LastFailed;                        // 最後にファイル削除に失敗したかどうか
151    EVENT *HaltEvent;                       // 停止イベント
152};
153
154// 削除できるファイルの一覧
155typedef struct ERASE_FILE
156{
157    char *FullPath;                         // フルパス
158    UINT64 UpdateTime;                      // 更新日時
159} ERASE_FILE;
160
161// SYSLOG オブジェクト
162struct SLOG
163{
164    LOCK *lock;                             // ロック
165    SOCK *Udp;                              // UDP ソケット
166    IP DestIp;                              // 宛先 IP アドレス
167    UINT DestPort;                          // 宛先ポート番号
168    char HostName[MAX_HOST_NAME_LEN + 1];   // ホスト名
169    UINT64 NextPollIp;                      // 最後に IP アドレスを調べた日時
170};
171
172// 関数プロトタイプ
173LOG *NewLog(char *dir, char *prefix, UINT switch_type);
174void FreeLog(LOG *g);
175void LogThread(THREAD *thread, void *param);
176void WaitLogFlush(LOG *g);
177void LockLog(LOG *g);
178void UnlockLog(LOG *g);
179void InsertRecord(LOG *g, void *data, RECORD_PARSE_PROC *proc);
180void InsertStringRecord(LOG *g, char *str);
181void InsertUnicodeRecord(LOG *g, wchar_t *unistr);
182char *StringRecordParseProc(RECORD *rec);
183bool MakeLogFileName(LOG *g, char *name, UINT size, char *dir, char *prefix, UINT64 tick, UINT switch_type, UINT num, char *old_datestr);
184void MakeLogFileNameStringFromTick(LOG *g, char *str, UINT size, UINT64 tick, UINT switch_type);
185void WriteRecordToBuffer(BUF *b, RECORD *r);
186void SetLogDirName(LOG *g, char *dir);
187void SetLogPrefix(LOG *g, char *prefix);
188void SetLogSwitchType(LOG *g, UINT switch_type);
189void PacketLog(HUB *hub, SESSION *src_session, SESSION *dest_session, PKT *packet);
190char *PacketLogParseProc(RECORD *rec);
191UINT CalcPacketLoggingLevel(HUB *hub, PKT *packet);
192UINT CalcPacketLoggingLevelEx(HUB_LOG *g, PKT *packet);
193char *GenCsvLine(TOKEN_LIST *t);
194void ReplaceForCsv(char *str);
195char *PortStr(CEDAR *cedar, UINT port, bool udp);
196char *TcpFlagStr(UCHAR flag);
197void WriteSecurityLog(HUB *h, char *str);
198void SecLog(HUB *h, char *fmt, ...);
199void SiSetDefaultLogSetting(HUB_LOG *g);
200void DebugLog(CEDAR *c, char *fmt, ...);
201void HubLog(HUB *h, wchar_t *fmt, ...);
202void ServerLog(CEDAR *c, wchar_t *fmt, ...);
203void SLog(CEDAR *c, char *name, ...);
204void WriteHubLog(HUB *h, wchar_t *str);
205void HLog(HUB *h, char *name, ...);
206void NLog(VH *v, char *name, ...);
207void WriteServerLog(CEDAR *c, wchar_t *str);
208void ALog(ADMIN *a, HUB *h, char *name, ...);
209void CLog(CLIENT *c, char *name, ...);
210void WriteClientLog(CLIENT *c, wchar_t *str);
211ERASER *NewEraser(LOG *log, UINT64 min_size);
212void FreeEraser(ERASER *e);
213void ELog(ERASER *e, char *name, ...);
214void EraserThread(THREAD *t, void *p);
215void EraserMain(ERASER *e);
216bool CheckEraserDiskFreeSpace(ERASER *e);
217int CompareEraseFile(void *p1, void *p2);
218LIST *GenerateEraseFileList(ERASER *e);
219void FreeEraseFileList(LIST *o);
220void PrintEraseFileList(LIST *o);
221void EnumEraseFile(LIST *o, char *dirname);
222SLOG *NewSysLog(char *hostname, UINT port);
223void SetSysLog(SLOG *g, char *hostname, UINT port);
224void FreeSysLog(SLOG *g);
225void SendSysLog(SLOG *g, wchar_t *str);
226void WriteMultiLineLog(LOG *g, BUF *b);
227
228#endif  // LOGGING_G
229
Note: See TracBrowser for help on using the repository browser.