usr/src/man/man1/nca.1

   1 '\" te
   2 .\" Copyright (C) 2005, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH NCA 1 "Feb 22, 2005"
   7 .SH NAME
   8 nca, snca \- the Solaris Network Cache and Accelerator (NCA)
   9 .SH DESCRIPTION
  10 .sp
  11 .LP
  12 The Solaris Network Cache and Accelerator ("\fBNCA\fR") is a kernel module
  13 designed to provide improved web server performance. The kernel module,
  14 \fBncakmod\fR, services \fBHTTP\fR requests. To improve the performance of
  15 servicing \fBHTTP\fR requests, the \fBNCA\fR kernel module maintains an
  16 in-kernel cache of web pages. If the \fBNCA\fR kernel module cannot service the
  17 request itself, it passes the request to the \fBhttp\fR daemon (\fBhttpd\fR).
  18 It uses either a sockets interface, with family type designated \fBPF_NCA\fR,
  19 or a private Solaris doors interface that is based on the Solaris doors RPC
  20 mechanism, to pass the request.
  21 .sp
  22 .LP
  23 To use the sockets interface, the web server must open a socket of family type
  24 \fBPF_NCA\fR. The \fBPF_NCA\fR family supports only \fBSOCK_STREAM\fR and
  25 protocol 0, otherwise an error occurs.
  26 .sp
  27 .LP
  28 The following features are not presently supported:
  29 .RS +4
  30 .TP
  31 .ie t \(bu
  32 .el o
  33 You cannot initiate a connection from a \fBPF_NCA\fR type socket. The
  34 \fBconnect\fR(3SOCKET) interface on \fBPF_NCA\fR fails.
  35 .RE
  36 .RS +4
  37 .TP
  38 .ie t \(bu
  39 .el o
  40 System calls that are associated with type \fBSO_DGRAM\fR, such as
  41 \fBsend()\fR, \fBsendto()\fR, \fBsendmsg()\fR, \fBrecv()\fR, \fBrecvfrom()\fR,
  42 and \fBrecvmsg()\fR, fails.
  43 .RE
  44 .RS +4
  45 .TP
  46 .ie t \(bu
  47 .el o
  48 You cannot set TCP or IP options on a \fBPF_NCA\fR type socket through
  49 \fBsetsockopt\fR(3SOCKET).
  50 .RE
  51 .sp
  52 .LP
  53 The \fBNCA\fR cache consistency is maintained by honoring \fBHTTP\fR headers
  54 that deal with a given content type and expiration date, much the same way as a
  55 proxy cache.
  56 .sp
  57 .LP
  58 For configuration information, see \fISystem Administration Guide: IP
  59 Services\fR
  60 .sp
  61 .LP
  62 When native \fBPF_NCA\fR socket support does not exist in the web server, the
  63 \fBncad_addr\fR(4) interface must be used to provide NCA support in that web
  64 server.
  65 .sp
  66 .LP
  67 \fBNCA\fR is intended to be run on a dedicated web server. Running other large
  68 processes while running \fBNCA\fR might cause undesirable behavior.
  69 .sp
  70 .LP
  71 \fBNCA\fR supports the logging of in-kernel cache hits. See
  72 \fBncalogd.conf\fR(4). \fBNCA\fR stores logs in a binary format. Use the
  73 \fBncab2clf\fR(1) utility to convert the log from a binary format to the Common
  74 Log File format.
  75 .SH FILES
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fB/etc/nca/ncakmod.conf\fR\fR
  80 .ad
  81 .RS 25n
  82 Lists configuration parameters for \fBNCA\fR.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fB/etc/nca/ncalogd.conf\fR\fR
  89 .ad
  90 .RS 25n
  91 Lists configuration parameters for \fBNCA\fR logging.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB/etc/nca/nca.if\fR\fR
  98 .ad
  99 .RS 25n
 100 Lists the physical interfaces on which \fBNCA\fR runs.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fB/etc/nca/ncaport.conf\fR\fR
 107 .ad
 108 .RS 25n
 109 \fBncaport\fR configuration file
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fB/etc/hostname.{}{0-9}\fR\fR
 116 .ad
 117 .RS 25n
 118 Lists all physical interfaces configured on the server.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fB/etc/hosts\fR\fR
 125 .ad
 126 .RS 25n
 127 Lists all host names associated with the server. Entries in this file must
 128 match with entries in \fB/etc/hostname.{}{0-9}\fR for \fBNCA\fR to function.
 129 .RE
 130
 131 .SH ATTRIBUTES
 132 .sp
 133 .LP
 134 See \fBattributes\fR(5) for descriptions of the following attributes:
 135 .sp
 136
 137 .sp
 138 .TS
 139 box;
 140 c | c
 141 l | l .
 142 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 143 _
 144 Interface Stability     Committed
 145 .TE
 146
 147 .SH SEE ALSO
 148 .sp
 149 .LP
 150 \fBncab2clf\fR(1), \fBncakmod\fR(1), \fBclose\fR(2), \fBread\fR(2),
 151 \fBwrite\fR(2), \fBsendfilev\fR(3EXT), \fBaccept\fR(3SOCKET),
 152 \fBbind\fR(3SOCKET), \fBconnect\fR(3SOCKET), \fBdoor_bind\fR(3C),
 153 \fBdoor_call\fR(3C), \fBdoor_create\fR(3C), \fBgetsockopt\fR(3SOCKET),
 154 \fBlisten\fR(3SOCKET), \fBsetsockopt\fR(3SOCKET), \fBshutdown\fR(3SOCKET),
 155 \fBsocket.h\fR(3HEAD), \fBsocket\fR(3SOCKET), \fBncad_addr\fR(4),
 156 \fBnca.if\fR(4), \fBncakmod.conf\fR(4), \fBncaport.conf\fR(4),
 157 \fBncalogd.conf\fR(4), \fBattributes\fR(5)
 158 .sp
 159 .LP
 160 \fISystem Administration Guide: IP Services\fR