Code:
/ 4.0 / 4.0 / untmp / DEVDIV_TFS / Dev10 / Releases / RTMRel / ndp / fx / src / Net / System / Net / Logging.cs / 1305376 / Logging.cs
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
namespace System.Net {
using System.Collections;
using System.IO;
using System.Threading;
using System.Diagnostics;
using System.Security;
using System.Security.Permissions;
using System.Runtime.InteropServices;
using System.Globalization;
using Microsoft.Win32;
using System.Diagnostics.CodeAnalysis;
internal class Logging {
private static bool s_LoggingEnabled = true;
private static bool s_LoggingInitialized;
private static bool s_AppDomainShutdown;
private const int DefaultMaxDumpSize = 1024;
private const bool DefaultUseProtocolTextOnly = false;
private const string AttributeNameMaxSize = "maxdatasize";
private const string AttributeNameTraceMode = "tracemode";
private static readonly string[] SupportedAttributes = new string[] { AttributeNameMaxSize, AttributeNameTraceMode };
private const string AttributeValueProtocolOnly = "protocolonly";
//private const string AttributeValueIncludeHex = "includehex";
private const string TraceSourceWebName = "System.Net";
private const string TraceSourceHttpListenerName = "System.Net.HttpListener";
private const string TraceSourceSocketsName = "System.Net.Sockets";
private const string TraceSourceCacheName = "System.Net.Cache";
private static TraceSource s_WebTraceSource;
private static TraceSource s_HttpListenerTraceSource;
private static TraceSource s_SocketsTraceSource;
private static TraceSource s_CacheTraceSource;
private Logging() {
}
private static object s_InternalSyncObject;
private static object InternalSyncObject {
get {
if (s_InternalSyncObject == null) {
object o = new Object();
Interlocked.CompareExchange(ref s_InternalSyncObject, o, null);
}
return s_InternalSyncObject;
}
}
internal static bool On {
get {
if (!s_LoggingInitialized) {
InitializeLogging();
}
return s_LoggingEnabled;
}
}
internal static bool IsVerbose(TraceSource traceSource) {
return ValidateSettings(traceSource, TraceEventType.Verbose);
}
internal static TraceSource Web {
get {
if (!s_LoggingInitialized) {
InitializeLogging();
}
if (!s_LoggingEnabled) {
return null;
}
return s_WebTraceSource;
}
}
internal static TraceSource HttpListener {
get {
if (!s_LoggingInitialized) {
InitializeLogging();
}
if (!s_LoggingEnabled) {
return null;
}
return s_HttpListenerTraceSource;
}
}
internal static TraceSource Sockets {
get {
if (!s_LoggingInitialized) {
InitializeLogging();
}
if (!s_LoggingEnabled) {
return null;
}
return s_SocketsTraceSource;
}
}
internal static TraceSource RequestCache {
get {
if (!s_LoggingInitialized) {
InitializeLogging();
}
if (!s_LoggingEnabled) {
return null;
}
return s_CacheTraceSource;
}
}
private static bool GetUseProtocolTextSetting(TraceSource traceSource) {
bool useProtocolTextOnly = DefaultUseProtocolTextOnly;
if (traceSource.Attributes[AttributeNameTraceMode] == AttributeValueProtocolOnly) {
useProtocolTextOnly = true;
}
return useProtocolTextOnly;
}
private static int GetMaxDumpSizeSetting(TraceSource traceSource) {
int maxDumpSize = DefaultMaxDumpSize;
if (traceSource.Attributes.ContainsKey(AttributeNameMaxSize)) {
try {
maxDumpSize = Int32.Parse(traceSource.Attributes[AttributeNameMaxSize], NumberFormatInfo.InvariantInfo);
} catch (Exception exception) {
if (exception is ThreadAbortException || exception is StackOverflowException || exception is OutOfMemoryException) {
throw;
}
traceSource.Attributes[AttributeNameMaxSize] = maxDumpSize.ToString(NumberFormatInfo.InvariantInfo);
}
}
return maxDumpSize;
}
///
/// Sets up internal config settings for logging. (MUST be called under critsec)
///
private static void InitializeLogging() {
lock(InternalSyncObject) {
if (!s_LoggingInitialized) {
bool loggingEnabled = false;
s_WebTraceSource = new NclTraceSource(TraceSourceWebName);
s_HttpListenerTraceSource = new NclTraceSource(TraceSourceHttpListenerName);
s_SocketsTraceSource = new NclTraceSource(TraceSourceSocketsName);
s_CacheTraceSource = new NclTraceSource(TraceSourceCacheName);
GlobalLog.Print("Initalizating tracing");
try {
loggingEnabled = (s_WebTraceSource.Switch.ShouldTrace(TraceEventType.Critical) ||
s_HttpListenerTraceSource.Switch.ShouldTrace(TraceEventType.Critical) ||
s_SocketsTraceSource.Switch.ShouldTrace(TraceEventType.Critical) ||
s_CacheTraceSource.Switch.ShouldTrace(TraceEventType.Critical));
}
catch (SecurityException) {
// These may throw if the caller does not have permission to hook up trace listeners.
// We treat this case as though logging were disabled.
Close();
loggingEnabled = false;
}
if (loggingEnabled) {
AppDomain currentDomain = AppDomain.CurrentDomain;
currentDomain.UnhandledException += new UnhandledExceptionEventHandler(UnhandledExceptionHandler);
currentDomain.DomainUnload += new EventHandler(AppDomainUnloadEvent);
currentDomain.ProcessExit += new EventHandler(ProcessExitEvent);
}
s_LoggingEnabled = loggingEnabled;
s_LoggingInitialized = true;
}
}
}
[SuppressMessage("Microsoft.Security","CA2122:DoNotIndirectlyExposeMethodsWithLinkDemands", Justification="Logging functions must work in partial trust mode")]
private static void Close() {
if (s_WebTraceSource != null) s_WebTraceSource.Close();
if (s_HttpListenerTraceSource != null) s_HttpListenerTraceSource.Close();
if (s_SocketsTraceSource != null) s_SocketsTraceSource.Close();
if (s_CacheTraceSource != null) s_CacheTraceSource.Close();
}
///
/// Logs any unhandled exception through this event handler
///
private static void UnhandledExceptionHandler(object sender, UnhandledExceptionEventArgs args) {
Exception e = (Exception) args.ExceptionObject;
Exception(Web, sender, "UnhandledExceptionHandler", e);
}
private static void ProcessExitEvent(object sender, EventArgs e) {
Close();
s_AppDomainShutdown = true;
}
///
/// Called when the system is shutting down, used to prevent additional logging post-shutdown
///
private static void AppDomainUnloadEvent(object sender, EventArgs e) {
Close();
s_AppDomainShutdown = true;
}
///
/// Confirms logging is enabled, given current logging settings
///
private static bool ValidateSettings(TraceSource traceSource, TraceEventType traceLevel) {
if (!s_LoggingEnabled) {
return false;
}
if (!s_LoggingInitialized) {
InitializeLogging();
}
if (traceSource == null || !traceSource.Switch.ShouldTrace(traceLevel)) {
return false;
}
if (s_AppDomainShutdown) {
return false;
}
return true;
}
///
/// Converts an object to a normalized string that can be printed
/// takes System.Net.ObjectNamedFoo and coverts to ObjectNamedFoo
///
private static string GetObjectName(object obj) {
string objName = obj.ToString();
try {
if (!(obj is Uri)) {
int index = objName.LastIndexOf('.')+1;
return objName.Substring(index, objName.Length-index);
} else {
return objName;
}
} catch (Exception exception) {
if (exception is ThreadAbortException || exception is StackOverflowException || exception is OutOfMemoryException) {
throw;
}
return objName;
}
}
internal static uint GetThreadId()
{
uint threadId = UnsafeNclNativeMethods.GetCurrentThreadId();
if (threadId == 0) {
threadId = (uint)Thread.CurrentThread.GetHashCode();
}
return threadId;
}
internal static void PrintLine(TraceSource traceSource, TraceEventType eventType, int id, string msg) {
string logHeader = "["+GetThreadId().ToString("d4", CultureInfo.InvariantCulture)+"] " ;
traceSource.TraceEvent(eventType, id, logHeader + msg);
}
///
/// Indicates that two objects are getting used with one another
///
internal static void Associate(TraceSource traceSource, object objA, object objB) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
string lineA = GetObjectName(objA) + "#" + ValidationHelper.HashString(objA);
string lineB = GetObjectName(objB) + "#" + ValidationHelper.HashString(objB);
PrintLine(traceSource, TraceEventType.Information, 0, "Associating " + lineA + " with " + lineB);
}
///
/// Logs entrance to a function
///
internal static void Enter(TraceSource traceSource, object obj, string method, string param) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
Enter(traceSource, GetObjectName(obj)+"#"+ValidationHelper.HashString(obj), method, param);
}
///
/// Logs entrance to a function
///
internal static void Enter(TraceSource traceSource, object obj, string method, object paramObject) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
Enter(traceSource, GetObjectName(obj)+"#"+ValidationHelper.HashString(obj), method, paramObject);
}
///
/// Logs entrance to a function
///
internal static void Enter(TraceSource traceSource, string obj, string method, string param) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
Enter(traceSource, obj +"::"+method+"("+param+")");
}
///
/// Logs entrance to a function
///
internal static void Enter(TraceSource traceSource, string obj, string method, object paramObject) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
string paramObjectValue = "";
if (paramObject != null) {
paramObjectValue = GetObjectName(paramObject) + "#" + ValidationHelper.HashString(paramObject);
}
Enter(traceSource, obj +"::"+method+"("+paramObjectValue+")");
}
///
/// Logs entrance to a function, indents and points that out
///
internal static void Enter(TraceSource traceSource, string method, string parameters) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
Enter(traceSource, method+"("+parameters+")");
}
///
/// Logs entrance to a function, indents and points that out
///
internal static void Enter(TraceSource traceSource, string msg) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
// Trace.CorrelationManager.StartLogicalOperation();
PrintLine(traceSource, TraceEventType.Verbose, 0, msg);
}
///
/// Logs exit from a function
///
internal static void Exit(TraceSource traceSource, object obj, string method, object retObject) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
string retValue = "";
if (retObject != null) {
retValue = GetObjectName(retObject)+ "#" + ValidationHelper.HashString(retObject);
}
Exit(traceSource, obj, method, retValue);
}
///
/// Logs exit from a function
///
internal static void Exit(TraceSource traceSource, string obj, string method, object retObject) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
string retValue = "";
if (retObject != null) {
retValue = GetObjectName(retObject) + "#" + ValidationHelper.HashString(retObject);
}
Exit(traceSource, obj, method, retValue);
}
///
/// Logs exit from a function
///
internal static void Exit(TraceSource traceSource, object obj, string method, string retValue) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
Exit(traceSource, GetObjectName(obj)+"#"+ValidationHelper.HashString(obj), method, retValue);
}
///
/// Logs exit from a function
///
internal static void Exit(TraceSource traceSource, string obj, string method, string retValue) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
if (!ValidationHelper.IsBlankString(retValue)) {
retValue = "\t-> " + retValue;
}
Exit(traceSource, obj+"::"+method+"() "+retValue);
}
///
/// Logs exit from a function
///
internal static void Exit(TraceSource traceSource, string method, string parameters) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
Exit(traceSource, method+"() "+parameters);
}
///
/// Logs exit from a function
///
internal static void Exit(TraceSource traceSource, string msg) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
PrintLine(traceSource, TraceEventType.Verbose, 0, "Exiting "+msg);
// Trace.CorrelationManager.StopLogicalOperation();
}
///
/// Logs Exception, restores indenting
///
internal static void Exception(TraceSource traceSource, object obj, string method, Exception e) {
if (!ValidateSettings(traceSource, TraceEventType.Error)) {
return;
}
string infoLine = "Exception in the "+GetObjectName(obj)+"#"+ValidationHelper.HashString(obj) +"::"+method+" - ";
//Trace.IndentLevel = 0;
PrintLine(traceSource, TraceEventType.Error, 0, infoLine + e.Message);
if (!ValidationHelper.IsBlankString(e.StackTrace)) {
PrintLine(traceSource, TraceEventType.Error, 0, e.StackTrace);
}
/*
if (e.InnerException != null)
{
PrintLine(" ---- inner exception --- ");
PrintLine(traceSource, TraceEventType.Error, 0, infoLine + e.InnerException.Message);
PrintLine(traceSource, TraceEventType.Error, 0, infoLine + e.InnerException.Message);
if (!ValidationHelper.IsBlankString(e.InnerException.StackTrace)) {
PrintLine(traceSource, TraceEventType.Error, 0, e.InnerException.StackTrace);
}
PrintLine(" ---- End of inner exception --- ");
}
*/
}
///
/// Logs an Info line
///
internal static void PrintInfo(TraceSource traceSource, string msg) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
PrintLine(traceSource, TraceEventType.Information, 0, msg);
}
///
/// Logs an Info line
///
internal static void PrintInfo(TraceSource traceSource, object obj, string msg) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
PrintLine(traceSource, TraceEventType.Information, 0,
GetObjectName(obj)+"#"+ValidationHelper.HashString(obj)
+" - "+msg);
}
///
/// Logs an Info line
///
internal static void PrintInfo(TraceSource traceSource, object obj, string method, string param) {
if (!ValidateSettings(traceSource, TraceEventType.Information)) {
return;
}
PrintLine(traceSource, TraceEventType.Information, 0,
GetObjectName(obj)+"#"+ValidationHelper.HashString(obj)
+"::"+method+"("+param+")");
}
///
/// Logs a Warning line
///
internal static void PrintWarning(TraceSource traceSource, string msg) {
if (!ValidateSettings(traceSource, TraceEventType.Warning)) {
return;
}
PrintLine(traceSource, TraceEventType.Warning, 0, msg);
}
///
/// Logs a Warning line
///
internal static void PrintWarning(TraceSource traceSource, object obj, string method, string msg) {
if (!ValidateSettings(traceSource, TraceEventType.Warning)) {
return;
}
PrintLine(traceSource, TraceEventType.Warning, 0,
GetObjectName(obj)+"#"+ValidationHelper.HashString(obj)
+"::"+method+"() - "+msg);
}
///
/// Logs an Error line
///
internal static void PrintError(TraceSource traceSource, string msg) {
if (!ValidateSettings(traceSource, TraceEventType.Error)) {
return;
}
PrintLine(traceSource, TraceEventType.Error, 0, msg);
}
///
/// Logs an Error line
///
internal static void PrintError(TraceSource traceSource, object obj, string method, string msg) {
if (!ValidateSettings(traceSource, TraceEventType.Error)) {
return;
}
PrintLine(traceSource, TraceEventType.Error, 0,
GetObjectName(obj)+"#"+ValidationHelper.HashString(obj)
+"::"+method+"() - "+msg);
}
///
/// Marhsalls a buffer ptr to an array and then dumps the byte array to the log
///
internal static void Dump(TraceSource traceSource, object obj, string method, IntPtr bufferPtr, int length) {
if (!ValidateSettings(traceSource, TraceEventType.Verbose) || bufferPtr == IntPtr.Zero || length < 0) {
return;
}
byte [] buffer = new byte[length];
Marshal.Copy(bufferPtr, buffer, 0, length);
Dump(traceSource, obj, method, buffer, 0, length);
}
///
/// Dumps a byte array to the log
///
internal static void Dump(TraceSource traceSource, object obj, string method, byte[] buffer, int offset, int length) {
if (!ValidateSettings(traceSource, TraceEventType.Verbose)) {
return;
}
if (buffer == null) {
PrintLine(traceSource, TraceEventType.Verbose, 0, "(null)");
return;
}
if (offset > buffer.Length) {
PrintLine(traceSource, TraceEventType.Verbose, 0, "(offset out of range)");
return;
}
PrintLine(traceSource, TraceEventType.Verbose, 0, "Data from "+GetObjectName(obj)+"#"+ValidationHelper.HashString(obj) +"::"+method);
int maxDumpSize = GetMaxDumpSizeSetting(traceSource);
if (length > maxDumpSize) {
PrintLine(traceSource, TraceEventType.Verbose, 0, "(printing " + maxDumpSize.ToString(NumberFormatInfo.InvariantInfo) + " out of " + length.ToString(NumberFormatInfo.InvariantInfo) + ")");
length = maxDumpSize;
}
if ((length < 0) || (length > buffer.Length - offset)) {
length = buffer.Length - offset;
}
if (GetUseProtocolTextSetting(traceSource)) {
string output = "<<" + WebHeaderCollection.HeaderEncoding.GetString(buffer, offset, length) + ">>";
PrintLine(traceSource, TraceEventType.Verbose, 0, output);
return;
}
do {
int n = Math.Min(length, 16);
string disp = String.Format(CultureInfo.CurrentCulture, "{0:X8} : ", offset);
for (int i = 0; i < n; ++i) {
disp += String.Format(CultureInfo.CurrentCulture, "{0:X2}", buffer[offset + i]) + ((i == 7) ? '-' : ' ');
}
for (int i = n; i < 16; ++i) {
disp += " ";
}
disp += ": ";
for (int i = 0; i < n; ++i) {
disp += ((buffer[offset + i] < 0x20) || (buffer[offset + i] > 0x7e))
? '.'
: (char)(buffer[offset + i]);
}
PrintLine(traceSource, TraceEventType.Verbose, 0, disp);
offset += n;
length -= n;
} while (length > 0);
}
private class NclTraceSource : TraceSource
{
internal NclTraceSource(string name) : base(name) { }
protected internal override string[] GetSupportedAttributes()
{
return Logging.SupportedAttributes;
}
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- AmbientLight.cs
- DispatcherOperation.cs
- SqlOuterApplyReducer.cs
- ZoomingMessageFilter.cs
- RadioButtonList.cs
- OleDbParameterCollection.cs
- StringInfo.cs
- DoubleAnimationUsingPath.cs
- DbConnectionPool.cs
- DocumentGrid.cs
- FileSecurity.cs
- SharedUtils.cs
- ObjectCloneHelper.cs
- Model3DGroup.cs
- TableLayoutPanelBehavior.cs
- MarkupProperty.cs
- QuaternionAnimation.cs
- SourceElementsCollection.cs
- IdnMapping.cs
- OledbConnectionStringbuilder.cs
- ResourceType.cs
- ToolbarAUtomationPeer.cs
- StandardOleMarshalObject.cs
- XmlNullResolver.cs
- ListBindableAttribute.cs
- TraceData.cs
- OperationDescriptionCollection.cs
- SoapHeaders.cs
- DispatchChannelSink.cs
- StylusEditingBehavior.cs
- MarshalByRefObject.cs
- Clock.cs
- ListViewItem.cs
- PersonalizableAttribute.cs
- LabelEditEvent.cs
- GeometryGroup.cs
- ValueConversionAttribute.cs
- SizeChangedInfo.cs
- DataGridViewHitTestInfo.cs
- ConsoleTraceListener.cs
- WebControl.cs
- HttpTransportManager.cs
- FullTextBreakpoint.cs
- XmlBufferReader.cs
- TypeResolver.cs
- WebControlAdapter.cs
- MasterPage.cs
- WebProxyScriptElement.cs
- BinaryReader.cs
- ChtmlPageAdapter.cs
- MissingFieldException.cs
- TableStyle.cs
- MeasureData.cs
- ElementMarkupObject.cs
- StructureChangedEventArgs.cs
- PropertySegmentSerializer.cs
- BatchWriter.cs
- EngineSiteSapi.cs
- InputLanguageProfileNotifySink.cs
- HttpProfileBase.cs
- ArgumentNullException.cs
- DataRecordObjectView.cs
- SQLResource.cs
- GenericUI.cs
- XmlAttributeProperties.cs
- SqlDataReaderSmi.cs
- ClientRolePrincipal.cs
- QueuePropertyVariants.cs
- QuaternionKeyFrameCollection.cs
- FieldToken.cs
- HttpVersion.cs
- OutputCacheSettings.cs
- XmlAttributeAttribute.cs
- NavigatorOutput.cs
- OciHandle.cs
- NavigationExpr.cs
- Stylesheet.cs
- ApplicationSecurityManager.cs
- HostedBindingBehavior.cs
- FormsIdentity.cs
- Vector3DAnimationUsingKeyFrames.cs
- ActivationServices.cs
- X509Certificate.cs
- PenContexts.cs
- ErrorHandlerModule.cs
- SingleKeyFrameCollection.cs
- AnnotationObservableCollection.cs
- DbConnectionPoolGroupProviderInfo.cs
- RoleService.cs
- AssertSection.cs
- DbConnectionStringBuilder.cs
- AssociatedControlConverter.cs
- AuditLevel.cs
- BindingsCollection.cs
- CollectionContainer.cs
- PresentationSource.cs
- XmlRawWriter.cs
- ResourceFallbackManager.cs
- SqlCaseSimplifier.cs
- Style.cs