Make map_errno_from_nt_status() a generic call, not just a cli specific one.
[samba.git] / source3 / libsmb / clierror.c
index 44573bd29b1c4c70d9d5ff09aa9338e357ecb432..54f8a7a43cecc1ad4ea69855d002ea61c140ae20 100644 (file)
@@ -7,7 +7,7 @@
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
@@ -16,8 +16,7 @@
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "includes.h"
@@ -73,18 +72,20 @@ static const char *cli_smb_errstr(struct cli_state *cli)
 static NTSTATUS cli_smb_rw_error_to_ntstatus(struct cli_state *cli)
 {
        switch(cli->smb_rw_error) {
-               case READ_TIMEOUT:
+               case SMB_READ_TIMEOUT:
                        return NT_STATUS_IO_TIMEOUT;
-               case READ_EOF:
+               case SMB_READ_EOF:
                        return NT_STATUS_END_OF_FILE;
                /* What we shoud really do for read/write errors is convert from errno. */
                /* FIXME. JRA. */
-               case READ_ERROR:
+               case SMB_READ_ERROR:
                        return NT_STATUS_INVALID_NETWORK_RESPONSE;
-               case WRITE_ERROR:
+               case SMB_WRITE_ERROR:
                        return NT_STATUS_UNEXPECTED_NETWORK_ERROR;
-               case READ_BAD_SIG:
+               case SMB_READ_BAD_SIG:
                        return NT_STATUS_INVALID_PARAMETER;
+               case SMB_NO_MEMORY:
+                       return NT_STATUS_NO_MEMORY;
                default:
                        break;
        }
@@ -99,46 +100,51 @@ static NTSTATUS cli_smb_rw_error_to_ntstatus(struct cli_state *cli)
 
 const char *cli_errstr(struct cli_state *cli)
 {   
-       static fstring cli_error_message;
+       fstring cli_error_message;
        uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), errnum;
        uint8 errclass;
        int i;
+       char *result;
 
        if (!cli->initialised) {
                fstrcpy(cli_error_message, "[Programmer's error] cli_errstr called on unitialized cli_stat struct!\n");
-               return cli_error_message;
+               goto done;
        }
 
        /* Was it server socket error ? */
        if (cli->fd == -1 && cli->smb_rw_error) {
                switch(cli->smb_rw_error) {
-                       case READ_TIMEOUT:
+                       case SMB_READ_TIMEOUT:
                                slprintf(cli_error_message, sizeof(cli_error_message) - 1,
                                        "Call timed out: server did not respond after %d milliseconds",
                                        cli->timeout);
                                break;
-                       case READ_EOF:
+                       case SMB_READ_EOF:
                                slprintf(cli_error_message, sizeof(cli_error_message) - 1,
                                        "Call returned zero bytes (EOF)" );
                                break;
-                       case READ_ERROR:
+                       case SMB_READ_ERROR:
                                slprintf(cli_error_message, sizeof(cli_error_message) - 1,
                                        "Read error: %s", strerror(errno) );
                                break;
-                       case WRITE_ERROR:
+                       case SMB_WRITE_ERROR:
                                slprintf(cli_error_message, sizeof(cli_error_message) - 1,
                                        "Write error: %s", strerror(errno) );
                                break;
-                       case READ_BAD_SIG:
+                       case SMB_READ_BAD_SIG:
                                slprintf(cli_error_message, sizeof(cli_error_message) - 1,
                                        "Server packet had invalid SMB signature!");
                                break;
+                       case SMB_NO_MEMORY:
+                               slprintf(cli_error_message, sizeof(cli_error_message) - 1,
+                                       "Out of memory");
+                               break;
                        default:
                                slprintf(cli_error_message, sizeof(cli_error_message) - 1,
                                        "Unknown error code %d\n", cli->smb_rw_error );
                                break;
                }
-               return cli_error_message;
+               goto done;
        }
 
        /* Case #1: RAP error */
@@ -152,7 +158,7 @@ const char *cli_errstr(struct cli_state *cli)
                slprintf(cli_error_message, sizeof(cli_error_message) - 1, "RAP code %d",
                        cli->rap_error);
 
-               return cli_error_message;
+               goto done;
        }
 
        /* Case #2: 32-bit NT errors */
