views:

470

answers:

5

I'm involved in one of those challenges where you try to produce the smallest possible binary, so I'm building my program without the C or C++ run-time libraries (RTL). I don't link to the DLL version or the static version. I don't even #include the header files. I have this working fine.

Some RTL functions, like memset(), can be useful, so I tried adding my own implementation. It works fine in Debug builds (even for those places where the compiler generates an implicit call to memset()). But in Release builds, I get an error saying that I cannot define an intrinsic function. You see, in Release builds, intrinsic functions are enabled, and memset() is an intrinsic.

I would love to use the intrinsic for memset() in my release builds, since it's probably inlined and smaller and faster than my implementation. But I seem to be a in catch-22. If I don't define memset(), the linker complains that it's undefined. If I do define it, the compiler complains that I cannot define an intrinsic function.

Does anyone know the right combination of definition, declaration, #pragma, and compiler and linker flags to get an intrinsic function without pulling in RTL overhead?

Visual Studio 2008, x86, Windows XP+.

To make the problem a little more concrete:

extern "C" void * __cdecl memset(void *, int, size_t);

#ifdef IMPLEMENT_MEMSET
void * __cdecl memset(void *pTarget, int value, size_t cbTarget) {
    char *p = reinterpret_cast<char *>(pTarget);
    while (cbTarget > 0) {
        *p++ = static_cast<char>(value);
        --cbTarget;
    }
    return pTarget;
}
#endif

struct MyStruct {
    int foo[10];
    int bar;
};

int main() {
    MyStruct blah;
    memset(&blah, 0, sizeof(blah));
    return blah.bar;
}

And I build like this:

cl /c /W4 /WX /GL /Ob2 /Oi /Oy /Gs- /GF /Gy intrinsic.cpp
link /SUBSYSTEM:CONSOLE /LTCG /DEBUG /NODEFAULTLIB /ENTRY:main intrinsic.obj

If I compile with my implementation of memset(), I get a compiler error:

error C2169: 'memset' : intrinsic function, cannot be defined

If I compile this without my implementation of memset(), I get a linker error:

error LNK2001: unresolved external symbol _memset
+3  A: 
  1. I'm pretty sure there's a compiler flag that tells VC++ not to use intrinsics

  2. The source to the runtime library is installed with the compiler. You do have the choice of excerpting functions you want/need, though often you'll have to modify them extensively (because they include features and/or dependencies you don't want/need).

  3. There are other open source runtime libraries available as well, which might need less customization.

  4. If you're really serious about this, you'll need to know (and maybe use) assembly language.

Edited to add:

I got your new test code to compile and link. These are the relevant settings:

Enable Intrinsic Functions: No
Whole Program Optimization: No

It's that last one that suppresses "compiler helpers" like the built-in memset.

Edited to add:

Now that it's decoupled, you can copy the asm code from memset.asm into your program--it has one global reference, but you can remove that. It's big enough so that it's not inlined, though if you remove all the tricks it uses to gain speed you might be able to make it small enough for that.

I took your above example and replaced the memset() with this:

void * __cdecl memset(void *pTarget, char value, size_t cbTarget) {
    _asm {
    push ecx
    push edi

    mov al, value
    mov ecx, cbTarget
    mov edi, pTarget
    rep stosb

    pop edi
    pop ecx
    }
    return pTarget;
}

It works, but the library's version is much faster.

egrunin
But that's working against the ultimate goal of trying to make the smallest possible binary. In many cases, including `memset`, the inlined intrinsic function is smaller than the function call.
Adrian McCarthy
Fabio Ceconello
The code in egrunin's second edit is essentially the same as the code generated by the compiler when it uses the intrinsic. The compiler is often able to save a few bytes when it knows that it doesn't need to preserve ecx and edi. The library version pays off when the number of bytes to clear gets larger. There's overhead in dealing with the possibly unaligned beginning and end.
Adrian McCarthy
@Adrian: so...did I answer your question?
egrunin
Everything you wrote it true, but it didn't really address my question. That's probably my fault for not being clear enough in the question. Turning off optimizations is counter to keeping the program small (which is why I'm trying to omit the RTL in the first place) and fast (which is a secondary goal). There doesn't seem to be a need to insert assembly into my code, when it's virtually identical to what the compiler generates. Thanks for the input.
Adrian McCarthy
+1  A: 

I think you have to set Optimization to "Minimize Size (/O1)" or "Disabled (/Od)" to get the Release configuration to compile; at least this is what did the trick for me with VS 2005. Intrinsics are designed for speed so it makes sense that they would be enabled for the other Optimization levels (Speed and Full).

Luke
I already have /O1, and /Od kinda defeats the goal of making the smallest possible binary. Speed is also an issue.
Adrian McCarthy
Well, I don't have VS2008 in front of me so maybe they changed something. In VS2005 this was the only change I had to make to get it to build successfully.
Luke
A: 

Just name the function something slightly different.

DeadMG
Good idea, but it doesn't work. I wrote my own version, called `ClearMemory()` using a namespace to make sure it doesn't conflict with anything else. The optimizer replaced my implementation of `ClearMemory()` with a call to `memset()` (with a byte value of 0)! Too smart for its own good. :-)
Adrian McCarthy
+1  A: 

I think I finally found a solution:

First, in a header file, declare memset() with a pragma, like so:

extern "C" void * __cdecl memset(void *, int, size_t);
#pragma intrinsic(memset)

That allows your code to call memset(). In most cases, the compiler will inline the intrinsic version.

Second, in a separate implementation file, provide an implementation. The trick to preventing the compiler from complaining about re-defining an intrinsic function is to use another pragma first. Like this:

#pragma function(memset)
void * __cdecl memset(void *pTarget, int value, size_t cbTarget) {
    char *p = reinterpret_cast<char *>(pTarget);
    while (cbTarget-- > 0) {
        *p++ = static_cast<char>(value);
    }
    return pTarget;
}

This provides an implementation for those cases where the optimizer decides not to use the intrinsic version.

The outstanding drawback is that you have to disable whole-program optimization (/GL and /LTCG). I'm not sure why. If someone finds a way to do this without disabling global optimization, please chime in.

Adrian McCarthy
What are all those casts doing there? Also, pointer conversions to and from `void *` are normally `static_cast`-s, not `reinterpret_cast`-s.
AndreyT
A: 

The way the "regular" runtime library does this is by compiling an assembly file with a definition of memset and linking it into the runtime library (You can find the assembly file in or around C:\Program Files\Microsoft Visual Studio 10.0\VC\crt\src\intel\memset.asm). That kind of thing works fine even with whole-program optimization.

Also note that the compiler will only use the memset intrinsic in some special cases (when the size is constant and small?). It will usually use the memset function provided by you, so you should probably use the optimized function in memset.asm, unless you're going to write something just as optimized.

Maybe I'll post a full example a bit later, or maybe you will.

namey