Singleton - Impl. using static class member vs. static member variable

Question

Bring you two different implantation of singleton design pattern:

static class member

class SingletonCSM;
using SingletonCSMSp = std::shared_ptr < SingletonCSM > ;

class SingletonCSM
{
public:

    ~SingletonCSM()  { spInstance = nullptr; }

    static SingletonCSMSp GetInstance()
    {
        if (!spInstance)
            spInstance = std::make_shared<SingletonCSM>();

        return spInstance;
    }

private:

    SingletonCSM() {}

    // will be intilized in the cpp: SingletonCSMSp SingletonCSM::spInstance = nullptr;
    static SingletonCSMSp spInstance; 
};

static member variable

class SingletonFSV;
using SingletonFSVSp = std::shared_ptr < SingletonFSV > ;

class SingletonFSV
{
public:

    ~SingletonFSV() {}

    static SingletonFSVSp GetInstance()
    {
        static SingletonFSVSp spInstance = std::make_shared<SingletonFSV>();
        return spInstance;
    }

private:

    SingletonFSV() {}

};

I always use the first impl. SingletonCSM. I came across, in our code, an impl. like SingletonFSV

Questions

Can we consider both impl. as a valid impl. of the design pattern?
Are both, functionally, the same?

Motivation

Background

Class SingletonFSV was implemented as a part of a DLL project. This DLL, compiled in VS 2013, is loaded in memory by an exe file and run.

Problem

I've upgrade my VS to VS 2015, compiled the DLL project and run the exe. All of a sudden, it crashed. While debugging, I've notice that the crash happened in the DLL itself. make_shared called withing GetInstance() returned nullptr and naturally caused segmentation fault.

Solution

I've changed SingletonFSV impl. to SingletonCSM and the crash stopped. make_shared returned a valid pointer and the problem was solved.

Question

I just don't understand what was the problem and why was it solved?

Do note that neither of these are singletons. They both have public constructors meaning you can make as many instances as you want. — NathanOliver
– NathanOliver, Commented Sep 21, 2016 at 12:47
@DieterLücking is that related to the problem or just a general comment? 10x. — idanshmu
– idanshmu, Commented Sep 21, 2016 at 12:47
@idanshmu ... the static variable of that inline function (not put into a specific translation unit) is the problem. — user2249683
– user2249683, Commented Sep 21, 2016 at 13:05

Galik · Accepted Answer · 2016-09-21 13:08:21Z

2

When you put a static variable inside a function it is created the first time the function is called so it is guaranteed to have been instantiated to all callers of the function.

Members that are declared static could be instantiated before or after you call your function because the initialization order between translation units is undefined. So a global object or static object could try to access a static member before its been initialized by the runtime system.

So to your questions:

Can we consider both impl. as a valid impl. of the design pattern?

Are both, functionally, the same?

No. Using a static member is dangerous because a caller to SingletonCSM::GetInstance() can access a non-created object if the nullptr initialization has not taken place before the call. The static function method is the recommended method because it guarantees initialization has completed for every caller.

I just don't understand what was the problem and why was it solved?

In your case moving to the more dangerous method appears to have stopped your crash. I can not explain why that is. But you may not have removed the problem, it may be that you have undefined behavior elsewhere that has simply stopped manifesting in this case but that may resurface later with a different change.

edited Sep 21, 2016 at 13:08

answered Sep 21, 2016 at 12:49

Galik

49k5 gold badges85 silver badges126 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

idanshmu Over a year ago

OK. but how does it explain the problem? I would expect SingletonFSV to work always while SingletonCSM may crash occasionally. but the problem is the other way around

Galik Over a year ago

@idanshmu Yes I can't answer your third question. I misread your problem and assumed the function static method solved it. This sounds like a job for your debugger because, in principle, using a static member is problematic and to be avoided whereas using a function static is considered the safe option.

Collectives™ on Stack Overflow

Singleton - Impl. using static class member vs. static member variable

static class member

static member variable

Questions

Motivation

Background

Problem

Solution

Question

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

static class member

static member variable

Questions

Motivation

Background

Problem

Solution

Question

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related