@@ -167,6 +173,11 @@ const char *cli_errstr(struct cli_state *cli)
        /* Case #3: SMB error */
 
        return cli_smb_errstr(cli);
+
+ done:
+       result = talloc_strdup(talloc_tos(), cli_error_message);
+       SMB_ASSERT(result);
+       return result;
 }
 
 
@@ -225,139 +236,6 @@ void cli_dos_error(struct cli_state *cli, uint8 *eclass, uint32 *ecode)
        *ecode  = SVAL(cli->inbuf,smb_err);
 }
 
-/* Return a UNIX errno from a NT status code */
-static struct {
-       NTSTATUS status;
-       int error;
-} nt_errno_map[] = {
-        {NT_STATUS_ACCESS_VIOLATION, EACCES},
-        {NT_STATUS_INVALID_HANDLE, EBADF},
-        {NT_STATUS_ACCESS_DENIED, EACCES},
-        {NT_STATUS_OBJECT_NAME_NOT_FOUND, ENOENT},
-        {NT_STATUS_SHARING_VIOLATION, EBUSY},
-        {NT_STATUS_OBJECT_PATH_INVALID, ENOTDIR},
-        {NT_STATUS_OBJECT_NAME_COLLISION, EEXIST},
-        {NT_STATUS_PATH_NOT_COVERED, ENOENT},
-       {NT_STATUS_UNSUCCESSFUL, EINVAL},
-       {NT_STATUS_NOT_IMPLEMENTED, ENOSYS},
-       {NT_STATUS_IN_PAGE_ERROR, EFAULT}, 
-       {NT_STATUS_BAD_NETWORK_NAME, ENOENT},
-#ifdef EDQUOT
-       {NT_STATUS_PAGEFILE_QUOTA, EDQUOT},
-       {NT_STATUS_QUOTA_EXCEEDED, EDQUOT},
-       {NT_STATUS_REGISTRY_QUOTA_LIMIT, EDQUOT},
-       {NT_STATUS_LICENSE_QUOTA_EXCEEDED, EDQUOT},
-#endif
-#ifdef ETIME
-       {NT_STATUS_TIMER_NOT_CANCELED, ETIME},
-#endif
-       {NT_STATUS_INVALID_PARAMETER, EINVAL},
-       {NT_STATUS_NO_SUCH_DEVICE, ENODEV},
-       {NT_STATUS_NO_SUCH_FILE, ENOENT},
-#ifdef ENODATA
-       {NT_STATUS_END_OF_FILE, ENODATA}, 
-#endif
-#ifdef ENOMEDIUM
-       {NT_STATUS_NO_MEDIA_IN_DEVICE, ENOMEDIUM}, 
-       {NT_STATUS_NO_MEDIA, ENOMEDIUM},
-#endif
-       {NT_STATUS_NONEXISTENT_SECTOR, ESPIPE}, 
-        {NT_STATUS_NO_MEMORY, ENOMEM},
-       {NT_STATUS_CONFLICTING_ADDRESSES, EADDRINUSE},
-       {NT_STATUS_NOT_MAPPED_VIEW, EINVAL},
-       {NT_STATUS_UNABLE_TO_FREE_VM, EADDRINUSE},
-       {NT_STATUS_ACCESS_DENIED, EACCES}, 
-       {NT_STATUS_BUFFER_TOO_SMALL, ENOBUFS},
-       {NT_STATUS_WRONG_PASSWORD, EACCES},
-       {NT_STATUS_LOGON_FAILURE, EACCES},
-       {NT_STATUS_INVALID_WORKSTATION, EACCES},
-       {NT_STATUS_INVALID_LOGON_HOURS, EACCES},
-       {NT_STATUS_PASSWORD_EXPIRED, EACCES},
-       {NT_STATUS_ACCOUNT_DISABLED, EACCES},
-       {NT_STATUS_DISK_FULL, ENOSPC},
-       {NT_STATUS_INVALID_PIPE_STATE, EPIPE},
-       {NT_STATUS_PIPE_BUSY, EPIPE},
-       {NT_STATUS_PIPE_DISCONNECTED, EPIPE},
-       {NT_STATUS_PIPE_NOT_AVAILABLE, ENOSYS},
-       {NT_STATUS_FILE_IS_A_DIRECTORY, EISDIR},
-       {NT_STATUS_NOT_SUPPORTED, ENOSYS},
-       {NT_STATUS_NOT_A_DIRECTORY, ENOTDIR},
-       {NT_STATUS_DIRECTORY_NOT_EMPTY, ENOTEMPTY},
-       {NT_STATUS_NETWORK_UNREACHABLE, ENETUNREACH},
-       {NT_STATUS_HOST_UNREACHABLE, EHOSTUNREACH},
-       {NT_STATUS_CONNECTION_ABORTED, ECONNABORTED},
-       {NT_STATUS_CONNECTION_REFUSED, ECONNREFUSED},
-       {NT_STATUS_TOO_MANY_LINKS, EMLINK},
-       {NT_STATUS_NETWORK_BUSY, EBUSY},
-       {NT_STATUS_DEVICE_DOES_NOT_EXIST, ENODEV},
-#ifdef ELIBACC
-       {NT_STATUS_DLL_NOT_FOUND, ELIBACC},
-#endif
-       {NT_STATUS_PIPE_BROKEN, EPIPE},
-       {NT_STATUS_REMOTE_NOT_LISTENING, ECONNREFUSED},
-       {NT_STATUS_NETWORK_ACCESS_DENIED, EACCES},
-       {NT_STATUS_TOO_MANY_OPENED_FILES, EMFILE},
-#ifdef EPROTO
-       {NT_STATUS_DEVICE_PROTOCOL_ERROR, EPROTO},
-#endif
-       {NT_STATUS_FLOAT_OVERFLOW, ERANGE},
-       {NT_STATUS_FLOAT_UNDERFLOW, ERANGE},
-       {NT_STATUS_INTEGER_OVERFLOW, ERANGE},
-       {NT_STATUS_MEDIA_WRITE_PROTECTED, EROFS},
-       {NT_STATUS_PIPE_CONNECTED, EISCONN},
-       {NT_STATUS_MEMORY_NOT_ALLOCATED, EFAULT},
-       {NT_STATUS_FLOAT_INEXACT_RESULT, ERANGE},
-       {NT_STATUS_ILL_FORMED_PASSWORD, EACCES},
-       {NT_STATUS_PASSWORD_RESTRICTION, EACCES},
-       {NT_STATUS_ACCOUNT_RESTRICTION, EACCES},
-       {NT_STATUS_PORT_CONNECTION_REFUSED, ECONNREFUSED},
-       {NT_STATUS_NAME_TOO_LONG, ENAMETOOLONG},
-       {NT_STATUS_REMOTE_DISCONNECT, ESHUTDOWN},
-       {NT_STATUS_CONNECTION_DISCONNECTED, ECONNABORTED},
-       {NT_STATUS_CONNECTION_RESET, ENETRESET},
-#ifdef ENOTUNIQ
-       {NT_STATUS_IP_ADDRESS_CONFLICT1, ENOTUNIQ},
-       {NT_STATUS_IP_ADDRESS_CONFLICT2, ENOTUNIQ},
-#endif
-       {NT_STATUS_PORT_MESSAGE_TOO_LONG, EMSGSIZE},
-       {NT_STATUS_PROTOCOL_UNREACHABLE, ENOPROTOOPT},
-       {NT_STATUS_ADDRESS_ALREADY_EXISTS, EADDRINUSE},
-       {NT_STATUS_PORT_UNREACHABLE, EHOSTUNREACH},
-       {NT_STATUS_IO_TIMEOUT, ETIMEDOUT},
-       {NT_STATUS_RETRY, EAGAIN},
-#ifdef ENOTUNIQ
-       {NT_STATUS_DUPLICATE_NAME, ENOTUNIQ},
-#endif
-#ifdef ECOMM
-       {NT_STATUS_NET_WRITE_FAULT, ECOMM},
-#endif
-
-       {NT_STATUS(0), 0}
-};
-
-/****************************************************************************
- The following mappings need tidying up and moving into libsmb/errormap.c...
-****************************************************************************/
-
-static int cli_errno_from_nt(NTSTATUS status)
-{
-       int i;
-        DEBUG(10,("cli_errno_from_nt: 32 bit codes: code=%08x\n", NT_STATUS_V(status)));
-
-        /* Status codes without this bit set are not errors */
-
-        if (!(NT_STATUS_V(status) & 0xc0000000)) {
-                return 0;
-       }
-
-       for (i=0;nt_errno_map[i].error;i++) {
-               if (NT_STATUS_V(nt_errno_map[i].status) ==
-                   NT_STATUS_V(status)) return nt_errno_map[i].error;
-       }
-
-        /* for all other cases - a default code */
-        return EINVAL;
-}
 
 /* Return a UNIX errno appropriate for the error received in the last
    packet. */
