DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Untracked file

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Red Hat, Inc.
 * Portions created by the Initial Developer are Copyright (C) 2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Kai Engert <kengert@redhat.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef _NSSSLTHREAD_H_
#define _NSSSLTHREAD_H_

#include "nsCOMPtr.h"
#include "nsIRequest.h"
#include "nsPSMBackgroundThread.h"

class nsNSSSocketInfo;
class nsIHttpChannel;

class nsSSLThread : public nsPSMBackgroundThread
{
private:
  // We use mMutex contained in our base class
  // to protect access to these variables:
  //   mBusySocket, mSocketScheduledToBeDestroyed
  // and to nsSSLSocketThreadData::mSSLState
  // while a socket is the busy socket.

  // We use mCond contained in our base class
  // to notify the SSL thread that a new SSL I/O 
  // request has been queued for processing.
  // It can be found in the mBusySocket variable,
  // containing all details in its member.

  // A socket that is currently owned by the SSL thread 
  // and has pending SSL I/O activity or I/O results 
  // not yet fetched by the original caller.
  nsNSSSocketInfo *mBusySocket;
  
  // A socket that should be closed and destroyed
  // as soon as possible. The request was initiated by
  // Necko, but it happened at a time when the SSL
  // thread had ownership of the socket, so the request
  // was delayed. It's now the responsibility of the
  // SSL thread to close and destroy this socket.
  nsNSSSocketInfo *mSocketScheduledToBeDestroyed;

  // Did we receive a request from NSS to fetch HTTP 
  // data on behalf of NSS? (Most likely this is a OCSP request)
  // We track a handle to the HTTP request sent to Necko.
  // As this HTTP request depends on some original SSL socket,
  // we can use this handle to cancel the dependent HTTP request,
  // should we be asked to close the original SSL socket.
  nsCOMPtr<nsIRequest> mPendingHTTPRequest;

  virtual void Run(void);

  // Called from SSL thread only
  static PRInt32 checkHandshake(PRInt32 bytesTransfered, 
                                PRBool wasReading,
                                PRFileDesc* fd, 
                                nsNSSSocketInfo *socketInfo);

  // Function can be called from either Necko or SSL thread
  // Caller must lock mMutex before this call.
  static void restoreOriginalSocket_locked(nsNSSSocketInfo *si);

  // Helper for requestSomething functions, 
  // caled from the Necko thread only.
  static PRFileDesc *getRealSSLFD(nsNSSSocketInfo *si);

  // Support of blocking sockets is very rudimentary.
  // We only support it because Mozilla's LDAP code requires blocking I/O.
  // We do not support switching the blocking mode of a socket.
  // We require the blocking state has been set prior to the first 
  // read/write call, and will stay that way for the remainder of the socket's lifetime.
  // This function must be called while holding the lock.
  // If the socket is a blocking socket, out_fd will contain the real FD, 
  // on a non-blocking socket out_fd will be nsnull.
  // If there is a failure in obtaining the status of the socket,
  // the function will return PR_FAILURE.
  static PRStatus getRealFDIfBlockingSocket_locked(nsNSSSocketInfo *si, 
                                                   PRFileDesc *&out_fd);
public:
  nsSSLThread();
  ~nsSSLThread();

  static nsSSLThread *ssl_thread_singleton;

  // All requestSomething functions are called from 
  // the Necko thread only.

  static PRInt32 requestRead(nsNSSSocketInfo *si, 
                             void *buf, 
                             PRInt32 amount,
                             PRIntervalTime timeout);

  static PRInt32 requestWrite(nsNSSSocketInfo *si, 
                              const void *buf, 
                              PRInt32 amount,
                              PRIntervalTime timeout);

  static PRInt16 requestPoll(nsNSSSocketInfo *si, 
                             PRInt16 in_flags, 
                             PRInt16 *out_flags);

  static PRInt32 requestRecvMsgPeek(nsNSSSocketInfo *si, void *buf, PRInt32 amount,
                                    PRIntn flags, PRIntervalTime timeout);

  static PRStatus requestClose(nsNSSSocketInfo *si);

  static PRStatus requestGetsockname(nsNSSSocketInfo *si, PRNetAddr *addr);

  static PRStatus requestGetpeername(nsNSSSocketInfo *si, PRNetAddr *addr);

  static PRStatus requestGetsocketoption(nsNSSSocketInfo *si, 
                                         PRSocketOptionData *data);

  static PRStatus requestSetsocketoption(nsNSSSocketInfo *si, 
                                         const PRSocketOptionData *data);

  static PRStatus requestConnectcontinue(nsNSSSocketInfo *si, 
                                         PRInt16 out_flags);

  static nsresult requestActivateSSL(nsNSSSocketInfo *si);
  
  static PRBool exitRequested();
};

#endif //_NSSSLTHREAD_H_