summaryrefslogtreecommitdiffstats
path: root/src/usr/vfs/vfsrp.H
blob: 014aad8157d264194b2fc3b8f13e988aa8b6adc2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/vfs/vfsrp.H $                                         */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 2011,2012              */
/*                                                                        */
/* p1                                                                     */
/*                                                                        */
/* Object Code Only (OCO) source materials                                */
/* Licensed Internal Code Source Materials                                */
/* IBM HostBoot Licensed Internal Code                                    */
/*                                                                        */
/* The source code for this program is not published or otherwise         */
/* divested of its trade secrets, irrespective of what has been           */
/* deposited with the U.S. Copyright Office.                              */
/*                                                                        */
/* Origin: 30                                                             */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
#ifndef VFSRP_H
#define VFSRP_H

#include <stdint.h>
#include <builtins.h>
#include <errl/errlentry.H>
#include <sys/msg.h>
#include <vector>
#include <sys/sync.h>

struct msg_t;

namespace VFS
{
    void vfs_msg_handler(void * unused);

    /**
     * Virtual File System Service
     */
    class VfsRp
    {
        public:

            /**
             * static init
             * @param[in] task args
             */
            static void init( errlHndl_t &io_taskRetErrl );

            /**
             * Get the list of test modules
             * @param[out] list of test module names
             */
            void get_test_modules(std::vector<const char *> & o_list) const;

            /**
             * Test for existance of module
             * @param[in] i_name module name
             * @return [true|false]
             */
            bool module_exists(const char * i_name) const;

            /**
             * get VfsSystemModule information
             * @param[in] i_name module name
             * @return pointer to VfsSystemModule entree
             *         or NULL if not found
             */
            const VfsSystemModule * get_vfs_info(const char * i_name) const;

            /**
             * Get the module name that contains the given address
             * @param[in] i_vaddr The virtual address
             * @return ptr to the module name or NULL if it's not found
             */
            const char * get_name_from_address(const void * i_vaddr) const;

            /**
             * Query if a module is loaded
             * @param[in] i_name  The module name
             * @return [true|false]
             */
            bool is_module_loaded(const char * i_name);

        protected:
            /**
             * Ctor
             */
            VfsRp() : iv_msgQ(NULL), iv_pnor_vaddr(0)
            {
                mutex_init(&iv_mutex);
            }

            /**
             * Dtor
             */
            ~VfsRp();

            /**
             * Start message handler
             */
            static void* msg_handler(void * unused);

            /**
             * Load or Unload a module
             * @param[in] i_msg the message
             * @note Does not return. 
             */
            static void* load_unload(void * i_msg);

            /**
             * Call _start on module
             * @param[in] i_msg the message
             * @note Does not return. 
             */
            static void* exec(void * i_msg);

        private: // functions

            /**
             * Initialize this object
             * @return return code on error
             */
            errlHndl_t _init();

            /**
             * Message handler
             */
            void msgHandler();

            /**
             * Load or Unload a module
             * @param[in] i_msg the message
             */
            void _load_unload(msg_t * i_msg);

            /**
             * Call _start on module
             * @param[in] i_msg the message
             */
            void _exec(msg_t * i_msg);

        private: // data

            msg_q_t iv_msgQ;         //!< message queue
            uint64_t iv_pnor_vaddr;  //!< virtual address of ext image in PFNOR

            typedef std::vector<VfsSystemModule *> ModuleList_t;

            mutex_t iv_mutex;       //!< lock for iv_loaded
            ModuleList_t iv_loaded; //!< Loaded modules
    };

}; // VFS namepsace

#endif
OpenPOWER on IntegriCloud