@@ -368,7 +246,7 @@ int cli_errno(struct cli_state *cli)
 
        if (cli_is_nt_error(cli)) {
                status = cli_nt_error(cli);
-               return cli_errno_from_nt(status);
+               return map_errno_from_nt_status(status);
        }
 
         if (cli_is_dos_error(cli)) {
@@ -377,7 +255,16 @@ int cli_errno(struct cli_state *cli)
 
                 cli_dos_error(cli, &eclass, &ecode);
                status = dos_to_ntstatus(eclass, ecode);
-               return cli_errno_from_nt(status);
+               return map_errno_from_nt_status(status);
+        }
+
+        /*
+         * Yuck!  A special case for this Vista error.  Since its high-order
+         * byte isn't 0xc0, it doesn't match cli_is_nt_error() above.
+         */
+        status = cli_nt_error(cli);
+        if (NT_STATUS_V(status) == NT_STATUS_V(NT_STATUS_INACCESSIBLE_SYSTEM_SHORTCUT)) {
+            return EACCES;
         }
 
        /* for other cases */
@@ -386,7 +273,7 @@ int cli_errno(struct cli_state *cli)
 
 /* Return true if the last packet was in error */
 
-BOOL cli_is_error(struct cli_state *cli)
+bool cli_is_error(struct cli_state *cli)
 {
        uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), rcls = 0;
 
