Changeset 745 for trunk/server/lib/tsocket

Timestamp:

Nov 27, 2012, 4:43:17 PM (13 years ago)

Author:

Silvan Scherrer

Message:

Samba Server: updated trunk to 3.6.0

Location:

trunk/server

Files:

• . (modified) (1 prop)
• lib/tsocket/config.mk (deleted)
• lib/tsocket/doxy.config (copied) (copied from vendor/current/lib/tsocket/doxy.config )
• lib/tsocket/tsocket.c (modified) (1 diff)
• lib/tsocket/tsocket.h (modified) (10 diffs)
• lib/tsocket/tsocket_bsd.c (modified) (25 diffs)
• lib/tsocket/tsocket_guide.txt (modified) (15 diffs)
• lib/tsocket/wscript_build (copied) (copied from vendor/current/lib/tsocket/wscript_build )

trunk/server/lib/tsocket/tsocket.c

@@ -47 +47 @@
                 return -1;
         default:
-                *perrno = EIO;
-                return -1;
+                break;
         }
 

trunk/server/lib/tsocket/tsocket.h

@@ -84 +84 @@
 
 /**
- * @brief Get a string representaion of the endpoint.
+ * @brief Get a string representation of the endpoint.
  *
  * This function creates a string representation of the endpoint for debugging.
@@ -102 +102 @@
  * @return              The address as a string representation, NULL on error.
  *
+ * @see tsocket_address_is_inet()
  * @see tsocket_address_inet_addr_string()
  * @see tsocket_address_inet_port()
@@ -486 +487 @@
  * @{
  */
+
+/**
+ * @brief Find out if the tsocket_address represents an ipv4 or ipv6 endpoint.
+ *
+ * @param[in]  addr     The tsocket_address pointer
+ *
+ * @param[in]  fam      The family can be can be "ipv4", "ipv6" or "ip". With
+ *                      "ip" is autodetects "ipv4" or "ipv6" based on the
+ *                      addr.
+ *
+ * @return              true if addr represents an address of the given family,
+ *                      otherwise false.
+ */
+bool tsocket_address_is_inet(const struct tsocket_address *addr, const char *fam);
 
 #if DOXYGEN
@@ -534 +549 @@
  * @return              A newly allocated string of the address, NULL on error
  *                      with errno set.
+ *
+ * @see tsocket_address_is_inet()
  */
 char *tsocket_address_inet_addr_string(const struct tsocket_address *addr,
@@ -559 +576 @@
                                   uint16_t port);
 
+/**
+ * @brief Find out if the tsocket_address represents an unix domain endpoint.
+ *
+ * @param[in]  addr     The tsocket_address pointer
+ *
+ * @return              true if addr represents an unix domain endpoint,
+ *                      otherwise false.
+ */
+bool tsocket_address_is_unix(const struct tsocket_address *addr);
+
 #ifdef DOXYGEN
 /**
@@ -570 +597 @@
  *
  * @return              0 on success, -1 on error with errno set.
+ *
+ * @see tsocket_address_is_unix()
  */
 int tsocket_address_unix_from_path(TALLOC_CTX *mem_ctx,
@@ -696 +725 @@
  * @param[in]  mem_ctx  The talloc memory context to use.
  *
- * @param[in]  stream   A tstream_context pointer to setup the tcp communication
+ * @param[out] stream   A tstream_context pointer to setup the tcp communication
  *                      on. This function will allocate the memory.
+ *
+ * @param[out] local    The real 'inet' tsocket_address of the local endpoint.
+ *                      This parameter is optional and can be NULL.
  *
  * @return              0 on success, -1 on error with perrno set.
@@ -704 +736 @@
                                   int *perrno,
                                   TALLOC_CTX *mem_ctx,
-                                  struct tstream_context **stream);
+                                  struct tstream_context **stream,
+                                  struct tsocket_address **local)
 #else
 int _tstream_inet_tcp_connect_recv(struct tevent_req *req,
@@ -710 +743 @@
                                    TALLOC_CTX *mem_ctx,
                                    struct tstream_context **stream,
+                                   struct tsocket_address **local,
                                    const char *location);
