{"id":4283,"date":"2009-09-01T12:29:00","date_gmt":"2009-09-01T12:29:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/vcblog\/2009\/09\/01\/compiler-warning-c4789\/"},"modified":"2019-02-18T18:45:48","modified_gmt":"2019-02-18T18:45:48","slug":"compiler-warning-c4789","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/cppblog\/compiler-warning-c4789\/","title":{"rendered":"Compiler Warning C4789"},"content":{"rendered":"

When Visual Studio 2010 ships, it will have improvements to warning C4789; allowing it to catch more cases of buffer overrun. This blog post will cover what C4789 warns about, and how to resolve the warning.<\/font><\/p>\n

What does C4789 mean?<\/p>\n

<\/font><\/font><\/font><\/span><\/h2>\n

\n

 <\/font><\/p>\n<\/p>\n

When compiling your source file, you may receive the warning: “warning C4789: destination of memory copy is too small.”<\/font><\/p>\n

This message means that the compiler has detected a possible buffer overrun in your code.<\/font><\/p>\n

Example 1<\/p>\n

<\/font><\/font><\/font><\/span><\/h3>\n

Let’s say we have the source file a.cpp that contains the following:<\/font><\/p>\n

1: #include<\/span> <memory.h><\/p>\n

<\/span><\/span><\/p>\n

2:<\/p>\n

<\/span><\/span><\/p>\n

3: int<\/span> p[1];<\/p>\n

<\/span><\/p>\n

4:<\/p>\n

<\/span><\/p>\n

5: void<\/span> bar() {<\/p>\n

<\/span><\/p>\n

6:     memset(&p[1], 1, sizeof<\/span>(int<\/span>));<\/p>\n

<\/span><\/p>\n

7: }<\/p>\n

<\/span><\/p>\n

\n

 <\/font><\/p>\n<\/p>\n

From the ”Visual Studio 2008 Command Prompt”, if you compile this with the command:<\/font><\/p>\n

cl \/c \/O2 a.cpp<\/p>\n

<\/font><\/span><\/p>\n

You will receive the warning:<\/font><\/p>\n

a.cpp(6) : warning C4789: destination of memory copy is too small<\/font><\/p>\n

For the example above, the compiler has detected a buffer overrun for the variable ‘p’. ‘p’ has been allocated as an array with one element. Arrays are zero-indexed, so the memset on line 6 is taking the address of the second<\/i> element of an array; this means that we are actually writing to memory outside the array, corrupting memory!<\/font><\/p>\n

In this case, the user most likely meant to memset the first element, and thus to fix this issue, the memset would be changed to <\/font><\/p>\n

memset(&p[0]<\/b>, 1, sizeof<\/span>(int<\/span>));<\/p>\n

<\/span><\/p>\n

\n

 <\/font><\/p>\n<\/p>\n

Typical User Scenarios<\/p>\n

<\/font><\/font><\/font><\/span><\/h2>\n

\n

 <\/font><\/p>\n<\/p>\n

In practice, a lot of buffer overruns will not be as obvious as Example 1, so I’ll provide some more examples to help you in your investigations.<\/font><\/p>\n

Example 2<\/p>\n

<\/font><\/font><\/font><\/span><\/h3>\n

Let’s say we have the source file a.cpp that contains the following:<\/font><\/p>\n

1:  short<\/span> G1;<\/p>\n

<\/span><\/p>\n

2:<\/p>\n

<\/span><\/p>\n

3:  void<\/span> foo(int<\/span> * x)<\/p>\n

<\/span><\/p>\n

4:  {<\/p>\n

<\/span><\/p>\n

5:      *x = 5;<\/p>\n

<\/span><\/p>\n

6:  }<\/p>\n

<\/span><\/p>\n

7: <\/p>\n

<\/span><\/p>\n

8:  void<\/span> bar() {<\/p>\n

<\/span><\/p>\n

9:     foo((int<\/span> *)&G1);<\/p>\n

<\/span><\/p>\n

10: }<\/span><\/p>\n

From the ”Visual Studio 2010<\/b> Command Prompt”, if you compile this with the command:<\/font><\/p>\n

cl \/c \/O2 a.cpp<\/p>\n

<\/font><\/span><\/p>\n

You will receive the warning:<\/font><\/p>\n

a.cpp(9) : warning C4789: destination of memory copy is too small<\/font><\/p>\n

In this example, we’ve created a variable ‘G1’ of si\nze short (which is only two bytes), but we’ve taken the address of it and casted it to ‘int *’ to pass to ‘foo’. ‘foo’ then writes 4 bytes to the memory location pointed at by ‘x’. As ‘G1’ is only 2 bytes in length, the store “*x = 5” will write past ‘G1’, resulting in a buffer overrun. <\/font><\/p>\n

There are a couple of important things to note about this example. This buffer overrun will only be caught with the improvements made in Visual Studio 2010. Also, this warning is caught by inlining ‘foo’ into ‘bar’. This means that this buffer overrun is only caught when optimizations are enabled.<\/font><\/p>\n

To fix the buffer overrun in Example 2, we declare ‘G1’ as int. If that isn’t an option, we can create a new variable to pass to ‘foo,’ and assign that variable to ‘G1’ (which truncates the int to a short):<\/font><\/p>\n

   int<\/span> y;<\/p>\n

<\/span><\/p>\n

   foo(&y);<\/p>\n

<\/span><\/p>\n

   G1 = y;<\/p>\n

<\/span><\/p>\n

\n

 <\/font><\/p>\n<\/p>\n

Example 3<\/p>\n

<\/font><\/font><\/font><\/span><\/h3>\n

Let’s say we have the source file a.cpp that contains the following:<\/font><\/p>\n

1:  int<\/span> G1;<\/p>\n

<\/span><\/p>\n

2:  int<\/span> G2;<\/p>\n

<\/span><\/p>\n

3:<\/p>\n

<\/span><\/p>\n

4:  void<\/span> foo(int<\/span> ** x)<\/p>\n

<\/span><\/p>\n

5:  {<\/p>\n

<\/span><\/p>\n

6:      *x = &G2;<\/p>\n

<\/span><\/p>\n

7:  }<\/p>\n

<\/span><\/p>\n

8:<\/p>\n

<\/span><\/p>\n

9:  void<\/span> bar() {<\/p>\n

<\/span><\/p>\n

10:     foo((int<\/span> *)&G1);<\/p>\n

<\/span><\/p>\n

11: }<\/span><\/p>\n

From the ”Visual Studio 2010 X64<\/b> Cross Tools Command Prompt”, if you compile this with the command:<\/font><\/p>\n

cl \/c \/O2 a.cpp<\/p>\n

<\/font><\/span><\/p>\n

You will receive the warning:<\/font><\/p>\n

a.cpp(10) : warning C4789: destination of memory copy is too small<\/font><\/p>\n

This example is exactly like Example 2 with a key difference. We’ve casted “int” to “int *”. On x86, this is a harmless cast (int and int * are the same size, 4 bytes). However, on x64, “int” is 4 bytes, and “int *” is 8 bytes, so this code is no longer correct when this code is run on x64.<\/font><\/p>\n

C4789 False Positives<\/p>\n

<\/font><\/font><\/font><\/span><\/h2>\n

\n

 <\/font><\/p>\n<\/p>\n

You may hit cases of C4789 where the warning is incorrect. This can happen because the compiler detects a buffer overrun along a code path that will never fire. <\/font><\/p>\n

Example 4<\/p>\n

<\/font><\/font><\/font><\/span><\/h3>\n

1:  __int64<\/span> G1;<\/p>\n

<\/span><\/p>\n

2:  int<\/span> lengthOfG1 = 8;<\/p>\n

<\/span><\/p>\n

3:<\/p>\n

<\/span><\/p>\n

4:  void<\/span> foo(char<\/span> * x, int<\/span> len) {<\/p>\n

<\/span><\/p>\n

5:      if<\/span> (len > 8) {<\/p>\n

<\/span><\/p>\n

6:          x[8] = 1;<\/p>\n

<\/span><\/p>\n

7:      }<\/p>\n

<\/span><\/p>\n

8:  }<\/p>\n

<\/span><\/p>\n

9:<\/p>\n

<\/span><\/p>\n

10: void<\/span> bar() {<\/p>\n

<\/span><\/p>\n

11:     foo((char<\/span> *)&G1, lengthOfG1);<\/p>\n

<\/span><\/p>\n

12: }<\/p>\n

<\/span><\/p>\n

From the ”Visual Studio 2010 Command Prompt”, if you compile this with the command:<\/font><\/p>\n

cl \/c \/O2 a.cpp<\/p>\n

<\/font><\/span><\/p>\n

You will receive the warning:<\/font><\/p>\n

a.cpp(11) : warning C4789: destination of memory copy is too small<\/font><\/p>\n

In this example, the compiler thinks that ‘G1’ can be buffer overrun because of “x[8] = 1” would assign outside of the size of ‘G1.’ However, as long as ‘lengthOfG1’ is the correct length of ‘G1,’ “x[8] = 1” will never fire for ‘G1,’ and thus a buffer overrun will never occur.<\/font><\/p>\n

For some of these false positives, the only option will be to disable the warning. In this particular example, however, changing “int lengthOfG1 = 8” to<\/font><\/p>\n

const int<\/span> lengthOfG1 = 8; <\/p>\n

<\/span><\/p>\n

would solve the problem.<\/font><\/p>\n

Workarounds<\/p>\n

<\/font><\/font><\/font><\/span><\/h2>\n

\n

 <\/font><\/p>\n<\/p>\n

If you have proven that the warning is a false positive, there are a couple of different ways to disable the warning.<\/font><\/p>\n

1.<\/font>       <\/span><\/span><\/span>Disable the warning for one function (recommended)<\/font><\/p>\n

2.<\/font>       <\/span><\/span><\/span>Disable the warning for all functions<\/font><\/p>\n

Disable the warning for one function<\/p>\n

<\/font><\/font><\/font><\/span><\/h2>\n

The compiler allows you to disable a warning for a particular function. This is done by putting<\/font><\/p>\n

#pragma<\/span> warning<\/span> ( disable<\/span> : 4789 )<\/span><\/p>\n

before the function, and putting<\/font><\/p>\n

#pragma<\/span> warning<\/span> ( default<\/span> : 4789 )<\/span><\/p>\n

after the function. This will disable the warning (in this case warning 4789) for that function (and any functions which inline it).<\/font><\/p>\n

Example 5<\/p>\n

<\/font><\/font><\/font><\/span><\/h3>\n

1:  __int64<\/span> G1;<\/p>\n

<\/span><\/p>\n

2:  int<\/span> lengthOfG1 = 8;<\/p>\n

<\/span><\/p>\n

3:<\/p>\n

<\/span><\/p>\n

4:  #pragma<\/span> warning<\/span> ( disable<\/span> : 4789 )<\/p>\n

<\/span><\/p>\n

5:  void<\/span> foo(char<\/span> * x, int<\/span> len) {<\/p>\n

<\/span><\/p>\n

6:      if<\/span> (len > 8) {<\/p>\n

<\/span><\/p>\n

7:          x[8] = 1;<\/p>\n

<\/span><\/p>\n

8:      }<\/p>\n

<\/span><\/p>\n

9:  }<\/p>\n

<\/span><\/p>\n

10: #pragma<\/span> warning<\/span> ( default<\/span> : 4789 )<\/p>\n

<\/span><\/p>\n

11:<\/p>\n

<\/span><\/p>\n

12: void<\/span> bar() {<\/p>\n

<\/span><\/p>\n

13:     foo((char<\/span> *)&G1, lengthOfG1);<\/p>\n

<\/span><\/p>\n

14: }<\/p>\n

<\/span><\/p>\n

15:<\/p>\n

<\/span><\/p>\n

16: void<\/span> bar1() {<\/p>\n

<\/span><\/p>\n

17:     foo((char<\/span> *)&G1, 9);<\/p>\n

<\/span><\/p>\n

18: }<\/p>\n

<\/span><\/p>\n

With the #pragma around ‘foo,’ you will receive no warnings; while without it you will receive the warnings:<\/font><\/p>\n

a.cpp(13) : warning C4789: destination of memory copy is too small<\/p>\n

<\/span><\/font><\/font><\/p>\n

a.cpp(17) : warning C4789: destination of memory copy is too small<\/font><\/p>\n

You can also choose to disable the warning for one of the functions where the warning occurs. In the example above, we could put the #pragma around ‘bar’ instead of ‘foo’, and then we’d eliminate the warning for line 13, but still receive the warning on line 17.<\/font><\/p>\n

Disable the warning for all functions<\/p>\n

<\/font><\/font><\/font><\/span><\/h2>\n

If you need to ignore warning 4789 completely, you can specify \/wd4789 on the command line.<\/font><\/p>\n

cl \/c \/O2 \/wd4789<\/b> a.cpp<\/p>\n

<\/font><\/span><\/p>\n

This option isn’t recommended as it will hide potentional buffer overruns in your code.<\/font><\/p>\n

\n

 <\/font><\/p><\/p>\n","protected":false},"excerpt":{"rendered":"

When Visual Studio 2010 ships, it will have improvements to warning C4789; allowing it to catch more cases of buffer overrun. This blog post will cover what C4789 warns about, and how to resolve the warning. What does C4789 mean?   When compiling your source file, you may receive the warning: “warning C4789: destination of […]<\/p>\n","protected":false},"author":289,"featured_media":35994,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[26,27],"class_list":["post-4283","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-cplusplus","tag-buffer-overrun","tag-c4789"],"acf":[],"blog_post_summary":"

When Visual Studio 2010 ships, it will have improvements to warning C4789; allowing it to catch more cases of buffer overrun. This blog post will cover what C4789 warns about, and how to resolve the warning. What does C4789 mean?   When compiling your source file, you may receive the warning: “warning C4789: destination of […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/4283","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/users\/289"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/comments?post=4283"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/posts\/4283\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media\/35994"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/media?parent=4283"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/categories?post=4283"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/cppblog\/wp-json\/wp\/v2\/tags?post=4283"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}