@@ -409,7 +296,7 @@ BOOL cli_is_error(struct cli_state *cli)
 
 /* Return true if the last error was an NT error */
 
-BOOL cli_is_nt_error(struct cli_state *cli)
+bool cli_is_nt_error(struct cli_state *cli)
 {
        uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
 
@@ -423,7 +310,7 @@ BOOL cli_is_nt_error(struct cli_state *cli)
 
 /* Return true if the last error was a DOS error */
 
-BOOL cli_is_dos_error(struct cli_state *cli)
+bool cli_is_dos_error(struct cli_state *cli)
 {
        uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
 
@@ -451,3 +338,24 @@ NTSTATUS cli_get_nt_error(struct cli_state *cli)
                return NT_STATUS_UNSUCCESSFUL;
        }
 }
+
+/* Push an error code into the inbuf to be returned on the next
+ * query. */
+
+void cli_set_nt_error(struct cli_state *cli, NTSTATUS status)
+{
+       SSVAL(cli->inbuf,smb_flg2, SVAL(cli->inbuf,smb_flg2)|FLAGS2_32_BIT_ERROR_CODES);
+       SIVAL(cli->inbuf, smb_rcls, NT_STATUS_V(status));
+}
+
+/* Reset an error. */
+
+void cli_reset_error(struct cli_state *cli)
+{
+        if (SVAL(cli->inbuf,smb_flg2) & FLAGS2_32_BIT_ERROR_CODES) {
+               SIVAL(cli->inbuf, smb_rcls, NT_STATUS_V(NT_STATUS_OK));
+       } else {
+               SCVAL(cli->inbuf,smb_rcls,0);
+               SSVAL(cli->inbuf,smb_err,0);
+       }
+}