-#define tstream_inet_tcp_connect_recv(req, perrno, mem_ctx, stream) \
-        _tstream_inet_tcp_connect_recv(req, perrno, mem_ctx, stream, \
+#define tstream_inet_tcp_connect_recv(req, perrno, mem_ctx, stream, local) \
+        _tstream_inet_tcp_connect_recv(req, perrno, mem_ctx, stream, local, \
                                        __location__)
 #endif
@@ -874 +908 @@
  * freed. If you still want to use the fd you have have to create a duplicate.
  *
- * @param[in]  mem_ctx      The talloc memory context to use.
- *
- * @param[in]  fd           The non blocking fd to use!
- *
- * @param[in]  stream       The filed tstream_context you allocated before.
- *
- * @return              0 on success, -1 on error with errno set.
- *
- * @warning You should read the tsocket_bsd.c code and unterstand it in order
- * use this function.
+ * @param[in]  mem_ctx  The talloc memory context to use.
+ *
+ * @param[in]  fd       The non blocking fd to use!
+ *
+ * @param[out] stream   A pointer to store an allocated tstream_context.
+ *
+ * @return              0 on success, -1 on error.
+ *
+ * Example:
+ * @code
+ *   fd2 = dup(fd);
+ *   rc = tstream_bsd_existing_socket(mem_ctx, fd2, &tstream);
+ *   if (rc < 0) {
+ *     stream_terminate_connection(conn, "named_pipe_accept: out of memory");
+ *     return;
+ *   }
+ * @endcode
+ *
+ * @warning This is an internal function. You should read the code to fully
+ *          understand it if you plan to use it.
  */
 int tstream_bsd_existing_socket(TALLOC_CTX *mem_ctx,

trunk/server/lib/tsocket/tsocket_bsd.c

@@ -264 +264 @@
 
         bsda->sa_socklen = sa_socklen;
+#ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
+        bsda->u.sa.sa_len = bsda->sa_socklen;
+#endif
 
         *_addr = addr;
@@ -292 +295 @@
 
         memcpy(sa, &bsda->u.ss, sa_socklen);
+#ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
+        sa->sa_len = sa_socklen;
+#endif
         return sa_socklen;
+}
+
+bool tsocket_address_is_inet(const struct tsocket_address *addr, const char *fam)
+{
+        struct tsocket_address_bsd *bsda = talloc_get_type(addr->private_data,
+                                           struct tsocket_address_bsd);
+
+        if (!bsda) {
+                return false;
+        }
+
+        switch (bsda->u.sa.sa_family) {
+        case AF_INET:
+                if (strcasecmp(fam, "ip") == 0) {
+                        return true;
+                }
+
+                if (strcasecmp(fam, "ipv4") == 0) {
+                        return true;
+                }
+
+                return false;
+#ifdef HAVE_IPV6
+        case AF_INET6:
+                if (strcasecmp(fam, "ip") == 0) {
+                        return true;
+                }
+
+                if (strcasecmp(fam, "ipv6") == 0) {
+                        return true;
+                }
+
+                return false;
+#endif
+        }
+
+        return false;
 }
 
@@ -465 +508 @@
 
         return 0;
+}
+
+bool tsocket_address_is_unix(const struct tsocket_address *addr)
+{
+        struct tsocket_address_bsd *bsda = talloc_get_type(addr->private_data,
+                                           struct tsocket_address_bsd);
+
+        if (!bsda) {
+                return false;
+        }
+
+        switch (bsda->u.sa.sa_family) {
+        case AF_UNIX:
+                return true;
+        }
+
+        return false;
 }
 
@@ -847 +907 @@
         ZERO_STRUCTP(bsda);
         bsda->sa_socklen = sizeof(bsda->u.ss);
+#ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
+        bsda->u.sa.sa_len = bsda->sa_socklen;
+#endif
 
         ret = recvfrom(bsds->fd, state->buf, state->len, 0,
@@ -1054 +1117 @@
         }
 
+        TALLOC_FREE(bsds->fde);
         ret = close(bsds->fd);
         bsds->fd = -1;
@@ -1184 +1248 @@
         fd = socket(sa_fam, SOCK_DGRAM, 0);
         if (fd < 0) {
-                return fd;
+                return -1;
         }
 
         fd = tsocket_bsd_common_prepare_fd(fd, true);
         if (fd < 0) {
-                return fd;
+                return -1;
         }
 
