• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef BASE_ANDROID_LIBRARY_LOADER_LIBRARY_LOADER_HOOKS_H_
6 #define BASE_ANDROID_LIBRARY_LOADER_LIBRARY_LOADER_HOOKS_H_
7 
8 #include <jni.h>
9 
10 #include "base/base_export.h"
11 
12 namespace base {
13 namespace android {
14 
15 // The process the shared library is loaded in.
16 // GENERATED_JAVA_ENUM_PACKAGE: org.chromium.base.library_loader
17 enum LibraryProcessType {
18   // The LibraryLoad has not been initialized.
19   PROCESS_UNINITIALIZED = 0,
20   // Shared library is running in browser process.
21   PROCESS_BROWSER = 1,
22   // Shared library is running in child process.
23   PROCESS_CHILD = 2,
24   // Shared library is running in the app that uses webview.
25   PROCESS_WEBVIEW = 3,
26   // Shared library is running in child process as part of webview.
27   PROCESS_WEBVIEW_CHILD = 4,
28 };
29 
30 // Record any pending renderer histogram value as histograms.  Pending values
31 // are set by RegisterChromiumAndroidLinkerRendererHistogram and
32 // RegisterLibraryPreloaderRendererHistogram.
33 BASE_EXPORT void RecordLibraryLoaderRendererHistograms();
34 
35 // Registers the callbacks that allows the entry point of the library to be
36 // exposed to the calling java code.  This handles only registering the
37 // the callbacks needed by the loader. Any application specific JNI bindings
38 // should happen once the native library has fully loaded, either in the library
39 // loaded hook function or later.
40 BASE_EXPORT bool RegisterLibraryLoaderEntryHook(JNIEnv* env);
41 
42 // Typedef for hook function to be called (indirectly from Java) once the
43 // libraries are loaded. The hook function should register the JNI bindings
44 // required to start the application. It should return true for success and
45 // false for failure.
46 // Note: this can't use base::Callback because there is no way of initializing
47 // the default callback without using static objects, which we forbid.
48 typedef bool LibraryLoadedHook(JNIEnv* env,
49                                jclass clazz);
50 
51 // Set the hook function to be called (from Java) once the libraries are loaded.
52 // SetLibraryLoadedHook may only be called from JNI_OnLoad. The hook function
53 // should register the JNI bindings required to start the application.
54 
55 BASE_EXPORT void SetLibraryLoadedHook(LibraryLoadedHook* func);
56 
57 // Pass the version name to the loader. This used to check that the library
58 // version matches the version expected by Java before completing JNI
59 // registration.
60 // Note: argument must remain valid at least until library loading is complete.
61 BASE_EXPORT void SetVersionNumber(const char* version_number);
62 
63 // Call on exit to delete the AtExitManager which OnLibraryLoadedOnUIThread
64 // created.
65 BASE_EXPORT void LibraryLoaderExitHook();
66 
67 // Return the process type the shared library is loaded in.
68 BASE_EXPORT LibraryProcessType GetLibraryProcessType(JNIEnv* env);
69 
70 // Initialize AtExitManager, this must be done at the begining of loading
71 // shared library.
72 void InitAtExitManager();
73 
74 }  // namespace android
75 }  // namespace base
76 
77 #endif  // BASE_ANDROID_LIBRARY_LOADER_LIBRARY_LOADER_HOOKS_H_
78