@@ -1217 +1281 @@
                         talloc_free(dgram);
                         errno = saved_errno;
-                        return ret;
+                        return -1;
                 }
         }
@@ -1231 +1295 @@
                         talloc_free(dgram);
                         errno = saved_errno;
-                        return ret;
+                        return -1;
                 }
         }
@@ -1244 +1308 @@
                         talloc_free(dgram);
                         errno = saved_errno;
-                        return ret;
+                        return -1;
                 }
         }
@@ -1254 +1318 @@
                         talloc_free(dgram);
                         errno = saved_errno;
-                        return ret;
+                        return -1;
                 }
         }
@@ -1270 +1334 @@
                         talloc_free(dgram);
                         errno = saved_errno;
-                        return ret;
+                        return -1;
                 }
         }
@@ -1610 +1674 @@
                         base = (uint8_t *)state->vector[0].iov_base;
                         base += ret;
-                        state->vector[0].iov_base = base;
+                        state->vector[0].iov_base = (void *)base;
                         state->vector[0].iov_len -= ret;
                         break;
@@ -1770 +1834 @@
                         base = (uint8_t *)state->vector[0].iov_base;
                         base += ret;
-                        state->vector[0].iov_base = base;
+                        state->vector[0].iov_base = (void *)base;
                         state->vector[0].iov_len -= ret;
                         break;
@@ -1841 +1905 @@
         }
 
+        TALLOC_FREE(bsds->fde);
         ret = close(bsds->fd);
         bsds->fd = -1;
@@ -1918 +1983 @@
         struct tevent_fd *fde;
         struct tstream_conext *stream;
+        struct tsocket_address *local;
 };
 
@@ -1936 +2002 @@
                                             void *private_data);
 
-static struct tevent_req * tstream_bsd_connect_send(TALLOC_CTX *mem_ctx,
+static struct tevent_req *tstream_bsd_connect_send(TALLOC_CTX *mem_ctx,
                                         struct tevent_context *ev,
                                         int sys_errno,
@@ -1947 +2013 @@
                 talloc_get_type_abort(local->private_data,
                 struct tsocket_address_bsd);
+        struct tsocket_address_bsd *lrbsda = NULL;
         struct tsocket_address_bsd *rbsda =
                 talloc_get_type_abort(remote->private_data,
@@ -2026 +2093 @@
         }
 
+        if (is_inet) {
+                state->local = tsocket_address_create(state,
+                                                      &tsocket_address_bsd_ops,
+                                                      &lrbsda,
+                                                      struct tsocket_address_bsd,
+                                                      __location__ "bsd_connect");
+                if (tevent_req_nomem(state->local, req)) {
+                        goto post;
+                }
+
+                ZERO_STRUCTP(lrbsda);
+                lrbsda->sa_socklen = sizeof(lrbsda->u.ss);
+#ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
+                lrbsda->u.sa.sa_len = lrbsda->sa_socklen;
+#endif
+        }
+
         state->fd = socket(sa_fam, SOCK_STREAM, 0);
         if (state->fd == -1) {
@@ -2082 +2166 @@
         }
         if (tevent_req_error(req, err)) {
+                goto post;
+        }
+
+        if (!state->local) {
+                tevent_req_done(req);
+                goto post;
+        }
+
+        ret = getsockname(state->fd, &lrbsda->u.sa, &lrbsda->sa_socklen);
+        if (ret == -1) {
+                tevent_req_error(req, errno);
                 goto post;
         }
@@ -2114 +2209 @@
         struct tstream_bsd_connect_state *state = tevent_req_data(req,
                                         struct tstream_bsd_connect_state);
+        struct tsocket_address_bsd *lrbsda = NULL;
         int ret;
         int error=0;
@@ -2136 +2232 @@
         }
 
+        if (!state->local) {
+                tevent_req_done(req);
+                return;
+        }
+
+        lrbsda = talloc_get_type_abort(state->local->private_data,
+                                       struct tsocket_address_bsd);
+
+        ret = getsockname(state->fd, &lrbsda->u.sa, &lrbsda->sa_socklen);
+        if (ret == -1) {
+                tevent_req_error(req, errno);
+                return;
+        }
+
         tevent_req_done(req);
 }
@@ -2143 +2253 @@
                                     TALLOC_CTX *mem_ctx,
                                     struct tstream_context **stream,
+                                    struct tsocket_address **local,
                                     const char *location)
 {
@@ -2161 +2272 @@
                 TALLOC_FREE(state->fde);
                 state->fd = -1;
+
+                if (local) {
+                        *local = talloc_move(mem_ctx, &state->local);
+                }
         }
 
@@ -2200 +2315 @@
                                    TALLOC_CTX *mem_ctx,
                                    struct tstream_context **stream,
+                                   struct tsocket_address **local,
                                    const char *location)
 {
-        return tstream_bsd_connect_recv(req, perrno, mem_ctx, stream, location);
+        return tstream_bsd_connect_recv(req, perrno,
+                                        mem_ctx, stream, local,
+                                        location);
 }
 
@@ -2235 +2353 @@
                                       const char *location)
 {
-        return tstream_bsd_connect_recv(req, perrno, mem_ctx, stream, location);
+        return tstream_bsd_connect_recv(req, perrno,
+                                        mem_ctx, stream, NULL,
+                                        location);
 }
 

trunk/server/lib/tsocket/tsocket_guide.txt

@@ -24 +24 @@
 ===============================
 
-The tsocket_address represents an socket endpoint genericly.
-As it's like an abstract class it has no specific constructor.
-The specific constructors are descripted later sections.
-
-There's a function get the string representation of the
-endpoint for debugging. Callers should not try to parse
-the string! The should use additional methods of the specific
-tsocket_address implemention to get more details.
+A tsocket_address represents a generic socket endpoint.
+It behaves like an abstract class, therefore it has no direct constructor.
+Constructors are described in later sections of this document.
+
+A function get the string representation of an endpoint for debugging is
+available but callers SHOULD NOT try to parse this string. To get more
+details callers should use getter methods of the specific tsocket_address
+implemention.
 
   char *tsocket_address_string(const struct tsocket_address *addr,
       TALLOC_CTX *mem_ctx);
 
-There's a function to create a copy of the tsocket_address.
-This is useful when before doing modifications to a socket
+A function to create a copy of the tsocket_address is also avilable.
+This is useful before doing modifications to a socket
 via additional methods of the specific tsocket_address implementation.
 
@@ -48 +48 @@
 The tdgram_context is like an abstract class for datagram
 based sockets. The interface provides async 'tevent_req' based
-functions on top functionality is similar to the
-recvfrom(2)/sendto(2)/close(2) syscalls.
+functions similar to recvfrom(2)/sendto(2)/close(2) syscalls.
 
 The tdgram_recvfrom_send() method can be called to ask for the
-next available datagram on the abstracted tdgram_context.
+next available datagram from the abstracted tdgram_context.
 It returns a 'tevent_req' handle, where the caller can register
 a callback with tevent_req_set_callback(). The callback is triggered
-when a datagram is available or an error happened.
+when a datagram is available or an error occurs.
 
 The callback is then supposed to get the result by calling
@@ -123 +122 @@
 ===============================
 
-The tstream_context is like an abstract class for stream
+A tstream_context is like an abstract class for stream
 based sockets. The interface provides async 'tevent_req' based
-functions on top functionality is similar to the
-readv(2)/writev(2)/close(2) syscalls.
-
-The tstream_pending_bytes() function is able to report
-how much bytes of the incoming stream have arrived
-but not consumed yet. It returns -1 and sets 'errno' on failure.
-Otherwise it returns the number of uncomsumed bytes
-(it can return 0!).
+functions similar to the readv(2)/writev(2)/close(2) syscalls.
+
+The tstream_pending_bytes() function is able to report how many bytes of
+the incoming stream have been received but have not been consumed yet.
+It returns -1 and sets 'errno' on failure.
+Otherwise it returns the number of uncomsumed bytes (it can return 0!).
 
   ssize_t tstream_pending_bytes(struct tstream_context *stream);
 
-The tstream_readv_send() method can be called to read for a
+The tstream_readv_send() method can be called to read a
 specific amount of bytes from the stream into the buffers
 of the given iovec vector. The caller has to preallocate the buffers
@@ -144 +141 @@
 where the caller can register a callback with tevent_req_set_callback().
 The callback is triggered when all iovec buffers are completely
-filled with bytes from the socket or an error happened.
+filled with bytes from the socket or an error occurs.
 
 The callback is then supposed to get the result by calling
 tstream_readv_recv() on the 'tevent_req'. It returns -1
 and sets '*perrno' to the actual 'errno' on failure.
-Otherwise it returns the length of the datagram
-(0 is never returned!).
+Otherwise it returns the length of the datagram (0 is never returned!).
 
 The caller can only have one outstanding tstream_readv_send()
@@ -166 +162 @@
 The tstream_writev_send() method can be called to write
 buffers in the given iovec vector into the stream socket.
-It's invalid to pass an empty vector.
+It is invalid to pass an empty vector.
 tstream_writev_send() returns a 'tevent_req' handle,
 where the caller can register a callback with tevent_req_set_callback().
@@ -190 +186 @@
       int *perrno);
 
-The tstream_disconnect_send() method should be used to normally
+The tstream_disconnect_send() method should normally be used to
 shutdown/close the abstracted socket.
 
@@ -209 +205 @@
 ============================
 
-In order to make the live easier for callers which want to implement
+In order to simplify the job, for callers that want to implement
 a function to receive a full PDU with a single async function pair,
-there're some helper functions.
+some helper functions are provided.
 
 The caller can use the tstream_readv_pdu_send() function
@@ -217 +213 @@
 The caller needs to provide a "next_vector" function and a private
 state for this function. The tstream_readv_pdu engine will ask
-the next_vector function for the next iovec vetor to be filled.
+the next_vector function for the next iovec vector to be used.
 There's a tstream_readv_send/recv pair for each vector returned
 by the next_vector function. If the next_vector function detects
@@ -223 +219 @@
 of the tevent_req (returned by tstream_readv_pdu_send()) is triggered.
 Note: the buffer allocation is completely up to the next_vector function
-and it's private state.
+and its private state.
 
 See the 'dcerpc_read_ncacn_packet_send/recv' functions in Samba as an
@@ -245 +241 @@
 ===========================================
 
-There're some cases where the caller wants doesn't care about the
-order of doing IO on the abstracted sockets.
+In some cases the caller doesn't care about the IO ordering on the
+abstracted socket.
 (Remember at the low level there's always only one IO in a specific
  direction allowed, only one tdgram_sendto_send() at a time).
 
-There're some helpers using 'tevent_queue' to make it easier
-for callers. The functions just get a 'queue' argument
-and serialize the operations.
+Some helpers that use 'tevent_queue' are avilable to simplify handling
+multiple IO requests. The functions just get a 'queue' argument and
+internally serialize all operations.
 
   struct tevent_req *tdgram_sendto_queue_send(TALLOC_CTX *mem_ctx,
@@ -296 +292 @@
 (dns names are not allowed!). But it's valid to pass NULL,
 which gets mapped to "0.0.0.0" or "::".
-It return -1 and set errno on error. Otherwise it returns 0.
+It returns -1 and sets errno on error. Otherwise it returns 0.
 
   int tsocket_address_inet_from_strings(TALLOC_CTX *mem_ctx,
@@ -343 +339 @@
 you can use the tsocket_address_unix_path() function.
 It will return NULL and set errno to EINVAL if the tsocket_address
-doesn't represent an unix domain endpoint path.
+doesn't represent a unix domain endpoint path.
 
   char *tsocket_address_unix_path(const struct tsocket_address *addr,
@@ -372 +368 @@
       struct tdgram_context **dgram);
 
-You can use tstream_inet_tcp_connect_send to async
+You can use tstream_inet_tcp_connect_send to asynchronously
 connect to a remote ipv4 or ipv6 TCP endpoint and create a
 tstream_context for the stream based communication. "local_address" has to be
@@ -398 +394 @@
       struct tstream_context **stream);
 
-You can use tstream_unix_connect_send to async
+You can use tstream_unix_connect_send to asynchronously
 connect to a unix domain endpoint and create a
 tstream_context for the stream based communication.
@@ -439 +435 @@
 for that. This should only be used if really needed, because of
 already existing fixed APIs. Only AF_INET, AF_INET6 and AF_UNIX
-sockets are allowed. The function returns -1 and set errno on error.
+sockets are allowed. The function returns -1 and sets errno on error.
 Otherwise it returns 0.